WsFederationOptions 类

定义

命名空间:

Microsoft.AspNetCore.Authentication.WsFederation

程序集:

Microsoft.AspNetCore.Authentication.WsFederation.dll

包:

Microsoft.AspNetCore.Authentication.WsFederation v9.0.0

Source:

WsFederationOptions.cs

WsFederationHandler 的配置选项

public ref class WsFederationOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions

public class WsFederationOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type WsFederationOptions = class
    inherit RemoteAuthenticationOptions

Public Class WsFederationOptions
Inherits RemoteAuthenticationOptions

继承

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

WsFederationOptions

构造函数

WsFederationOptions()

初始化新的 WsFederationOptions

属性

AccessDeniedPath	获取或设置用户代理重定向到的可选路径（如果用户未批准远程服务器请求的授权要求）。 默认情况下不设置此属性。 在这种情况下，如果远程授权服务器返回access_denied响应，则会引发异常。 (继承自 RemoteAuthenticationOptions)
AllowUnsolicitedLogins	Ws-Federation 协议允许用户启动登录名，而无需先联系应用程序进行质询。 但是，该流容易受到 XSRF 和其他攻击的影响，因此默认情况下会在此处禁用该流。
Backchannel	用于与远程标识提供者通信。 (继承自 RemoteAuthenticationOptions)
BackchannelHttpHandler	用于与远程标识提供者通信的 HttpMessageHandler。 这不能与 BackchannelCertificateValidator 同时设置，除非该值可以向下转换为 WebRequestHandler。 (继承自 RemoteAuthenticationOptions)
BackchannelTimeout	获取或设置与远程标识提供者的反向通道通信的超时值（以毫秒为单位）。 (继承自 RemoteAuthenticationOptions)
CallbackPath	将返回用户代理的应用程序基路径中的请求路径。 当中间件到达时，中间件将处理此请求。 (继承自 RemoteAuthenticationOptions)
ClaimsIssuer	获取或设置应用于所创建的任何声明的颁发者 (继承自 AuthenticationSchemeOptions)
Configuration	开发人员直接提供的配置。 如果提供，则不会使用 MetadataAddress 和 Backchannel 属性。 在请求处理期间不应更新此信息。
ConfigurationManager	负责从元数据检索、缓存和刷新配置。 如果未提供，将使用 MetadataAddress 和 Backchannel 属性创建一个。
CorrelationCookie	确定用于在将 Cookie 添加到响应之前创建相关 Cookie 的设置。 (继承自 RemoteAuthenticationOptions)
DataProtectionProvider	获取或设置用于保护数据的类型。 (继承自 RemoteAuthenticationOptions)
Events	获取或设置处理 WsFederation 消息时要调用的 WsFederationEvents。
EventsType	如果已设置，将用作服务类型来获取事件实例而不是属性。 (继承自 AuthenticationSchemeOptions)
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)
MetadataAddress	获取或设置用于检索 wsFederation 元数据的地址
RefreshOnIssuerKeyNotFound	获取或设置是否应在 SecurityTokenSignatureKeyNotFoundException 之后尝试元数据刷新。 这允许在签名密钥滚动更新时自动恢复。 默认情况下启用此功能。
RemoteAuthenticationTimeout	获取或设置完成身份验证流的时间限制（默认情况下为 15 分钟）。 (继承自 RemoteAuthenticationOptions)
RemoteSignOutPath	在此路径上收到的请求将导致处理程序使用 SignOutScheme 调用 SignOut。
RequireHttpsMetadata	获取或设置元数据地址或颁发机构是否需要 HTTPS。 默认值为 true。 这只能在开发环境中禁用。
ReturnUrlParameter	获取或设置参数的名称，该参数用于在远程质询触发到访问被拒绝页面之前传达用户的原始位置。 仅当显式指定 AccessDeniedPath 时，才使用此属性。 (继承自 RemoteAuthenticationOptions)
SaveTokens	WsFederation 不支持 SaveTokens
SecurityTokenHandlers	已过时. 获取或设置用于读取和验证 SecurityToken的 ISecurityTokenValidator 的集合。
SignInScheme	获取或设置与负责在成功身份验证后保留用户标识的中间件对应的身份验证方案。 此值通常对应于 Startup 类中注册的 Cookie 中间件。 省略时，DefaultSignInScheme 用作回退值。 (继承自 RemoteAuthenticationOptions)
SignOutScheme	与 RemoteSignOutPath 中的 SignOutAsync 一起使用的身份验证方案。 如果未设置，将使用 SignInScheme。
SignOutWreply	获取或设置注销期间使用的“wreply”值。如果未指定任何值，则使用 Wreply 字段中的值。
SkipUnrecognizedRequests	指示对 CallbackPath 的请求是否也可能用于其他组件。 如果启用，处理程序将通过不包含 WsFederation 身份验证响应的请求传递。 禁用此功能并将 CallbackPath 设置为专用终结点可能会提供更好的错误处理。 默认情况下，这是禁用的。
StateDataFormat	获取或设置用于保护中间件处理的数据的类型。
TimeProvider	用于测试。 (继承自 AuthenticationSchemeOptions)
TokenHandlers	获取用于读取和验证 SecurityTokenISecurityTokenValidator 的集合。
TokenValidationParameters	获取或设置 TokenValidationParameters
UseSecurityTokenHandlers	获取或设置 TokenHandlers 还是 SecurityTokenHandlers 将用于验证入站令牌。
UseTokenLifetime	指示身份验证会话生存期（例如 cookies）应与身份验证令牌的生存期匹配。 如果令牌不提供生存期信息，则将使用正常会话生存期。 默认情况下启用此功能。
Wreply	获取或设置“wreply”。 必须将 CallbackPath 设置为匹配或清除，以便可以动态生成它。 此字段是可选的。 如果未设置，它将从当前请求和 CallbackPath 生成。
Wtrealm	获取或设置“wtrealm”。

方法

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