AuthenticationHandler<TOptions> 类

定义

用于实现 的 IAuthenticationHandler有意见的抽象。

generic <typename TOptions>
 where TOptions : AuthenticationOptionspublic ref class AuthenticationHandler abstract : Microsoft::AspNetCore::Http::Features::Authentication::IAuthenticationHandler
generic <typename TOptions>
 where TOptions : AuthenticationSchemeOptionsgcnew()public ref class AuthenticationHandler abstract : Microsoft::AspNetCore::Authentication::IAuthenticationHandler
public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Http.Features.Authentication.IAuthenticationHandler where TOptions : AuthenticationOptions
public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.IAuthenticationHandler where TOptions : AuthenticationSchemeOptions, new()
type AuthenticationHandler<'Options (requires 'Options :> AuthenticationOptions)> = class
    interface IAuthenticationHandler
type AuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
    interface IAuthenticationHandler
Public MustInherit Class AuthenticationHandler(Of TOptions)
Implements IAuthenticationHandler

类型参数

TOptions

用于配置身份验证处理程序的选项的类型。

继承
AuthenticationHandler<TOptions>
派生
实现

构造函数

AuthenticationHandler<TOptions>()

用于实现 的 IAuthenticationHandler有意见的抽象。

AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)

初始化 AuthenticationHandler<TOptions> 的新实例。

AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)
已过时.

初始化 AuthenticationHandler<TOptions> 的新实例。

属性

ChallengeCalled

用于实现 的 IAuthenticationHandler有意见的抽象。

ClaimsIssuer

获取颁发任何声明时应使用的颁发者。

Clock
已过时.

获取 ISystemClock

Context

获取或设置 HttpContext

CurrentUri

获取绝对当前 URL。

Events

处理程序对事件调用方法,这些方法在发生处理的某些点为应用程序提供控制。 如果未提供提供程序,则将提供默认实例,该实例在调用方法时不执行任何操作。

InitializeResult

用于实现 的 IAuthenticationHandler有意见的抽象。

Logger

获取 ILogger

Options

获取或设置与此身份验证处理程序关联的选项。

OptionsMonitor

获取 IOptionsMonitor<TOptions> 用于检测选项更改的 。

OriginalPath

获取身份验证中间件看到的路径。

OriginalPathBase

获取身份验证中间件看到的路径基。

PriorHandler

用于实现 的 IAuthenticationHandler有意见的抽象。

Request

获取与 HttpRequest 当前请求关联的 。

Response

获取与 HttpResponse 当前请求关联的 。

Scheme

获取或设置 AuthenticationScheme 与该身份验证处理程序关联的 。

SignInAccepted

用于实现 的 IAuthenticationHandler有意见的抽象。

SignOutAccepted

用于实现 的 IAuthenticationHandler有意见的抽象。

TimeProvider

获取当前时间,主要用于单元测试。

UrlEncoder

获取 UrlEncoder

方法

AuthenticateAsync()

对当前请求进行身份验证。

AuthenticateAsync(AuthenticateContext)

用于实现 的 IAuthenticationHandler有意见的抽象。

BuildRedirectUri(String)

为指定的 targetPath构造绝对 URL。

ChallengeAsync(AuthenticationProperties)

质询当前请求。

ChallengeAsync(ChallengeContext)

用于实现 的 IAuthenticationHandler有意见的抽象。

CreateEventsAsync()

创建事件实例的新实例。

FinishResponseAsync()

在即将发送响应时调用的挂钩

ForbidAsync(AuthenticationProperties)

禁止当前请求。

GetDescriptions(DescribeSchemesContext)

用于实现 的 IAuthenticationHandler有意见的抽象。

HandleAuthenticateAsync()

允许派生类型处理身份验证。

HandleAuthenticateOnceAsync()

用于确保 HandleAuthenticateAsync 仅调用一次。 后续调用将返回相同的身份验证结果。

HandleAuthenticateOnceSafeAsync()

用于确保 HandleAuthenticateAsync 仅安全调用一次。 后续调用将返回相同的身份验证结果。 任何异常都将转换为包含异常的失败身份验证结果。

HandleChallengeAsync(AuthenticationProperties)

如果某个身份验证方案将身份验证交互作为请求流的一部分处理,请重写此方法来处理 401 质询问题。 (例如添加响应标头,或将 401 结果更改为登录页的 302 或外部登录位置。)

HandleForbiddenAsync(AuthenticationProperties)

重写此方法以处理 Forbid。

HandleForbiddenAsync(ChallengeContext)

重写此方法以处理禁止的质询。

HandleRequestAsync()

在初始化之后由公共代码调用一次。 如果身份验证中间件直接响应已知的专用路径,则必须重写此虚拟路径,将请求路径与其已知路径进行比较,提供适当的响应信息,并停止进一步处理。

HandleSignInAsync(SignInContext)

用于实现 的 IAuthenticationHandler有意见的抽象。

HandleSignOutAsync(SignOutContext)

用于实现 的 IAuthenticationHandler有意见的抽象。

HandleUnauthorizedAsync(ChallengeContext)

如果某个身份验证方案将身份验证交互作为请求流的一部分处理,请重写此方法来处理 401 质询问题。 (例如添加响应标头,或将 401 结果更改为登录页的 302 或外部登录位置。)

InitializeAsync(AuthenticationScheme, HttpContext)

初始化处理程序,解析选项并对其进行验证。

InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

每个请求调用一次 Initialize,以便将此实例与适当的状态进行上下文化。

InitializeEventsAsync()

初始化事件对象,每个请求由 InitializeAsync(AuthenticationScheme, HttpContext)调用一次。

InitializeHandlerAsync()

在初始化选项/事件后调用,以便处理程序完成自身初始化。

ResolveTarget(String)

解析此身份验证操作转发到的方案。

ShouldHandleScheme(String, Boolean)

用于实现 的 IAuthenticationHandler有意见的抽象。

SignInAsync(SignInContext)

用于实现 的 IAuthenticationHandler有意见的抽象。

SignOutAsync(SignOutContext)

用于实现 的 IAuthenticationHandler有意见的抽象。

适用于