JsonWebTokenHandler.EncryptToken Méthode

Définition

Espace de noms:
Microsoft.IdentityModel.JsonWebTokens
Assembly:
Microsoft.IdentityModel.JsonWebTokens.dll
Paquet:
Microsoft.IdentityModel.JsonWebTokens v8.19.1

Surcharges

EncryptToken(String, EncryptingCredentials)

Chiffre un 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

Paramètres

innerJwt
String

Jeton web JSON (JWT) au format de sérialisation JWS Compact.

encryptingCredentials
EncryptingCredentials

Définit la clé de sécurité et l’algorithme qui seront utilisés pour chiffrer le innerJwt.

Retours

String

Exceptions

ArgumentNullException

Levée si encryptingCredentials la valeur est null.

ArgumentException

Levée si les deux CryptoProviderFactory et Key sont null.

SecurityTokenEncryptionFailedException

Levée si vous n’utilisez pas l’un des algorithmes de clé de chiffrement de contenu (CEK) pris en charge : 128, 384 ou 512 AesCbcHmac (cela s’applique uniquement dans le cas d’un wrapper de clé, pas de chiffrement direct).

S’applique à

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

Chiffre un 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

Paramètres

innerJwt
String

Jeton web JSON (JWT) au format de sérialisation JWS Compact.

encryptingCredentials
EncryptingCredentials

Définit la clé de sécurité et l’algorithme qui seront utilisés pour chiffrer le innerJwt.

additionalHeaderClaims
IDictionary<String,Object>

Définit le dictionnaire contenant toutes les revendications d’en-tête personnalisées qui doivent être ajoutées à l’en-tête de jeton JWT externe.

Retours

String

Exceptions

ArgumentNullException

Levée si additionalHeaderClaims la valeur est null.

ArgumentException

Levée si les deux CryptoProviderFactory et Key sont null.

SecurityTokenEncryptionFailedException

Levée si vous n’utilisez pas l’un des algorithmes de clé de chiffrement de contenu (CEK) pris en charge : 128, 384 ou 512 AesCbcHmac (cela s’applique uniquement dans le cas d’un wrapper de clé, pas de chiffrement direct).

S’applique à

EncryptToken(String, EncryptingCredentials, String)

Chiffre un 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

Paramètres

innerJwt
String

Jeton web JSON (JWT) au format de sérialisation JWS Compact.

encryptingCredentials
EncryptingCredentials

Définit la clé de sécurité et l’algorithme qui seront utilisés pour chiffrer le innerJwt.

algorithm
String

Définit l’algorithme de compression qui sera utilisé pour compresser le innerJwt.

Retours

String

Exceptions

ArgumentNullException

Levée si algorithm la valeur est null ou vide.

ArgumentException

Levée si les deux CryptoProviderFactory et Key sont null.

SecurityTokenEncryptionFailedException

Levée si vous n’utilisez pas l’un des algorithmes de clé de chiffrement de contenu (CEK) pris en charge : 128, 384 ou 512 AesCbcHmac (cela s’applique uniquement dans le cas d’un wrapper de clé, pas de chiffrement direct).

SecurityTokenCompressionFailedException

Levée en cas d’échec de la compression.algorithm

S’applique à

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

Chiffre un 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

Paramètres

innerJwt
String

Jeton web JSON (JWT) au format de sérialisation JWS Compact.

encryptingCredentials
EncryptingCredentials

Définit la clé de sécurité et l’algorithme qui seront utilisés pour chiffrer le innerJwt.

algorithm
String

Définit l’algorithme de compression qui sera utilisé pour compresser le innerJwt

additionalHeaderClaims
IDictionary<String,Object>

Définit le dictionnaire contenant toutes les revendications d’en-tête personnalisées qui doivent être ajoutées à l’en-tête de jeton JWT externe.

Retours

String

Exceptions

ArgumentNullException

Levée si additionalHeaderClaims la valeur est null ou vide.

ArgumentException

Levée si les deux CryptoProviderFactory et Key sont null.

SecurityTokenEncryptionFailedException

Levée si vous n’utilisez pas l’un des algorithmes de clé de chiffrement de contenu (CEK) pris en charge : 128, 384 ou 512 AesCbcHmac (cela s’applique uniquement dans le cas d’un wrapper de clé, pas de chiffrement direct).

SecurityTokenCompressionFailedException

Levée si la compression à l’aide de l’algorithme échoue.

S’applique à