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- (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm) — Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.
#algorithm=
def algorithm=(value) -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm- value (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm) — Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.
- (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm) — Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.
#crypto_key_version
def crypto_key_version() -> ::String-
(::String) — Optional. The optional name of
an existing CryptoKeyVersion to
target for an import operation. If this field is not present, a new
CryptoKeyVersion containing the
supplied key material is created.
If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via [ImportCryptoKeyVersion][], and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material.
#crypto_key_version=
def crypto_key_version=(value) -> ::String-
value (::String) — Optional. The optional name of
an existing CryptoKeyVersion to
target for an import operation. If this field is not present, a new
CryptoKeyVersion containing the
supplied key material is created.
If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via [ImportCryptoKeyVersion][], and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material.
-
(::String) — Optional. The optional name of
an existing CryptoKeyVersion to
target for an import operation. If this field is not present, a new
CryptoKeyVersion containing the
supplied key material is created.
If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via [ImportCryptoKeyVersion][], and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material.
#import_job
def import_job() -> ::String#import_job=
def import_job=(value) -> ::String#parent
def parent() -> ::String-
(::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-
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.
-
(::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-
(::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:
- 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.
- 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-
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:
- 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.
- 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.
-
(::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:
- 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.
- 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.