google-cloud-kms 1.6.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,491 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Kms
19
- module V1
20
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
21
- # @!attribute [rw] parent
22
- # @return [String]
23
- # Required. The resource name of the location associated with the
24
- # {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format `projects/*/locations/*`.
25
- # @!attribute [rw] page_size
26
- # @return [Integer]
27
- # Optional. Optional limit on the number of {Google::Cloud::Kms::V1::KeyRing KeyRings} to include in the
28
- # response. Further {Google::Cloud::Kms::V1::KeyRing KeyRings} can subsequently be obtained by
29
- # including the {Google::Cloud::Kms::V1::ListKeyRingsResponse#next_page_token ListKeyRingsResponse#next_page_token} in a subsequent
30
- # request. If unspecified, the server will pick an appropriate default.
31
- # @!attribute [rw] page_token
32
- # @return [String]
33
- # Optional. Optional pagination token, returned earlier via
34
- # {Google::Cloud::Kms::V1::ListKeyRingsResponse#next_page_token ListKeyRingsResponse#next_page_token}.
35
- # @!attribute [rw] filter
36
- # @return [String]
37
- # Optional. Only include resources that match the filter in the response. For
38
- # more information, see
39
- # [Sorting and filtering list
40
- # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
41
- # @!attribute [rw] order_by
42
- # @return [String]
43
- # Optional. Specify how the results should be sorted. If not specified, the
44
- # results will be sorted in the default order. For more information, see
45
- # [Sorting and filtering list
46
- # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
47
- class ListKeyRingsRequest; end
48
-
49
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
50
- # @!attribute [rw] parent
51
- # @return [String]
52
- # Required. The resource name of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to list, in the format
53
- # `projects/*/locations/*/keyRings/*`.
54
- # @!attribute [rw] page_size
55
- # @return [Integer]
56
- # Optional. Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} to include in the
57
- # response. Further {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} can subsequently be obtained by
58
- # including the {Google::Cloud::Kms::V1::ListCryptoKeysResponse#next_page_token ListCryptoKeysResponse#next_page_token} in a subsequent
59
- # request. If unspecified, the server will pick an appropriate default.
60
- # @!attribute [rw] page_token
61
- # @return [String]
62
- # Optional. Optional pagination token, returned earlier via
63
- # {Google::Cloud::Kms::V1::ListCryptoKeysResponse#next_page_token ListCryptoKeysResponse#next_page_token}.
64
- # @!attribute [rw] version_view
65
- # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView]
66
- # The fields of the primary version to include in the response.
67
- # @!attribute [rw] filter
68
- # @return [String]
69
- # Optional. Only include resources that match the filter in the response. For
70
- # more information, see
71
- # [Sorting and filtering list
72
- # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
73
- # @!attribute [rw] order_by
74
- # @return [String]
75
- # Optional. Specify how the results should be sorted. If not specified, the
76
- # results will be sorted in the default order. For more information, see
77
- # [Sorting and filtering list
78
- # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
79
- class ListCryptoKeysRequest; end
80
-
81
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
82
- # @!attribute [rw] parent
83
- # @return [String]
84
- # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to list, in the format
85
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
86
- # @!attribute [rw] page_size
87
- # @return [Integer]
88
- # Optional. Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} to
89
- # include in the response. Further {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} can
90
- # subsequently be obtained by including the
91
- # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse#next_page_token ListCryptoKeyVersionsResponse#next_page_token} in a subsequent request.
92
- # If unspecified, the server will pick an appropriate default.
93
- # @!attribute [rw] page_token
94
- # @return [String]
95
- # Optional. Optional pagination token, returned earlier via
96
- # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse#next_page_token ListCryptoKeyVersionsResponse#next_page_token}.
97
- # @!attribute [rw] view
98
- # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView]
99
- # The fields to include in the response.
100
- # @!attribute [rw] filter
101
- # @return [String]
102
- # Optional. Only include resources that match the filter in the response. For
103
- # more information, see
104
- # [Sorting and filtering list
105
- # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
106
- # @!attribute [rw] order_by
107
- # @return [String]
108
- # Optional. Specify how the results should be sorted. If not specified, the
109
- # results will be sorted in the default order. For more information, see
110
- # [Sorting and filtering list
111
- # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
112
- class ListCryptoKeyVersionsRequest; end
113
-
114
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListImportJobs KeyManagementService::ListImportJobs}.
115
- # @!attribute [rw] parent
116
- # @return [String]
117
- # Required. The resource name of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to list, in the format
118
- # `projects/*/locations/*/keyRings/*`.
119
- # @!attribute [rw] page_size
120
- # @return [Integer]
121
- # Optional. Optional limit on the number of {Google::Cloud::Kms::V1::ImportJob ImportJobs} to include in the
122
- # response. Further {Google::Cloud::Kms::V1::ImportJob ImportJobs} can subsequently be obtained by
123
- # including the {Google::Cloud::Kms::V1::ListImportJobsResponse#next_page_token ListImportJobsResponse#next_page_token} in a subsequent
124
- # request. If unspecified, the server will pick an appropriate default.
125
- # @!attribute [rw] page_token
126
- # @return [String]
127
- # Optional. Optional pagination token, returned earlier via
128
- # {Google::Cloud::Kms::V1::ListImportJobsResponse#next_page_token ListImportJobsResponse#next_page_token}.
129
- # @!attribute [rw] filter
130
- # @return [String]
131
- # Optional. Only include resources that match the filter in the response. For
132
- # more information, see
133
- # [Sorting and filtering list
134
- # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
135
- # @!attribute [rw] order_by
136
- # @return [String]
137
- # Optional. Specify how the results should be sorted. If not specified, the
138
- # results will be sorted in the default order. For more information, see
139
- # [Sorting and filtering list
140
- # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
141
- class ListImportJobsRequest; end
142
-
143
- # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
144
- # @!attribute [rw] key_rings
145
- # @return [Array<Google::Cloud::Kms::V1::KeyRing>]
146
- # The list of {Google::Cloud::Kms::V1::KeyRing KeyRings}.
147
- # @!attribute [rw] next_page_token
148
- # @return [String]
149
- # A token to retrieve next page of results. Pass this value in
150
- # {Google::Cloud::Kms::V1::ListKeyRingsRequest#page_token ListKeyRingsRequest#page_token} to retrieve the next page of results.
151
- # @!attribute [rw] total_size
152
- # @return [Integer]
153
- # The total number of {Google::Cloud::Kms::V1::KeyRing KeyRings} that matched the query.
154
- class ListKeyRingsResponse; end
155
-
156
- # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
157
- # @!attribute [rw] crypto_keys
158
- # @return [Array<Google::Cloud::Kms::V1::CryptoKey>]
159
- # The list of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
160
- # @!attribute [rw] next_page_token
161
- # @return [String]
162
- # A token to retrieve next page of results. Pass this value in
163
- # {Google::Cloud::Kms::V1::ListCryptoKeysRequest#page_token ListCryptoKeysRequest#page_token} to retrieve the next page of results.
164
- # @!attribute [rw] total_size
165
- # @return [Integer]
166
- # The total number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} that matched the query.
167
- class ListCryptoKeysResponse; end
168
-
169
- # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
170
- # @!attribute [rw] crypto_key_versions
171
- # @return [Array<Google::Cloud::Kms::V1::CryptoKeyVersion>]
172
- # The list of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}.
173
- # @!attribute [rw] next_page_token
174
- # @return [String]
175
- # A token to retrieve next page of results. Pass this value in
176
- # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest#page_token ListCryptoKeyVersionsRequest#page_token} to retrieve the next page of
177
- # results.
178
- # @!attribute [rw] total_size
179
- # @return [Integer]
180
- # The total number of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} that matched the
181
- # query.
182
- class ListCryptoKeyVersionsResponse; end
183
-
184
- # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListImportJobs KeyManagementService::ListImportJobs}.
185
- # @!attribute [rw] import_jobs
186
- # @return [Array<Google::Cloud::Kms::V1::ImportJob>]
187
- # The list of {Google::Cloud::Kms::V1::ImportJob ImportJobs}.
188
- # @!attribute [rw] next_page_token
189
- # @return [String]
190
- # A token to retrieve next page of results. Pass this value in
191
- # {Google::Cloud::Kms::V1::ListImportJobsRequest#page_token ListImportJobsRequest#page_token} to retrieve the next page of results.
192
- # @!attribute [rw] total_size
193
- # @return [Integer]
194
- # The total number of {Google::Cloud::Kms::V1::ImportJob ImportJobs} that matched the query.
195
- class ListImportJobsResponse; end
196
-
197
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetKeyRing KeyManagementService::GetKeyRing}.
198
- # @!attribute [rw] name
199
- # @return [String]
200
- # Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to get.
201
- class GetKeyRingRequest; end
202
-
203
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKey KeyManagementService::GetCryptoKey}.
204
- # @!attribute [rw] name
205
- # @return [String]
206
- # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to get.
207
- class GetCryptoKeyRequest; end
208
-
209
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKeyVersion KeyManagementService::GetCryptoKeyVersion}.
210
- # @!attribute [rw] name
211
- # @return [String]
212
- # Required. The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get.
213
- class GetCryptoKeyVersionRequest; end
214
-
215
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetPublicKey KeyManagementService::GetPublicKey}.
216
- # @!attribute [rw] name
217
- # @return [String]
218
- # Required. The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to
219
- # get.
220
- class GetPublicKeyRequest; end
221
-
222
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetImportJob KeyManagementService::GetImportJob}.
223
- # @!attribute [rw] name
224
- # @return [String]
225
- # Required. The {Google::Cloud::Kms::V1::ImportJob#name name} of the {Google::Cloud::Kms::V1::ImportJob ImportJob} to get.
226
- class GetImportJobRequest; end
227
-
228
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateKeyRing KeyManagementService::CreateKeyRing}.
229
- # @!attribute [rw] parent
230
- # @return [String]
231
- # Required. The resource name of the location associated with the
232
- # {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format `projects/*/locations/*`.
233
- # @!attribute [rw] key_ring_id
234
- # @return [String]
235
- # Required. It must be unique within a location and match the regular
236
- # expression `[a-zA-Z0-9_-]{1,63}`
237
- # @!attribute [rw] key_ring
238
- # @return [Google::Cloud::Kms::V1::KeyRing]
239
- # Required. A {Google::Cloud::Kms::V1::KeyRing KeyRing} with initial field values.
240
- class CreateKeyRingRequest; end
241
-
242
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKey KeyManagementService::CreateCryptoKey}.
243
- # @!attribute [rw] parent
244
- # @return [String]
245
- # Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the KeyRing associated with the
246
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
247
- # @!attribute [rw] crypto_key_id
248
- # @return [String]
249
- # Required. It must be unique within a KeyRing and match the regular
250
- # expression `[a-zA-Z0-9_-]{1,63}`
251
- # @!attribute [rw] crypto_key
252
- # @return [Google::Cloud::Kms::V1::CryptoKey]
253
- # Required. A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with initial field values.
254
- # @!attribute [rw] skip_initial_version_creation
255
- # @return [true, false]
256
- # If set to true, the request will create a {Google::Cloud::Kms::V1::CryptoKey CryptoKey} without any
257
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}. You must manually call
258
- # {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKeyVersion CreateCryptoKeyVersion} or
259
- # {Google::Cloud::Kms::V1::KeyManagementService::ImportCryptoKeyVersion ImportCryptoKeyVersion}
260
- # before you can use this {Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
261
- class CreateCryptoKeyRequest; end
262
-
263
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKeyVersion KeyManagementService::CreateCryptoKeyVersion}.
264
- # @!attribute [rw] parent
265
- # @return [String]
266
- # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} associated with
267
- # the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}.
268
- # @!attribute [rw] crypto_key_version
269
- # @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
270
- # Required. A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial field values.
271
- class CreateCryptoKeyVersionRequest; end
272
-
273
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ImportCryptoKeyVersion KeyManagementService::ImportCryptoKeyVersion}.
274
- # @!attribute [rw] parent
275
- # @return [String]
276
- # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to
277
- # be imported into.
278
- # @!attribute [rw] algorithm
279
- # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm]
280
- # Required. The {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm algorithm} of
281
- # the key being imported. This does not need to match the
282
- # {Google::Cloud::Kms::V1::CryptoKey#version_template version_template} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} this
283
- # version imports into.
284
- # @!attribute [rw] import_job
285
- # @return [String]
286
- # Required. The {Google::Cloud::Kms::V1::ImportJob#name name} of the {Google::Cloud::Kms::V1::ImportJob ImportJob} that was used to
287
- # wrap this key material.
288
- # @!attribute [rw] rsa_aes_wrapped_key
289
- # @return [String]
290
- # Wrapped key material produced with
291
- # {Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_3072_SHA1_AES_256 RSA_OAEP_3072_SHA1_AES_256}
292
- # or
293
- # {Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_4096_SHA1_AES_256 RSA_OAEP_4096_SHA1_AES_256}.
294
- #
295
- # This field contains the concatenation of two wrapped keys:
296
- # <ol>
297
- # <li>An ephemeral AES-256 wrapping key wrapped with the
298
- # {Google::Cloud::Kms::V1::ImportJob#public_key public_key} using RSAES-OAEP with SHA-1,
299
- # MGF1 with SHA-1, and an empty label.
300
- # </li>
301
- # <li>The key to be imported, wrapped with the ephemeral AES-256 key
302
- # using AES-KWP (RFC 5649).
303
- # </li>
304
- # </ol>
305
- #
306
- # If importing symmetric key material, it is expected that the unwrapped
307
- # key contains plain bytes. If importing asymmetric key material, it is
308
- # expected that the unwrapped key is in PKCS#8-encoded DER format (the
309
- # PrivateKeyInfo structure from RFC 5208).
310
- #
311
- # This format is the same as the format produced by PKCS#11 mechanism
312
- # CKM_RSA_AES_KEY_WRAP.
313
- class ImportCryptoKeyVersionRequest; end
314
-
315
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateImportJob KeyManagementService::CreateImportJob}.
316
- # @!attribute [rw] parent
317
- # @return [String]
318
- # Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the {Google::Cloud::Kms::V1::KeyRing KeyRing} associated with the
319
- # {Google::Cloud::Kms::V1::ImportJob ImportJobs}.
320
- # @!attribute [rw] import_job_id
321
- # @return [String]
322
- # Required. It must be unique within a KeyRing and match the regular
323
- # expression `[a-zA-Z0-9_-]{1,63}`
324
- # @!attribute [rw] import_job
325
- # @return [Google::Cloud::Kms::V1::ImportJob]
326
- # Required. An {Google::Cloud::Kms::V1::ImportJob ImportJob} with initial field values.
327
- class CreateImportJobRequest; end
328
-
329
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKey KeyManagementService::UpdateCryptoKey}.
330
- # @!attribute [rw] crypto_key
331
- # @return [Google::Cloud::Kms::V1::CryptoKey]
332
- # Required. {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with updated values.
333
- # @!attribute [rw] update_mask
334
- # @return [Google::Protobuf::FieldMask]
335
- # Required. List of fields to be updated in this request.
336
- class UpdateCryptoKeyRequest; end
337
-
338
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyVersion KeyManagementService::UpdateCryptoKeyVersion}.
339
- # @!attribute [rw] crypto_key_version
340
- # @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
341
- # Required. {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated values.
342
- # @!attribute [rw] update_mask
343
- # @return [Google::Protobuf::FieldMask]
344
- # Required. List of fields to be updated in this request.
345
- class UpdateCryptoKeyVersionRequest; end
346
-
347
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
348
- # @!attribute [rw] name
349
- # @return [String]
350
- # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} or {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}
351
- # to use for encryption.
352
- #
353
- # If a {Google::Cloud::Kms::V1::CryptoKey CryptoKey} is specified, the server will use its
354
- # {Google::Cloud::Kms::V1::CryptoKey#primary primary version}.
355
- # @!attribute [rw] plaintext
356
- # @return [String]
357
- # Required. The data to encrypt. Must be no larger than 64KiB.
358
- #
359
- # The maximum size depends on the key version's
360
- # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}. For
361
- # {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the plaintext must be no larger
362
- # than 64KiB. For {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of the
363
- # plaintext and additional_authenticated_data fields must be no larger than
364
- # 8KiB.
365
- # @!attribute [rw] additional_authenticated_data
366
- # @return [String]
367
- # Optional. Optional data that, if specified, must also be provided during decryption
368
- # through {Google::Cloud::Kms::V1::DecryptRequest#additional_authenticated_data DecryptRequest#additional_authenticated_data}.
369
- #
370
- # The maximum size depends on the key version's
371
- # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}. For
372
- # {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the AAD must be no larger than
373
- # 64KiB. For {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of the
374
- # plaintext and additional_authenticated_data fields must be no larger than
375
- # 8KiB.
376
- class EncryptRequest; end
377
-
378
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}.
379
- # @!attribute [rw] name
380
- # @return [String]
381
- # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to use for decryption.
382
- # The server will choose the appropriate version.
383
- # @!attribute [rw] ciphertext
384
- # @return [String]
385
- # Required. The encrypted data originally returned in
386
- # {Google::Cloud::Kms::V1::EncryptResponse#ciphertext EncryptResponse#ciphertext}.
387
- # @!attribute [rw] additional_authenticated_data
388
- # @return [String]
389
- # Optional. Optional data that must match the data originally supplied in
390
- # {Google::Cloud::Kms::V1::EncryptRequest#additional_authenticated_data EncryptRequest#additional_authenticated_data}.
391
- class DecryptRequest; end
392
-
393
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}.
394
- # @!attribute [rw] name
395
- # @return [String]
396
- # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for signing.
397
- # @!attribute [rw] digest
398
- # @return [Google::Cloud::Kms::V1::Digest]
399
- # Required. The digest of the data to sign. The digest must be produced with
400
- # the same digest algorithm as specified by the key version's
401
- # {Google::Cloud::Kms::V1::CryptoKeyVersion#algorithm algorithm}.
402
- class AsymmetricSignRequest; end
403
-
404
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}.
405
- # @!attribute [rw] name
406
- # @return [String]
407
- # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for
408
- # decryption.
409
- # @!attribute [rw] ciphertext
410
- # @return [String]
411
- # Required. The data encrypted with the named {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s public
412
- # key using OAEP.
413
- class AsymmetricDecryptRequest; end
414
-
415
- # Response message for {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}.
416
- # @!attribute [rw] plaintext
417
- # @return [String]
418
- # The decrypted data originally supplied in {Google::Cloud::Kms::V1::EncryptRequest#plaintext EncryptRequest#plaintext}.
419
- class DecryptResponse; end
420
-
421
- # Response message for {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
422
- # @!attribute [rw] name
423
- # @return [String]
424
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} used in encryption. Check
425
- # this field to verify that the intended resource was used for encryption.
426
- # @!attribute [rw] ciphertext
427
- # @return [String]
428
- # The encrypted data.
429
- class EncryptResponse; end
430
-
431
- # Response message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}.
432
- # @!attribute [rw] signature
433
- # @return [String]
434
- # The created signature.
435
- class AsymmetricSignResponse; end
436
-
437
- # Response message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}.
438
- # @!attribute [rw] plaintext
439
- # @return [String]
440
- # The decrypted data originally encrypted with the matching public key.
441
- class AsymmetricDecryptResponse; end
442
-
443
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyPrimaryVersion KeyManagementService::UpdateCryptoKeyPrimaryVersion}.
444
- # @!attribute [rw] name
445
- # @return [String]
446
- # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to update.
447
- # @!attribute [rw] crypto_key_version_id
448
- # @return [String]
449
- # Required. The id of the child {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use as primary.
450
- class UpdateCryptoKeyPrimaryVersionRequest; end
451
-
452
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::DestroyCryptoKeyVersion KeyManagementService::DestroyCryptoKeyVersion}.
453
- # @!attribute [rw] name
454
- # @return [String]
455
- # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to destroy.
456
- class DestroyCryptoKeyVersionRequest; end
457
-
458
- # Request message for {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion KeyManagementService::RestoreCryptoKeyVersion}.
459
- # @!attribute [rw] name
460
- # @return [String]
461
- # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore.
462
- class RestoreCryptoKeyVersionRequest; end
463
-
464
- # A {Google::Cloud::Kms::V1::Digest Digest} holds a cryptographic message digest.
465
- # @!attribute [rw] sha256
466
- # @return [String]
467
- # A message digest produced with the SHA-256 algorithm.
468
- # @!attribute [rw] sha384
469
- # @return [String]
470
- # A message digest produced with the SHA-384 algorithm.
471
- # @!attribute [rw] sha512
472
- # @return [String]
473
- # A message digest produced with the SHA-512 algorithm.
474
- class Digest; end
475
-
476
- # Cloud KMS metadata for the given {Google::Cloud::Location::Location}.
477
- # @!attribute [rw] hsm_available
478
- # @return [true, false]
479
- # Indicates whether {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with
480
- # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}
481
- # {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} can be created in this location.
482
- # @!attribute [rw] ekm_available
483
- # @return [true, false]
484
- # Indicates whether {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with
485
- # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}
486
- # {Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL EXTERNAL} can be created in this location.
487
- class LocationMetadata; end
488
- end
489
- end
490
- end
491
- end