ImportJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS.
When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material.
Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key.
An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key.
For more information, see Importing a
key <https://cloud.google.com/kms/docs/importing-a-key>__.
Attributes | |
|---|---|
| Name | Description |
name |
str
Output only. The resource name for this ImportJob in the format projects/*/locations/*/keyRings/*/importJobs/*.
|
import_method |
google.cloud.kms_v1.types.ImportJob.ImportMethod
Required. Immutable. The wrapping method to be used for incoming key material. |
protection_level |
google.cloud.kms_v1.types.ProtectionLevel
Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which this ImportJob was created. |
generate_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time this ImportJob's key material was generated. |
expire_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material. |
expire_event_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time this ImportJob expired. Only present if state is EXPIRED. |
state |
google.cloud.kms_v1.types.ImportJob.ImportJobState
Output only. The current state of the ImportJob, indicating if it can be used. |
public_key |
google.cloud.kms_v1.types.ImportJob.WrappingPublicKey
Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. |
attestation |
google.cloud.kms_v1.types.KeyOperationAttestation
Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM. |
Classes
ImportJobState
ImportJobState(value)The state of the ImportJob, indicating if it can be used.
Values: IMPORT_JOB_STATE_UNSPECIFIED (0): Not specified. PENDING_GENERATION (1): The wrapping key for this job is still being generated. It may not be used. Cloud KMS will automatically mark this job as ACTIVE as soon as the wrapping key is generated. ACTIVE (2): This job may be used in CreateCryptoKey and CreateCryptoKeyVersion requests. EXPIRED (3): This job can no longer be used and may not leave this state once entered.
ImportMethod
ImportMethod(value)ImportMethod describes the key wrapping method chosen for this ImportJob.
Values:
IMPORT_METHOD_UNSPECIFIED (0):
Not specified.
RSA_OAEP_3072_SHA1_AES_256 (1):
This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key
wrapping scheme defined in the PKCS #11 standard. In
summary, this involves wrapping the raw key with an
ephemeral AES key, and wrapping the ephemeral AES key with a
3072 bit RSA key. For more details, see RSA AES key wrap
mechanism <http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908>.
RSA_OAEP_4096_SHA1_AES_256 (2):
This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key
wrapping scheme defined in the PKCS #11 standard. In
summary, this involves wrapping the raw key with an
ephemeral AES key, and wrapping the ephemeral AES key with a
4096 bit RSA key. For more details, see RSA AES key wrap
mechanism <http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908>.
RSA_OAEP_3072_SHA256_AES_256 (3):
This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key
wrapping scheme defined in the PKCS #11 standard. In
summary, this involves wrapping the raw key with an
ephemeral AES key, and wrapping the ephemeral AES key with a
3072 bit RSA key. For more details, see RSA AES key wrap
mechanism <http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908>.
RSA_OAEP_4096_SHA256_AES_256 (4):
This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key
wrapping scheme defined in the PKCS #11 standard. In
summary, this involves wrapping the raw key with an
ephemeral AES key, and wrapping the ephemeral AES key with a
4096 bit RSA key. For more details, see RSA AES key wrap
mechanism <http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908>.
RSA_OAEP_3072_SHA256 (5):
This ImportMethod represents RSAES-OAEP with
a 3072 bit RSA key. The key material to be
imported is wrapped directly with the RSA key.
Due to technical limitations of RSA wrapping,
this method cannot be used to wrap RSA keys for
import.
RSA_OAEP_4096_SHA256 (6):
This ImportMethod represents RSAES-OAEP with
a 4096 bit RSA key. The key material to be
imported is wrapped directly with the RSA key.
Due to technical limitations of RSA wrapping,
this method cannot be used to wrap RSA keys for
import.
WrappingPublicKey
WrappingPublicKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod.