unwrap Key - unwrap Key

Service:

Key Vault

API Version:

7.4

Desencapsula una clave simétrica con la clave especificada que se usó inicialmente para encapsular esa clave.
La operación de desencapsulado UNWRAP admite el descifrado de una clave simétrica utilizando la clave de cifrado de claves de destino. Esta operación es la inversa de la operación de encapsulado WRAP. La operación de desencapsulado UNWRAP se aplica a las claves simétricas y asimétricas almacenadas en el Almacén de claves de Azure, ya que utiliza la parte privada de la clave. Esta operación requiere el permiso keys/unwrapKey.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
key-name	path	True	string	El nombre de la clave.
key-version	path	True	string	Versión de la clave.
vaultBaseUrl	path	True	string	El nombre del almacén, por ejemplo https://myvault.vault.azure.net, .
api-version	query	True	string	Versión de API del cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
alg	True	JsonWebKeyEncryptionAlgorithm	identificador de algoritmo
value	True	string
aad		string	Datos adicionales para autenticar, pero no cifrar o descifrar al usar algoritmos criptográficos autenticados.
iv		string	Vector de inicialización no repetido criptográficamente aleatorio para algoritmos simétricos.
tag		string	Etiqueta que se va a autenticar al realizar el descifrado con un algoritmo autenticado.

Respuestas

Nombre	Tipo	Description
200 OK	KeyOperationResult	Clave simétrica desencapsulada.
Other Status Codes	KeyVaultError	Key Vault respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

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"
}

Definiciones

Nombre	Description
Error	Error del servidor del almacén de claves.
JsonWebKeyEncryptionAlgorithm	identificador de algoritmo
KeyOperationResult	Resultado de la operación de clave.
KeyOperationsParameters	Parámetros de operaciones clave.
KeyVaultError	Excepción de error del almacén de claves.

Error

Error del servidor del almacén de claves.

Nombre	Tipo	Description
code	string	Código de error.
innererror	Error	Error del servidor del almacén de claves.
message	string	El mensaje de error.

JsonWebKeyEncryptionAlgorithm

identificador de algoritmo

Nombre	Tipo	Description
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

Resultado de la operación de clave.

Nombre	Tipo	Description
aad	string
iv	string
kid	string	Identificador de clave
tag	string
value	string

KeyOperationsParameters

Parámetros de operaciones clave.

Nombre	Tipo	Description
aad	string	Datos adicionales para autenticar, pero no cifrar o descifrar al usar algoritmos criptográficos autenticados.
alg	JsonWebKeyEncryptionAlgorithm	identificador de algoritmo
iv	string	Vector de inicialización no repetido criptográficamente aleatorio para algoritmos simétricos.
tag	string	Etiqueta que se va a autenticar al realizar el descifrado con un algoritmo autenticado.
value	string

KeyVaultError

Excepción de error del almacén de claves.

Nombre	Tipo	Description
error	Error	Error del servidor del almacén de claves.