Class SamlAuthenticationHandler

Namespace

ComponentSpace.Saml2.Authentication

Assembly

ComponentSpace.Saml2.dll

The SAML authentication handler.

public class SamlAuthenticationHandler : AuthenticationHandler<SamlAuthenticationOptions>, IAuthenticationRequestHandler, IAuthenticationSignOutHandler, IAuthenticationHandler

Inheritance

object

AuthenticationHandler<SamlAuthenticationOptions>

SamlAuthenticationHandler

Implements

IAuthenticationRequestHandler

IAuthenticationSignOutHandler

IAuthenticationHandler

Inherited Members

AuthenticationHandler<SamlAuthenticationOptions>.InitializeAsync(AuthenticationScheme, HttpContext)

AuthenticationHandler<SamlAuthenticationOptions>.InitializeEventsAsync()

AuthenticationHandler<SamlAuthenticationOptions>.CreateEventsAsync()

AuthenticationHandler<SamlAuthenticationOptions>.InitializeHandlerAsync()

AuthenticationHandler<SamlAuthenticationOptions>.BuildRedirectUri(string)

AuthenticationHandler<SamlAuthenticationOptions>.ResolveTarget(string)

AuthenticationHandler<SamlAuthenticationOptions>.AuthenticateAsync()

AuthenticationHandler<SamlAuthenticationOptions>.HandleAuthenticateOnceAsync()

AuthenticationHandler<SamlAuthenticationOptions>.HandleAuthenticateOnceSafeAsync()

AuthenticationHandler<SamlAuthenticationOptions>.ChallengeAsync(AuthenticationProperties)

AuthenticationHandler<SamlAuthenticationOptions>.ForbidAsync(AuthenticationProperties)

AuthenticationHandler<SamlAuthenticationOptions>.Scheme

AuthenticationHandler<SamlAuthenticationOptions>.Options

AuthenticationHandler<SamlAuthenticationOptions>.Context

AuthenticationHandler<SamlAuthenticationOptions>.Request

AuthenticationHandler<SamlAuthenticationOptions>.Response

AuthenticationHandler<SamlAuthenticationOptions>.OriginalPath

AuthenticationHandler<SamlAuthenticationOptions>.OriginalPathBase

AuthenticationHandler<SamlAuthenticationOptions>.Logger

AuthenticationHandler<SamlAuthenticationOptions>.UrlEncoder

AuthenticationHandler<SamlAuthenticationOptions>.Clock

AuthenticationHandler<SamlAuthenticationOptions>.TimeProvider

AuthenticationHandler<SamlAuthenticationOptions>.OptionsMonitor

AuthenticationHandler<SamlAuthenticationOptions>.Events

AuthenticationHandler<SamlAuthenticationOptions>.ClaimsIssuer

AuthenticationHandler<SamlAuthenticationOptions>.CurrentUri

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SamlAuthenticationHandler(IOptionsMonitor<SamlAuthenticationOptions>, ILoggerFactory, UrlEncoder, ISamlServiceProvider, ISsoSessionStore, ISamlClaimFactory, IUrlUtility)

Initializes a new instance of the SamlAuthenticationHandler class.

public SamlAuthenticationHandler(IOptionsMonitor<SamlAuthenticationOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISamlServiceProvider samlServiceProvider, ISsoSessionStore ssoSessionStore, ISamlClaimFactory samlClaimFactory, IUrlUtility urlUtility)

Parameters

options IOptionsMonitor<SamlAuthenticationOptions>

The SAML authentication options.

logger ILoggerFactory

The logger factory.

encoder UrlEncoder

The URL encoder.

samlServiceProvider ISamlServiceProvider

The SAML service provider.

ssoSessionStore ISsoSessionStore

The SSO session store.

samlClaimFactory ISamlClaimFactory

The SAML claims factory.

urlUtility IUrlUtility

The URL utility.

Methods

HandleAuthenticateAsync()

Handles authentication.

protected override Task<AuthenticateResult> HandleAuthenticateAsync()

Returns

Task<AuthenticateResult>

A task that represents the operation.

HandleChallengeAsync(AuthenticationProperties)

Handles challenge.

protected override Task HandleChallengeAsync(AuthenticationProperties authenticationProperties)

Parameters

authenticationProperties AuthenticationProperties

The authentication properties.

Returns

Task

A task that represents the operation.

HandleForbiddenAsync(AuthenticationProperties)

Handles forbidden.

protected override Task HandleForbiddenAsync(AuthenticationProperties authenticationProperties)

Parameters

authenticationProperties AuthenticationProperties

The authentication properties.

Returns

Task

A task that represents the operation.

HandleRequestAsync()

Handles a request.

public virtual Task<bool> HandleRequestAsync()

Returns

Task<bool>

true if the request is handled; otherwise false.

SignOutAsync(AuthenticationProperties)

Signs out.

public virtual Task SignOutAsync(AuthenticationProperties authenticationProperties)

Parameters

authenticationProperties AuthenticationProperties

The authentication properties.

Returns

Task

A task that represents the operation.