Microsoft.Owin.Security.OAuth

Data object used by TokenEndpointRequest which contains parameter information when the "grant_type" is unrecognized.

The parameter information when the "grant_type" is unrecognized.

Data object used by TokenEndpointRequest when the "grant_type" parameter is "refresh_token".

The value passed to the Token endpoint in the "refresh_token" parameter

The value passed to the Token endpoint in the "scope" parameter

Data object used by TokenEndpointRequest when the "grant_type" is "authorization_code".

The value passed to the Token endpoint in the "code" parameter

The value passed to the Token endpoint in the "redirect_uri" parameter. This MUST be provided by the caller if the original visit to the Authorize endpoint contained a "redirect_uri" parameter.

Data object representing the information contained in the query string of an Authorize endpoint request.

Creates a new instance populated with values from the query string parameters.

Query string parameters from a request.

The "response_type" query string parameter of the Authorize request. Known values are "code" and "token".

The "client_id" query string parameter of the Authorize request.

The "redirect_uri" query string parameter of the Authorize request. May be absent if the server should use the redirect uri known to be registered to the client id.

The "scope" query string parameter of the Authorize request. May be absent if the server should use default scopes.

The "scope" query string parameter of the Authorize request. May be absent if the client does not require state to be included when returning to the RedirectUri.

True if the "response_type" query string parameter is "code". See also, http://tools.ietf.org/html/rfc6749#section-4.1.1

True if the "response_type" query string parameter is "token". See also, http://tools.ietf.org/html/rfc6749#section-4.2.1

Data object representing the information contained in form encoded body of a Token endpoint request.

Creates a new instance populated with values from the form encoded body parameters.

Form encoded body parameters from a request.

The form encoded body parameters of the Token endpoint request

The "grant_type" parameter of the Token endpoint request. This parameter is required.

The "client_id" parameter of the Token endpoint request. This parameter is optional. It might not be present if the request is authenticated in a different way, for example, by using basic authentication credentials.

Data object available when the "grant_type" is "authorization_code". See also http://tools.ietf.org/html/rfc6749#section-4.1.3

Data object available when the "grant_type" is "client_credentials". See also http://tools.ietf.org/html/rfc6749#section-4.4.2

Data object available when the "grant_type" is "refresh_token". See also http://tools.ietf.org/html/rfc6749#section-6

Data object available when the "grant_type" is "password". See also http://tools.ietf.org/html/rfc6749#section-4.3.2

Data object available when the "grant_type" is unrecognized. See also http://tools.ietf.org/html/rfc6749#section-4.5

True when the "grant_type" is "authorization_code". See also http://tools.ietf.org/html/rfc6749#section-4.1.3

True when the "grant_type" is "client_credentials". See also http://tools.ietf.org/html/rfc6749#section-4.4.2

True when the "grant_type" is "refresh_token". See also http://tools.ietf.org/html/rfc6749#section-6

True when the "grant_type" is "password". See also http://tools.ietf.org/html/rfc6749#section-4.3.2

True when the "grant_type" is unrecognized. See also http://tools.ietf.org/html/rfc6749#section-4.5

Data object used by TokenEndpointRequest when the "grant_type" is "client_credentials".

The value passed to the Token endpoint in the "scope" parameter

Data object used by TokenEndpointRequest when the "grant_type" is "password".

The value passed to the Token endpoint in the "username" parameter

The value passed to the Token endpoint in the "password" parameter

The value passed to the Token endpoint in the "scope" parameter

Extension methods to add Authorization Server capabilities to an OWIN pipeline

Adds OAuth2 Authorization Server capabilities to an OWIN web application. This middleware performs the request processing for the Authorize and Token endpoints defined by the OAuth2 specification. See also http://tools.ietf.org/html/rfc6749

The web application builder Options which control the behavior of the Authorization Server. The application builder

Options class provides information needed to control Authorization Server middleware behavior

Creates an instance of authorization server options with default values.

The request path where client applications will redirect the user-agent in order to obtain user consent to issue a token. Must begin with a leading slash, like "/Authorize".

The request path client applications communicate with directly as part of the OAuth protocol. Must begin with a leading slash, like "/Token". If the client is issued a client_secret, it must be provided to this endpoint.

The object provided by the application to process events raised by the Authorization Server middleware. The application may implement the interface fully, or it may create an instance of OAuthAuthorizationServerProvider and assign delegates only to the events it wants to process.

The data format used to protect and unprotect the information contained in the authorization code. If not provided by the application the default data protection provider depends on the host server. The SystemWeb host on IIS will use ASP.NET machine key data protection, and HttpListener and other self-hosted servers will use DPAPI data protection.

The data format used to protect the information contained in the access token. If not provided by the application the default data protection provider depends on the host server. The SystemWeb host on IIS will use ASP.NET machine key data protection, and HttpListener and other self-hosted servers will use DPAPI data protection. If a different access token provider or format is assigned, a compatible instance must be assigned to the OAuthBearerAuthenticationOptions.AccessTokenProvider or OAuthBearerAuthenticationOptions.AccessTokenFormat property of the resource server.

The data format used to protect and unprotect the information contained in the refresh token. If not provided by the application the default data protection provider depends on the host server. The SystemWeb host on IIS will use ASP.NET machine key data protection, and HttpListener and other self-hosted servers will use DPAPI data protection.

The period of time the authorization code remains valid after being issued. The default is five minutes. This time span must also take into account clock synchronization between servers in a web farm, so a very brief value could result in unexpectedly expired tokens.

The period of time the access token remains valid after being issued. The default is twenty minutes. The client application is expected to refresh or acquire a new access token after the token has expired.

Produces a single-use authorization code to return to the client application. For the OAuth server to be secure the application MUST provide an instance for AuthorizationCodeProvider where the token produced by the OnCreate or OnCreateAsync event is considered valid for only one call to OnReceive or OnReceiveAsync.

Produces a bearer token the client application will typically be providing to resource server as the authorization bearer http request header. If not provided the token produced on the server's default data protection. If a different access token provider or format is assigned, a compatible instance must be assigned to the OAuthBearerAuthenticationOptions.AccessTokenProvider or OAuthBearerAuthenticationOptions.AccessTokenFormat property of the resource server.

Produces a refresh token which may be used to produce a new access token when needed. If not provided the authorization server will not return refresh tokens from the /Token endpoint.

Set to true if the web application is able to render error messages on the /Authorize endpoint. This is only needed for cases where the browser is not redirected back to the client application, for example, when the client_id or redirect_uri are incorrect. The /Authorize endpoint should expect to see "oauth.Error", "oauth.ErrorDescription", "oauth.ErrorUri" properties added to the owin environment.

Used to know what the current clock time is when calculating or validating token expiration. When not assigned default is based on DateTimeOffset.UtcNow. This is typically needed only for unit testing.

True to allow authorize and token requests to arrive on http URI addresses, and to allow incoming redirect_uri authorize request parameter to have http URI addresses.

Authorization Server middleware component which is added to an OWIN pipeline. This class is not created by application code directly, instead it is added by calling the the IAppBuilder UseOAuthAuthorizationServer extension method.

Authorization Server middleware component which is added to an OWIN pipeline. This constructor is not called by application code directly, instead it is added by calling the the IAppBuilder UseOAuthAuthorizationServer extension method.

Called by the AuthenticationMiddleware base class to create a per-request handler.

A new instance of the request handler

Extension methods to add OAuth Bearer authentication capabilities to an OWIN application pipeline

Adds Bearer token processing to an OWIN application pipeline. This middleware understands appropriately formatted and secured tokens which appear in the request header. If the Options.AuthenticationMode is Active, the claims within the bearer token are added to the current request's IPrincipal User. If the Options.AuthenticationMode is Passive, then the current request is not modified, but IAuthenticationManager AuthenticateAsync may be used at any time to obtain the claims from the request's bearer token. See also http://tools.ietf.org/html/rfc6749

The web application builder Options which control the processing of the bearer header. The application builder

Bearer authentication middleware component which is added to an OWIN pipeline. This class is not created by application code directly, instead it is added by calling the the IAppBuilder UseOAuthBearerAuthentication extension method.

Bearer authentication component which is added to an OWIN pipeline. This constructor is not called by application code directly, instead it is added by calling the the IAppBuilder UseOAuthBearerAuthentication extension method.

Called by the AuthenticationMiddleware base class to create a per-request handler.

A new instance of the request handler

Options class provides information needed to control Bearer Authentication middleware behavior

Creates an instance of bearer authentication options with default values.

Determines what realm value is included when the bearer middleware adds a response header to an unauthorized request. If not assigned, the response header does not have a realm.

The object provided by the application to process events raised by the bearer authentication middleware. The application may implement the interface fully, or it may create an instance of OAuthBearerAuthenticationProvider and assign delegates only to the events it wants to process.

The data format used to unprotect the information contained in the access token. If not provided by the application the default data protection provider depends on the host server. The SystemWeb host on IIS will use ASP.NET machine key data protection, and HttpListener and other self-hosted servers will use DPAPI data protection. If a different access token provider or format is assigned, a compatible instance must be assigned to the OAuthAuthorizationServerOptions.AccessTokenProvider and OAuthAuthorizationServerOptions.AccessTokenFormat of the authorizatoin server.

Receives the bearer token the client application will be providing to web application. If not provided the token produced on the server's default data protection by using the AccessTokenFormat. If a different access token provider or format is assigned, a compatible instance must be assigned to the OAuthAuthorizationServerOptions.AccessTokenProvider and OAuthAuthorizationServerOptions.AccessTokenFormat of the authorization server.

Used to know what the current clock time is when calculating or validaing token expiration. When not assigned default is based on DateTimeOffset.UtcNow. This is typically needed only for unit testing.

Default values used by authorization server and bearer authentication.

Default value for AuthenticationType property in the OAuthBearerAuthenticationOptions and OAuthAuthorizationServerOptions.

Base class used for certain event contexts

Initializes base class used for certain event contexts

Marks this context as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.

True if the validation has taken effect.

Marks this context as not validated by the application. IsValidated and HasError become false as a result of calling.

Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.

Assigned to the Error property

Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.

Assigned to the Error property Assigned to the ErrorDescription property

Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.

Assigned to the Error property Assigned to the ErrorDescription property Assigned to the ErrorUri property

True if application code has called any of the Validate methods on this context.

True if application code has called any of the SetError methods on this context.

The error argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error" parameter.

The optional errorDescription argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error_description" parameter.

The optional errorUri argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error_uri" parameter.

Initializes base class used for certain event contexts

The "client_id" parameter for the current request. The Authorization Server application is responsible for validating this value identifies a registered client.

Base class used for certain event contexts

Initializes base class used for certain event contexts

Replaces the ticket information on this context and marks it as as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.

Assigned to the Ticket property True if the validation has taken effect.

Alters the ticket information on this context and marks it as as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.

Assigned to the Ticket.Identity property True if the validation has taken effect.

Contains the identity and properties for the application to authenticate. If the Validated method is invoked with an AuthenticationTicket or ClaimsIdentity argument, that new value is assigned to this property in addition to changing IsValidated to true.

An event raised after the Authorization Server has processed the request, but before it is passed on to the web application. Calling RequestCompleted will prevent the request from passing on to the web application.

Creates an instance of this context

Interface for OAuthAuthorizationServerOptions.Provider property used by Authorization Server to communicate with the web application while processing requests.

Called to determine if an incoming request is treated as an Authorize or Token endpoint. If Options.AuthorizeEndpointPath or Options.TokenEndpointPath are assigned values, then handling this event is optional and context.IsAuthorizeEndpoint and context.IsTokenEndpoint will already be true if the request path matches.