CookieAuthenticationOptions 类

定义

命名空间:

Microsoft.AspNetCore.Builder

程序集:

Microsoft.AspNetCore.Authentication.Cookies.dll

包:

Microsoft.AspNetCore.Authentication.Cookies v1.1.0

CookieAuthenticationMiddleware 的配置选项。

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Builder::AuthenticationOptions, Microsoft::Extensions::Options::IOptions<Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^>

public class CookieAuthenticationOptions : Microsoft.AspNetCore.Builder.AuthenticationOptions, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.CookieAuthenticationOptions>

type CookieAuthenticationOptions = class
    inherit AuthenticationOptions
    interface IOptions<CookieAuthenticationOptions>

Public Class CookieAuthenticationOptions
Inherits AuthenticationOptions
Implements IOptions(Of CookieAuthenticationOptions)

继承

Object

AuthenticationOptions

CookieAuthenticationOptions

实现

IOptions<CookieAuthenticationOptions>

构造函数

CookieAuthenticationOptions()

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

属性

AccessDeniedPath	AccessDeniedPath 属性通知中间件，它应将传出的 403 禁止访问状态代码更改为 302 重定向到给定路径。
AuthenticationScheme	选项中的 AuthenticationScheme 对应于特定身份验证方案的逻辑名称。 可以分配其他值，以便在一个管道中多次使用同一个身份验证中间件类型。 (继承自 AuthenticationOptions)
AutomaticAuthenticate	如果为 true，则身份验证中间件会更改传入的请求用户。 如果为 false，则身份验证中间件仅在 AuthenticationScheme 显式指示时才提供标识。 (继承自 AuthenticationOptions)
AutomaticChallenge	如果为 true，则身份验证中间件应处理自动质询。 如果为 false，则身份验证中间件仅在 AuthenticationScheme 显式指示时更改响应。 (继承自 AuthenticationOptions)
ClaimsIssuer	获取或设置应用于创建的任何声明的颁发者 (继承自 AuthenticationOptions)
CookieDomain	确定用于创建 Cookie 的域。 默认情况下未提供。
CookieHttpOnly	确定浏览器是否应允许客户端 javascript 访问 Cookie。 默认值为 true，这表示只将 Cookie 传递给 http 请求，而不可供页上的脚本使用。
CookieManager	用于从请求中获取 Cookie 或在响应中设置 Cookie 的组件。 默认情况下将使用 ChunkingCookieManager。
CookieName	确定用于保持身份的 Cookie 名称。 默认值为“。AspNetCore.Cookies”。 如果更改 AuthenticationScheme 的名称，应更改此值，尤其是在系统多次使用 Cookie 身份验证中间件时。
CookiePath	确定用于创建 Cookie 的路径。 默认值为“/”表示最高浏览器兼容性。
CookieSecure	确定 Cookie 是否只应根据 HTTPS 请求传输。 默认值是当正在执行登录的页面也是 HTTPS 时将 Cookie 限制为 HTTPS 请求。 如果你有 HTTPS 登录页并且你的部分站点是 HTTP，则可能需要更改此值。
DataProtectionProvider	如果设置此项，则 CookieAuthenticationMiddleware 将使用该项进行数据保护。
Description	为应用程序提供的有关身份验证类型的附加信息。 (继承自 AuthenticationOptions)
Events	可能会向应用程序在启动时创建的对象实例分配提供程序。 中间件在提供程序上调用方法，这些方法在进行处理的某些点为应用程序提供控制。 如果未提供提供程序，则将提供默认实例，该实例在调用方法时不执行任何操作。
ExpireTimeSpan	控制自创建 Cookie 的时点起，Cookie 保持有效的时间。 过期信息在受保护的 Cookie 票证中。 正因如此，将忽略已过期的 Cookie，即使将本应被浏览器清除的该 Cookie 传递到服务器，也是如此
LoginPath	LoginPath 属性通知中间件：应将传出的“401 未授权”状态代码更改为“302 重定向到给定登录路径”。 生成 401 的当前 URL 将作为名为 ReturnUrlParameter 的查询字符串参数添加到 LoginPath。 对 LoginPath 的请求授予新的 SignIn 标识后，将使用 ReturnUrlParameter 值将浏览器重定向回 指向导致原始未授权状态代码的 URL。
LogoutPath	如果为 LogoutPath　提供了中间件，则对该路径的请求将基于 ReturnUrlParameter 进行重定向。
ReturnUrlParameter	ReturnUrlParameter 可确定将“401 未授权”状态代码更改为“302 重定向到登录路径”时，由中间件追加的查询字符串参数的名称。 这也是请求到达登录路径或注销路径时所查找的查询字符串参数，目的是在执行操作后返回到原始 URL。
SessionStore	一个可选容器，每次请求后将在该容器中存储标识。 如果使用，则只将会话标识符发送到客户端。 这可用于缓解由于标识过大而造成的潜在问题。
SlidingExpiration	若要指示中间件在处理的请求已在过期窗口上行程过半时，随时使用新的过期时间重新发布新的 Cookie，则将 SlidingExpiration 设置为 true。
SystemClock	仅用于测试目的。 (继承自 AuthenticationOptions)
TicketDataFormat	TicketDataFormat 用于保护和取消保护身份和其他存储在 Cookie 值中的属性。 如果未提供，则使用 IApplicationBuilder.Properties 中包含的数据保护服务创建默认数据处理程序。 运行在 ASP.NET 和 DPAPI（在不同进程中运行时）上时，默认的数据保护服务将基于计算机密钥。

显式接口实现

IOptions<CookieAuthenticationOptions>.Value

CookieAuthenticationMiddleware 的配置选项。