Método: cryptoKeys.encrypt

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

Criptografa os dados para que eles só possam ser recuperados por meio de uma chamada a cryptoKeys.decrypt. CryptoKey.purpose precisa ser ENCRYPT_DECRYPT.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso da CryptoKey ou da CryptoKeyVersion para usar na criptografia.

Se uma CryptoKey for especificada, o servidor usará a respectiva primary version.

A autorização exige a permissão do Google IAM a seguir para o recurso name especificado:

  • cloudkms.cryptoKeyVersions.useToEncrypt

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON

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

string (bytes format)

Obrigatório. Dados para criptografar. Não pode ser maior que 64 KiB.

O tamanho máximo depende do protectionLevel da versão da chave. Para chaves SOFTWARE, o plaintext não pode ser maior que 64 KiB. Para chaves HSM, o comprimento combinado dos campos plaintext e additionalAuthenticatedData não pode ser maior que 8 KiB.

Uma string codificada em base64.

additionalAuthenticatedData

string (bytes format)

Dados opcionais que, se especificados, também precisarão ser fornecidos na descriptografia por meio de DecryptRequest.additional_authenticated_data.

O tamanho máximo depende do protectionLevel da versão da chave. Para chaves SOFTWARE, os AAD não podem ser maiores que 64 KiB. Para chaves HSM, o comprimento combinado dos campos plaintext e additionalAuthenticatedData não pode ser maior que 8 KiB.

Uma string codificada em base64.

Corpo da resposta

Se bem-sucedido, o corpo da resposta conterá os dados com a estrutura a seguir:

Mensagem da resposta para KeyManagementService.Encrypt.

Representação JSON

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

string

O nome do recurso da CryptoKeyVersion usada na criptografia.

ciphertext

string (bytes format)

Dados criptografados.

Uma string codificada em Base64.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte a Visão geral da autenticação.

Testar

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Documentação do Cloud KMS