google-cloud-kms 1.3.1 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/kms.rb +1 -0
  3. data/lib/google/cloud/kms/v1.rb +1 -0
  4. data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb +10 -8
  5. data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb +61 -35
  6. data/lib/google/cloud/kms/v1/key_management_service_client.rb +55 -26
  7. data/lib/google/cloud/kms/v1/resources_pb.rb +3 -0
  8. data/lib/google/cloud/kms/v1/service_pb.rb +3 -1
  9. data/lib/google/cloud/kms/v1/service_services_pb.rb +1 -1
  10. data/lib/google/cloud/kms/version.rb +1 -1
  11. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9c8c0ae476705516a90cb35fae982d898d9e368de60e5b3515b98851b3410286
4
- data.tar.gz: 93752a3d1740697bb7f11614d584e691132f2271622e179eeb4ecec80a852a13
3
+ metadata.gz: 2b78cda1d225442be599632a682fb286a843cd8362f5b1d4f97545fceeb0e980
4
+ data.tar.gz: 367d3fa44bf24f6908fe4de6ffeead72c303b118af529999a238246df3aadfe8
5
5
  SHA512:
6
- metadata.gz: 9b3de6d169b0fa6958a4ca7bc9d4d6c3b9c46c0109f4b6cc664e3420e08ae1d51fb0ba227d3bec73a72a3dd9006c99bbd4a04888f9cc0024faa9be1e0960cba2
7
- data.tar.gz: 9fb57a81fcf92c50876ae6366c30cad2c7a992684cf303df3da96db46e443cb46961165234fe4ec90c2e5d3a6e71546408344bc66419e39c341995b9f81c9848
6
+ metadata.gz: acec7c75b8aec9a7e393654fcd906dceadc37dc8a2403c9e634c200196404264200687496327118e393a651c56bc02119c9de43d6a33de98173bc89ef126cd47
7
+ data.tar.gz: 16acacd42eb291028f928bbccccfefac5aa06a04ae1b117453a0f3ee6bb3f802e27f9f4fd561d75c77385a70399bd91538cfc3e26472e21b96daea58e4f27be2
data/lib/google/cloud/kms.rb CHANGED
@@ -96,6 +96,7 @@ module Google
96
96
  # * {Google::Cloud::Kms::V1::KeyRing KeyRing}
97
97
  # * {Google::Cloud::Kms::V1::CryptoKey CryptoKey}
98
98
  # * {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}
99
+ # * {Google::Cloud::Kms::V1::ImportJob ImportJob}
99
100
  #
100
101
  # If you are using manual gRPC libraries, see
101
102
  # [Using gRPC with Cloud KMS](https://cloud.google.com/kms/docs/grpc).
data/lib/google/cloud/kms/v1.rb CHANGED
@@ -90,6 +90,7 @@ module Google
90
90
  # * {Google::Cloud::Kms::V1::KeyRing KeyRing}
91
91
  # * {Google::Cloud::Kms::V1::CryptoKey CryptoKey}
92
92
  # * {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}
93
+ # * {Google::Cloud::Kms::V1::ImportJob ImportJob}
93
94
  #
94
95
  # If you are using manual gRPC libraries, see
95
96
  # [Using gRPC with Cloud KMS](https://cloud.google.com/kms/docs/grpc).
data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb CHANGED
@@ -45,12 +45,12 @@ module Google
45
45
  # The {Google::Cloud::Kms::V1::CryptoKey CryptoKey}'s primary version can be updated via
46
46
  # {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyPrimaryVersion UpdateCryptoKeyPrimaryVersion}.
47
47
  #
48
- # All keys with {Google::Cloud::Kms::V1::CryptoKey#purpose purpose}
49
- # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT} have a
48
+ # Keys with {Google::Cloud::Kms::V1::CryptoKey#purpose purpose}
49
+ # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT} may have a
50
50
  # primary. For other keys, this field will be omitted.
51
51
  # @!attribute [rw] purpose
52
52
  # @return [Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose]
53
- # The immutable purpose of this {Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
53
+ # Immutable. The immutable purpose of this {Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
54
54
  # @!attribute [rw] create_time
55
55
  # @return [Google::Protobuf::Timestamp]
56
56
  # Output only. The time at which this {Google::Cloud::Kms::V1::CryptoKey CryptoKey} was created.
@@ -72,7 +72,8 @@ module Google
72
72
  # @!attribute [rw] rotation_period
73
73
  # @return [Google::Protobuf::Duration]
74
74
  # {Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time} will be advanced by this period when the service
75
- # automatically rotates a key. Must be at least one day.
75
+ # automatically rotates a key. Must be at least 24 hours and at most
76
+ # 876,000 hours.
76
77
  #
77
78
  # If {Google::Cloud::Kms::V1::CryptoKey#rotation_period rotation_period} is set, {Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time} must also be set.
78
79
  #
@@ -408,12 +409,10 @@ module Google
408
409
  # `projects/*/locations/*/keyRings/*/importJobs/*`.
409
410
  # @!attribute [rw] import_method
410
411
  # @return [Google::Cloud::Kms::V1::ImportJob::ImportMethod]
411
- # Required and immutable. The wrapping method to be used for incoming
412
- # key material.
412
+ # Required. Immutable. The wrapping method to be used for incoming key material.
413
413
  # @!attribute [rw] protection_level
414
414
  # @return [Google::Cloud::Kms::V1::ProtectionLevel]
415
- # Required and immutable. The protection level of the {Google::Cloud::Kms::V1::ImportJob ImportJob}. This
416
- # must match the
415
+ # Required. Immutable. The protection level of the {Google::Cloud::Kms::V1::ImportJob ImportJob}. This must match the
417
416
  # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level} of the
418
417
  # {Google::Cloud::Kms::V1::CryptoKey#version_template version_template} on the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} you
419
418
  # attempt to import into.
@@ -515,6 +514,9 @@ module Google
515
514
 
516
515
  # Crypto operations are performed in a Hardware Security Module.
517
516
  HSM = 2
517
+
518
+ # Crypto operations are performed by an external key manager.
519
+ EXTERNAL = 3
518
520
  end
519
521
  end
520
522
  end
data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb CHANGED
@@ -24,21 +24,26 @@ module Google
24
24
  # {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format `projects/*/locations/*`.
25
25
  # @!attribute [rw] page_size
26
26
  # @return [Integer]
27
- # Optional limit on the number of {Google::Cloud::Kms::V1::KeyRing KeyRings} to include in the
27
+ # Optional. Optional limit on the number of {Google::Cloud::Kms::V1::KeyRing KeyRings} to include in the
28
28
  # response. Further {Google::Cloud::Kms::V1::KeyRing KeyRings} can subsequently be obtained by
29
29
  # including the {Google::Cloud::Kms::V1::ListKeyRingsResponse#next_page_token ListKeyRingsResponse#next_page_token} in a subsequent
30
30
  # request. If unspecified, the server will pick an appropriate default.
31
31
  # @!attribute [rw] page_token
32
32
  # @return [String]
33
- # Optional pagination token, returned earlier via
33
+ # Optional. Optional pagination token, returned earlier via
34
34
  # {Google::Cloud::Kms::V1::ListKeyRingsResponse#next_page_token ListKeyRingsResponse#next_page_token}.
35
35
  # @!attribute [rw] filter
36
36
  # @return [String]
37
- # Optional. Only include resources that match the filter in the response.
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).
38
41
  # @!attribute [rw] order_by
39
42
  # @return [String]
40
43
  # Optional. Specify how the results should be sorted. If not specified, the
41
- # results will be sorted in the default order.
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).
42
47
  class ListKeyRingsRequest; end
43
48
 
44
49
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
@@ -48,24 +53,29 @@ module Google
48
53
  # `projects/*/locations/*/keyRings/*`.
49
54
  # @!attribute [rw] page_size
50
55
  # @return [Integer]
51
- # Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} to include in the
56
+ # Optional. Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} to include in the
52
57
  # response. Further {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} can subsequently be obtained by
53
58
  # including the {Google::Cloud::Kms::V1::ListCryptoKeysResponse#next_page_token ListCryptoKeysResponse#next_page_token} in a subsequent
54
59
  # request. If unspecified, the server will pick an appropriate default.
55
60
  # @!attribute [rw] page_token
56
61
  # @return [String]
57
- # Optional pagination token, returned earlier via
62
+ # Optional. Optional pagination token, returned earlier via
58
63
  # {Google::Cloud::Kms::V1::ListCryptoKeysResponse#next_page_token ListCryptoKeysResponse#next_page_token}.
59
64
  # @!attribute [rw] version_view
60
65
  # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView]
61
66
  # The fields of the primary version to include in the response.
62
67
  # @!attribute [rw] filter
63
68
  # @return [String]
64
- # Optional. Only include resources that match the filter in the response.
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).
65
73
  # @!attribute [rw] order_by
66
74
  # @return [String]
67
75
  # Optional. Specify how the results should be sorted. If not specified, the
68
- # results will be sorted in the default order.
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).
69
79
  class ListCryptoKeysRequest; end
70
80
 
71
81
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
@@ -75,25 +85,30 @@ module Google
75
85
  # `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
76
86
  # @!attribute [rw] page_size
77
87
  # @return [Integer]
78
- # Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} to
88
+ # Optional. Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} to
79
89
  # include in the response. Further {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} can
80
90
  # subsequently be obtained by including the
81
91
  # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse#next_page_token ListCryptoKeyVersionsResponse#next_page_token} in a subsequent request.
82
92
  # If unspecified, the server will pick an appropriate default.
83
93
  # @!attribute [rw] page_token
84
94
  # @return [String]
85
- # Optional pagination token, returned earlier via
95
+ # Optional. Optional pagination token, returned earlier via
86
96
  # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse#next_page_token ListCryptoKeyVersionsResponse#next_page_token}.
87
97
  # @!attribute [rw] view
88
98
  # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView]
89
99
  # The fields to include in the response.
90
100
  # @!attribute [rw] filter
91
101
  # @return [String]
92
- # Optional. Only include resources that match the filter in the response.
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).
93
106
  # @!attribute [rw] order_by
94
107
  # @return [String]
95
108
  # Optional. Specify how the results should be sorted. If not specified, the
96
- # results will be sorted in the default order.
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).
97
112
  class ListCryptoKeyVersionsRequest; end
98
113
 
99
114
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListImportJobs KeyManagementService::ListImportJobs}.
@@ -103,21 +118,26 @@ module Google
103
118
  # `projects/*/locations/*/keyRings/*`.
104
119
  # @!attribute [rw] page_size
105
120
  # @return [Integer]
106
- # Optional limit on the number of {Google::Cloud::Kms::V1::ImportJob ImportJobs} to include in the
121
+ # Optional. Optional limit on the number of {Google::Cloud::Kms::V1::ImportJob ImportJobs} to include in the
107
122
  # response. Further {Google::Cloud::Kms::V1::ImportJob ImportJobs} can subsequently be obtained by
108
123
  # including the {Google::Cloud::Kms::V1::ListImportJobsResponse#next_page_token ListImportJobsResponse#next_page_token} in a subsequent
109
124
  # request. If unspecified, the server will pick an appropriate default.
110
125
  # @!attribute [rw] page_token
111
126
  # @return [String]
112
- # Optional pagination token, returned earlier via
127
+ # Optional. Optional pagination token, returned earlier via
113
128
  # {Google::Cloud::Kms::V1::ListImportJobsResponse#next_page_token ListImportJobsResponse#next_page_token}.
114
129
  # @!attribute [rw] filter
115
130
  # @return [String]
116
- # Optional. Only include resources that match the filter in the response.
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).
117
135
  # @!attribute [rw] order_by
118
136
  # @return [String]
119
137
  # Optional. Specify how the results should be sorted. If not specified, the
120
- # results will be sorted in the default order.
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).
121
141
  class ListImportJobsRequest; end
122
142
 
123
143
  # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
@@ -177,32 +197,32 @@ module Google
177
197
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetKeyRing KeyManagementService::GetKeyRing}.
178
198
  # @!attribute [rw] name
179
199
  # @return [String]
180
- # The {Google::Cloud::Kms::V1::KeyRing#name name} of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to get.
200
+ # Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to get.
181
201
  class GetKeyRingRequest; end
182
202
 
183
203
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKey KeyManagementService::GetCryptoKey}.
184
204
  # @!attribute [rw] name
185
205
  # @return [String]
186
- # The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to get.
206
+ # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to get.
187
207
  class GetCryptoKeyRequest; end
188
208
 
189
209
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKeyVersion KeyManagementService::GetCryptoKeyVersion}.
190
210
  # @!attribute [rw] name
191
211
  # @return [String]
192
- # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get.
212
+ # Required. The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get.
193
213
  class GetCryptoKeyVersionRequest; end
194
214
 
195
215
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetPublicKey KeyManagementService::GetPublicKey}.
196
216
  # @!attribute [rw] name
197
217
  # @return [String]
198
- # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to
218
+ # Required. The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to
199
219
  # get.
200
220
  class GetPublicKeyRequest; end
201
221
 
202
222
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetImportJob KeyManagementService::GetImportJob}.
203
223
  # @!attribute [rw] name
204
224
  # @return [String]
205
- # The {Google::Cloud::Kms::V1::ImportJob#name name} of the {Google::Cloud::Kms::V1::ImportJob ImportJob} to get.
225
+ # Required. The {Google::Cloud::Kms::V1::ImportJob#name name} of the {Google::Cloud::Kms::V1::ImportJob ImportJob} to get.
206
226
  class GetImportJobRequest; end
207
227
 
208
228
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateKeyRing KeyManagementService::CreateKeyRing}.
@@ -216,7 +236,7 @@ module Google
216
236
  # expression `[a-zA-Z0-9_-]{1,63}`
217
237
  # @!attribute [rw] key_ring
218
238
  # @return [Google::Cloud::Kms::V1::KeyRing]
219
- # A {Google::Cloud::Kms::V1::KeyRing KeyRing} with initial field values.
239
+ # Required. A {Google::Cloud::Kms::V1::KeyRing KeyRing} with initial field values.
220
240
  class CreateKeyRingRequest; end
221
241
 
222
242
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKey KeyManagementService::CreateCryptoKey}.
@@ -230,7 +250,7 @@ module Google
230
250
  # expression `[a-zA-Z0-9_-]{1,63}`
231
251
  # @!attribute [rw] crypto_key
232
252
  # @return [Google::Cloud::Kms::V1::CryptoKey]
233
- # A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with initial field values.
253
+ # Required. A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with initial field values.
234
254
  # @!attribute [rw] skip_initial_version_creation
235
255
  # @return [true, false]
236
256
  # If set to true, the request will create a {Google::Cloud::Kms::V1::CryptoKey CryptoKey} without any
@@ -247,7 +267,7 @@ module Google
247
267
  # the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}.
248
268
  # @!attribute [rw] crypto_key_version
249
269
  # @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
250
- # A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial field values.
270
+ # Required. A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial field values.
251
271
  class CreateCryptoKeyVersionRequest; end
252
272
 
253
273
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ImportCryptoKeyVersion KeyManagementService::ImportCryptoKeyVersion}.
@@ -283,6 +303,11 @@ module Google
283
303
  # </li>
284
304
  # </ol>
285
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
+ #
286
311
  # This format is the same as the format produced by PKCS#11 mechanism
287
312
  # CKM_RSA_AES_KEY_WRAP.
288
313
  class ImportCryptoKeyVersionRequest; end
@@ -304,19 +329,19 @@ module Google
304
329
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKey KeyManagementService::UpdateCryptoKey}.
305
330
  # @!attribute [rw] crypto_key
306
331
  # @return [Google::Cloud::Kms::V1::CryptoKey]
307
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with updated values.
332
+ # Required. {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with updated values.
308
333
  # @!attribute [rw] update_mask
309
334
  # @return [Google::Protobuf::FieldMask]
310
- # Required list of fields to be updated in this request.
335
+ # Required. List of fields to be updated in this request.
311
336
  class UpdateCryptoKeyRequest; end
312
337
 
313
338
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyVersion KeyManagementService::UpdateCryptoKeyVersion}.
314
339
  # @!attribute [rw] crypto_key_version
315
340
  # @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
316
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated values.
341
+ # Required. {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated values.
317
342
  # @!attribute [rw] update_mask
318
343
  # @return [Google::Protobuf::FieldMask]
319
- # Required list of fields to be updated in this request.
344
+ # Required. List of fields to be updated in this request.
320
345
  class UpdateCryptoKeyVersionRequest; end
321
346
 
322
347
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
@@ -339,7 +364,7 @@ module Google
339
364
  # 8KiB.
340
365
  # @!attribute [rw] additional_authenticated_data
341
366
  # @return [String]
342
- # Optional data that, if specified, must also be provided during decryption
367
+ # Optional. Optional data that, if specified, must also be provided during decryption
343
368
  # through {Google::Cloud::Kms::V1::DecryptRequest#additional_authenticated_data DecryptRequest#additional_authenticated_data}.
344
369
  #
345
370
  # The maximum size depends on the key version's
@@ -361,7 +386,7 @@ module Google
361
386
  # {Google::Cloud::Kms::V1::EncryptResponse#ciphertext EncryptResponse#ciphertext}.
362
387
  # @!attribute [rw] additional_authenticated_data
363
388
  # @return [String]
364
- # Optional data that must match the data originally supplied in
389
+ # Optional. Optional data that must match the data originally supplied in
365
390
  # {Google::Cloud::Kms::V1::EncryptRequest#additional_authenticated_data EncryptRequest#additional_authenticated_data}.
366
391
  class DecryptRequest; end
367
392
 
@@ -396,7 +421,8 @@ module Google
396
421
  # Response message for {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
397
422
  # @!attribute [rw] name
398
423
  # @return [String]
399
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} used in encryption.
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.
400
426
  # @!attribute [rw] ciphertext
401
427
  # @return [String]
402
428
  # The encrypted data.
@@ -417,22 +443,22 @@ module Google
417
443
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyPrimaryVersion KeyManagementService::UpdateCryptoKeyPrimaryVersion}.
418
444
  # @!attribute [rw] name
419
445
  # @return [String]
420
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to update.
446
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to update.
421
447
  # @!attribute [rw] crypto_key_version_id
422
448
  # @return [String]
423
- # The id of the child {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use as primary.
449
+ # Required. The id of the child {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use as primary.
424
450
  class UpdateCryptoKeyPrimaryVersionRequest; end
425
451
 
426
452
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::DestroyCryptoKeyVersion KeyManagementService::DestroyCryptoKeyVersion}.
427
453
  # @!attribute [rw] name
428
454
  # @return [String]
429
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to destroy.
455
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to destroy.
430
456
  class DestroyCryptoKeyVersionRequest; end
431
457
 
432
458
  # Request message for {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion KeyManagementService::RestoreCryptoKeyVersion}.
433
459
  # @!attribute [rw] name
434
460
  # @return [String]
435
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore.
461
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore.
436
462
  class RestoreCryptoKeyVersionRequest; end
437
463
 
438
464
  # A {Google::Cloud::Kms::V1::Digest Digest} holds a cryptographic message digest.
data/lib/google/cloud/kms/v1/key_management_service_client.rb CHANGED
@@ -42,6 +42,7 @@ module Google
42
42
  # * {Google::Cloud::Kms::V1::KeyRing KeyRing}
43
43
  # * {Google::Cloud::Kms::V1::CryptoKey CryptoKey}
44
44
  # * {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}
45
+ # * {Google::Cloud::Kms::V1::ImportJob ImportJob}
45
46
  #
46
47
  # If you are using manual gRPC libraries, see
47
48
  # [Using gRPC with Cloud KMS](https://cloud.google.com/kms/docs/grpc).
@@ -560,10 +561,15 @@ module Google
560
561
  # performed per-page, this determines the maximum number of
561
562
  # resources in a page.
562
563
  # @param filter [String]
563
- # Optional. Only include resources that match the filter in the response.
564
+ # Optional. Only include resources that match the filter in the response. For
565
+ # more information, see
566
+ # [Sorting and filtering list
567
+ # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
564
568
  # @param order_by [String]
565
569
  # Optional. Specify how the results should be sorted. If not specified, the
566
- # results will be sorted in the default order.
570
+ # results will be sorted in the default order. For more information, see
571
+ # [Sorting and filtering list
572
+ # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
567
573
  # @param options [Google::Gax::CallOptions]
568
574
  # Overrides the default settings for this call, e.g, timeout,
569
575
  # retries, etc.
@@ -624,10 +630,15 @@ module Google
624
630
  # performed per-page, this determines the maximum number of
625
631
  # resources in a page.
626
632
  # @param filter [String]
627
- # Optional. Only include resources that match the filter in the response.
633
+ # Optional. Only include resources that match the filter in the response. For
634
+ # more information, see
635
+ # [Sorting and filtering list
636
+ # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
628
637
  # @param order_by [String]
629
638
  # Optional. Specify how the results should be sorted. If not specified, the
630
- # results will be sorted in the default order.
639
+ # results will be sorted in the default order. For more information, see
640
+ # [Sorting and filtering list
641
+ # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
631
642
  # @param options [Google::Gax::CallOptions]
632
643
  # Overrides the default settings for this call, e.g, timeout,
633
644
  # retries, etc.
@@ -690,10 +701,15 @@ module Google
690
701
  # @param version_view [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView]
691
702
  # The fields of the primary version to include in the response.
692
703
  # @param filter [String]
693
- # Optional. Only include resources that match the filter in the response.
704
+ # Optional. Only include resources that match the filter in the response. For
705
+ # more information, see
706
+ # [Sorting and filtering list
707
+ # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
694
708
  # @param order_by [String]
695
709
  # Optional. Specify how the results should be sorted. If not specified, the
696
- # results will be sorted in the default order.
710
+ # results will be sorted in the default order. For more information, see
711
+ # [Sorting and filtering list
712
+ # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
697
713
  # @param options [Google::Gax::CallOptions]
698
714
  # Overrides the default settings for this call, e.g, timeout,
699
715
  # retries, etc.
@@ -758,10 +774,15 @@ module Google
758
774
  # @param view [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView]
759
775
  # The fields to include in the response.
760
776
  # @param filter [String]
761
- # Optional. Only include resources that match the filter in the response.
777
+ # Optional. Only include resources that match the filter in the response. For
778
+ # more information, see
779
+ # [Sorting and filtering list
780
+ # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
762
781
  # @param order_by [String]
763
782
  # Optional. Specify how the results should be sorted. If not specified, the
764
- # results will be sorted in the default order.
783
+ # results will be sorted in the default order. For more information, see
784
+ # [Sorting and filtering list
785
+ # results](https://cloud.google.com/kms/docs/sorting-and-filtering).
765
786
  # @param options [Google::Gax::CallOptions]
766
787
  # Overrides the default settings for this call, e.g, timeout,
767
788
  # retries, etc.
@@ -815,7 +836,7 @@ module Google
815
836
  # Returns metadata for a given {Google::Cloud::Kms::V1::KeyRing KeyRing}.
816
837
  #
817
838
  # @param name [String]
818
- # The {Google::Cloud::Kms::V1::KeyRing#name name} of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to get.
839
+ # Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to get.
819
840
  # @param options [Google::Gax::CallOptions]
820
841
  # Overrides the default settings for this call, e.g, timeout,
821
842
  # retries, etc.
@@ -845,7 +866,7 @@ module Google
845
866
  # Returns metadata for a given {Google::Cloud::Kms::V1::ImportJob ImportJob}.
846
867
  #
847
868
  # @param name [String]
848
- # The {Google::Cloud::Kms::V1::ImportJob#name name} of the {Google::Cloud::Kms::V1::ImportJob ImportJob} to get.
869
+ # Required. The {Google::Cloud::Kms::V1::ImportJob#name name} of the {Google::Cloud::Kms::V1::ImportJob ImportJob} to get.
849
870
  # @param options [Google::Gax::CallOptions]
850
871
  # Overrides the default settings for this call, e.g, timeout,
851
872
  # retries, etc.
@@ -876,7 +897,7 @@ module Google
876
897
  # {Google::Cloud::Kms::V1::CryptoKey#primary primary} {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}.
877
898
  #
878
899
  # @param name [String]
879
- # The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to get.
900
+ # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to get.
880
901
  # @param options [Google::Gax::CallOptions]
881
902
  # Overrides the default settings for this call, e.g, timeout,
882
903
  # retries, etc.
@@ -906,7 +927,7 @@ module Google
906
927
  # Returns metadata for a given {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}.
907
928
  #
908
929
  # @param name [String]
909
- # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get.
930
+ # Required. The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get.
910
931
  # @param options [Google::Gax::CallOptions]
911
932
  # Overrides the default settings for this call, e.g, timeout,
912
933
  # retries, etc.
@@ -942,7 +963,7 @@ module Google
942
963
  # Required. It must be unique within a location and match the regular
943
964
  # expression `[a-zA-Z0-9_-]{1,63}`
944
965
  # @param key_ring [Google::Cloud::Kms::V1::KeyRing | Hash]
945
- # A {Google::Cloud::Kms::V1::KeyRing KeyRing} with initial field values.
966
+ # Required. A {Google::Cloud::Kms::V1::KeyRing KeyRing} with initial field values.
946
967
  # A hash of the same form as `Google::Cloud::Kms::V1::KeyRing`
947
968
  # can also be provided.
948
969
  # @param options [Google::Gax::CallOptions]
@@ -1042,7 +1063,7 @@ module Google
1042
1063
  # Required. It must be unique within a KeyRing and match the regular
1043
1064
  # expression `[a-zA-Z0-9_-]{1,63}`
1044
1065
  # @param crypto_key [Google::Cloud::Kms::V1::CryptoKey | Hash]
1045
- # A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with initial field values.
1066
+ # Required. A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with initial field values.
1046
1067
  # A hash of the same form as `Google::Cloud::Kms::V1::CryptoKey`
1047
1068
  # can also be provided.
1048
1069
  # @param skip_initial_version_creation [true, false]
@@ -1104,7 +1125,7 @@ module Google
1104
1125
  # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} associated with
1105
1126
  # the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}.
1106
1127
  # @param crypto_key_version [Google::Cloud::Kms::V1::CryptoKeyVersion | Hash]
1107
- # A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial field values.
1128
+ # Required. A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial field values.
1108
1129
  # A hash of the same form as `Google::Cloud::Kms::V1::CryptoKeyVersion`
1109
1130
  # can also be provided.
1110
1131
  # @param options [Google::Gax::CallOptions]
@@ -1172,6 +1193,11 @@ module Google
1172
1193
  # </li>
1173
1194
  # </ol>
1174
1195
  #
1196
+ # If importing symmetric key material, it is expected that the unwrapped
1197
+ # key contains plain bytes. If importing asymmetric key material, it is
1198
+ # expected that the unwrapped key is in PKCS#8-encoded DER format (the
1199
+ # PrivateKeyInfo structure from RFC 5208).
1200
+ #
1175
1201
  # This format is the same as the format produced by PKCS#11 mechanism
1176
1202
  # CKM_RSA_AES_KEY_WRAP.
1177
1203
  # @param options [Google::Gax::CallOptions]
@@ -1215,11 +1241,11 @@ module Google
1215
1241
  # Update a {Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
1216
1242
  #
1217
1243
  # @param crypto_key [Google::Cloud::Kms::V1::CryptoKey | Hash]
1218
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with updated values.
1244
+ # Required. {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with updated values.
1219
1245
  # A hash of the same form as `Google::Cloud::Kms::V1::CryptoKey`
1220
1246
  # can also be provided.
1221
1247
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
1222
- # Required list of fields to be updated in this request.
1248
+ # Required. List of fields to be updated in this request.
1223
1249
  # A hash of the same form as `Google::Protobuf::FieldMask`
1224
1250
  # can also be provided.
1225
1251
  # @param options [Google::Gax::CallOptions]
@@ -1264,11 +1290,11 @@ module Google
1264
1290
  # move between other states.
1265
1291
  #
1266
1292
  # @param crypto_key_version [Google::Cloud::Kms::V1::CryptoKeyVersion | Hash]
1267
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated values.
1293
+ # Required. {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated values.
1268
1294
  # A hash of the same form as `Google::Cloud::Kms::V1::CryptoKeyVersion`
1269
1295
  # can also be provided.
1270
1296
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
1271
- # Required list of fields to be updated in this request.
1297
+ # Required. List of fields to be updated in this request.
1272
1298
  # A hash of the same form as `Google::Protobuf::FieldMask`
1273
1299
  # can also be provided.
1274
1300
  # @param options [Google::Gax::CallOptions]
@@ -1324,7 +1350,7 @@ module Google
1324
1350
  # plaintext and additional_authenticated_data fields must be no larger than
1325
1351
  # 8KiB.
1326
1352
  # @param additional_authenticated_data [String]
1327
- # Optional data that, if specified, must also be provided during decryption
1353
+ # Optional. Optional data that, if specified, must also be provided during decryption
1328
1354
  # through {Google::Cloud::Kms::V1::DecryptRequest#additional_authenticated_data DecryptRequest#additional_authenticated_data}.
1329
1355
  #
1330
1356
  # The maximum size depends on the key version's
@@ -1376,7 +1402,7 @@ module Google
1376
1402
  # Required. The encrypted data originally returned in
1377
1403
  # {Google::Cloud::Kms::V1::EncryptResponse#ciphertext EncryptResponse#ciphertext}.
1378
1404
  # @param additional_authenticated_data [String]
1379
- # Optional data that must match the data originally supplied in
1405
+ # Optional. Optional data that must match the data originally supplied in
1380
1406
  # {Google::Cloud::Kms::V1::EncryptRequest#additional_authenticated_data EncryptRequest#additional_authenticated_data}.
1381
1407
  # @param options [Google::Gax::CallOptions]
1382
1408
  # Overrides the default settings for this call, e.g, timeout,
@@ -1416,9 +1442,9 @@ module Google
1416
1442
  # Returns an error if called on an asymmetric key.
1417
1443
  #
1418
1444
  # @param name [String]
1419
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to update.
1445
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to update.
1420
1446
  # @param crypto_key_version_id [String]
1421
- # The id of the child {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use as primary.
1447
+ # Required. The id of the child {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use as primary.
1422
1448
  # @param options [Google::Gax::CallOptions]
1423
1449
  # Overrides the default settings for this call, e.g, timeout,
1424
1450
  # retries, etc.
@@ -1464,7 +1490,7 @@ module Google
1464
1490
  # {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion RestoreCryptoKeyVersion} may be called to reverse the process.
1465
1491
  #
1466
1492
  # @param name [String]
1467
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to destroy.
1493
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to destroy.
1468
1494
  # @param options [Google::Gax::CallOptions]
1469
1495
  # Overrides the default settings for this call, e.g, timeout,
1470
1496
  # retries, etc.
@@ -1500,7 +1526,7 @@ module Google
1500
1526
  # and {Google::Cloud::Kms::V1::CryptoKeyVersion#destroy_time destroy_time} will be cleared.
1501
1527
  #
1502
1528
  # @param name [String]
1503
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore.
1529
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore.
1504
1530
  # @param options [Google::Gax::CallOptions]
1505
1531
  # Overrides the default settings for this call, e.g, timeout,
1506
1532
  # retries, etc.
@@ -1533,7 +1559,7 @@ module Google
1533
1559
  # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_DECRYPT ASYMMETRIC_DECRYPT}.
1534
1560
  #
1535
1561
  # @param name [String]
1536
- # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to
1562
+ # Required. The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to
1537
1563
  # get.
1538
1564
  # @param options [Google::Gax::CallOptions]
1539
1565
  # Overrides the default settings for this call, e.g, timeout,
@@ -1648,6 +1674,9 @@ module Google
1648
1674
  # Sets the access control policy on the specified resource. Replaces
1649
1675
  # any existing policy.
1650
1676
  #
1677
+ # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and
1678
+ # PERMISSION_DENIED
1679
+ #
1651
1680
  # @param resource [String]
1652
1681
  # REQUIRED: The resource for which the policy is being specified.
1653
1682
  # See the operation documentation for the appropriate value for this field.
data/lib/google/cloud/kms/v1/resources_pb.rb CHANGED
@@ -5,6 +5,8 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/field_behavior_pb'
9
+ require 'google/api/resource_pb'
8
10
  require 'google/protobuf/duration_pb'
9
11
  require 'google/protobuf/timestamp_pb'
10
12
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -123,6 +125,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
123
125
  value :PROTECTION_LEVEL_UNSPECIFIED, 0
124
126
  value :SOFTWARE, 1
125
127
  value :HSM, 2
128
+ value :EXTERNAL, 3
126
129
  end
127
130
  end
128
131
 
data/lib/google/cloud/kms/v1/service_pb.rb CHANGED
@@ -5,9 +5,11 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/client_pb'
9
+ require 'google/api/field_behavior_pb'
10
+ require 'google/api/resource_pb'
8
11
  require 'google/cloud/kms/v1/resources_pb'
9
12
  require 'google/protobuf/field_mask_pb'
10
- require 'google/api/client_pb'
11
13
  Google::Protobuf::DescriptorPool.generated_pool.build do
12
14
  add_message "google.cloud.kms.v1.ListKeyRingsRequest" do
13
15
  optional :parent, :string, 1
data/lib/google/cloud/kms/v1/service_services_pb.rb CHANGED
@@ -15,7 +15,6 @@
15
15
  # See the License for the specific language governing permissions and
16
16
  # limitations under the License.
17
17
  #
18
- #
19
18
 
20
19
 
21
20
  require 'grpc'
@@ -34,6 +33,7 @@ module Google
34
33
  # * [KeyRing][google.cloud.kms.v1.KeyRing]
35
34
  # * [CryptoKey][google.cloud.kms.v1.CryptoKey]
36
35
  # * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
36
+ # * [ImportJob][google.cloud.kms.v1.ImportJob]
37
37
  #
38
38
  # If you are using manual gRPC libraries, see
39
39
  # [Using gRPC with Cloud KMS](https://cloud.google.com/kms/docs/grpc).
data/lib/google/cloud/kms/version.rb CHANGED
@@ -16,7 +16,7 @@
16
16
  module Google
17
17
  module Cloud
18
18
  module Kms
19
- VERSION = "1.3.1".freeze
19
+ VERSION = "1.4.0".freeze
20
20
  end
21
21
  end
22
22
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-kms
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.1
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-11-07 00:00:00.000000000 Z
11
+ date: 2020-01-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-gax