Pacote google.cloud.kms.v1

Índice

KeyManagementService

Google Cloud Key Management Service

Gerencia chaves criptográficas e operações que usam essas chaves. Implementa um modelo REST com os seguintes objetos:

Se você usa bibliotecas gRPC manuais, consulte Como usar o gRPC com o Cloud KMS.

AsymmetricDecrypt

rpc AsymmetricDecrypt(AsymmetricDecryptRequest) retorna (AsymmetricDecryptResponse)

Descriptografa os dados que foram criptografados com uma chave pública recuperada de GetPublicKey, correspondente a uma CryptoKeyVersion com CryptoKey.purpose ASYMMETRIC_DECRYPT.

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 Visão geral da autenticação.

AsymmetricSign

rpc AsymmetricSign(AsymmetricSignRequest) retorna (AsymmetricSignResponse)

Assina os dados usando CryptoKeyVersion com CryptoKey.purpose ASYMMETRIC_SIGN, o que produz uma assinatura que pode ser verificada com a chave pública recuperada de GetPublicKey.

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 Visão geral da autenticação.

CreateCryptoKey

rpc CreateCryptoKey(CreateCryptoKeyRequest) retorna (CryptoKey)

Crie uma nova CryptoKey dentro de um KeyRing.

CryptoKey.purpose e CryptoKey.version_template.algorithm são obrigatórios.

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 Visão geral da autenticação.

CreateCryptoKeyVersion

rpc CreateCryptoKeyVersion(CreateCryptoKeyVersionRequest) retorna (CryptoKeyVersion)

Crie uma nova CryptoKeyVersion em uma CryptoKey.

O servidor atribuirá o próximo código sequencial. Se não for definido, o state será assumido como ENABLED.

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 Visão geral da autenticação.

CreateKeyRing

rpc CreateKeyRing(CreateKeyRingRequest) retorna (KeyRing)

Crie um novo KeyRing em um projeto e local específicos.

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 Visão geral da autenticação.

Decrypt

rpc Decrypt(DecryptRequest) retorna (DecryptResponse)

Descriptografa dados que foram protegidos por Encrypt. CryptoKey.purpose precisa ser ENCRYPT_DECRYPT.

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 Visão geral da autenticação.

DestroyCryptoKeyVersion

rpc DestroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest) retorna (CryptoKeyVersion)

Programe uma CryptoKeyVersion para destruição.

Ao chamar esse método, CryptoKeyVersion.state será definido como DESTROY_SCHEDULED, e destroy_time será definido como um horário 24 horas no futuro, quando o state será alterado para DESTROYED e o material da chave será destruído de modo irreversível.

Antes do destroy_time ser atingido, RestoreCryptoKeyVersion pode ser chamado para reverter o processo.

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 Visão geral da autenticação.

Encrypt

rpc Encrypt(EncryptRequest) retorna (EncryptResponse)

Criptografa dados para que só possam ser recuperados por uma chamada a Decrypt. CryptoKey.purpose precisa ser ENCRYPT_DECRYPT.

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 Visão geral da autenticação.

GetCryptoKey

rpc GetCryptoKey(GetCryptoKeyRequest) retorna (CryptoKey)

Retorna metadados para determinada CryptoKey e a respectiva primary CryptoKeyVersion.

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 Visão geral da autenticação.

GetCryptoKeyVersion

rpc GetCryptoKeyVersion(GetCryptoKeyVersionRequest) retorna (CryptoKeyVersion)

Retorna metadados para determinada CryptoKeyVersion.

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 Visão geral da autenticação.

GetKeyRing

rpc GetKeyRing(GetKeyRingRequest) retorna (KeyRing)

Retorna metadados para determinado KeyRing.

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 Visão geral da autenticação.

GetPublicKey

rpc GetPublicKey(GetPublicKeyRequest) retorna (PublicKey)

Retorna a chave pública para a CryptoKeyVersion específica. CryptoKey.purpose precisa ser ASYMMETRIC_SIGN ou ASYMMETRIC_DECRYPT.

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 Visão geral da autenticação.

ListCryptoKeyVersions

rpc ListCryptoKeyVersions(ListCryptoKeyVersionsRequest) retorna (ListCryptoKeyVersionsResponse)

Lista as CryptoKeyVersions.

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 Visão geral da autenticação.

ListCryptoKeys

rpc ListCryptoKeys(ListCryptoKeysRequest) retorna (ListCryptoKeysResponse)

Lista as CryptoKeys.

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 Visão geral da autenticação.

ListKeyRings

rpc ListKeyRings(ListKeyRingsRequest) retorna (ListKeyRingsResponse)

Lista os KeyRings.

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 Visão geral da autenticação.

RestoreCryptoKeyVersion

rpc RestoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest) retorna (CryptoKeyVersion)

Restaure uma CryptoKeyVersion no estado DESTROY_SCHEDULED.

Após a restauração da CryptoKeyVersion, o state será definido como DISABLED, e destroy_time será limpo.

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 Visão geral da autenticação.

UpdateCryptoKey

rpc UpdateCryptoKey(UpdateCryptoKeyRequest) retorna (CryptoKey)

Atualize uma CryptoKey.

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 Visão geral da autenticação.

UpdateCryptoKeyPrimaryVersion

rpc UpdateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest) retorna (CryptoKey)

Atualize a versão de uma CryptoKey que será usada em Encrypt.

Retornará um erro se chamado em uma chave assimétrica.

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 Visão geral da autenticação.

UpdateCryptoKeyVersion

rpc UpdateCryptoKeyVersion(UpdateCryptoKeyVersionRequest) retorna (CryptoKeyVersion)

Atualize os metadados de uma CryptoKeyVersion.

Com esse método, é possível alternar o state entre ENABLED e DISABLED. Consulte DestroyCryptoKeyVersion e RestoreCryptoKeyVersion para alternar entre outros estados.

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 Visão geral da autenticação.

AsymmetricDecryptRequest

Solicite uma mensagem para KeyManagementService.AsymmetricDecrypt.

Campos
name

string

Obrigatório. O nome do recurso da CryptoKeyVersion que será usada para descriptografia.

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

  • cloudkms.cryptoKeyVersions.useToDecrypt

ciphertext

bytes

Obrigatório. Os dados criptografados com a chave pública CryptoKeyVersion indicada usando OAEP.

AsymmetricDecryptResponse

Mensagem da resposta para KeyManagementService.AsymmetricDecrypt.

Campos
plaintext

bytes

Os dados descriptografados que foram originalmente criptografados com a chave pública correspondente.

AsymmetricSignRequest

Solicite uma mensagem para KeyManagementService.AsymmetricSign.

Campos
name

string

Obrigatório. O nome do recurso da CryptoKeyVersion que será usada para assinatura.

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

  • cloudkms.cryptoKeyVersions.useToSign

digest

Digest

Obrigatório. O resumo dos dados para assinar. O resumo precisa ser produzido com o mesmo algoritmo de resumo especificado pelo algorithm da versão da chave.

AsymmetricSignResponse

Mensagem da resposta para KeyManagementService.AsymmetricSign.

Campos
signature

bytes

A assinatura criada.

CreateCryptoKeyRequest

Solicite uma mensagem para KeyManagementService.CreateCryptoKey.

Campos
parent

string

Obrigatório. O name do KeyRing associado às CryptoKeys.

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

  • cloudkms.cryptoKeys.create

crypto_key_id

string

Obrigatório. Precisa ser exclusivo dentro de um KeyRing e corresponder à expressão regular [a-zA-Z0-9_-]{1,63}.

crypto_key

CryptoKey

Uma CryptoKey com valores de campo iniciais.

CreateCryptoKeyVersionRequest

Solicite uma mensagem para KeyManagementService.CreateCryptoKeyVersion.

Campos
parent

string

Obrigatório. O name da CryptoKey associada a CryptoKeyVersions.

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

  • cloudkms.cryptoKeyVersions.create

crypto_key_version

CryptoKeyVersion

Uma CryptoKeyVersion com valores de campo iniciais.

CreateKeyRingRequest

Solicite uma mensagem para KeyManagementService.CreateKeyRing.

Campos
parent

string

Obrigatório. O nome do recurso do local associado a KeyRings, no formato projects/*/locations/*.

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

  • cloudkms.keyRings.create

key_ring_id

string

Obrigatório. Precisa ser exclusivo em um local e corresponder à expressão regular [a-zA-Z0-9_-]{1,63}.

key_ring

KeyRing

Um KeyRing com valores de campo iniciais.

CryptoKey

Uma CryptoKey representa uma chave lógica que pode ser usada em operações criptográficas.

Uma CryptoKey é composta de uma ou mais versions, que representam o material da chave real usado nas operações criptográficas.

Campos
name

string

Apenas saída. O nome do recurso desta CryptoKey no formato projects/*/locations/*/keyRings/*/cryptoKeys/*.

primary

CryptoKeyVersion

Apenas saída. Uma cópia da CryptoKeyVersion "principal" a ser usada por Encrypt quando esta CryptoKey é fornecida em EncryptRequest.name.

A versão principal da CryptoKey pode ser atualizada por UpdateCryptoKeyPrimaryVersion.

Todas as chaves com purpose ENCRYPT_DECRYPT têm uma versão principal. Para outras chaves, esse campo será omitido.

purpose

CryptoKeyPurpose

O propósito imutável desta CryptoKey.

create_time

Timestamp

Apenas saída. O horário de criação desta CryptoKey.

next_rotation_time

Timestamp

Em next_rotation_time, o Key Management Service executa automaticamente as seguintes ações:

  1. Criar uma nova versão desta CryptoKey.
  2. Marcar uma nova versão como principal.

As rotações de chaves realizadas manualmente por CreateCryptoKeyVersion e UpdateCryptoKeyPrimaryVersion não afetam next_rotation_time.

As chaves com purpose ENCRYPT_DECRYPT permitem a rotação automática. Para outras chaves, esse campo precisa ser omitido.

version_template

CryptoKeyVersionTemplate

Um modelo que descreve as configurações para novas instâncias de CryptoKeyVersion. As propriedades das novas instâncias de CryptoKeyVersion criadas por CreateCryptoKeyVersion ou por rotação automática são controladas por esse modelo.

labels

map<string, string>

Rótulos com metadados definidos pelo usuário. Para mais informações, consulte Como rotular chaves.

rotation_period

Duration

O next_rotation_time será adiantado por este período quando o serviço fizer a rotação de uma chave automaticamente. O período mínimo é de um dia.

Tanto rotation_period quanto next_rotation_time precisam ser configurados.

As chaves com purpose ENCRYPT_DECRYPT permitem a rotação automática. Para outras chaves, esse campo precisa ser omitido.

CryptoKeyPurpose

CryptoKeyPurpose descreve os recursos criptográficos de uma CryptoKey. Uma determinada chave apenas pode ser usada nas operações permitidas pela finalidade dela.

Enums
CRYPTO_KEY_PURPOSE_UNSPECIFIED Não especificado.
ENCRYPT_DECRYPT CryptoKeys com essa finalidade pode ser usado com Encrypt e Decrypt.
ASYMMETRIC_SIGN CryptoKeys com essa finalidade pode ser usado com AsymmetricSign e GetPublicKey.
ASYMMETRIC_DECRYPT CryptoKeys com essa finalidade pode ser usado com AsymmetricDecrypt e GetPublicKey.

CryptoKeyVersion

Uma CryptoKeyVersion representa uma chave criptográfica individual e o material associado da chave.

Uma versão ENABLED pode ser usada em operações criptográficas.

Por razões de segurança, o material bruto da chave criptográfica representado por CryptoKeyVersion nunca será visualizado nem exportado. Ele só pode ser usado para criptografar, descriptografar ou assinar dados quando um usuário ou aplicativo autorizado invoca o Cloud KMS.

Campos
name

string

Apenas saída. O nome do recurso desta CryptoKeyVersion no formato projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

state

CryptoKeyVersionState

O estado atual da CryptoKeyVersion.

protection_level

ProtectionLevel

Apenas saída. O ProtectionLevel que descreve como as operações de criptografia são executadas com esta CryptoKeyVersion.

algorithm

CryptoKeyVersionAlgorithm

Apenas saída. O CryptoKeyVersionAlgorithm aceito por esta CryptoKeyVersion.

attestation

KeyOperationAttestation

Apenas saída. Instrução que foi gerada e assinada pelo HSM no momento da criação da chave. Use essa instrução para verificar os atributos da chave conforme armazenados no HSM, independentemente do Google. Especificado apenas para versões de chave com protection_level HSM.

create_time

Timestamp

Apenas saída. O horário de criação desta CryptoKeyVersion.

generate_time

Timestamp

Apenas saída. O horário de geração do material da chave desta CryptoKeyVersion.

destroy_time

Timestamp

Apenas saída. O horário programado para destruição do material da chave desta CryptoKeyVersion. Somente estará presente se state for DESTROY_SCHEDULED.

destroy_event_time

Timestamp

Apenas saída. O horário de destruição do material da chave desta CryptoKeyVersion. Somente estará presente se state for DESTROYED.

CryptoKeyVersionAlgorithm

O algoritmo da CryptoKeyVersion, indicando quais parâmetros precisam ser usados em cada operação criptográfica.

O algoritmo GOOGLE_SYMMETRIC_ENCRYPTION pode ser usado com CryptoKey.purpose ENCRYPT_DECRYPT.

Os algoritmos que começam com "RSA_SIGN_" podem ser usados com CryptoKey.purpose ASYMMETRIC_SIGN.

Os campos no nome após "RSA_SIGN_" correspondem aos seguintes parâmetros: algoritmo de preenchimento, comprimento de bit de módulo e algoritmo de resumo.

Para PSS, o comprimento do sal usado é igual ao do algoritmo de resumo. Por exemplo, RSA_SIGN_PSS_2048_SHA256 usará o PSS com um comprimento de sal de 256 bits ou 32 bytes.

Os algoritmos que começam com "RSA_DECRYPT_" podem ser usados com CryptoKey.purpose ASYMMETRIC_DECRYPT.

Os campos no nome após "RSA_DECRYPT_" correspondem aos seguintes parâmetros: algoritmo de preenchimento, comprimento de bit de módulo e algoritmo de resumo.

Os algoritmos que começam com "EC_SIGN_" podem ser usados com CryptoKey.purpose ASYMMETRIC_SIGN.

Os campos no nome após "EC_SIGN_" correspondem aos seguintes parâmetros: curva elíptica e algoritmo de resumo.

Enums
CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED Não especificado.
GOOGLE_SYMMETRIC_ENCRYPTION Cria chaves de criptografia simétricas.
RSA_SIGN_PSS_2048_SHA256 Chave RSASSA-PSS de 2.048 bits com um resumo SHA256.
RSA_SIGN_PSS_3072_SHA256 Chave RSASSA-PSS de 3.072 bits com um resumo SHA256.
RSA_SIGN_PSS_4096_SHA256 Chave RSASSA-PSS de 4.096 bits com um resumo SHA256.
RSA_SIGN_PSS_4096_SHA512 Chave RSASSA-PSS de 4.096 bits com um resumo SHA512.
RSA_SIGN_PKCS1_2048_SHA256 RSASSA-PKCS1-v1_5 com uma chave de 2.048 bits e um resumo SHA256.
RSA_SIGN_PKCS1_3072_SHA256 RSASSA-PKCS1-v1_5 com uma chave de 3.072 bits e um resumo SHA256.
RSA_SIGN_PKCS1_4096_SHA256 RSASSA-PKCS1-v1_5 com uma chave de 4.096 bits e um resumo SHA256.
RSA_SIGN_PKCS1_4096_SHA512 RSASSA-PKCS1-v1_5 com uma chave de 4.096 bits e um resumo SHA512.
RSA_DECRYPT_OAEP_2048_SHA256 Chave RSAES-OAEP de 2.048 bits com um resumo SHA256.
RSA_DECRYPT_OAEP_3072_SHA256 Chave RSAES-OAEP de 3.072 bits com um resumo SHA256.
RSA_DECRYPT_OAEP_4096_SHA256 Chave RSAES-OAEP de 4.096 bits com um resumo SHA256.
RSA_DECRYPT_OAEP_4096_SHA512 Chave RSAES-OAEP de 4.096 bits com um resumo SHA512.
EC_SIGN_P256_SHA256 ECDSA na curva NIST P-256 com um resumo SHA256.
EC_SIGN_P384_SHA384 ECDSA na curva NIST P-384 com um resumo SHA384.

CryptoKeyVersionState

O estado de uma CryptoKeyVersion que indica se ela pode ser usada.

Enums
CRYPTO_KEY_VERSION_STATE_UNSPECIFIED Não especificado.
PENDING_GENERATION Esta versão ainda está sendo gerada. Ela ainda não pode ser usada, ativada, desativada ou destruída. O Cloud KMS marcará automaticamente essa versão como ENABLED assim que ela estiver pronta.
ENABLED Esta versão pode ser usada em operações criptográficas.
DISABLED Esta versão não pode ser usada, mas o material da chave ainda está disponível, e a versão pode voltar ao estado ENABLED.
DESTROYED Esta versão foi destruída e o material da chave não está mais armazenado uma vez que não é possível que uma versão saia deste estado.
DESTROY_SCHEDULED Esta versão está programada para destruição e será destruída em breve. Chame RestoreCryptoKeyVersion para colocá-la novamente no estado DISABLED.

CryptoKeyVersionView

Uma visualização para CryptoKeyVersions. Controla o nível de detalhe retornado para CryptoKeyVersions em KeyManagementService.ListCryptoKeyVersions e KeyManagementService.ListCryptoKeys.

Enums
CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED Visualização padrão para cada CryptoKeyVersion. Não inclui o campo attestation.
FULL Fornece todos os campos em cada CryptoKeyVersion, incluindo attestation.

CryptoKeyVersionTemplate

Um CryptoKeyVersionTemplate especifica as propriedades a serem usadas ao criar uma nova CryptoKeyVersion, manualmente com CreateCryptoKeyVersion ou automaticamente como resultado da rotação automática.

Campos
protection_level

ProtectionLevel

ProtectionLevel para usar ao criar uma CryptoKeyVersion com base nesse modelo. Imutável. Padrões para SOFTWARE.

algorithm

CryptoKeyVersionAlgorithm

Obrigatório. Algorithm para usar ao criar uma CryptoKeyVersion com base nesse modelo.

Para compatibilidade com versões anteriores, o GOOGLE_SYMMETRIC_ENCRYPTION estará implícito se ambos os campos forem omitidos e CryptoKey.purpose for ENCRYPT_DECRYPT.

DecryptRequest

Solicite uma mensagem para KeyManagementService.Decrypt.

Campos
name

string

Obrigatório. O nome do recurso da CryptoKey que será usada para descriptografia. O servidor escolherá a versão apropriada.

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

  • cloudkms.cryptoKeyVersions.useToDecrypt

ciphertext

bytes

Obrigatório. Dados criptografados retornados originalmente em EncryptResponse.ciphertext.

additional_authenticated_data

bytes

Dados opcionais que precisam corresponder aos dados fornecidos originalmente em EncryptRequest.additional_authenticated_data.

DecryptResponse

Mensagem da resposta para KeyManagementService.Decrypt.

Campos
plaintext

bytes

Dados descriptografados fornecidos originalmente em EncryptRequest.plaintext.

DestroyCryptoKeyVersionRequest

Solicite uma mensagem para KeyManagementService.DestroyCryptoKeyVersion.

Campos
name

string

Nome do recurso da CryptoKeyVersion para destruir.

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

  • cloudkms.cryptoKeyVersions.destroy

Digest

Um Digest contém um resumo da mensagem criptográfica.

Campos
digest do campo de união. Obrigatório. O resumo da mensagem. digest pode ser apenas um dos seguintes:
sha256

bytes

Um resumo da mensagem produzido com o algoritmo SHA-256.

sha384

bytes

Um resumo da mensagem produzido com o algoritmo SHA-384.

sha512

bytes

Um resumo da mensagem produzido com o algoritmo SHA-512.

EncryptRequest

Solicite uma mensagem para KeyManagementService.Encrypt.

Campos
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

plaintext

bytes

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

O tamanho máximo depende do protection_level 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 additional_authenticated_data não pode ser maior que 8 KiB.

additional_authenticated_data

bytes

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 protection_level 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 additional_authenticated_data não pode ser maior que 8 KiB.

EncryptResponse

Mensagem da resposta para KeyManagementService.Encrypt.

Campos
name

string

O nome do recurso da CryptoKeyVersion usada na criptografia.

ciphertext

bytes

Dados criptografados.

GetCryptoKeyRequest

Solicite uma mensagem para KeyManagementService.GetCryptoKey.

Campos
name

string

O name da CryptoKey a ser recebida.

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

  • cloudkms.cryptoKeys.get

GetCryptoKeyVersionRequest

Solicite uma mensagem para KeyManagementService.GetCryptoKeyVersion.

Campos
name

string

O name da CryptoKeyVersion a ser recebida.

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

  • cloudkms.cryptoKeyVersions.get

GetKeyRingRequest

Solicite uma mensagem para KeyManagementService.GetKeyRing.

Campos
name

string

O name do KeyRing a ser recebido.

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

  • cloudkms.keyRings.get

GetPublicKeyRequest

Solicite uma mensagem para KeyManagementService.GetPublicKey.

Campos
name

string

O name da chave pública CryptoKeyVersion a ser recebida.

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

  • cloudkms.cryptoKeyVersions.viewPublicKey

KeyOperationAttestation

Contém um atestado gerado pelo HSM sobre uma operação de chave.

Campos
format

AttestationFormat

Apenas saída. O formato dos dados do atestado.

content

bytes

Apenas saída. Os dados do atestado fornecidos pelo HSM quando a operação de chave foi executada.

AttestationFormat

Formatos de atestado fornecidos pelo HSM.

Enums
ATTESTATION_FORMAT_UNSPECIFIED
CAVIUM_V1_COMPRESSED Atestado do HSM do Cavium compactado com gzip. Observe que esse formato é definido pelo Cavium e está sujeito a alterações a qualquer momento.

KeyRing

Um KeyRing é um agrupamento lógico de nível superior de CryptoKeys.

Campos
name

string

Apenas saída. O nome do recurso do KeyRing no formato projects/*/locations/*/keyRings/*.

create_time

Timestamp

Apenas saída. O horário de criação deste KeyRing.

ListCryptoKeyVersionsRequest

Solicite uma mensagem para KeyManagementService.ListCryptoKeyVersions.

Campos
parent

string

Obrigatório. O nome do recurso da CryptoKey para listar, no formato projects/*/locations/*/keyRings/*/cryptoKeys/*.

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

  • cloudkms.cryptoKeyVersions.list

page_size

int32

Limite opcional para o número de CryptoKeyVersions a serem incluídas na resposta. Outras CryptoKeyVersions podem ser recebidas posteriormente com a inclusão de ListCryptoKeyVersionsResponse.next_page_token em uma solicitação subsequente. Se não for especificado, o servidor escolherá um padrão apropriado.

page_token

string

Token de paginação opcional, antes retornado por ListCryptoKeyVersionsResponse.next_page_token.

view

CryptoKeyVersionView

Os campos para incluir na resposta.

ListCryptoKeyVersionsResponse

Mensagem da resposta para KeyManagementService.ListCryptoKeyVersions.

Campos
crypto_key_versions[]

CryptoKeyVersion

Lista de CryptoKeyVersions.

next_page_token

string

Token para recuperar a próxima página de resultados. Insira esse valor em ListCryptoKeyVersionsRequest.page_token para recuperar a próxima página de resultados.

total_size

int32

Número total de CryptoKeyVersions que correspondem à consulta.

ListCryptoKeysRequest

Solicite uma mensagem para KeyManagementService.ListCryptoKeys.

Campos
parent

string

Obrigatório. O nome do recurso do KeyRing para listar, no formato projects/*/locations/*/keyRings/*.

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

  • cloudkms.cryptoKeys.list

page_size

int32

Limite opcional para o número de CryptoKeys a serem incluídas na resposta. Outras CryptoKeys podem ser recebidas posteriormente com a inclusão de ListCryptoKeysResponse.next_page_token em uma solicitação subsequente. Se não for especificado, o servidor escolherá um padrão apropriado.

page_token

string

Token de paginação opcional, antes retornado por ListCryptoKeysResponse.next_page_token.

version_view

CryptoKeyVersionView

Os campos da versão principal para incluir na resposta.

ListCryptoKeysResponse

Mensagem da resposta para KeyManagementService.ListCryptoKeys.

Campos
crypto_keys[]

CryptoKey

Lista de CryptoKeys.

next_page_token

string

Token para recuperar a próxima página de resultados. Insira esse valor em ListCryptoKeysRequest.page_token para recuperar a próxima página de resultados.

total_size

int32

Número total de CryptoKeys que correspondem à consulta.

ListKeyRingsRequest

Solicite uma mensagem para KeyManagementService.ListKeyRings.

Campos
parent

string

Obrigatório. O nome do recurso do local associado a KeyRings, no formato projects/*/locations/*.

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

  • cloudkms.keyRings.list

page_size

int32

Limite opcional para o número de KeyRings a serem incluídos na resposta. Outros KeyRings podem ser recebidos posteriormente com a inclusão de ListKeyRingsResponse.next_page_token em uma solicitação subsequente. Se não for especificado, o servidor escolherá um padrão apropriado.

page_token

string

Token de paginação opcional, antes retornado por ListKeyRingsResponse.next_page_token.

ListKeyRingsResponse

Mensagem da resposta para KeyManagementService.ListKeyRings.

Campos
key_rings[]

KeyRing

Lista de KeyRings.

next_page_token

string

Token para recuperar a próxima página de resultados. Insira esse valor em ListKeyRingsRequest.page_token para recuperar a próxima página de resultados.

total_size

int32

Número total de KeyRings que correspondem à consulta.

LocationMetadata

Metadados do Cloud KMS para o google.cloud.location.Location especificado.

Campos
hsm_available

bool

Indica se as CryptoKeys com o protection_level HSM podem ser criadas neste local.

ProtectionLevel

ProtectionLevel especifica como as operações criptográficas são realizadas.

Enums
PROTECTION_LEVEL_UNSPECIFIED Não especificado.
SOFTWARE As operações de criptografia são executadas no software.
HSM As operações de criptografia são realizadas em um módulo de segurança de hardware.

PublicKey

A chave pública para uma CryptoKeyVersion específica. Extraída por GetPublicKey.

Campos
pem

string

A chave pública, codificada no formato PEM. Para mais informações, consulte as seções RFC 7468 referentes a Considerações gerais e Codificação textual de informações de chave pública do assunto.

algorithm

CryptoKeyVersionAlgorithm

O Algorithm associado a essa chave.

RestoreCryptoKeyVersionRequest

Solicite uma mensagem para KeyManagementService.RestoreCryptoKeyVersion.

Campos
name

string

O nome do recurso da CryptoKeyVersion para restaurar.

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

  • cloudkms.cryptoKeyVersions.restore

UpdateCryptoKeyPrimaryVersionRequest

Solicite uma mensagem para KeyManagementService.UpdateCryptoKeyPrimaryVersion.

Campos
name

string

O nome do recurso da CryptoKey para atualizar.

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

  • cloudkms.cryptoKeys.update

crypto_key_version_id

string

Código da CryptoKeyVersion filho para usar como principal.

UpdateCryptoKeyRequest

Solicite uma mensagem para KeyManagementService.UpdateCryptoKey.

Campos
crypto_key

CryptoKey

CryptoKey com valores atualizados.

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

  • cloudkms.cryptoKeys.update

update_mask

FieldMask

Lista obrigatória de campos a serem atualizados nesta solicitação.

UpdateCryptoKeyVersionRequest

Solicite uma mensagem para KeyManagementService.UpdateCryptoKeyVersion.

Campos
crypto_key_version

CryptoKeyVersion

CryptoKeyVersion com valores atualizados.

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

  • cloudkms.cryptoKeyVersions.update

update_mask

FieldMask

Lista obrigatória de campos a serem atualizados nesta solicitação.

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

Enviar comentários sobre…

Documentação do Cloud KMS