Console
    Contact Us Start free

    Cloud KMS V1 Client - Class ImportCryptoKeyVersionRequest (2.1.6)

    Reference documentation and code samples for the Cloud KMS V1 Client class ImportCryptoKeyVersionRequest.

    Request message for KeyManagementService.ImportCryptoKeyVersion .

    Generated from protobuf message google.cloud.kms.v1.ImportCryptoKeyVersionRequest

    Namespace

    Google \ Cloud \ Kms \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ parent
    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 .

    ↳ crypto_key_version
    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.

    ↳ algorithm
    int

    Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.

    ↳ import_job
    string

    Required. The name of the ImportJob that was used to wrap this key material.

    ↳ wrapped_key
    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][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256] or [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256] or [RSA_OAEP_3072_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256_AES_256] or [RSA_OAEP_4096_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.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][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256] or [RSA_OAEP_4096_SHA256][google.cloud.kms.v1.ImportJob.ImportMethod.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.
    ↳ rsa_aes_wrapped_key
    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.

    getParent

    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
    Type
    Description
    string

    setParent

    Required. The name of the CryptoKey to be imported into.

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCryptoKeyVersion

    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.

    Returns
    Type
    Description
    string

    setCryptoKeyVersion

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAlgorithm

    Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.

    Returns
    Type
    Description
    int

    setAlgorithm

    Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getImportJob

    Required. The name of the ImportJob that was used to wrap this key material.

    Returns
    Type
    Description
    string

    setImportJob

    Required. The name of the ImportJob that was used to wrap this key material.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getWrappedKey

    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][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256] or [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256] or [RSA_OAEP_3072_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256_AES_256] or [RSA_OAEP_4096_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.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][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256] or [RSA_OAEP_4096_SHA256][google.cloud.kms.v1.ImportJob.ImportMethod.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
    Type
    Description
    string

    setWrappedKey

    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][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256] or [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256] or [RSA_OAEP_3072_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256_AES_256] or [RSA_OAEP_4096_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.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][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256] or [RSA_OAEP_4096_SHA256][google.cloud.kms.v1.ImportJob.ImportMethod.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.
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRsaAesWrappedKey

    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
    Type
    Description
    string

    hasRsaAesWrappedKey

    setRsaAesWrappedKey

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getWrappedKeyMaterial

    Returns
    Type
    Description
    string
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: