AuthenticationHandler<TOptions> 类

定义

命名空间:

Microsoft.AspNetCore.Authentication

程序集:

Microsoft.AspNetCore.Authentication.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

AuthenticationHandler.cs

实施 IAuthenticationHandler的有意见抽象。

public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.IAuthenticationHandler where TOptions : AuthenticationSchemeOptions, new()

type AuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
    interface IAuthenticationHandler

Public MustInherit Class AuthenticationHandler(Of TOptions)
Implements IAuthenticationHandler

类型参数

TOptions

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

继承

Object

AuthenticationHandler<TOptions>

派生

Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler

Microsoft.AspNetCore.Authentication.Negotiate.NegotiateHandler

Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions>

Microsoft.AspNetCore.Authentication.SignOutAuthenticationHandler<TOptions>

实现

IAuthenticationHandler

构造函数

AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	初始化 AuthenticationHandler<TOptions>的新实例。
AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	已过时. 初始化 AuthenticationHandler<TOptions>的新实例。

属性

ClaimsIssuer	获取应在发出任何声明时使用的颁发者。
Clock	已过时. 获取 ISystemClock。
Context	获取或设置 HttpContext。
CurrentUri	获取绝对当前 URL。
Events	处理程序对事件调用方法，这些事件在发生处理的某些点为应用程序控制。 如果未提供默认实例，则会在调用方法时不执行任何操作。
Logger	获取 ILogger。
Options	获取或设置与此身份验证处理程序关联的选项。
OptionsMonitor	获取用于检测选项更改的 IOptionsMonitor<TOptions>。
OriginalPath	获取身份验证中间件看到的路径。
OriginalPathBase	获取身份验证中间件看到的路径基。
Request	获取与当前请求关联的 HttpRequest。
Response	获取与当前请求关联的 HttpResponse。
Scheme	获取或设置与此身份验证处理程序关联的 AuthenticationScheme。
TimeProvider	获取当前时间，主要用于单元测试。
UrlEncoder	获取 UrlEncoder。

方法

AuthenticateAsync()	对当前请求进行身份验证。
BuildRedirectUri(String)	构造指定 targetPath的绝对 URL。
ChallengeAsync(AuthenticationProperties)	质询当前请求。
CreateEventsAsync()	创建事件实例的新实例。
ForbidAsync(AuthenticationProperties)	禁止当前请求。
HandleAuthenticateAsync()	允许派生类型处理身份验证。
HandleAuthenticateOnceAsync()	用于确保 HandleAuthenticateAsync 只调用一次。 后续调用将返回相同的身份验证结果。
HandleAuthenticateOnceSafeAsync()	用于确保 HandleAuthenticateAsync 仅安全调用一次。 后续调用将返回相同的身份验证结果。 任何异常都将转换为包含异常的失败身份验证结果。
HandleChallengeAsync(AuthenticationProperties)	如果有问题的身份验证方案在请求流中处理身份验证交互，请重写此方法来处理 401 质询问题。 （例如添加响应标头，或者将 401 结果更改为登录页或外部登录位置的 302）。
HandleForbiddenAsync(AuthenticationProperties)	重写此方法以处理 Forbid。
InitializeAsync(AuthenticationScheme, HttpContext)	初始化处理程序，解析选项并验证它们。
InitializeEventsAsync()	通过 InitializeAsync(AuthenticationScheme, HttpContext)对每个请求调用一次的事件对象进行初始化。
InitializeHandlerAsync()	在初始化选项/事件后调用，以便处理程序完成自身初始化。
ResolveTarget(String)	解析此身份验证操作转发到的方案。