encrypt - encrypt
Chiffre une séquence arbitraire d’octets à l’aide d’une clé de chiffrement stockée dans un coffre de clés.
L'opération ENCRYPT chiffre une séquence arbitraire d'octets à l'aide d'une clé de chiffrement stockée dans Azure Key Vault. Notez que l'opération ENCRYPT ne prend en charge qu'un seul bloc de données, dont la taille dépend de la clé cible et de l'algorithme de chiffrement à utiliser. L'opération ENCRYPT est strictement nécessaire uniquement pour les clés symétriques stockées dans le coffre de clés Azure, 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 clés/chiffrement.
POST {vaultBaseUrl}/keys/{key-name}/{key-version}/encrypt?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é. |
vault
|
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 |
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 aléatoire et 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 |
Résultat du chiffrement. |
|
Other Status Codes |
Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération. |
Exemples
Encrypt example
Sample Request
POST https://myvault.vault.azure.net//keys/sdktestkey/f6bc1f3d37c14b2bb1a2ebb4b24e9535/encrypt?api-version=7.4
{
"alg": "RSA1_5",
"value": "5ka5IVsnGrzufA"
}
Sample Response
{
"kid": "https://myvault.vault.azure.net/keys/sdktestkey/f6bc1f3d37c14b2bb1a2ebb4b24e9535",
"value": "CR0Hk0z72oOit5TxObqRpo-WFGZkb5BeN1C0xJFKHxzdDCESYPCNB-OkiWVAnMcSyu6g2aC8riVRRxY5MC2CWKj-CJ_SMke5X2kTi5yi4hJ5vuOLzmg_M6Bmqib7LsI-TeJHr9rs3-tZaSCdZ2zICeFWYduWV5rPjTnAD98epTorT8AA1zMaYHMIhKpmttcj18-dHr0E0T55dgRtsjK04uC3FlRd3odl4RhO1UHAmYpDd5FUqN-20R0dK0Zk8F8sOtThLhEmuLvqPHOCUBiGUhHA4nRDq1La4SUbThu2KMQJL6BbxxEymuliaYcNNtW7MxgVOf6V3mFxVNRY622i9g"
}
Définitions
Nom | Description |
---|---|
Error |
Erreur du serveur du coffre de clés. |
Json |
identificateur d’algorithme |
Key |
Résultat de l’opération de clé. |
Key |
Paramètres des opérations de clé. |
Key |
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 |
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 des opérations de clé.
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 |
identificateur d’algorithme |
|
iv |
string |
Vecteur d’initialisation aléatoire et 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 |
Erreur du serveur du coffre de clés. |