Compartilhar via


unwrap Key - unwrap Key

Desembrulha uma chave simétrica usando a chave especificada que foi inicialmente usada para encapsular essa chave.
A operação UNWRAP oferece suporte a descriptografia de uma chave simétrica usando a chave de criptografia de chave de destino. Essa operação é o inverso da operação WRAP. A operação UNWRAP se aplica às chaves simétricas e assimétricas armazenadas no Cofre de Chaves do Azure já que ele usa a parte da chave privada. Essa operação requer a permissão keys/unwrapKey.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
key-name
path True

string

O nome da chave.

key-version
path True

string

A versão da chave.

vaultBaseUrl
path True

string

O nome do cofre, por exemplo https://myvault.vault.azure.net, .

api-version
query True

string

Versão de API do cliente.

Corpo da solicitação

Nome Obrigatório Tipo Description
alg True

JsonWebKeyEncryptionAlgorithm

identificador de algoritmo

value True

string

aad

string

Dados adicionais para autenticar, mas não criptografar/descriptografar ao usar algoritmos de criptografia autenticados.

iv

string

Vetor de inicialização criptograficamente aleatório e sem repetição para algoritmos simétricos.

tag

string

A marca a ser autenticada ao executar a descriptografia com um algoritmo autenticado.

Respostas

Nome Tipo Description
200 OK

KeyOperationResult

A chave simétrica desembrulhada.

Other Status Codes

KeyVaultError

Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

Unwrapkey

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
Error

O erro do servidor do cofre de chaves.

JsonWebKeyEncryptionAlgorithm

identificador de algoritmo

KeyOperationResult

O resultado da operação de chave.

KeyOperationsParameters

Os principais parâmetros de operações.

KeyVaultError

A exceção de erro do cofre de chaves.

Error

O erro do servidor do cofre de chaves.

Nome Tipo Description
code

string

O código de erro.

innererror

Error

O erro do servidor do cofre de chaves.

message

string

A mensagem de erro.

JsonWebKeyEncryptionAlgorithm

identificador de algoritmo

Nome 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

O resultado da operação de chave.

Nome Tipo Description
aad

string

iv

string

kid

string

Identificador da chave

tag

string

value

string

KeyOperationsParameters

Os principais parâmetros de operações.

Nome Tipo Description
aad

string

Dados adicionais para autenticar, mas não criptografar/descriptografar ao usar algoritmos de criptografia autenticados.

alg

JsonWebKeyEncryptionAlgorithm

identificador de algoritmo

iv

string

Vetor de inicialização criptograficamente aleatório e sem repetição para algoritmos simétricos.

tag

string

A marca a ser autenticada ao executar a descriptografia com um algoritmo autenticado.

value

string

KeyVaultError

A exceção de erro do cofre de chaves.

Nome Tipo Description
error

Error

O erro do servidor do cofre de chaves.