OpenIdConnectAuthenticationHandler Class

Article
10/27/2015

A per-request authentication handler for the OpenIdConnectAuthenticationMiddleware.

Namespace: Microsoft.Owin.Security.OpenIdConnect
Assembly: Microsoft.Owin.Security.OpenIdConnect (in Microsoft.Owin.Security.OpenIdConnect.dll)

Inheritance Hierarchy

System.Object
Microsoft.Owin.Security.Infrastructure.AuthenticationHandler
Microsoft.Owin.Security.Infrastructure.AuthenticationHandler<TOptions>
Microsoft.Owin.Security.OpenIdConnect.OpenIdConnectAuthenticationHandler

Syntax

public class OpenIdConnectAuthenticationHandler : AuthenticationHandler<OpenIdConnectAuthenticationOptions>

public ref class OpenIdConnectAuthenticationHandler : AuthenticationHandler<OpenIdConnectAuthenticationOptions^>

type OpenIdConnectAuthenticationHandler = 
    class
        inherit AuthenticationHandler<OpenIdConnectAuthenticationOptions>
    end

Public Class OpenIdConnectAuthenticationHandler
    Inherits AuthenticationHandler(Of OpenIdConnectAuthenticationOptions)

Constructors

	Name	Description
	OpenIdConnectAuthenticationHandler(ILogger)	Creates a new OpenIdConnectAuthenticationHandler

Properties

	Name	Description
	Context	(Inherited from AuthenticationHandler.)
	Faulted	(Inherited from AuthenticationHandler.)
	Helper	(Inherited from AuthenticationHandler.)
	Options	(Inherited from AuthenticationHandler<TOptions>.)
	Request	(Inherited from AuthenticationHandler.)
	RequestPathBase	(Inherited from AuthenticationHandler.)
	Response	(Inherited from AuthenticationHandler.)

Methods

	Name	Description
	AddNonceToMessage(OpenIdConnectMessage)	Sets Nonce to !:Options.ProtocolValidator.GenerateNonce.
	ApplyResponseChallengeAsync()	Handles SignIn(Overrides AuthenticationHandler.ApplyResponseChallengeAsync().)
	ApplyResponseCoreAsync()	Core method that may be overridden by handler. The default behavior is to call two common response activities, one that deals with sign-in/sign-out concerns, and a second to deal with 401 challenges.(Inherited from AuthenticationHandler.)
	ApplyResponseGrantAsync()	Handles Signout(Overrides AuthenticationHandler.ApplyResponseGrantAsync().)
	AuthenticateAsync()	Causes the authentication logic in AuthenticateCore to be performed for the current request at most once and returns the results. Calling Authenticate more than once will always return the original value. This method should always be called instead of calling AuthenticateCore directly.(Inherited from AuthenticationHandler.)
	AuthenticateCoreAsync()	Invoked to process incoming authentication messages.(Overrides AuthenticationHandler.AuthenticateCoreAsync().)
	BaseInitializeAsync(AuthenticationOptions, IOwinContext)	(Inherited from AuthenticationHandler.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GenerateCorrelationId(AuthenticationProperties)	(Inherited from AuthenticationHandler.)
	GetHashCode()	(Inherited from Object.)
	GetNonceKey(String)
	GetType()	(Inherited from Object.)
	InitializeCoreAsync()	(Inherited from AuthenticationHandler.)
	InvokeAsync()	Calls InvokeReplyPathAsync(Overrides AuthenticationHandler.InvokeAsync().)
	MemberwiseClone()	(Inherited from Object.)
	RememberNonce(OpenIdConnectMessage, String)	'Remembers' the nonce associated with this message. By default the nonce added as a secure cookie.
	RetrieveNonce(OpenIdConnectMessage)
	TeardownCoreAsync()	(Inherited from AuthenticationHandler.)
	ToString()	(Inherited from Object.)
	ValidateCorrelationId(AuthenticationProperties, ILogger)	(Inherited from AuthenticationHandler.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.