JwtSecurityTokenHandler 類別

定義

命名空間:

System.IdentityModel.Tokens.Jwt

組件:

System.IdentityModel.Tokens.Jwt.dll

套件:

System.IdentityModel.Tokens.Jwt v8.19.1

SecurityTokenHandler一個專為建立與驗證 Json Web Tokens 而設計的。 參見： https://datatracker.ietf.org/doc/html/rfc7519 以及 http://www.rfc-editor.org/info/rfc7515

public class JwtSecurityTokenHandler : Microsoft.IdentityModel.Tokens.SecurityTokenHandler

type JwtSecurityTokenHandler = class
    inherit SecurityTokenHandler

Public Class JwtSecurityTokenHandler
Inherits SecurityTokenHandler

繼承

Object

TokenHandler

SecurityTokenHandler

JwtSecurityTokenHandler

建構函式

名稱	Description
JwtSecurityTokenHandler()	初始化 JwtSecurityTokenHandler 類別的新執行個體。

欄位

名稱	Description
DefaultInboundClaimFilter	預設理賠類型篩選清單。
DefaultInboundClaimTypeMap	入站理賠的預設理賠類型映射。
DefaultMapInboundClaims	預設值為決定是否使用 InboundClaimTypeMap 的旗標。
DefaultOutboundAlgorithmMap	預設 JwtHeader 演算法映射
DefaultOutboundClaimTypeMap	出站理賠的預設理賠類型映射。

屬性

名稱	Description
CanValidateToken	回傳一個值，指示此處理器是否能驗證 。SecurityToken
CanWriteToken	取得表示此實例是否能寫入 SecurityToken的值。
InboundClaimFilter	在填充ClaimsIdentity申請JwtSecurityToken時，取得或設定 來ISet<T>過濾理賠。 當 a JwtSecurityToken 被驗證時，該類型中出現 ISet<T> 的主張不會被加入 ClaimsIdentity。 預設值為 ClaimTypeMapping.InboundClaimFilter。
InboundClaimTypeMap	取得或設定 ， InboundClaimTypeMap 該 用於設定 Type ， ClaimsPrincipal 在驗證 a JwtSecurityToken時擷取 。 在使用此映射轉換後，會 Type 設定為 JSON 權利要求的「名稱」。 預設值為 ClaimTypeMapping.InboundClaimTypeMap。
JsonClaimTypeProperty	取得或設定 will 包含 .Net 類型的屬性名稱 Properties ，該類型在序列化為 JSON 時 Claims 被識別。 另見 <cref=“P：System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap”></參見。>
MapInboundClaims	取得或設定 MapInboundClaims 屬性，用於判斷是否映射驗證時 JwtSecurityToken提取的權利要求類型。 若此值設為 true，則在使用此映射轉換後，該 Type 會被設定為 JSON 聲明的「名稱」。 否則，不會發生映射。 預設值為 True。
MaximumTokenSizeInBytes	取得並設定將要處理的最大符號大小（位元組）。 (繼承來源 TokenHandler)
OutboundAlgorithmMap	取得傳給 JwtHeader 建構子的出站演算法映射。
OutboundClaimTypeMap	取得或設定 ，OutboundClaimTypeMap該 用於從 （s） 建立 。JwtSecurityTokenClaim JSON 宣稱的「名稱」值在使用此映射轉換後設定為 。Type 預設值為 ClaimTypeMapping.OutboundClaimTypeMap
SetDefaultTimesOnTokenCreation	取得或設定一個布爾值，控制代幣創建時是否會設定預設的「經驗值」、「nbf」或「iat」（未指定）。 (繼承來源 TokenHandler)
ShortClaimTypeProperty	若在建立時Properties有映射，則取得或設定 will（檔案）的屬性名稱Claim包含原始 JSON 聲明的「名稱」。 另見 <cref=“P：System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap”></參見。>
TokenLifetimeInMinutes	能在幾分鐘內取得或設定代幣壽命。 (繼承來源 TokenHandler)
TokenType	取得 JwtSecurityToken的型別。

方法

名稱	Description
CanReadToken(String)	判斷該字串是否為良好形式的 Json Web Token（JWT）。 請參閱：https://datatracker.ietf.org/doc/html/rfc7519
CanReadToken(XmlReader)	表示 是否 XmlReader 位於可讀取的元素。 (繼承來源 SecurityTokenHandler)
CreateActorValue(ClaimsIdentity)	為演員主張創造「值」：{ actort， 'value' }
CreateClaimsIdentity(JwtSecurityToken, String, TokenValidationParameters)	從 ClaimsIdentity中產生 a JwtSecurityToken 。
CreateEncodedJwt(SecurityTokenDescriptor)	回傳一個 json 網頁標記（JWT）。
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	建立一個「緊湊序列化格式」的 JWT。
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	建立一個「緊湊序列化格式」的 JWT。
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	建立一個「緊湊序列化格式」的 JWT。
CreateJwtSecurityToken(SecurityTokenDescriptor)	建立一個 JSON 網頁令牌（JWT）。
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	產生 JwtSecurityToken
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	產生 JwtSecurityToken
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	產生 JwtSecurityToken
CreateSecurityTokenReference(SecurityToken, Boolean)	傳回 SecurityKeyIdentifierClause。 (繼承來源 SecurityTokenHandler)
CreateToken(SecurityTokenDescriptor)	建立一個 JSON 網頁令牌（JWT）。
DecryptToken(JwtSecurityToken, TokenValidationParameters)	解密 JWE 並回傳明文
ReadJwtToken(String)	將字串轉換為 的 JwtSecurityToken實例。
ReadToken(String)	將字串轉換為 的 JwtSecurityToken實例。
ReadToken(XmlReader, TokenValidationParameters)	用提供的 TokenValidationParameters反序列化標記。
ReadToken(XmlReader)	會拿到安全令牌。 (繼承來源 SecurityTokenHandler)
ResolveIssuerSigningKey(String, JwtSecurityToken, TokenValidationParameters)	在驗證標記簽名時回傳 a SecurityKey 以使用。
ResolveTokenDecryptionKey(String, JwtSecurityToken, TokenValidationParameters)	解密 JWE 時會回傳 a SecurityKey 以使用。
ValidateAudience(IEnumerable<String>, JwtSecurityToken, TokenValidationParameters)	判斷 a JwtSecurityToken 中出現的受眾是否有效。
ValidateIssuer(String, JwtSecurityToken, TokenValidationParameters)	判斷在 a JwtSecurityToken 中發現的發行人是否有效。
ValidateIssuerSecurityKey(SecurityKey, JwtSecurityToken, TokenValidationParameters)	驗證 SigningKey 是期望值。
ValidateLifetime(Nullable<DateTime>, Nullable<DateTime>, JwtSecurityToken, TokenValidationParameters)	驗證 的 JwtSecurityToken壽命。
ValidateSignature(String, TokenValidationParameters)	驗證該簽名（若找到或需要）為有效。
ValidateToken(String, TokenValidationParameters, SecurityToken)	讀取並驗證以緊湊序列化格式編碼為 JWS 或 JWE 的「JSON Web Token」（JWT）。
ValidateToken(XmlReader, TokenValidationParameters, SecurityToken)	使用 xmlReader 讀取並驗證權杖，且 TokenValidationParameters (繼承來源 SecurityTokenHandler)
ValidateTokenAsync(SecurityToken, TokenValidationParameters)	驗證代幣。 驗證失敗時不會拋出例外;例外會被設定在回傳的 TokenValidationResult.Exception 屬性中。 呼叫者應始終檢查 TokenValidationResult.IsValid 屬性以驗證結果的有效性。 (繼承來源 TokenHandler)
ValidateTokenAsync(String, TokenValidationParameters)	驗證代幣。 驗證失敗時不會拋出例外;例外會被設定在回傳的 TokenValidationResult.Exception 屬性中。 呼叫者應始終檢查 TokenValidationResult.IsValid 屬性以驗證結果的有效性。
ValidateTokenPayload(JwtSecurityToken, TokenValidationParameters)	驗證 JSON 的有效載荷 JwtSecurityToken。
ValidateTokenReplay(Nullable<DateTime>, String, TokenValidationParameters)	判斷 a JwtSecurityToken 是否已經被驗證過。
WriteToken(SecurityToken)	將 a JwtSecurityToken 序列化成 JWT，採用緊湊序列化格式。
WriteToken(XmlWriter, SecurityToken)	將此實例所處理的類型標記序列化為 XML。