google.cloud.kms.v1.ImportCryptoKeyVersionRequest */ class ImportCryptoKeyVersionRequest extends \Google\Protobuf\Internal\Message { /** * Required. The [name][google.cloud.kms.v1.CryptoKey.name] of the * [CryptoKey][google.cloud.kms.v1.CryptoKey] to be imported into. * The create permission is only required on this key when creating a new * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $parent = ''; /** * Optional. The optional [name][google.cloud.kms.v1.CryptoKeyVersion.name] of * an existing [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to * target for an import operation. If this field is not present, a new * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] containing the * supplied key material is created. * If this field is present, the supplied key material is imported into * the existing [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. To * import into an existing * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion], the * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] must be a child of * [ImportCryptoKeyVersionRequest.parent][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.parent], * have been previously created via [ImportCryptoKeyVersion][], and be in * [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED] * or * [IMPORT_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.IMPORT_FAILED] * state. The key material and algorithm must match the previous * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] exactly if the * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] has ever contained * key material. * * Generated from protobuf field string crypto_key_version = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ private $crypto_key_version = ''; /** * Required. The * [algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] * of the key being imported. This does not need to match the * [version_template][google.cloud.kms.v1.CryptoKey.version_template] of the * [CryptoKey][google.cloud.kms.v1.CryptoKey] this version imports into. * * Generated from protobuf field .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED]; */ private $algorithm = 0; /** * Required. The [name][google.cloud.kms.v1.ImportJob.name] of the * [ImportJob][google.cloud.kms.v1.ImportJob] that was used to wrap this key * material. * * Generated from protobuf field string import_job = 4 [(.google.api.field_behavior) = REQUIRED]; */ private $import_job = ''; /** * 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][google.cloud.kms.v1.ImportJob.public_key] using * RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty * label. *
    2. *
  2. The formatted key to be imported, wrapped with the ephemeral AES-256 * key using AES-KWP (RFC 5649). *
    3. *
* 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][google.cloud.kms.v1.ImportJob.public_key] using RSAES-OAEP * with SHA-256, MGF1 with SHA-256, and an empty label. * * Generated from protobuf field bytes wrapped_key = 8 [(.google.api.field_behavior) = OPTIONAL]; */ private $wrapped_key = ''; protected $wrapped_key_material; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $parent * Required. The [name][google.cloud.kms.v1.CryptoKey.name] of the * [CryptoKey][google.cloud.kms.v1.CryptoKey] to be imported into. * The create permission is only required on this key when creating a new * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. * @type string $crypto_key_version * Optional. The optional [name][google.cloud.kms.v1.CryptoKeyVersion.name] of * an existing [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to * target for an import operation. If this field is not present, a new * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] containing the * supplied key material is created. * If this field is present, the supplied key material is imported into * the existing [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. To * import into an existing * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion], the * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] must be a child of * [ImportCryptoKeyVersionRequest.parent][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.parent], * have been previously created via [ImportCryptoKeyVersion][], and be in * [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED] * or * [IMPORT_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.IMPORT_FAILED] * state. The key material and algorithm must match the previous * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] exactly if the * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] has ever contained * key material. * @type int $algorithm * Required. The * [algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] * of the key being imported. This does not need to match the * [version_template][google.cloud.kms.v1.CryptoKey.version_template] of the * [CryptoKey][google.cloud.kms.v1.CryptoKey] this version imports into. * @type string $import_job * Required. The [name][google.cloud.kms.v1.ImportJob.name] of the * [ImportJob][google.cloud.kms.v1.ImportJob] that was used to wrap this key * material. * @type string $wrapped_key * 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][google.cloud.kms.v1.ImportJob.public_key] using * RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty * label. *
    2. *
  2. The formatted key to be imported, wrapped with the ephemeral AES-256 * key using AES-KWP (RFC 5649). *
    3. *
* 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][google.cloud.kms.v1.ImportJob.public_key] using RSAES-OAEP * with SHA-256, MGF1 with SHA-256, and an empty label. * @type string $rsa_aes_wrapped_key * Optional. This field has the same meaning as * [wrapped_key][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.wrapped_key]. * Prefer to use that field in new work. Either that field or this field * (but not both) must be specified. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Kms\V1\Service::initOnce(); parent::__construct($data); } /** * Required. The [name][google.cloud.kms.v1.CryptoKey.name] of the * [CryptoKey][google.cloud.kms.v1.CryptoKey] to be imported into. * The create permission is only required on this key when creating a new * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getParent() { return $this->parent; } /** * Required. The [name][google.cloud.kms.v1.CryptoKey.name] of the * [CryptoKey][google.cloud.kms.v1.CryptoKey] to be imported into. * The create permission is only required on this key when creating a new * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ public function setParent($var) { GPBUtil::checkString($var, True); $this->parent = $var; return $this; } /** * Optional. The optional [name][google.cloud.kms.v1.CryptoKeyVersion.name] of * an existing [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to * target for an import operation. If this field is not present, a new * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] containing the * supplied key material is created. * If this field is present, the supplied key material is imported into * the existing [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. To * import into an existing * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion], the * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] must be a child of * [ImportCryptoKeyVersionRequest.parent][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.parent], * have been previously created via [ImportCryptoKeyVersion][], and be in * [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED] * or * [IMPORT_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.IMPORT_FAILED] * state. The key material and algorithm must match the previous * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] exactly if the * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] has ever contained * key material. * * Generated from protobuf field string crypto_key_version = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string */ public function getCryptoKeyVersion() { return $this->crypto_key_version; } /** * Optional. The optional [name][google.cloud.kms.v1.CryptoKeyVersion.name] of * an existing [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to * target for an import operation. If this field is not present, a new * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] containing the * supplied key material is created. * If this field is present, the supplied key material is imported into * the existing [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. To * import into an existing * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion], the * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] must be a child of * [ImportCryptoKeyVersionRequest.parent][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.parent], * have been previously created via [ImportCryptoKeyVersion][], and be in * [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED] * or * [IMPORT_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.IMPORT_FAILED] * state. The key material and algorithm must match the previous * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] exactly if the * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] has ever contained * key material. * * Generated from protobuf field string crypto_key_version = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var * @return $this */ public function setCryptoKeyVersion($var) { GPBUtil::checkString($var, True); $this->crypto_key_version = $var; return $this; } /** * Required. The * [algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] * of the key being imported. This does not need to match the * [version_template][google.cloud.kms.v1.CryptoKey.version_template] of the * [CryptoKey][google.cloud.kms.v1.CryptoKey] this version imports into. * * Generated from protobuf field .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED]; * @return int */ public function getAlgorithm() { return $this->algorithm; } /** * Required. The * [algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] * of the key being imported. This does not need to match the * [version_template][google.cloud.kms.v1.CryptoKey.version_template] of the * [CryptoKey][google.cloud.kms.v1.CryptoKey] this version imports into. * * Generated from protobuf field .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED]; * @param int $var * @return $this */ public function setAlgorithm($var) { GPBUtil::checkEnum($var, \Google\Cloud\Kms\V1\CryptoKeyVersion\CryptoKeyVersionAlgorithm::class); $this->algorithm = $var; return $this; } /** * Required. The [name][google.cloud.kms.v1.ImportJob.name] of the * [ImportJob][google.cloud.kms.v1.ImportJob] that was used to wrap this key * material. * * Generated from protobuf field string import_job = 4 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getImportJob() { return $this->import_job; } /** * Required. The [name][google.cloud.kms.v1.ImportJob.name] of the * [ImportJob][google.cloud.kms.v1.ImportJob] that was used to wrap this key * material. * * Generated from protobuf field string import_job = 4 [(.google.api.field_behavior) = REQUIRED]; * @param string $var * @return $this */ public function setImportJob($var) { GPBUtil::checkString($var, True); $this->import_job = $var; return $this; } /** * 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][google.cloud.kms.v1.ImportJob.public_key] using * RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty * label. *
    2. *
  2. The formatted key to be imported, wrapped with the ephemeral AES-256 * key using AES-KWP (RFC 5649). *
    3. *
* 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][google.cloud.kms.v1.ImportJob.public_key] using RSAES-OAEP * with SHA-256, MGF1 with SHA-256, and an empty label. * * Generated from protobuf field bytes wrapped_key = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getWrappedKey() { return $this->wrapped_key; } /** * 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][google.cloud.kms.v1.ImportJob.public_key] using * RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty * label. *
    2. *
  2. The formatted key to be imported, wrapped with the ephemeral AES-256 * key using AES-KWP (RFC 5649). *
    3. *
* 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][google.cloud.kms.v1.ImportJob.public_key] using RSAES-OAEP * with SHA-256, MGF1 with SHA-256, and an empty label. * * Generated from protobuf field bytes wrapped_key = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ public function setWrappedKey($var) { GPBUtil::checkString($var, False); $this->wrapped_key = $var; return $this; } /** * Optional. This field has the same meaning as * [wrapped_key][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.wrapped_key]. * Prefer to use that field in new work. Either that field or this field * (but not both) must be specified. * * Generated from protobuf field bytes rsa_aes_wrapped_key = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getRsaAesWrappedKey() { return $this->readOneof(5); } public function hasRsaAesWrappedKey() { return $this->hasOneof(5); } /** * Optional. This field has the same meaning as * [wrapped_key][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.wrapped_key]. * Prefer to use that field in new work. Either that field or this field * (but not both) must be specified. * * Generated from protobuf field bytes rsa_aes_wrapped_key = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ public function setRsaAesWrappedKey($var) { GPBUtil::checkString($var, False); $this->writeOneof(5, $var); return $this; } /** * @return string */ public function getWrappedKeyMaterial() { return $this->whichOneof("wrapped_key_material"); } }