Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest (v0.23.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) — Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified.

#rsa_aes_wrapped_key=

def rsa_aes_wrapped_key=(value) -> ::String
Parameter
  • value (::String) — Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified.
Returns
  • (::String) — Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified.

#wrapped_key

def wrapped_key() -> ::String
Returns
  • (::String) — Optional. The wrapped key material to import.

    Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208).

    When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256),

    this field must contain the concatenation of:

    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 formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649).

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

    When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256),

    this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.

#wrapped_key=

def wrapped_key=(value) -> ::String
Parameter
  • value (::String) — Optional. The wrapped key material to import.

    Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208).

    When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256),

    this field must contain the concatenation of:

    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 formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649).

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

    When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256),

    this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.

Returns
  • (::String) — Optional. The wrapped key material to import.

    Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208).

    When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256),

    this field must contain the concatenation of:

    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 formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649).

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

    When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256),

    this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.