wrap Key - wrap Key

Référence

Service:: Key Vault

API Version:: 7.4

Encapsule une clé symétrique à l’aide d’une clé spécifiée.
L'opération WRAP prend en charge le chiffrement d'une clé symétrique à l'aide d'une clé de chiffrement précédemment stockée dans un coffre de clés Azure. L'opération WRAP est strictement nécessaire uniquement pour les clés symétriques stockées dans Azure Key Vault, dans la mesure où la protection à l'aide d'une clé asymétrique peut être effectuée à l'aide de la partie publique de la clé. Cette opération est prise en charge pour les clés asymétriques par souci de commodité pour les appelants qui ont une référence de clé, mais n'ont pas accès à la clé publique. Cette opération nécessite l’autorisation keys/wrapKey.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
key-name	path	True	string	Nom de la clé.
key-version	path	True	string	Version de la clé.
vaultBaseUrl	path	True	string	Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version	query	True	string	Version d’API client.

Corps de la demande

Nom	Obligatoire	Type	Description
alg	True	JsonWebKeyEncryptionAlgorithm	identificateur d’algorithme
value	True	string
aad		string	Données supplémentaires à authentifier, mais pas chiffrer/déchiffrer lors de l’utilisation d’algorithmes de chiffrement authentifiés.
iv		string	Vecteur d’initialisation non répétitif pour les algorithmes symétriques.
tag		string	Balise à authentifier lors de l’exécution du déchiffrement avec un algorithme authentifié.

Réponses

Nom	Type	Description
200 OK	KeyOperationResult	Clé symétrique encapsulée.
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

Wrapkey

Sample Request

HTTP

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

{
  "alg": "RSA1_5",
  "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo"
}

Sample Response

Status code:: 200

{
  "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6",
  "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw"
}

Définitions

Nom	Description
Error	Erreur du serveur du coffre de clés.
JsonWebKeyEncryptionAlgorithm	identificateur d’algorithme
KeyOperationResult	Résultat de l’opération de clé.
KeyOperationsParameters	Paramètres d’opérations clés.
KeyVaultError	Exception d’erreur du coffre de clés.

Error

Erreur du serveur du coffre de clés.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	Erreur du serveur du coffre de clés.
message	string	Message d’erreur.

JsonWebKeyEncryptionAlgorithm

identificateur d’algorithme

Nom	Type	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

Résultat de l’opération de clé.

Nom	Type	Description
aad	string
iv	string
kid	string	Identificateur de clé
tag	string
value	string

KeyOperationsParameters

Paramètres d’opérations clés.

Nom	Type	Description
aad	string	Données supplémentaires à authentifier, mais pas chiffrer/déchiffrer lors de l’utilisation d’algorithmes de chiffrement authentifiés.
alg	JsonWebKeyEncryptionAlgorithm	identificateur d’algorithme
iv	string	Vecteur d’initialisation non répétitif pour les algorithmes symétriques.
tag	string	Balise à authentifier lors de l’exécution du déchiffrement avec un algorithme authentifié.
value	string

KeyVaultError

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur du serveur du coffre de clés.

Partager via