語言

JsonWebTokenHandler 類別

定義

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

public class JsonWebTokenHandler : Microsoft.IdentityModel.Tokens.TokenHandler, Microsoft.IdentityModel.Tokens.Experimental.IResultBasedValidation
type JsonWebTokenHandler = class
    inherit TokenHandler
    interface IResultBasedValidation
Public Class JsonWebTokenHandler
Inherits TokenHandler
Implements IResultBasedValidation
繼承
JsonWebTokenHandler
實作

備註

此部分類別包含與符號驗證相關的方法與邏輯。

建構函式

名稱 Description
JsonWebTokenHandler()

初始化 JsonWebTokenHandler 類別的新執行個體。

欄位

名稱 Description
Base64UrlEncodedUnsignedJWSHeader

取得以下 JWT 標頭的 Base64Url 編碼字串表示:{ Alg, None }。

DefaultInboundClaimTypeMap

入站理賠的預設理賠類型映射。

DefaultMapInboundClaims

預設值為決定是否使用 InboundClaimTypeMap 的旗標。

屬性

名稱 Description
CanValidateToken

回傳一個值,指示此處理器是否能驗證 。SecurityToken

InboundClaimTypeMap

取得或設定 , InboundClaimTypeMap 該 用於設定 Type , ClaimsPrincipal 在驗證 a JsonWebToken時擷取 。

在使用此映射轉換後,會 Type 設定為 JSON 權利要求的「名稱」。

預設值為 ClaimTypeMapping.InboundClaimTypeMap。

MapInboundClaims

取得或設定 MapInboundClaims 屬性,用於判斷是否映射驗證時 JsonWebToken提取的權利要求類型。

若此值設為 true,則在使用此映射轉換後,該 Type 會被設定為 JSON 聲明的「名稱」。 否則,不會發生映射。

預設值為 false。

MaximumTokenSizeInBytes

取得並設定將要處理的最大符號大小(位元組)。

(繼承來源 TokenHandler)
SetDefaultTimesOnTokenCreation

取得或設定一個布爾值,控制代幣創建時是否會設定預設的「經驗值」、「nbf」或「iat」(未指定)。

(繼承來源 TokenHandler)
ShortClaimTypeProperty

若在建立時Claim有映射,則取得或設定 will(檔案)的屬性名稱Properties包含原始 JSON 聲明的「名稱」。

TokenLifetimeInMinutes

能在幾分鐘內取得或設定代幣壽命。

(繼承來源 TokenHandler)
TokenType

取得 JsonWebToken的型別。

方法

名稱 Description
CanReadToken(String)

判斷該字串是否為良好形式的 JSON Web Token(JWT)。 請參閱:https://datatracker.ietf.org/doc/html/rfc7519。

CreateClaimsIdentity(JsonWebToken, TokenValidationParameters, String)

從 a JsonWebToken 與指定的發行人建立 aClaimsIdentity。

CreateClaimsIdentity(JsonWebToken, TokenValidationParameters)

從 ClaimsIdentity中產生 a JsonWebToken 。

CreateToken(SecurityTokenDescriptor)

建立一個可以是 JWS 或 JWE。

CreateToken(String, EncryptingCredentials, IDictionary<String,Object>)

建立 JSON 網頁加密(JWE)。

CreateToken(String, EncryptingCredentials, String)

建立 JSON 網頁加密(JWE)。

CreateToken(String, EncryptingCredentials)

建立 JSON 網頁加密(JWE)。

CreateToken(String, IDictionary<String,Object>)

建立一個未簽署的 JSON 網頁簽章(JWS)。

CreateToken(String, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)

建立 JSON 網頁加密(JWE)。

CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>, IDictionary<String,Object>)

建立 JSON 網頁加密(JWE)。

CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>)

建立 JSON 網頁加密(JWE)。

CreateToken(String, SigningCredentials, EncryptingCredentials, String)

建立 JSON 網頁加密(JWE)。

CreateToken(String, SigningCredentials, EncryptingCredentials)

建立 JSON 網頁加密(JWE)。

CreateToken(String, SigningCredentials, IDictionary<String,Object>)

建立 JSON 網頁簽章(JWS)。

CreateToken(String, SigningCredentials)

建立 JSON 網頁簽章(JWS)。

CreateToken(String)

建立一個未簽署的 JSON 網頁簽章(JWS)。

DecryptToken(JsonWebToken, TokenValidationParameters)

解密 JWE 並回傳明文。

DecryptTokenWithConfigurationAsync(JsonWebToken, TokenValidationParameters, CancellationToken)

解密 JWE 並回傳明文。

EncryptToken(String, EncryptingCredentials, IDictionary<String,Object>)

加密 JWS。

EncryptToken(String, EncryptingCredentials, String, IDictionary<String,Object>)

加密 JWS。

EncryptToken(String, EncryptingCredentials, String)

加密 JWS。

EncryptToken(String, EncryptingCredentials)

加密 JWS。

ReadJsonWebToken(ReadOnlyMemory<Char>)

將 ReadOnlyMemory 的字元範圍轉換為 的實例 JsonWebToken。

ReadJsonWebToken(String)

將字串轉換為 的 JsonWebToken實例。

ReadToken(String)

將字串轉換為 的 JsonWebToken實例。

ResolveTokenDecryptionKey(String, JsonWebToken, TokenValidationParameters)

解密 JWE 時回傳 a SecurityKey 以使用。

ValidateToken(String, TokenValidationParameters)
已淘汰.

驗證 JWS 或 JWE。

ValidateTokenAsync(SecurityToken, TokenValidationParameters)

驗證代幣。 驗證失敗時不會拋出例外;例外會被設定在回傳的 TokenValidationResult.Exception 屬性中。 呼叫者應始終檢查 TokenValidationResult.IsValid 屬性以驗證結果的有效性。

ValidateTokenAsync(String, TokenValidationParameters)

驗證代幣。 驗證失敗時不會拋出例外;例外會被設定在回傳的 TokenValidationResult.Exception 屬性中。 呼叫者應始終檢查 TokenValidationResult.IsValid 屬性以驗證結果的有效性。

明確介面實作

名稱 Description
IResultBasedValidation.ValidateTokenAsync(SecurityToken, ValidationParameters, CallContext, CancellationToken)

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

IResultBasedValidation.ValidateTokenAsync(SecurityToken, ValidationParameters, CallContext)

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

IResultBasedValidation.ValidateTokenAsync(String, ValidationParameters, CallContext, CancellationToken)

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

IResultBasedValidation.ValidateTokenAsync(String, ValidationParameters, CallContext)

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

適用於