Método: cryptoKeys.encrypt

Nombre completo: projects.locations.keyRings.cryptoKeys.encrypt

Permite encriptar datos, de manera que solo puedan recuperarse mediante una llamada a cryptoKeys.decrypt. El CryptoKey.purpose debe ser ENCRYPT_DECRYPT.

Solicitud HTTP

POST https://cloudkms.googleapis.com/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/**}:encrypt

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. El nombre de recurso de la CryptoKey o CryptoKeyVersion que se debe usar para la encriptación.

Si se especifica una CryptoKey, el servidor usará su primary version.

La autorización necesita el siguiente permiso de Google IAM sobre el name del recurso especificado:

  • cloudkms.cryptoKeyVersions.useToEncrypt

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON

{
  "plaintext": string,
  "additionalAuthenticatedData": string
}
Campos
plaintext

string (bytes format)

Obligatorio. Los datos que se encriptarán. No deben superar los 64 KiB.

El tamaño máximo depende del protectionLevel de la versión de la clave. Para las claves SOFTWARE, el texto sin formato no debe superar los 64 KiB. Para las claves HSM, la longitud combinada del texto sin formato y los campos additionalAuthenticatedData no debe superar los 8 KiB.

Una string codificada en base 64.

additionalAuthenticatedData

string (bytes format)

Datos opcionales que, si se especifican, también deben proporcionarse durante la desencriptación mediante DecryptRequest.additional_authenticated_data.

El tamaño máximo depende del protectionLevel de la versión de la clave. Para las claves de SOFTWARE, AAD no debe superar los 64 KiB. En el caso de las claves de HSM, la longitud combinada del texto sin formato y los campos additionalAuthenticatedData no debe superar los 8 KiB.

Una string codificada en base 64.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Mensaje de respuesta para KeyManagementService.Encrypt.

Representación JSON

{
  "name": string,
  "ciphertext": string
}
Campos
name

string

El nombre de recurso de la CryptoKeyVersion que se usó en la encriptación.

ciphertext

string (bytes format)

Los datos encriptados.

Una string codificada en base 64.

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

Pruébalo

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Documentación de Cloud KMS