encrypt - encrypt
Cifra una secuencia arbitraria de bytes mediante una clave de cifrado almacenada en un almacén de claves.
La operación de cifrado ENCRYPT cifra una secuencia arbitraria de bytes con una clave de cifrado que se almacena en el Almacén de claves de Azure. Tenga en cuenta que la operación de cifrado ENCRYPT solo admite un único bloque de datos, el tamaño del cual depende de la clave de destino y el algoritmo de cifrado que se utilizará. La operación de cifrado ENCRYPT solo es estrictamente necesaria para las claves simétricas almacenadas en el Almacén de claves de Azure, puesto que la protección con una clave asimétrica se puede realizar con la parte pública de la clave. Esta operación se admite para las claves asimétricas por comodidad para los llamadores que tienen una referencia de clave pero no tienen acceso al material de clave público. Esta operación requiere el permiso keys/encrypt.
POST {vaultBaseUrl}/keys/{key-name}/{key-version}/encrypt?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. |
vault
|
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 |
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 sin repetición 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 |
Resultado del cifrado. |
|
Other Status Codes |
Key Vault respuesta de error que describe por qué se produjo un error en la operación. |
Ejemplos
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"
}
Definiciones
Nombre | Description |
---|---|
Error |
Error del servidor del almacén de claves. |
Json |
identificador de algoritmo |
Key |
Resultado de la operación de clave. |
Key |
Parámetros de operaciones clave. |
Key |
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 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 |
identificador de algoritmo |
|
iv |
string |
Vector de inicialización sin repetición 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 del servidor del almacén de claves. |