Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest (v0.13.0)

Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest.

Request message for KeyManagementService.ImportCryptoKeyVersion.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#algorithm

def algorithm() -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm
Returns

#algorithm=

def algorithm=(value) -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm
Parameter
Returns

#crypto_key_version

def crypto_key_version() -> ::String
Returns

#crypto_key_version=

def crypto_key_version=(value) -> ::String
Parameter
Returns

#import_job

def import_job() -> ::String
Returns
  • (::String) — Required. The name of the ImportJob that was used to wrap this key material.

#import_job=

def import_job=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the ImportJob that was used to wrap this key material.
Returns
  • (::String) — Required. The name of the ImportJob that was used to wrap this key material.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The name of the CryptoKey to be imported into.

    The create permission is only required on this key when creating a new CryptoKeyVersion.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the CryptoKey to be imported into.

    The create permission is only required on this key when creating a new CryptoKeyVersion.

Returns
  • (::String) — Required. The name of the CryptoKey to be imported into.

    The create permission is only required on this key when creating a new CryptoKeyVersion.

#rsa_aes_wrapped_key

def rsa_aes_wrapped_key() -> ::String
Returns
  • (::String) — Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256.

    This field contains the concatenation of two wrapped keys:

    1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label.
    2. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649).

    If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208).

    This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP.

#rsa_aes_wrapped_key=

def rsa_aes_wrapped_key=(value) -> ::String
Parameter
  • value (::String) — Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256.

    This field contains the concatenation of two wrapped keys:

    1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label.
    2. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649).

    If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208).

    This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP.

Returns
  • (::String) — Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256.

    This field contains the concatenation of two wrapped keys:

    1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label.
    2. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649).

    If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208).

    This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP.