Share via


AuthenticationHandler Class

Base class for the per-request work performed by most authentication middleware.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public MustInherit Class AuthenticationHandler
'Usage
Dim instance As AuthenticationHandler
public abstract class AuthenticationHandler
public ref class AuthenticationHandler abstract
[<AbstractClassAttribute>]
type AuthenticationHandler =  class end
public abstract class AuthenticationHandler

The AuthenticationHandler type exposes the following members.

Constructors

  Name Description
Protected method AuthenticationHandler Initializes a new instance of the AuthenticationHandler class.

Top

Properties

  Name Description
Protected property Context
Protected property Helper
Protected property Request
Protected property RequestPathBase
Protected property Response

Top

Methods

  Name Description
Protected method ApplyResponseChallengeAsync Override this method to dela with 401 challenge concerns, if an authentication scheme in question deals an authentication interaction as part of it's request flow. (like adding a response header, or changing the 401 result to 302 of a login page or external sign-in location.)
Protected method 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.
Protected method ApplyResponseGrantAsync Override this method to dela with sign-in/sign-out concerns, if an authentication scheme in question deals with grant/revoke as part of it's request flow. (like setting/deleting cookies)
Public method 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.
Protected method AuthenticateCoreAsync The core authentication logic which must be provided by the handler. Will be invoked at most once per request. Do not call directly, call the wrapping Authenticate method instead.
Protected method BaseInitializeAsync
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GenerateCorrelationId
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InitializeCoreAsync
Public method InvokeAsync Called once by common code after initialization. If an authentication middleware responds directly to specifically known paths it must override this virtual, compare the request path to it's known paths, provide any response information as appropriate, and true to stop further processing.
Protected method MemberwiseClone (Inherited from Object.)
Protected method TeardownCoreAsync
Public method ToString (Inherited from Object.)
Protected method ValidateCorrelationId

Top

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.

See Also

Reference

Microsoft.Owin.Security.Infrastructure Namespace