Język

JsonWebTokenHandler.EncryptToken Metoda

Definicja

Przeciążenia

EncryptToken(String, EncryptingCredentials)

Szyfruje zestaw 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

Parametry

innerJwt
String

Token internetowy JSON (JWT) w formacie serializacji JWS Compact.

encryptingCredentials
EncryptingCredentials

Definiuje klucz zabezpieczeń i algorytm, który będzie używany do szyfrowania elementu innerJwt.

Zwraca

Wyjątki

Zgłaszany, jeśli encryptingCredentials ma wartość null.

Wyrzucony, jeśli obie CryptoProviderFactory wartości i Key mają wartość null.

W przypadku braku użycia jednego z obsługiwanych algorytmów klucza szyfrowania zawartości (CEK): 128, 384 lub 512 AesCbcHmac (dotyczy to tylko zawijania klucza, a nie bezpośredniego szyfrowania).

Dotyczy

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

Szyfruje zestaw 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

Parametry

innerJwt
String

Token internetowy JSON (JWT) w formacie serializacji JWS Compact.

encryptingCredentials
EncryptingCredentials

Definiuje klucz zabezpieczeń i algorytm, który będzie używany do szyfrowania elementu innerJwt.

additionalHeaderClaims
IDictionary<String,Object>

Definiuje słownik zawierający wszelkie niestandardowe oświadczenia nagłówka, które należy dodać do zewnętrznego nagłówka tokenu JWT.

Zwraca

Wyjątki

Zgłaszany, jeśli additionalHeaderClaims ma wartość null.

Wyrzucony, jeśli obie CryptoProviderFactory wartości i Key mają wartość null.

W przypadku braku użycia jednego z obsługiwanych algorytmów klucza szyfrowania zawartości (CEK): 128, 384 lub 512 AesCbcHmac (dotyczy to tylko zawijania klucza, a nie bezpośredniego szyfrowania).

Dotyczy

EncryptToken(String, EncryptingCredentials, String)

Szyfruje zestaw 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

Parametry

innerJwt
String

Token internetowy JSON (JWT) w formacie serializacji JWS Compact.

encryptingCredentials
EncryptingCredentials

Definiuje klucz zabezpieczeń i algorytm, który będzie używany do szyfrowania elementu innerJwt.

algorithm
String

Definiuje algorytm kompresji, który będzie używany do kompresowania .innerJwt

Zwraca

Wyjątki

Zgłaszany, jeśli algorithm wartość ma wartość null lub jest pusta.

Wyrzucony, jeśli obie CryptoProviderFactory wartości i Key mają wartość null.

W przypadku braku użycia jednego z obsługiwanych algorytmów klucza szyfrowania zawartości (CEK): 128, 384 lub 512 AesCbcHmac (dotyczy to tylko zawijania klucza, a nie bezpośredniego szyfrowania).

Zgłaszany, jeśli kompresja kończy się niepowodzeniem algorithm .

Dotyczy

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

Szyfruje zestaw 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

Parametry

innerJwt
String

Token internetowy JSON (JWT) w formacie serializacji JWS Compact.

encryptingCredentials
EncryptingCredentials

Definiuje klucz zabezpieczeń i algorytm, który będzie używany do szyfrowania elementu innerJwt.

algorithm
String

Definiuje algorytm kompresji, który będzie używany do kompresowania innerJwt

additionalHeaderClaims
IDictionary<String,Object>

Definiuje słownik zawierający wszelkie niestandardowe oświadczenia nagłówka, które należy dodać do zewnętrznego nagłówka tokenu JWT.

Zwraca

Wyjątki

Zgłaszany, jeśli additionalHeaderClaims wartość ma wartość null lub jest pusta.

Wyrzucony, jeśli obie CryptoProviderFactory wartości i Key mają wartość null.

W przypadku braku użycia jednego z obsługiwanych algorytmów klucza szyfrowania zawartości (CEK): 128, 384 lub 512 AesCbcHmac (dotyczy to tylko zawijania klucza, a nie bezpośredniego szyfrowania).

Zgłaszany, jeśli kompresja przy użyciu algorytmu kończy się niepowodzeniem.

Dotyczy