Namespace Arc4u.OAuth2.Options

Classes

ApiExtraContextAuthenticationOption

Extra parameters added to the authorization and token requests sent to the identity provider.

ApiExtraContextAuthenticationSectionOption

Gives the configuration section paths from which the extra authorization and token request parameters are read.

AuthorityOptions

Describes an OpenID Connect authority (identity provider) and its endpoints. Endpoints that are not set explicitly are discovered from the metadata document (.well-known/openid-configuration) of the authority.

BasicAuthenticationConfigurationOptions

The code based configuration of the Basic authentication middleware, given to AddBasicAuthenticationSettings(IServiceCollection, Action<BasicAuthenticationConfigurationOptions>).

BasicAuthenticationConfigurationSectionOptions

The configuration section layout of the Basic authentication, bound from the section given to AddBasicAuthenticationSettings(IServiceCollection, IConfiguration, string, IX509CertificateLoader?, bool) (Authentication:Basic by default).

BasicAuthenticationSettingsOptions

The validated Basic authentication settings, registered as options and consumed by the BasicAuthenticationMiddleware.

ClaimsFillerOptions

Inform if extra claims must be loaded during the authentication process.

ClaimsIdentifierOption

The ordered list of claim types used to identify a user. The first claim type found on the identity is used.

ClientTokenSettingsOptions

Unified configuration entry for the Authentication:ClientTokens section.

Carries only the fields common to every client token acquisition scenario. The Scenario property is the discriminator that selects the IClientTokenScenario responsible for validating this entry and projecting it into a SimpleKeyValueSettings.

All scenario-specific values (ClientId, ClientSecret, User, Password, Credential, …) live in the open Settings bag. The selected scenario claims the keys it consumes; every remaining key is forwarded verbatim to the token endpoint as an extra request parameter.

ConfigureCookieWithTicketStoreAuthenticationOptions

Configures the authentication cookie so the session is kept in an ITicketStore. It is registered (with TryAddSingleton) by AddOidcAuthentication and AddHybridAuthentication when AuthenticationCacheTicketStoreOption is set; another IPostConfigureOptions<TOptions> of the cookie options registered before replaces it.

ConfigureStandardCookieAuthenticationOptions

Configures the authentication cookie when no ticket store is used (the session is kept in the cookie). It is registered (with TryAddSingleton) by AddOidcAuthentication and AddHybridAuthentication when AuthenticationCacheTicketStoreOption is not set.

HybridAuthenticationOptions

The options of the hybrid authentication: the OidcAuthenticationOptions of the browser (OpenID Connect and cookie) authentication plus the settings used to validate JWT bearer tokens.

HybridAuthenticationSectionOptions

The configuration layout of the hybrid authentication: the OidcAuthenticationSectionOptions plus the paths of the JWT bearer and Basic authentication sections.

JwtAuthenticationOptions

The options of the JWT bearer authentication, given to AddJwtAuthentication.

JwtAuthenticationSectionOptions

The configuration layout of the JWT bearer authentication. It is bound from the root Authentication section (or the section name given to AddJwtAuthentication). The *Path properties are the paths of the other configuration sections read during registration.

OAuth2SettingsOption

The settings used to validate the JWT bearer tokens received by the application and to obtain a token from them. Bound from the Authentication:OAuth2.Settings section by default. They are registered as the SimpleKeyValueSettings named OAuth2 (see OAuth2SettingsExtension).

OidcAuthenticationOptions

The options of the OpenID Connect authentication. They are given to AddOidcAuthentication or filled from the configuration by the configuration based overload. They are registered as IOptions<OidcAuthenticationOptions> and read by the cookie and OpenID Connect events.

OidcAuthenticationSectionOptions

The configuration layout of the OpenID Connect authentication. It is bound from the root Authentication section (or the section name given to AddOidcAuthentication). The *Path properties are the paths of the other configuration sections read during registration; each one has a default that can be overridden.

OnBehalfOfSettingsOptions

The settings of an on-behalf-of token request. The entries of the Authentication:OnBehalfOf section are bound to this class; each one is registered as a SimpleKeyValueSettings named as the entry.

OpenIdBearerInjectorOptions

Configures the OpenID bearer injector middleware: the names under which the token settings and the token provider are registered.

OpenIdBearerInjectorSettingsOptions

The resolved settings used by the OpenID bearer injector middleware. They are filled from OpenIdBearerInjectorOptions by PostConfigureOpenIdBearerInjectorSettings.

OpenIdSettingsOption

The settings of the OpenID Connect client. Bound from the Authentication:OpenId.Settings section by default. They are registered as the SimpleKeyValueSettings named Cookies (see OpenIdSettingsExtension).

PostConfigureOpenIdBearerInjectorSettings

Fills the default (unnamed) OpenIdBearerInjectorSettingsOptions from the named SimpleKeyValueSettings designated by OpenIdBearerInjectorOptions.

RemoteSecretSettingsOptions

Describes a remote secret: an encrypted credential that a caller sends in a header and that the server decrypts and exchanges for a token. Each entry of the Authentication:RemoteSecrets section is bound to this class.

TokenCacheOptions

Defines the cache in which the tokens are stored and for how long.

ValidateResourceRightMiddlewareOptions

Protects one resource path with an authorization policy.

ValidateResourcesRightMiddlewareOptions

Configures the resources right validation middleware.