Struct OAuthRegistrationStore

pub struct OAuthRegistrationStore { /* private fields */ }

Available on non-WebAssembly only.

An API to store and restore OAuth 2.0 client registrations.

This stores dynamic client registrations in a file, and accepts “static” client registrations via OAuthRegistrationStore::with_static_registrations(), for servers that don’t support dynamic client registration.

If the client metadata passed to this API changes, the previous registrations that were stored in the file are invalidated, allowing to re-register with the new metadata.

The purpose of storing client IDs outside of the state store or separate from the user’s session is that it allows to reuse the same client ID between user sessions on the same server.

Implementations

impl OAuthRegistrationStore

pub async fn new( file: PathBuf, metadata: Raw<ClientMetadata>, ) -> Result<Self, OAuthRegistrationStoreError>

Creates a new registration store.

This method creates the file’s parent directory if it doesn’t exist.

Arguments

• file - A file path where the registrations will be stored. This previously took a directory and stored the registrations with the path supplied_directory/oidc/registrations.json.

• metadata - The metadata used to register the client. If this changes compared to the value stored in the file, any stored registrations will be invalidated so the client can re-register with the new data.

pub fn with_static_registrations( self, static_registrations: HashMap<Url, ClientId>, ) -> Self

Add static registrations to the store.

Static registrations are used for servers that don’t support dynamic registration but provide a client ID out-of-band.

These registrations are not stored in the file and must be provided each time.

pub async fn client_id( &self, issuer: &Url, ) -> Result<Option<ClientId>, OAuthRegistrationStoreError>

Returns the client ID registered for a particular issuer or None if a registration hasn’t been made.

Arguments

• issuer - The issuer to look up.

Errors

Returns an error if the file could not be read, or if the data in the file could not be deserialized.

pub async fn set_and_write_client_id( &self, client_id: ClientId, issuer: Url, ) -> Result<(), OAuthRegistrationStoreError>

Stores a new client ID registration for a particular issuer.

If a client ID has already been stored for the given issuer, this will overwrite the old value.

Arguments

• client_id - The client ID obtained after registration.

• issuer - The issuer associated with the client ID.

Errors

Returns an error if the file could not be read from or written to, or if the data in the file could not be (de)serialized.

Trait Implementations

impl Debug for OAuthRegistrationStore

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<OAuthRegistrationStore> for ClientRegistrationMethod

fn from(value: OAuthRegistrationStore) -> Self

Converts to this type from the input type.