unwrap Key - unwrap Key
Распаковывает симметричный ключ, используя указанный ключ, который изначально использовался для упаковки этого ключа.
Операция UNWRAP поддерживает расшифровку симметричного ключа с помощью ключа шифрования целевого ключа. Эта операция является обратной по отношению к операции WRAP. Операция UNWRAP применяется к асимметричным и симметричным ключам, хранимым в хранилище ключей Azure, поскольку она использует закрытую часть ключа. Для этой операции требуется разрешение keys/unwrapKey.
POST {vaultBaseUrl}/keys/{key-name}/{key-version}/unwrapkey?api-version=7.4
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
key-name
|
path | True |
string |
Имя ключа. |
key-version
|
path | True |
string |
Версия ключа. |
vault
|
path | True |
string |
Имя хранилища, например https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Версия API клиента. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
alg | True |
идентификатор алгоритма |
|
value | True |
string |
|
aad |
string |
Дополнительные данные для проверки подлинности, но не для шифрования и расшифровки при использовании алгоритмов шифрования, прошедших проверку подлинности. |
|
iv |
string |
Криптографически случайный, неповторяющийся вектор инициализации для симметричного алгоритма. |
|
tag |
string |
Тег для проверки подлинности при выполнении расшифровки с помощью алгоритма, прошедшего проверку подлинности. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Распакованный симметричный ключ. |
|
Other Status Codes |
Key Vault ответ об ошибке, описывающий причину сбоя операции. |
Примеры
Unwrapkey
Sample Request
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
{
"kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6",
"value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo"
}
Определения
Имя | Описание |
---|---|
Error |
Ошибка сервера хранилища ключей. |
Json |
идентификатор алгоритма |
Key |
Результат операции с ключом. |
Key |
Параметры ключевых операций. |
Key |
Исключение ошибки хранилища ключей. |
Error
Ошибка сервера хранилища ключей.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
innererror |
Ошибка сервера хранилища ключей. |
|
message |
string |
Сообщение об ошибке. |
JsonWebKeyEncryptionAlgorithm
идентификатор алгоритма
Имя | Тип | Описание |
---|---|---|
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
Результат операции с ключом.
Имя | Тип | Описание |
---|---|---|
aad |
string |
|
iv |
string |
|
kid |
string |
Идентификатор ключа |
tag |
string |
|
value |
string |
KeyOperationsParameters
Параметры ключевых операций.
Имя | Тип | Описание |
---|---|---|
aad |
string |
Дополнительные данные для проверки подлинности, но не для шифрования и расшифровки при использовании алгоритмов шифрования, прошедших проверку подлинности. |
alg |
идентификатор алгоритма |
|
iv |
string |
Криптографически случайный, неповторяющийся вектор инициализации для симметричного алгоритма. |
tag |
string |
Тег для проверки подлинности при выполнении расшифровки с помощью алгоритма, прошедшего проверку подлинности. |
value |
string |
KeyVaultError
Исключение ошибки хранилища ключей.
Имя | Тип | Описание |
---|---|---|
error |
Ошибка сервера хранилища ключей. |