Struct ExternalAuthProviderRegistry 

pub struct ExternalAuthProviderRegistry { /* private fields */ }

Registry of external authentication provider drivers keyed by provider kind.

The registry is the shared capability boundary for application services. Callers can use it to list descriptors for admin surfaces, gate stored provider configs before a login flow starts, and retrieve the runtime driver for a validated provider. The registry deliberately does not know how providers are stored in a product database; applications adapt their own rows into ExternalAuthProviderConfig immediately before using this type.

Implementations

impl ExternalAuthProviderRegistry

pub fn empty() -> Self

Creates an empty registry with no built-in provider drivers.

This is useful for applications that want a fully explicit provider list, tests that need deterministic registration behavior across Cargo feature sets, or plugin hosts that build a registry from externally supplied drivers.

pub fn new() -> Self

Creates a registry populated with all feature-enabled built-in drivers.

pub fn with_external_registrations<F>(configure: F) -> Result<Self>

where F: FnOnce(&mut Self) -> Result<()>,

Creates a built-in registry and lets an external system append registrations.

This is the intended integration point for application-level extension systems: the caller receives a mutable registry, calls ExternalAuthProviderRegistry::add for each external driver it wants to expose, and returns any setup error. Built-in drivers are registered before the callback runs, so external systems cannot accidentally replace them through the non-replacing add API.

pub fn add<D>(&mut self, driver: D) -> Result<()>

where D: ExternalAuthProviderDriver + 'static,

Adds a driver if its provider kind is not already registered.

Use this for product-specific or plugin-provided drivers. Duplicate provider kinds return a configuration error instead of replacing the existing driver, which keeps built-in behavior stable when external systems are enabled.

pub fn add_arc( &mut self, driver: Arc<dyn ExternalAuthProviderDriver>, ) -> Result<()>

Adds an already shared driver if its provider kind is not already registered.

pub fn register<D>(&mut self, driver: D) -> Result<()>

where D: ExternalAuthProviderDriver + 'static,

Registers or replaces a driver for its provider kind.

Use this only when replacement is intentional, such as tests or product-level overrides. The driver must still report a descriptor for the same provider kind that it registers.

pub fn register_arc( &mut self, driver: Arc<dyn ExternalAuthProviderDriver>, ) -> Result<()>

Registers or replaces an already shared driver for its provider kind.

pub fn supported_kinds( &self, ) -> impl Iterator<Item = ExternalAuthProviderKind> + '_

Iterates over registered provider kinds.

pub fn contains(&self, kind: ExternalAuthProviderKind) -> bool

Returns whether a driver for kind is registered.

pub fn descriptors(&self) -> Vec<ExternalAuthProviderDescriptor>

Returns registered provider descriptors sorted by provider kind.

pub fn descriptor_for( &self, kind: ExternalAuthProviderKind, ) -> Result<ExternalAuthProviderDescriptor>

Returns the descriptor for a registered provider kind.

pub fn ensure_provider_supported( &self, kind: ExternalAuthProviderKind, ) -> Result<()>

Ensures that a provider kind is enabled in this registry.

This is useful for service-layer guards that need to reject disabled provider kinds without constructing a login flow or exposing the underlying driver.

pub fn validate_provider_config( &self, provider: &ExternalAuthProviderConfig, ) -> Result<ExternalAuthProviderDescriptor>

Validates that a product-owned provider config matches a registered driver descriptor.

This catches configuration drift before provider-specific network calls run. The method checks that the provider kind is enabled and that the stored protocol matches the driver’s declared protocol. It returns the descriptor so callers can keep using the capability data without another registry lookup.

pub fn driver_for_provider( &self, provider: &ExternalAuthProviderConfig, ) -> Result<Arc<dyn ExternalAuthProviderDriver>>

Returns the registered driver for a provider config after validating the config boundary.

Product services should prefer this method when starting authorization, exchanging a callback, or testing a provider because it applies the same registry-level gates for every flow.

pub fn get_driver( &self, kind: ExternalAuthProviderKind, ) -> Result<Arc<dyn ExternalAuthProviderDriver>>

Returns a registered driver by provider kind.

pub fn oidc(&self) -> Result<Arc<dyn ExternalAuthProviderDriver>>

Returns the OIDC driver from this registry.

Trait Implementations

impl Default for ExternalAuthProviderRegistry

fn default() -> Self

Returns the “default value” for a type.