JsonWebTokenHandler.EncryptToken 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
多載
EncryptToken(String, EncryptingCredentials)
加密 JWS。
public string EncryptToken(string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);
member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string
Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials) As String
參數
- innerJwt
- String
一種以 JWS Compact Serialization 格式呈現的 JSON 網頁令牌(JWT)。
- encryptingCredentials
- EncryptingCredentials
定義了用於加密的安全 innerJwt金鑰與演算法。
傳回
例外狀況
如果 encryptingCredentials 是空,則擲出。
如果 和 Key 都CryptoProviderFactory為零,則會被拋棄。
若未使用支援的內容加密金鑰(CEK)演算法之一,則會丟出:128、384 或 512 AesCbcHmac(此僅適用於金鑰包裝,不適用於直接加密)。
適用於
EncryptToken(String, EncryptingCredentials, IDictionary<String,Object>)
加密 JWS。
public string EncryptToken(string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);
member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string
Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String
參數
- innerJwt
- String
一種以 JWS Compact Serialization 格式呈現的 JSON 網頁令牌(JWT)。
- encryptingCredentials
- EncryptingCredentials
定義了用於加密的安全 innerJwt金鑰與演算法。
- additionalHeaderClaims
- IDictionary<String,Object>
定義字典,包含任何需要加入外部 JWT 標記標頭的自訂標頭聲明。
傳回
例外狀況
如果 additionalHeaderClaims 是空,則擲出。
如果 和 Key 都CryptoProviderFactory為零,則會被拋棄。
若未使用支援的內容加密金鑰(CEK)演算法之一,則會丟出:128、384 或 512 AesCbcHmac(此僅適用於金鑰包裝,不適用於直接加密)。
適用於
EncryptToken(String, EncryptingCredentials, String)
加密 JWS。
public string EncryptToken(string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string algorithm);
member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string
Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, algorithm As String) As String
參數
- innerJwt
- String
一種以 JWS Compact Serialization 格式呈現的 JSON 網頁令牌(JWT)。
- encryptingCredentials
- EncryptingCredentials
定義了用於加密的安全 innerJwt金鑰與演算法。
- algorithm
- String
定義將用於壓縮 的 innerJwt壓縮演算法。
傳回
例外狀況
如果 algorithm 是空或空,則會拋出。
如果 和 Key 都CryptoProviderFactory為零,則會被拋棄。
若未使用支援的內容加密金鑰(CEK)演算法之一,則會丟出:128、384 或 512 AesCbcHmac(此僅適用於金鑰包裝,不適用於直接加密)。
壓縮失敗時 algorithm 丟棄。
適用於
EncryptToken(String, EncryptingCredentials, String, IDictionary<String,Object>)
加密 JWS。
public string EncryptToken(string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string algorithm, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);
member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> -> string
Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, algorithm As String, additionalHeaderClaims As IDictionary(Of String, Object)) As String
參數
- innerJwt
- String
一種以 JWS Compact Serialization 格式呈現的 JSON 網頁令牌(JWT)。
- encryptingCredentials
- EncryptingCredentials
定義了用於加密的安全 innerJwt金鑰與演算法。
- algorithm
- String
定義將用於壓縮 innerJwt
- additionalHeaderClaims
- IDictionary<String,Object>
定義字典,包含任何需要加入外部 JWT 標記標頭的自訂標頭聲明。
傳回
例外狀況
如果 additionalHeaderClaims 是空或空,則會拋出。
如果 和 Key 都CryptoProviderFactory為零,則會被拋棄。
若未使用支援的內容加密金鑰(CEK)演算法之一,則會丟出:128、384 或 512 AesCbcHmac(此僅適用於金鑰包裝,不適用於直接加密)。
如果用「演算法」壓縮失敗,就會丟棄。