AuthenticationHandler Class

Handles authentication using the configured ISecurityProvider implementation in the Owin pipeline.

Inheritance Hierarchy

SystemObject
  AuthenticationHandler
    AuthenticationHandlerAuthenticationOptions
      GSF.Web.SecurityAuthenticationHandler

Namespace: GSF.Web.Security
Assembly: GSF.Web (in GSF.Web.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public class AuthenticationHandler : AuthenticationHandler<AuthenticationOptions>

Public Class AuthenticationHandler
	Inherits AuthenticationHandler(Of AuthenticationOptions)

public ref class AuthenticationHandler : public AuthenticationHandler<AuthenticationOptions^>

type AuthenticationHandler = 
    class
        inherit AuthenticationHandler<AuthenticationOptions>
    end

GSF.Web.Security.AuthenticationHandler = function();

Type.createClass(
	'GSF.Web.Security.AuthenticationHandler',
	Microsoft.Owin.Security.Infrastructure.AuthenticationHandler`1);

View Source

The AuthenticationHandler type exposes the following members.

Constructors

	Name	Description
	AuthenticationHandler	Initializes a new instance of the AuthenticationHandler class

Top

Properties

	Name	Description
	Context	(Inherited from AuthenticationHandler)
	Faulted	(Inherited from AuthenticationHandler)
	Helper	(Inherited from AuthenticationHandler)
	Options	(Inherited from AuthenticationHandlerAuthenticationOptions)
	Request	(Inherited from AuthenticationHandler)
	RequestPathBase	(Inherited from AuthenticationHandler)
	Response	(Inherited from AuthenticationHandler)

Top

Methods

	Name	Description
	ApplyResponseChallengeAsync	Override this method to deal 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.) (Inherited from AuthenticationHandler)
	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	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) (Inherited from AuthenticationHandler)
	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	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. (Overrides AuthenticationHandler.AuthenticateCoreAsync)
	BaseInitializeAsync	(Inherited from AuthenticationHandler)
	ClearAuthorizationCache	Clears any cached authorizations for the specified sessionID.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GenerateCorrelationId(AuthenticationProperties)	(Inherited from AuthenticationHandler)
	GenerateCorrelationId(ICookieManager, AuthenticationProperties)	(Inherited from AuthenticationHandler)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	InitializeCoreAsync	(Inherited from AuthenticationHandler)
	InvokeAsync	Called once by common code after initialization. If an authentication middle-ware 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. (Overrides AuthenticationHandler.InvokeAsync)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	TeardownCoreAsync	(Inherited from AuthenticationHandler)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryGetPrincipal	Attempt to get current security principal for specified sessionID.
	ValidateCorrelationId(AuthenticationProperties, ILogger)	(Inherited from AuthenticationHandler)
	ValidateCorrelationId(ICookieManager, AuthenticationProperties, ILogger)	(Inherited from AuthenticationHandler)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.Web.Security Namespace