unwrap Key - unwrap Key

Odwołanie

Service:: Key Vault

API Version:: 7.4

Odpakowuje klucz symetryczny przy użyciu określonego klucza, który został początkowo użyty do opakowywania tego klucza.
Operacja UNWRAP obsługuje odszyfrowywanie klucza symetrycznego przy użyciu klucza szyfrowania klucza docelowego. Ta operacja jest odwrotną operacją WRAP. Operacja UNWRAP ma zastosowanie do kluczy asymetrycznych i symetrycznych przechowywanych w usłudze Azure Key Vault, ponieważ używa prywatnej części klucza. Ta operacja wymaga uprawnień kluczy/unwrapKey.

POST {vaultBaseUrl}/keys/{key-name}/{key-version}/unwrapkey?api-version=7.4

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
key-name	path	True	string	Nazwa klucza.
key-version	path	True	string	Wersja klucza.
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
alg	True	JsonWebKeyEncryptionAlgorithm	identyfikator algorytmu
value	True	string
aad		string	Dodatkowe dane do uwierzytelniania, ale nie szyfrują/odszyfrowywać podczas korzystania z uwierzytelnionych algorytmów kryptograficznych.
iv		string	Kryptograficznie losowy, nie powtarzający się wektor inicjowania dla algorytmów symetrycznych.
tag		string	Tag do uwierzytelniania podczas odszyfrowywania przy użyciu uwierzytelnionego algorytmu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	KeyOperationResult	Niezapisany klucz symetryczny.
Other Status Codes	KeyVaultError	Key Vault odpowiedzi na błąd opisujący, dlaczego operacja nie powiodła się.

Przykłady

Unwrapkey

Sample Request

HTTP

POST https://myvault.vault.azure.net//keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6/unwrapkey?api-version=7.4

{
  "alg": "RSA1_5",
  "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw"
}

Sample Response

Status code:: 200

{
  "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6",
  "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo"
}

Definicje

Nazwa	Opis
Error	Błąd serwera magazynu kluczy.
JsonWebKeyEncryptionAlgorithm	identyfikator algorytmu
KeyOperationResult	Wynik operacji klucza.
KeyOperationsParameters	Kluczowe parametry operacji.
KeyVaultError	Wyjątek błędu magazynu kluczy.

Error

Błąd serwera magazynu kluczy.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Błąd serwera magazynu kluczy.
message	string	Komunikat o błędzie.

JsonWebKeyEncryptionAlgorithm

identyfikator algorytmu

Nazwa	Typ	Opis
A128CBC	string
A128CBCPAD	string
A128GCM	string
A128KW	string
A192CBC	string
A192CBCPAD	string
A192GCM	string
A192KW	string
A256CBC	string
A256CBCPAD	string
A256GCM	string
A256KW	string
RSA-OAEP	string
RSA-OAEP-256	string
RSA1_5	string

KeyOperationResult

Wynik operacji klucza.

Nazwa	Typ	Opis
aad	string
iv	string
kid	string	Identyfikator klucza
tag	string
value	string

KeyOperationsParameters

Kluczowe parametry operacji.

Nazwa	Typ	Opis
aad	string	Dodatkowe dane do uwierzytelniania, ale nie szyfrują/odszyfrowywać podczas korzystania z uwierzytelnionych algorytmów kryptograficznych.
alg	JsonWebKeyEncryptionAlgorithm	identyfikator algorytmu
iv	string	Kryptograficznie losowy, nie powtarzający się wektor inicjowania dla algorytmów symetrycznych.
tag	string	Tag do uwierzytelniania podczas odszyfrowywania przy użyciu uwierzytelnionego algorytmu.
value	string

KeyVaultError

Wyjątek błędu magazynu kluczy.

Nazwa	Typ	Opis
error	Error	Błąd serwera magazynu kluczy.