CookieAuthenticationOptions 类

定义

命名空间:

Microsoft.AspNetCore.Authentication.Cookies

程序集:

Microsoft.AspNetCore.Authentication.Cookies.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

CookieAuthenticationOptions.cs

CookieAuthenticationOptions 的配置选项。

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions

public class CookieAuthenticationOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions

type CookieAuthenticationOptions = class
    inherit AuthenticationSchemeOptions

Public Class CookieAuthenticationOptions
Inherits AuthenticationSchemeOptions

继承

Object

AuthenticationSchemeOptions

CookieAuthenticationOptions

构造函数

CookieAuthenticationOptions()

创建使用默认值初始化的选项实例

属性

AccessDeniedPath	处理 ForbidAsync 时，处理程序将 AccessDeniedPath 属性用于重定向目标。
ClaimsIssuer	获取或设置应用于创建的任何声明的颁发者 (继承自 AuthenticationSchemeOptions)
Cookie	确定用于创建 Cookie 的设置。
CookieManager	用于从请求中获取 Cookie 或在响应中设置 Cookie 的组件。 默认情况下将使用 ChunkingCookieManager。
DataProtectionProvider	如果设置此项，CookieAuthenticationHandler 将使用它进行数据保护。
Events	可能会向应用程序在启动时创建的对象实例分配提供程序。 处理程序在提供程序上调用方法，这些方法在进行处理的某些点为应用程序提供控制。 如果未提供提供程序，则将提供默认实例，该实例在调用方法时不执行任何操作。
EventsType	如果设置，将用作服务类型来获取事件实例而不是 属性。 (继承自 AuthenticationSchemeOptions)
ExpireTimeSpan	控制存储在 Cookie 中的身份验证票证从创建时起保持有效的时间。 过期信息存储在受保护的 Cookie 票证中。 因此，在浏览器应清除它后，即使它传递到服务器，也会忽略过期的 Cookie。 这与 的值是分开的 Expires，该值指定浏览器将保留 Cookie 的时间。
ForwardAuthenticate	如果已设置，则指定此方案应将 AuthenticateAsync 调用转发到的目标方案。 例如 Context.AuthenticateAsync (“ThisScheme”) => Context.AuthenticateAsync (“ForwardAuthenticateValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardChallenge	如果已设置，则指定此方案应将 ChallengeAsync 调用转发到的目标方案。 例如 Context.ChallengeAsync (“ThisScheme”) => Context.ChallengeAsync (“ForwardChallengeValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardDefault	如果已设置，则指定身份验证处理程序默认应将所有身份验证操作转发到的默认方案。 默认转发逻辑将首先检查最具体的 ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 设置，然后检查 ForwardDefaultSelector，然后检查 ForwardDefault。 第一个非 null 结果将用作要转发到的目标方案。 (继承自 AuthenticationSchemeOptions)
ForwardDefaultSelector	用于为身份验证处理程序默认将所有身份验证操作转发到的当前请求选择默认方案。 默认转发逻辑将首先检查最具体的 ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 设置，然后检查 ForwardDefaultSelector，然后检查 ForwardDefault。 第一个非 null 结果将用作要转发到的目标方案。 (继承自 AuthenticationSchemeOptions)
ForwardForbid	如果已设置，则指定此方案应将 ForbidAsync 调用转发到的目标方案。 例如 Context.ForbidAsync (“ThisScheme”) => Context.ForbidAsync (“ForwardForbidValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardSignIn	如果设置，则指定此方案应将 SignInAsync 调用转发到的目标方案。 例如 Context.SignInAsync (“ThisScheme”) => Context.SignInAsync (“ForwardSignInValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardSignOut	如果已设置，则指定此方案应将 SignOutAsync 调用转发到的目标方案。 例如 Context.SignOutAsync (“ThisScheme”) => Context.SignOutAsync (“ForwardSignOutValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
LoginPath	处理 ChallengeAsync 时，处理程序会将 LoginPath 属性用于重定向目标。 作为由 ReturnUrlParameter 命名的查询字符串参数添加到 LoginPath 的当前 URL。 对 LoginPath 的请求授予新的 SignIn 标识后，将使用 ReturnUrlParameter 值将浏览器重定向回原始 URL。
LogoutPath	如果为 LogoutPath 提供了处理程序，则对该路径的请求将根据 ReturnUrlParameter 进行重定向。
ReturnUrlParameter	ReturnUrlParameter 确定处理程序在质询期间追加的查询字符串参数的名称。 这也是请求到达登录路径或注销路径时所查找的查询字符串参数，目的是在执行操作后返回到原始 URL。
SessionStore	一个可选容器，每次请求后将在该容器中存储标识。 如果使用，则只将会话标识符发送到客户端。 这可用于缓解由于标识过大而造成的潜在问题。
SlidingExpiration	SlidingExpiration 设置为 true，指示处理程序在处理超过过期窗口一半的请求时，使用新的过期时间重新发出新的 Cookie。
TicketDataFormat	TicketDataFormat 用于保护和取消保护身份和其他存储在 Cookie 值中的属性。 如果未提供，将使用 创建 DataProtectionProvider一个 。
TimeProvider	用于测试。 (继承自 AuthenticationSchemeOptions)

方法

Validate()	检查选项是否有效。 如果情况不正常，应引发异常。 (继承自 AuthenticationSchemeOptions)
Validate(String)	检查选项是否对特定方案有效 (继承自 AuthenticationSchemeOptions)