|
|
|
@ -31,7 +31,6 @@ option java_outer_classname = "KmsProto"; |
|
|
|
|
option java_package = "com.google.cloud.kms.v1"; |
|
|
|
|
option php_namespace = "Google\\Cloud\\Kms\\V1"; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Google Cloud Key Management Service |
|
|
|
|
// |
|
|
|
|
// Manages cryptographic keys and operations using those keys. Implements a REST |
|
|
|
@ -59,7 +58,8 @@ service KeyManagementService { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Lists [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]. |
|
|
|
|
rpc ListCryptoKeyVersions(ListCryptoKeyVersionsRequest) returns (ListCryptoKeyVersionsResponse) { |
|
|
|
|
rpc ListCryptoKeyVersions(ListCryptoKeyVersionsRequest) |
|
|
|
|
returns (ListCryptoKeyVersionsResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
get: "/v1/{parent=projects/*/locations/*/keyRings/*/cryptoKeys/*}/cryptoKeyVersions" |
|
|
|
|
}; |
|
|
|
@ -72,24 +72,29 @@ service KeyManagementService { |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Returns metadata for a given [CryptoKey][google.cloud.kms.v1.CryptoKey], as well as its |
|
|
|
|
// [primary][google.cloud.kms.v1.CryptoKey.primary] [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. |
|
|
|
|
// Returns metadata for a given [CryptoKey][google.cloud.kms.v1.CryptoKey], as |
|
|
|
|
// well as its [primary][google.cloud.kms.v1.CryptoKey.primary] |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. |
|
|
|
|
rpc GetCryptoKey(GetCryptoKeyRequest) returns (CryptoKey) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
get: "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/*}" |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Returns metadata for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. |
|
|
|
|
rpc GetCryptoKeyVersion(GetCryptoKeyVersionRequest) returns (CryptoKeyVersion) { |
|
|
|
|
// Returns metadata for a given |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. |
|
|
|
|
rpc GetCryptoKeyVersion(GetCryptoKeyVersionRequest) |
|
|
|
|
returns (CryptoKeyVersion) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
get: "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*}" |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Returns the public key for the given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. The |
|
|
|
|
// Returns the public key for the given |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. The |
|
|
|
|
// [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be |
|
|
|
|
// [ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN] or |
|
|
|
|
// [ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN] |
|
|
|
|
// or |
|
|
|
|
// [ASYMMETRIC_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_DECRYPT]. |
|
|
|
|
rpc GetPublicKey(GetPublicKeyRequest) returns (PublicKey) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
@ -97,7 +102,8 @@ service KeyManagementService { |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Create a new [KeyRing][google.cloud.kms.v1.KeyRing] in a given Project and Location. |
|
|
|
|
// Create a new [KeyRing][google.cloud.kms.v1.KeyRing] in a given Project and |
|
|
|
|
// Location. |
|
|
|
|
rpc CreateKeyRing(CreateKeyRingRequest) returns (KeyRing) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{parent=projects/*/locations/*}/keyRings" |
|
|
|
@ -105,7 +111,8 @@ service KeyManagementService { |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Create a new [CryptoKey][google.cloud.kms.v1.CryptoKey] within a [KeyRing][google.cloud.kms.v1.KeyRing]. |
|
|
|
|
// Create a new [CryptoKey][google.cloud.kms.v1.CryptoKey] within a |
|
|
|
|
// [KeyRing][google.cloud.kms.v1.KeyRing]. |
|
|
|
|
// |
|
|
|
|
// [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] and |
|
|
|
|
// [CryptoKey.version_template.algorithm][google.cloud.kms.v1.CryptoKeyVersionTemplate.algorithm] |
|
|
|
@ -117,12 +124,14 @@ service KeyManagementService { |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Create a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in a [CryptoKey][google.cloud.kms.v1.CryptoKey]. |
|
|
|
|
// Create a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in a |
|
|
|
|
// [CryptoKey][google.cloud.kms.v1.CryptoKey]. |
|
|
|
|
// |
|
|
|
|
// The server will assign the next sequential id. If unset, |
|
|
|
|
// [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to |
|
|
|
|
// [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]. |
|
|
|
|
rpc CreateCryptoKeyVersion(CreateCryptoKeyVersionRequest) returns (CryptoKeyVersion) { |
|
|
|
|
rpc CreateCryptoKeyVersion(CreateCryptoKeyVersionRequest) |
|
|
|
|
returns (CryptoKeyVersion) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{parent=projects/*/locations/*/keyRings/*/cryptoKeys/*}/cryptoKeyVersions" |
|
|
|
|
body: "crypto_key_version" |
|
|
|
@ -137,22 +146,29 @@ service KeyManagementService { |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Update a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s metadata. |
|
|
|
|
// Update a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s |
|
|
|
|
// metadata. |
|
|
|
|
// |
|
|
|
|
// [state][google.cloud.kms.v1.CryptoKeyVersion.state] may be changed between |
|
|
|
|
// [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED] and |
|
|
|
|
// [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED] using this |
|
|
|
|
// method. See [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion] and [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] to |
|
|
|
|
// move between other states. |
|
|
|
|
rpc UpdateCryptoKeyVersion(UpdateCryptoKeyVersionRequest) returns (CryptoKeyVersion) { |
|
|
|
|
// [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED] |
|
|
|
|
// and |
|
|
|
|
// [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED] |
|
|
|
|
// using this method. See |
|
|
|
|
// [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion] |
|
|
|
|
// and |
|
|
|
|
// [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] |
|
|
|
|
// to move between other states. |
|
|
|
|
rpc UpdateCryptoKeyVersion(UpdateCryptoKeyVersionRequest) |
|
|
|
|
returns (CryptoKeyVersion) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
patch: "/v1/{crypto_key_version.name=projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*}" |
|
|
|
|
body: "crypto_key_version" |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Encrypts data, so that it can only be recovered by a call to [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. |
|
|
|
|
// The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be |
|
|
|
|
// Encrypts data, so that it can only be recovered by a call to |
|
|
|
|
// [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. The |
|
|
|
|
// [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be |
|
|
|
|
// [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]. |
|
|
|
|
rpc Encrypt(EncryptRequest) returns (EncryptResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
@ -161,8 +177,10 @@ service KeyManagementService { |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Decrypts data that was protected by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] |
|
|
|
|
// must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]. |
|
|
|
|
// Decrypts data that was protected by |
|
|
|
|
// [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. The |
|
|
|
|
// [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be |
|
|
|
|
// [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]. |
|
|
|
|
rpc Decrypt(DecryptRequest) returns (DecryptResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/*}:decrypt" |
|
|
|
@ -170,9 +188,11 @@ service KeyManagementService { |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] |
|
|
|
|
// Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] |
|
|
|
|
// with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] |
|
|
|
|
// ASYMMETRIC_SIGN, producing a signature that can be verified with the public |
|
|
|
|
// key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey]. |
|
|
|
|
// key retrieved from |
|
|
|
|
// [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey]. |
|
|
|
|
rpc AsymmetricSign(AsymmetricSignRequest) returns (AsymmetricSignResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*}:asymmetricSign" |
|
|
|
@ -181,38 +201,51 @@ service KeyManagementService { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Decrypts data that was encrypted with a public key retrieved from |
|
|
|
|
// [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] corresponding to a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with |
|
|
|
|
// [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_DECRYPT. |
|
|
|
|
rpc AsymmetricDecrypt(AsymmetricDecryptRequest) returns (AsymmetricDecryptResponse) { |
|
|
|
|
// [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] |
|
|
|
|
// corresponding to a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] |
|
|
|
|
// with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] |
|
|
|
|
// ASYMMETRIC_DECRYPT. |
|
|
|
|
rpc AsymmetricDecrypt(AsymmetricDecryptRequest) |
|
|
|
|
returns (AsymmetricDecryptResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*}:asymmetricDecrypt" |
|
|
|
|
body: "*" |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Update the version of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that will be used in [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. |
|
|
|
|
// Update the version of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that |
|
|
|
|
// will be used in |
|
|
|
|
// [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. |
|
|
|
|
// |
|
|
|
|
// Returns an error if called on an asymmetric key. |
|
|
|
|
rpc UpdateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest) returns (CryptoKey) { |
|
|
|
|
rpc UpdateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest) |
|
|
|
|
returns (CryptoKey) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/*}:updatePrimaryVersion" |
|
|
|
|
body: "*" |
|
|
|
|
}; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Schedule a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] for destruction. |
|
|
|
|
// Schedule a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] for |
|
|
|
|
// destruction. |
|
|
|
|
// |
|
|
|
|
// Upon calling this method, [CryptoKeyVersion.state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to |
|
|
|
|
// Upon calling this method, |
|
|
|
|
// [CryptoKeyVersion.state][google.cloud.kms.v1.CryptoKeyVersion.state] will |
|
|
|
|
// be set to |
|
|
|
|
// [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] |
|
|
|
|
// and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be set to a time 24 |
|
|
|
|
// hours in the future, at which point the [state][google.cloud.kms.v1.CryptoKeyVersion.state] |
|
|
|
|
// will be changed to |
|
|
|
|
// [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED], and the key |
|
|
|
|
// material will be irrevocably destroyed. |
|
|
|
|
// and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will |
|
|
|
|
// be set to a time 24 hours in the future, at which point the |
|
|
|
|
// [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be changed to |
|
|
|
|
// [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED], |
|
|
|
|
// and the key material will be irrevocably destroyed. |
|
|
|
|
// |
|
|
|
|
// Before the [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] is reached, |
|
|
|
|
// [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] may be called to reverse the process. |
|
|
|
|
rpc DestroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest) returns (CryptoKeyVersion) { |
|
|
|
|
// Before the |
|
|
|
|
// [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] is |
|
|
|
|
// reached, |
|
|
|
|
// [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] |
|
|
|
|
// may be called to reverse the process. |
|
|
|
|
rpc DestroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest) |
|
|
|
|
returns (CryptoKeyVersion) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*}:destroy" |
|
|
|
|
body: "*" |
|
|
|
@ -223,10 +256,13 @@ service KeyManagementService { |
|
|
|
|
// [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] |
|
|
|
|
// state. |
|
|
|
|
// |
|
|
|
|
// Upon restoration of the CryptoKeyVersion, [state][google.cloud.kms.v1.CryptoKeyVersion.state] |
|
|
|
|
// will be set to [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED], |
|
|
|
|
// and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be cleared. |
|
|
|
|
rpc RestoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest) returns (CryptoKeyVersion) { |
|
|
|
|
// Upon restoration of the CryptoKeyVersion, |
|
|
|
|
// [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to |
|
|
|
|
// [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED], |
|
|
|
|
// and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will |
|
|
|
|
// be cleared. |
|
|
|
|
rpc RestoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest) |
|
|
|
|
returns (CryptoKeyVersion) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*}:restore" |
|
|
|
|
body: "*" |
|
|
|
@ -234,16 +270,20 @@ service KeyManagementService { |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.ListKeyRings][google.cloud.kms.v1.KeyManagementService.ListKeyRings]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.ListKeyRings][google.cloud.kms.v1.KeyManagementService.ListKeyRings]. |
|
|
|
|
message ListKeyRingsRequest { |
|
|
|
|
// Required. The resource name of the location associated with the |
|
|
|
|
// [KeyRings][google.cloud.kms.v1.KeyRing], in the format `projects/*/locations/*`. |
|
|
|
|
// [KeyRings][google.cloud.kms.v1.KeyRing], in the format |
|
|
|
|
// `projects/*/locations/*`. |
|
|
|
|
string parent = 1; |
|
|
|
|
|
|
|
|
|
// Optional limit on the number of [KeyRings][google.cloud.kms.v1.KeyRing] to include in the |
|
|
|
|
// response. Further [KeyRings][google.cloud.kms.v1.KeyRing] can subsequently be obtained by |
|
|
|
|
// including the [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.next_page_token] in a subsequent |
|
|
|
|
// request. If unspecified, the server will pick an appropriate default. |
|
|
|
|
// Optional limit on the number of [KeyRings][google.cloud.kms.v1.KeyRing] to |
|
|
|
|
// include in the response. Further [KeyRings][google.cloud.kms.v1.KeyRing] |
|
|
|
|
// can subsequently be obtained by including the |
|
|
|
|
// [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.next_page_token] |
|
|
|
|
// in a subsequent request. If unspecified, the server will pick an |
|
|
|
|
// appropriate default. |
|
|
|
|
int32 page_size = 2; |
|
|
|
|
|
|
|
|
|
// Optional pagination token, returned earlier via |
|
|
|
@ -251,16 +291,20 @@ message ListKeyRingsRequest { |
|
|
|
|
string page_token = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.ListCryptoKeys][google.cloud.kms.v1.KeyManagementService.ListCryptoKeys]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.ListCryptoKeys][google.cloud.kms.v1.KeyManagementService.ListCryptoKeys]. |
|
|
|
|
message ListCryptoKeysRequest { |
|
|
|
|
// Required. The resource name of the [KeyRing][google.cloud.kms.v1.KeyRing] to list, in the format |
|
|
|
|
// `projects/*/locations/*/keyRings/*`. |
|
|
|
|
// Required. The resource name of the [KeyRing][google.cloud.kms.v1.KeyRing] |
|
|
|
|
// to list, in the format `projects/*/locations/*/keyRings/*`. |
|
|
|
|
string parent = 1; |
|
|
|
|
|
|
|
|
|
// Optional limit on the number of [CryptoKeys][google.cloud.kms.v1.CryptoKey] to include in the |
|
|
|
|
// response. Further [CryptoKeys][google.cloud.kms.v1.CryptoKey] can subsequently be obtained by |
|
|
|
|
// including the [ListCryptoKeysResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeysResponse.next_page_token] in a subsequent |
|
|
|
|
// request. If unspecified, the server will pick an appropriate default. |
|
|
|
|
// Optional limit on the number of [CryptoKeys][google.cloud.kms.v1.CryptoKey] |
|
|
|
|
// to include in the response. Further |
|
|
|
|
// [CryptoKeys][google.cloud.kms.v1.CryptoKey] can subsequently be obtained by |
|
|
|
|
// including the |
|
|
|
|
// [ListCryptoKeysResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeysResponse.next_page_token] |
|
|
|
|
// in a subsequent request. If unspecified, the server will pick an |
|
|
|
|
// appropriate default. |
|
|
|
|
int32 page_size = 2; |
|
|
|
|
|
|
|
|
|
// Optional pagination token, returned earlier via |
|
|
|
@ -271,17 +315,21 @@ message ListCryptoKeysRequest { |
|
|
|
|
CryptoKeyVersion.CryptoKeyVersionView version_view = 4; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.ListCryptoKeyVersions][google.cloud.kms.v1.KeyManagementService.ListCryptoKeyVersions]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.ListCryptoKeyVersions][google.cloud.kms.v1.KeyManagementService.ListCryptoKeyVersions]. |
|
|
|
|
message ListCryptoKeyVersionsRequest { |
|
|
|
|
// Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey] to list, in the format |
|
|
|
|
// Required. The resource name of the |
|
|
|
|
// [CryptoKey][google.cloud.kms.v1.CryptoKey] to list, in the format |
|
|
|
|
// `projects/*/locations/*/keyRings/*/cryptoKeys/*`. |
|
|
|
|
string parent = 1; |
|
|
|
|
|
|
|
|
|
// Optional limit on the number of [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] to |
|
|
|
|
// include in the response. Further [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] can |
|
|
|
|
// subsequently be obtained by including the |
|
|
|
|
// [ListCryptoKeyVersionsResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeyVersionsResponse.next_page_token] in a subsequent request. |
|
|
|
|
// If unspecified, the server will pick an appropriate default. |
|
|
|
|
// Optional limit on the number of |
|
|
|
|
// [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] to include in the |
|
|
|
|
// response. Further [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] |
|
|
|
|
// can subsequently be obtained by including the |
|
|
|
|
// [ListCryptoKeyVersionsResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeyVersionsResponse.next_page_token] |
|
|
|
|
// in a subsequent request. If unspecified, the server will pick an |
|
|
|
|
// appropriate default. |
|
|
|
|
int32 page_size = 2; |
|
|
|
|
|
|
|
|
|
// Optional pagination token, returned earlier via |
|
|
|
@ -292,76 +340,93 @@ message ListCryptoKeyVersionsRequest { |
|
|
|
|
CryptoKeyVersion.CryptoKeyVersionView view = 4; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Response message for [KeyManagementService.ListKeyRings][google.cloud.kms.v1.KeyManagementService.ListKeyRings]. |
|
|
|
|
// Response message for |
|
|
|
|
// [KeyManagementService.ListKeyRings][google.cloud.kms.v1.KeyManagementService.ListKeyRings]. |
|
|
|
|
message ListKeyRingsResponse { |
|
|
|
|
// The list of [KeyRings][google.cloud.kms.v1.KeyRing]. |
|
|
|
|
repeated KeyRing key_rings = 1; |
|
|
|
|
|
|
|
|
|
// A token to retrieve next page of results. Pass this value in |
|
|
|
|
// [ListKeyRingsRequest.page_token][google.cloud.kms.v1.ListKeyRingsRequest.page_token] to retrieve the next page of results. |
|
|
|
|
// [ListKeyRingsRequest.page_token][google.cloud.kms.v1.ListKeyRingsRequest.page_token] |
|
|
|
|
// to retrieve the next page of results. |
|
|
|
|
string next_page_token = 2; |
|
|
|
|
|
|
|
|
|
// The total number of [KeyRings][google.cloud.kms.v1.KeyRing] that matched the query. |
|
|
|
|
// The total number of [KeyRings][google.cloud.kms.v1.KeyRing] that matched |
|
|
|
|
// the query. |
|
|
|
|
int32 total_size = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Response message for [KeyManagementService.ListCryptoKeys][google.cloud.kms.v1.KeyManagementService.ListCryptoKeys]. |
|
|
|
|
// Response message for |
|
|
|
|
// [KeyManagementService.ListCryptoKeys][google.cloud.kms.v1.KeyManagementService.ListCryptoKeys]. |
|
|
|
|
message ListCryptoKeysResponse { |
|
|
|
|
// The list of [CryptoKeys][google.cloud.kms.v1.CryptoKey]. |
|
|
|
|
repeated CryptoKey crypto_keys = 1; |
|
|
|
|
|
|
|
|
|
// A token to retrieve next page of results. Pass this value in |
|
|
|
|
// [ListCryptoKeysRequest.page_token][google.cloud.kms.v1.ListCryptoKeysRequest.page_token] to retrieve the next page of results. |
|
|
|
|
// [ListCryptoKeysRequest.page_token][google.cloud.kms.v1.ListCryptoKeysRequest.page_token] |
|
|
|
|
// to retrieve the next page of results. |
|
|
|
|
string next_page_token = 2; |
|
|
|
|
|
|
|
|
|
// The total number of [CryptoKeys][google.cloud.kms.v1.CryptoKey] that matched the query. |
|
|
|
|
// The total number of [CryptoKeys][google.cloud.kms.v1.CryptoKey] that |
|
|
|
|
// matched the query. |
|
|
|
|
int32 total_size = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Response message for [KeyManagementService.ListCryptoKeyVersions][google.cloud.kms.v1.KeyManagementService.ListCryptoKeyVersions]. |
|
|
|
|
// Response message for |
|
|
|
|
// [KeyManagementService.ListCryptoKeyVersions][google.cloud.kms.v1.KeyManagementService.ListCryptoKeyVersions]. |
|
|
|
|
message ListCryptoKeyVersionsResponse { |
|
|
|
|
// The list of [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]. |
|
|
|
|
repeated CryptoKeyVersion crypto_key_versions = 1; |
|
|
|
|
|
|
|
|
|
// A token to retrieve next page of results. Pass this value in |
|
|
|
|
// [ListCryptoKeyVersionsRequest.page_token][google.cloud.kms.v1.ListCryptoKeyVersionsRequest.page_token] to retrieve the next page of |
|
|
|
|
// results. |
|
|
|
|
// [ListCryptoKeyVersionsRequest.page_token][google.cloud.kms.v1.ListCryptoKeyVersionsRequest.page_token] |
|
|
|
|
// to retrieve the next page of results. |
|
|
|
|
string next_page_token = 2; |
|
|
|
|
|
|
|
|
|
// The total number of [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] that matched the |
|
|
|
|
// The total number of |
|
|
|
|
// [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] that matched the |
|
|
|
|
// query. |
|
|
|
|
int32 total_size = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.GetKeyRing][google.cloud.kms.v1.KeyManagementService.GetKeyRing]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.GetKeyRing][google.cloud.kms.v1.KeyManagementService.GetKeyRing]. |
|
|
|
|
message GetKeyRingRequest { |
|
|
|
|
// The [name][google.cloud.kms.v1.KeyRing.name] of the [KeyRing][google.cloud.kms.v1.KeyRing] to get. |
|
|
|
|
// The [name][google.cloud.kms.v1.KeyRing.name] of the |
|
|
|
|
// [KeyRing][google.cloud.kms.v1.KeyRing] to get. |
|
|
|
|
string name = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.GetCryptoKey][google.cloud.kms.v1.KeyManagementService.GetCryptoKey]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.GetCryptoKey][google.cloud.kms.v1.KeyManagementService.GetCryptoKey]. |
|
|
|
|
message GetCryptoKeyRequest { |
|
|
|
|
// The [name][google.cloud.kms.v1.CryptoKey.name] of the [CryptoKey][google.cloud.kms.v1.CryptoKey] to get. |
|
|
|
|
// The [name][google.cloud.kms.v1.CryptoKey.name] of the |
|
|
|
|
// [CryptoKey][google.cloud.kms.v1.CryptoKey] to get. |
|
|
|
|
string name = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.GetCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.GetCryptoKeyVersion]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.GetCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.GetCryptoKeyVersion]. |
|
|
|
|
message GetCryptoKeyVersionRequest { |
|
|
|
|
// The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to get. |
|
|
|
|
// The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to get. |
|
|
|
|
string name = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey]. |
|
|
|
|
message GetPublicKeyRequest { |
|
|
|
|
// The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key to |
|
|
|
|
// get. |
|
|
|
|
// The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key to get. |
|
|
|
|
string name = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.CreateKeyRing][google.cloud.kms.v1.KeyManagementService.CreateKeyRing]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.CreateKeyRing][google.cloud.kms.v1.KeyManagementService.CreateKeyRing]. |
|
|
|
|
message CreateKeyRingRequest { |
|
|
|
|
// Required. The resource name of the location associated with the |
|
|
|
|
// [KeyRings][google.cloud.kms.v1.KeyRing], in the format `projects/*/locations/*`. |
|
|
|
|
// [KeyRings][google.cloud.kms.v1.KeyRing], in the format |
|
|
|
|
// `projects/*/locations/*`. |
|
|
|
|
string parent = 1; |
|
|
|
|
|
|
|
|
|
// Required. It must be unique within a location and match the regular |
|
|
|
@ -372,10 +437,11 @@ message CreateKeyRingRequest { |
|
|
|
|
KeyRing key_ring = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.CreateCryptoKey][google.cloud.kms.v1.KeyManagementService.CreateCryptoKey]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.CreateCryptoKey][google.cloud.kms.v1.KeyManagementService.CreateCryptoKey]. |
|
|
|
|
message CreateCryptoKeyRequest { |
|
|
|
|
// Required. The [name][google.cloud.kms.v1.KeyRing.name] of the KeyRing associated with the |
|
|
|
|
// [CryptoKeys][google.cloud.kms.v1.CryptoKey]. |
|
|
|
|
// Required. The [name][google.cloud.kms.v1.KeyRing.name] of the KeyRing |
|
|
|
|
// associated with the [CryptoKeys][google.cloud.kms.v1.CryptoKey]. |
|
|
|
|
string parent = 1; |
|
|
|
|
|
|
|
|
|
// Required. It must be unique within a KeyRing and match the regular |
|
|
|
@ -386,17 +452,21 @@ message CreateCryptoKeyRequest { |
|
|
|
|
CryptoKey crypto_key = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]. |
|
|
|
|
message CreateCryptoKeyVersionRequest { |
|
|
|
|
// Required. The [name][google.cloud.kms.v1.CryptoKey.name] of the [CryptoKey][google.cloud.kms.v1.CryptoKey] associated with |
|
|
|
|
// the [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]. |
|
|
|
|
// Required. The [name][google.cloud.kms.v1.CryptoKey.name] of the |
|
|
|
|
// [CryptoKey][google.cloud.kms.v1.CryptoKey] associated with the |
|
|
|
|
// [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]. |
|
|
|
|
string parent = 1; |
|
|
|
|
|
|
|
|
|
// A [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with initial field values. |
|
|
|
|
// A [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with initial |
|
|
|
|
// field values. |
|
|
|
|
CryptoKeyVersion crypto_key_version = 2; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.UpdateCryptoKey][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKey]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.UpdateCryptoKey][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKey]. |
|
|
|
|
message UpdateCryptoKeyRequest { |
|
|
|
|
// [CryptoKey][google.cloud.kms.v1.CryptoKey] with updated values. |
|
|
|
|
CryptoKey crypto_key = 1; |
|
|
|
@ -405,50 +475,60 @@ message UpdateCryptoKeyRequest { |
|
|
|
|
google.protobuf.FieldMask update_mask = 2; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.UpdateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyVersion]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.UpdateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyVersion]. |
|
|
|
|
message UpdateCryptoKeyVersionRequest { |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with updated values. |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with updated |
|
|
|
|
// values. |
|
|
|
|
CryptoKeyVersion crypto_key_version = 1; |
|
|
|
|
|
|
|
|
|
// Required list of fields to be updated in this request. |
|
|
|
|
google.protobuf.FieldMask update_mask = 2; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. |
|
|
|
|
message EncryptRequest { |
|
|
|
|
// Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey] or [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] |
|
|
|
|
// to use for encryption. |
|
|
|
|
// Required. The resource name of the |
|
|
|
|
// [CryptoKey][google.cloud.kms.v1.CryptoKey] or |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for |
|
|
|
|
// encryption. |
|
|
|
|
// |
|
|
|
|
// If a [CryptoKey][google.cloud.kms.v1.CryptoKey] is specified, the server will use its |
|
|
|
|
// [primary version][google.cloud.kms.v1.CryptoKey.primary]. |
|
|
|
|
// If a [CryptoKey][google.cloud.kms.v1.CryptoKey] is specified, the server |
|
|
|
|
// will use its [primary version][google.cloud.kms.v1.CryptoKey.primary]. |
|
|
|
|
string name = 1; |
|
|
|
|
|
|
|
|
|
// Required. The data to encrypt. Must be no larger than 64KiB. |
|
|
|
|
// |
|
|
|
|
// The maximum size depends on the key version's |
|
|
|
|
// [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]. For |
|
|
|
|
// [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the plaintext must be no larger |
|
|
|
|
// than 64KiB. For [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of the |
|
|
|
|
// plaintext and additional_authenticated_data fields must be no larger than |
|
|
|
|
// 8KiB. |
|
|
|
|
// [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]. |
|
|
|
|
// For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the |
|
|
|
|
// plaintext must be no larger than 64KiB. For |
|
|
|
|
// [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of |
|
|
|
|
// the plaintext and additional_authenticated_data fields must be no larger |
|
|
|
|
// than 8KiB. |
|
|
|
|
bytes plaintext = 2; |
|
|
|
|
|
|
|
|
|
// Optional data that, if specified, must also be provided during decryption |
|
|
|
|
// through [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]. |
|
|
|
|
// through |
|
|
|
|
// [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]. |
|
|
|
|
// |
|
|
|
|
// The maximum size depends on the key version's |
|
|
|
|
// [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]. For |
|
|
|
|
// [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the AAD must be no larger than |
|
|
|
|
// 64KiB. For [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of the |
|
|
|
|
// plaintext and additional_authenticated_data fields must be no larger than |
|
|
|
|
// 8KiB. |
|
|
|
|
// [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]. |
|
|
|
|
// For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the AAD |
|
|
|
|
// must be no larger than 64KiB. For |
|
|
|
|
// [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of |
|
|
|
|
// the plaintext and additional_authenticated_data fields must be no larger |
|
|
|
|
// than 8KiB. |
|
|
|
|
bytes additional_authenticated_data = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. |
|
|
|
|
message DecryptRequest { |
|
|
|
|
// Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey] to use for decryption. |
|
|
|
|
// The server will choose the appropriate version. |
|
|
|
|
// Required. The resource name of the |
|
|
|
|
// [CryptoKey][google.cloud.kms.v1.CryptoKey] to use for decryption. The |
|
|
|
|
// server will choose the appropriate version. |
|
|
|
|
string name = 1; |
|
|
|
|
|
|
|
|
|
// Required. The encrypted data originally returned in |
|
|
|
@ -460,9 +540,12 @@ message DecryptRequest { |
|
|
|
|
bytes additional_authenticated_data = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]. |
|
|
|
|
message AsymmetricSignRequest { |
|
|
|
|
// Required. The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for signing. |
|
|
|
|
// Required. The resource name of the |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for |
|
|
|
|
// signing. |
|
|
|
|
string name = 1; |
|
|
|
|
|
|
|
|
|
// Required. The digest of the data to sign. The digest must be produced with |
|
|
|
@ -471,62 +554,79 @@ message AsymmetricSignRequest { |
|
|
|
|
Digest digest = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]. |
|
|
|
|
message AsymmetricDecryptRequest { |
|
|
|
|
// Required. The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for |
|
|
|
|
// Required. The resource name of the |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for |
|
|
|
|
// decryption. |
|
|
|
|
string name = 1; |
|
|
|
|
|
|
|
|
|
// Required. The data encrypted with the named [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s public |
|
|
|
|
// key using OAEP. |
|
|
|
|
// Required. The data encrypted with the named |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s public key using |
|
|
|
|
// OAEP. |
|
|
|
|
bytes ciphertext = 3; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Response message for [KeyManagementService.Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. |
|
|
|
|
// Response message for |
|
|
|
|
// [KeyManagementService.Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. |
|
|
|
|
message DecryptResponse { |
|
|
|
|
// The decrypted data originally supplied in [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]. |
|
|
|
|
// The decrypted data originally supplied in |
|
|
|
|
// [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]. |
|
|
|
|
bytes plaintext = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Response message for [KeyManagementService.Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. |
|
|
|
|
// Response message for |
|
|
|
|
// [KeyManagementService.Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. |
|
|
|
|
message EncryptResponse { |
|
|
|
|
// The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption. |
|
|
|
|
// The resource name of the |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in |
|
|
|
|
// encryption. |
|
|
|
|
string name = 1; |
|
|
|
|
|
|
|
|
|
// The encrypted data. |
|
|
|
|
bytes ciphertext = 2; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Response message for [KeyManagementService.AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]. |
|
|
|
|
// Response message for |
|
|
|
|
// [KeyManagementService.AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]. |
|
|
|
|
message AsymmetricSignResponse { |
|
|
|
|
// The created signature. |
|
|
|
|
bytes signature = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Response message for [KeyManagementService.AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]. |
|
|
|
|
// Response message for |
|
|
|
|
// [KeyManagementService.AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]. |
|
|
|
|
message AsymmetricDecryptResponse { |
|
|
|
|
// The decrypted data originally encrypted with the matching public key. |
|
|
|
|
bytes plaintext = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]. |
|
|
|
|
message UpdateCryptoKeyPrimaryVersionRequest { |
|
|
|
|
// The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey] to update. |
|
|
|
|
// The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey] to |
|
|
|
|
// update. |
|
|
|
|
string name = 1; |
|
|
|
|
|
|
|
|
|
// The id of the child [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use as primary. |
|
|
|
|
// The id of the child |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use as primary. |
|
|
|
|
string crypto_key_version_id = 2; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion]. |
|
|
|
|
message DestroyCryptoKeyVersionRequest { |
|
|
|
|
// The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to destroy. |
|
|
|
|
// The resource name of the |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to destroy. |
|
|
|
|
string name = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request message for [KeyManagementService.RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion]. |
|
|
|
|
// Request message for |
|
|
|
|
// [KeyManagementService.RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion]. |
|
|
|
|
message RestoreCryptoKeyVersionRequest { |
|
|
|
|
// The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to restore. |
|
|
|
|
// The resource name of the |
|
|
|
|
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to restore. |
|
|
|
|
string name = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
@ -545,10 +645,12 @@ message Digest { |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Cloud KMS metadata for the given [google.cloud.location.Location][google.cloud.location.Location]. |
|
|
|
|
// Cloud KMS metadata for the given |
|
|
|
|
// [google.cloud.location.Location][google.cloud.location.Location]. |
|
|
|
|
message LocationMetadata { |
|
|
|
|
// Indicates whether [CryptoKeys][google.cloud.kms.v1.CryptoKey] with |
|
|
|
|
// [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level] |
|
|
|
|
// [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] can be created in this location. |
|
|
|
|
// [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] can be created in this |
|
|
|
|
// location. |
|
|
|
|
bool hsm_available = 1; |
|
|
|
|
} |
|
|
|
|