Spire 天擎

外观

class TokenValidationParameters ​

cangjie
public class TokenValidationParameters

功能：表示令牌验证时使用的参数集合。

成员概览 ​

成员功能
init()创建默认的令牌验证参数。
init(TokenValidationParameters)通过复制现有参数创建新的令牌验证参数。
var validateIssuer获取或设置是否验证令牌颁发者。
var requireAudience获取或设置是否要求令牌必须包含受众。
var validateLifetime获取或设置是否验证令牌生命周期。
var validateAudience获取或设置是否验证令牌受众。
var validateTokenReplay获取或设置是否验证令牌重放。
var requireExpirationTime获取或设置是否要求令牌必须包含过期时间。
var validateIssuerSigningKey获取或设置是否验证颁发者签名密钥。
var validTypes获取或设置允许的令牌类型集合。
var clockSkew获取或设置验证时间声明时允许的时钟偏差。
var validIssuers获取或设置允许的颁发者集合。
var validAudiences获取或设置允许的受众集合。
var tokenReader获取或设置自定义令牌读取委托。
var typeValidator获取或设置自定义类型验证委托。
var issuerValidator获取或设置自定义颁发者验证委托。
var tokenReplayCache获取或设置令牌重放缓存实现。
var lifetimeValidator获取或设置自定义生命周期验证委托。
var audienceValidator获取或设置自定义受众验证委托。
var signatureValidator获取或设置自定义签名验证委托。
var tokenReplayValidator获取或设置自定义重放验证委托。
var issuerSigningKeyResolver获取或设置颁发者签名密钥解析委托。
var issuerSigningKeyValidator获取或设置颁发者签名密钥验证委托。
var issuerSigningKeys获取或设置可用于验证的签名密钥集合。
var authenticationType获取或设置创建身份对象时使用的认证类型。
func clone()复制当前令牌验证参数。

init() ​

cangjie
public init()

功能：创建默认的令牌验证参数。

init(TokenValidationParameters) ​

cangjie
public init(that: TokenValidationParameters)

功能：通过复制现有参数创建新的令牌验证参数。

参数：

var validateIssuer ​

cangjie
public var validateIssuer = true

功能：获取或设置是否验证令牌颁发者。

var requireAudience ​

cangjie
public var requireAudience = true

功能：获取或设置是否要求令牌必须包含受众。

var validateLifetime ​

cangjie
public var validateLifetime = true

功能：获取或设置是否验证令牌生命周期。

var validateAudience ​

cangjie
public var validateAudience = true

功能：获取或设置是否验证令牌受众。

var validateTokenReplay ​

cangjie
public var validateTokenReplay = false

功能：获取或设置是否验证令牌重放。

var requireExpirationTime ​

cangjie
public var requireExpirationTime = true

功能：获取或设置是否要求令牌必须包含过期时间。

var validateIssuerSigningKey ​

cangjie
public var validateIssuerSigningKey = true

功能：获取或设置是否验证颁发者签名密钥。

var validTypes ​

cangjie
public var validTypes = Array<String>()

功能：获取或设置允许的令牌类型集合。

var clockSkew ​

cangjie
public var clockSkew = Duration.Zero

功能：获取或设置验证时间声明时允许的时钟偏差。

var validIssuers ​

cangjie
public var validIssuers = Array<String>()

功能：获取或设置允许的颁发者集合。

var validAudiences ​

cangjie
public var validAudiences = Array<String>()

功能：获取或设置允许的受众集合。

var tokenReader ​

cangjie
public var tokenReader: ?TokenReader = None

功能：获取或设置自定义令牌读取委托。

类型：?TokenReader

var typeValidator ​

cangjie
public var typeValidator: ?TypeValidator = None

功能：获取或设置自定义类型验证委托。

类型：?TypeValidator

var issuerValidator ​

cangjie
public var issuerValidator: ?IssuerValidator = None

功能：获取或设置自定义颁发者验证委托。

类型：?IssuerValidator

var tokenReplayCache ​

cangjie
public var tokenReplayCache: ?ITokenReplayCache = None

功能：获取或设置令牌重放缓存实现。

类型：?ITokenReplayCache

var lifetimeValidator ​

cangjie
public var lifetimeValidator: ?LifetimeValidator = None

功能：获取或设置自定义生命周期验证委托。

类型：?LifetimeValidator

var audienceValidator ​

cangjie
public var audienceValidator: ?AudienceValidator = None

功能：获取或设置自定义受众验证委托。

类型：?AudienceValidator

var signatureValidator ​

cangjie
public var signatureValidator: ?SignatureValidator = None

功能：获取或设置自定义签名验证委托。

类型：?SignatureValidator

var tokenReplayValidator ​

cangjie
public var tokenReplayValidator: ?TokenReplayValidator = None

功能：获取或设置自定义重放验证委托。

类型：?TokenReplayValidator

var issuerSigningKeyResolver ​

cangjie
public var issuerSigningKeyResolver: ?IssuerSigningKeyResolver = None

功能：获取或设置颁发者签名密钥解析委托。

类型：?IssuerSigningKeyResolver

var issuerSigningKeyValidator ​

cangjie
public var issuerSigningKeyValidator: ?IssuerSigningKeyValidator = None

功能：获取或设置颁发者签名密钥验证委托。

类型：?IssuerSigningKeyValidator

var issuerSigningKeys ​

cangjie
public var issuerSigningKeys = Array<SecurityKey>()

功能：获取或设置可用于验证的签名密钥集合。

var authenticationType ​

cangjie
public var authenticationType: String = "AuthenticationTypes.Federation"

功能：获取或设置创建身份对象时使用的认证类型。

类型：String

func clone() ​

cangjie
public func clone(): TokenValidationParameters

功能：复制当前令牌验证参数。

返回值：