encrypt - encrypt

Servicio:

Key Vault

Versión de la API:

7.4

Cifra una secuencia arbitraria de bytes mediante una clave de cifrado almacenada en un almacén de claves.
La operación ENCRYPT cifra una secuencia arbitraria de bytes mediante una clave de cifrado almacenada en Azure Key Vault. Tenga en cuenta que la operación ENCRYPT solo admite un único bloque de datos, cuyo tamaño depende de la clave de destino y del algoritmo de cifrado que se va a usar. La operación ENCRYPT solo es estrictamente necesaria para las claves simétricas almacenadas en Azure Key Vault, ya que la protección con una clave asimétrica se puede realizar mediante la parte pública de la clave. Esta operación se admite para las claves asimétricas como una comodidad para los autores de llamadas que tienen una referencia de clave, pero no tienen acceso al material de clave pública. 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	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 la API de cliente.

Cuerpo de la solicitud

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

Respuestas

Nombre	Tipo	Description
200 OK	KeyOperationResult	Resultado del cifrado.
Other Status Codes	KeyVaultError	Respuesta de error de Key Vault que describe por qué se produjo un error en la operación.

Ejemplos

Encrypt example

Solicitud de ejemplo

HTTP

POST https://myvault.vault.azure.net//keys/sdktestkey/f6bc1f3d37c14b2bb1a2ebb4b24e9535/encrypt?api-version=7.4

{
  "alg": "RSA1_5",
  "value": "5ka5IVsnGrzufA"
}

Respuesta de muestra

status code:

200

{
  "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.
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

Object

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	Mensaje de error.

JsonWebKeyEncryptionAlgorithm

Enumeración

identificador de algoritmo

Valor	Description
A128CBC
A128CBCPAD
A128GCM
A128KW
A192CBC
A192CBCPAD
A192GCM
A192KW
A256CBC
A256CBCPAD
A256GCM
A256KW
RSA-OAEP
RSA-OAEP-256
RSA1_5

KeyOperationResult

Object

Resultado de la operación de clave.

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

KeyOperationsParameters

Object

Parámetros de operaciones clave.

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

KeyVaultError

Object

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

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