Recurso REST: projects.locations.keyRings.cryptoKeys.cryptoKeyVersions

Recurso: 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.

Representação JSON

{
  "name": string,
  "state": enum(CryptoKeyVersionState),
  "protectionLevel": enum(ProtectionLevel),
  "algorithm": enum(CryptoKeyVersionAlgorithm),
  "attestation": {
    object(KeyOperationAttestation)
  },
  "createTime": string,
  "generateTime": string,
  "destroyTime": string,
  "destroyEventTime": string
}
Campos
name

string

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

state

enum(CryptoKeyVersionState)

O estado atual da CryptoKeyVersion.

protectionLevel

enum(ProtectionLevel)

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

algorithm

enum(CryptoKeyVersionAlgorithm)

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

attestation

object(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 protectionLevel HSM.

createTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC "Zulu" RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

generateTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

destroyTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

destroyEventTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

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 cryptoKeyVersions.restore para colocá-la novamente no estado DISABLED.

KeyOperationAttestation

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

Representação JSON

{
  "format": enum(AttestationFormat),
  "content": string
}
Campos
format

enum(AttestationFormat)

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

content

string (bytes format)

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

Uma string codificada em base64.

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.

Métodos

asymmetricDecrypt

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

asymmetricSign

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.

create

Cria uma nova CryptoKeyVersion em uma CryptoKey.

destroy

Programa uma CryptoKeyVersion para destruição.

get

Retorna metadados para determinada CryptoKeyVersion.

getPublicKey

Retorna a chave pública para a CryptoKeyVersion específica.

list

Lista as CryptoKeyVersions.

patch

Atualiza os metadados de uma CryptoKeyVersion.

restore

Restaura uma CryptoKeyVersion no estado DESTROY_SCHEDULED.
Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Documentação do Cloud KMS