wrap Key - wrap Key
Opakowuje klucz symetryczny przy użyciu określonego klucza.
Operacja WRAP obsługuje szyfrowanie klucza symetrycznego przy użyciu klucza szyfrowania klucza, który wcześniej był przechowywany w usłudze Azure Key Vault. Operacja zawijania WRAP jest niezbędna tylko w przypadku kluczy symetrycznych przechowywanych w usłudze Azure Key Vault, ponieważ ochronę za pomocą klucza asymetrycznego można wykonać przy użyciu publicznej części klucza. Ta operacja jest obsługiwana w przypadku kluczy asymetrycznych jako wygody dla wywołujących, którzy mają odwołanie do klucza, ale nie mają dostępu do materiału klucza publicznego. Ta operacja wymaga uprawnień klucze/zawijanieklucz.
POST {vaultBaseUrl}/keys/{key-name}/{key-version}/wrapkey?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. |
vault
|
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 |
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 |
Opakowany klucz symetryczny. |
|
Other Status Codes |
Key Vault odpowiedzi na błąd opisujący, dlaczego operacja nie powiodła się. |
Przykłady
Wrapkey
Sample Request
POST https://myvault.vault.azure.net//keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6/wrapkey?api-version=7.4
{
"alg": "RSA1_5",
"value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo"
}
Sample Response
{
"kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6",
"value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw"
}
Definicje
Nazwa | Opis |
---|---|
Error |
Błąd serwera magazynu kluczy. |
Json |
identyfikator algorytmu |
Key |
Wynik operacji klucza. |
Key |
Kluczowe parametry operacji. |
Key |
Wyjątek błędu magazynu kluczy. |
Error
Błąd serwera magazynu kluczy.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
innererror |
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 |
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 |
Błąd serwera magazynu kluczy. |