google-apis-cloudkms_v1 0.39.0 → 0.40.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.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e6a3ec4770dd6380ec90662303f32ccd5259106ad103cda1b47008f1b8b6c255
|
4
|
+
data.tar.gz: a5d57e894cef9e3a58328f9122234fc490cd3b5b7a61487f61e545e03492894a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e44040ed69f88f5ae735439176b22eb933f2de3547bff3706292f62245def54175a190a3c4163762886b85e0fd4cb7bdb0777f67ede79549af2e4ec7bd750817
|
7
|
+
data.tar.gz: 11c16a7861c189c77af1a15a8ab845bffe4f7245460ab018d3bc015bb5df8ccf89decc82018ad5004d7784a18636c9c997524e2c4ee862174436c80e33284a86
|
data/CHANGELOG.md
CHANGED
@@ -2170,6 +2170,394 @@ module Google
|
|
2170
2170
|
end
|
2171
2171
|
end
|
2172
2172
|
|
2173
|
+
# Request message for KeyManagementService.RawDecrypt.
|
2174
|
+
class RawDecryptRequest
|
2175
|
+
include Google::Apis::Core::Hashable
|
2176
|
+
|
2177
|
+
# Optional. Optional data that must match the data originally supplied in
|
2178
|
+
# RawEncryptRequest.additional_authenticated_data.
|
2179
|
+
# Corresponds to the JSON property `additionalAuthenticatedData`
|
2180
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2181
|
+
# @return [String]
|
2182
|
+
attr_accessor :additional_authenticated_data
|
2183
|
+
|
2184
|
+
# Optional. An optional CRC32C checksum of the RawDecryptRequest.
|
2185
|
+
# additional_authenticated_data. If specified, KeyManagementService will verify
|
2186
|
+
# the integrity of the received additional_authenticated_data using this
|
2187
|
+
# checksum. KeyManagementService will report an error if the checksum
|
2188
|
+
# verification fails. If you receive a checksum error, your client should verify
|
2189
|
+
# that CRC32C(additional_authenticated_data) is equal to
|
2190
|
+
# additional_authenticated_data_crc32c, and if so, perform a limited number of
|
2191
|
+
# retries. A persistent mismatch may indicate an issue in your computation of
|
2192
|
+
# the CRC32C checksum. Note: This field is defined as int64 for reasons of
|
2193
|
+
# compatibility across different languages. However, it is a non-negative
|
2194
|
+
# integer, which will never exceed 2^32-1, and can be safely downconverted to
|
2195
|
+
# uint32 in languages that support this type.
|
2196
|
+
# Corresponds to the JSON property `additionalAuthenticatedDataCrc32c`
|
2197
|
+
# @return [Fixnum]
|
2198
|
+
attr_accessor :additional_authenticated_data_crc32c
|
2199
|
+
|
2200
|
+
# Required. The encrypted data originally returned in RawEncryptResponse.
|
2201
|
+
# ciphertext.
|
2202
|
+
# Corresponds to the JSON property `ciphertext`
|
2203
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2204
|
+
# @return [String]
|
2205
|
+
attr_accessor :ciphertext
|
2206
|
+
|
2207
|
+
# Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If
|
2208
|
+
# specified, KeyManagementService will verify the integrity of the received
|
2209
|
+
# ciphertext using this checksum. KeyManagementService will report an error if
|
2210
|
+
# the checksum verification fails. If you receive a checksum error, your client
|
2211
|
+
# should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so,
|
2212
|
+
# perform a limited number of retries. A persistent mismatch may indicate an
|
2213
|
+
# issue in your computation of the CRC32C checksum. Note: This field is defined
|
2214
|
+
# as int64 for reasons of compatibility across different languages. However, it
|
2215
|
+
# is a non-negative integer, which will never exceed 2^32-1, and can be safely
|
2216
|
+
# downconverted to uint32 in languages that support this type.
|
2217
|
+
# Corresponds to the JSON property `ciphertextCrc32c`
|
2218
|
+
# @return [Fixnum]
|
2219
|
+
attr_accessor :ciphertext_crc32c
|
2220
|
+
|
2221
|
+
# Required. The initialization vector (IV) used during encryption, which must
|
2222
|
+
# match the data originally provided in RawEncryptResponse.initialization_vector.
|
2223
|
+
# Corresponds to the JSON property `initializationVector`
|
2224
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2225
|
+
# @return [String]
|
2226
|
+
attr_accessor :initialization_vector
|
2227
|
+
|
2228
|
+
# Optional. An optional CRC32C checksum of the RawDecryptRequest.
|
2229
|
+
# initialization_vector. If specified, KeyManagementService will verify the
|
2230
|
+
# integrity of the received initialization_vector using this checksum.
|
2231
|
+
# KeyManagementService will report an error if the checksum verification fails.
|
2232
|
+
# If you receive a checksum error, your client should verify that CRC32C(
|
2233
|
+
# initialization_vector) is equal to initialization_vector_crc32c, and if so,
|
2234
|
+
# perform a limited number of retries. A persistent mismatch may indicate an
|
2235
|
+
# issue in your computation of the CRC32C checksum. Note: This field is defined
|
2236
|
+
# as int64 for reasons of compatibility across different languages. However, it
|
2237
|
+
# is a non-negative integer, which will never exceed 2^32-1, and can be safely
|
2238
|
+
# downconverted to uint32 in languages that support this type.
|
2239
|
+
# Corresponds to the JSON property `initializationVectorCrc32c`
|
2240
|
+
# @return [Fixnum]
|
2241
|
+
attr_accessor :initialization_vector_crc32c
|
2242
|
+
|
2243
|
+
# The length of the authentication tag that is appended to the end of the
|
2244
|
+
# ciphertext. If unspecified (0), the default value for the key's algorithm will
|
2245
|
+
# be used (for AES-GCM, the default value is 16).
|
2246
|
+
# Corresponds to the JSON property `tagLength`
|
2247
|
+
# @return [Fixnum]
|
2248
|
+
attr_accessor :tag_length
|
2249
|
+
|
2250
|
+
def initialize(**args)
|
2251
|
+
update!(**args)
|
2252
|
+
end
|
2253
|
+
|
2254
|
+
# Update properties of this object
|
2255
|
+
def update!(**args)
|
2256
|
+
@additional_authenticated_data = args[:additional_authenticated_data] if args.key?(:additional_authenticated_data)
|
2257
|
+
@additional_authenticated_data_crc32c = args[:additional_authenticated_data_crc32c] if args.key?(:additional_authenticated_data_crc32c)
|
2258
|
+
@ciphertext = args[:ciphertext] if args.key?(:ciphertext)
|
2259
|
+
@ciphertext_crc32c = args[:ciphertext_crc32c] if args.key?(:ciphertext_crc32c)
|
2260
|
+
@initialization_vector = args[:initialization_vector] if args.key?(:initialization_vector)
|
2261
|
+
@initialization_vector_crc32c = args[:initialization_vector_crc32c] if args.key?(:initialization_vector_crc32c)
|
2262
|
+
@tag_length = args[:tag_length] if args.key?(:tag_length)
|
2263
|
+
end
|
2264
|
+
end
|
2265
|
+
|
2266
|
+
# Response message for KeyManagementService.RawDecrypt.
|
2267
|
+
class RawDecryptResponse
|
2268
|
+
include Google::Apis::Core::Hashable
|
2269
|
+
|
2270
|
+
# The decrypted data.
|
2271
|
+
# Corresponds to the JSON property `plaintext`
|
2272
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2273
|
+
# @return [String]
|
2274
|
+
attr_accessor :plaintext
|
2275
|
+
|
2276
|
+
# Integrity verification field. A CRC32C checksum of the returned
|
2277
|
+
# RawDecryptResponse.plaintext. An integrity check of plaintext can be performed
|
2278
|
+
# by computing the CRC32C checksum of plaintext and comparing your results to
|
2279
|
+
# this field. Discard the response in case of non-matching checksum values, and
|
2280
|
+
# perform a limited number of retries. A persistent mismatch may indicate an
|
2281
|
+
# issue in your computation of the CRC32C checksum. Note: receiving this
|
2282
|
+
# response message indicates that KeyManagementService is able to successfully
|
2283
|
+
# decrypt the ciphertext. Note: This field is defined as int64 for reasons of
|
2284
|
+
# compatibility across different languages. However, it is a non-negative
|
2285
|
+
# integer, which will never exceed 2^32-1, and can be safely downconverted to
|
2286
|
+
# uint32 in languages that support this type.
|
2287
|
+
# Corresponds to the JSON property `plaintextCrc32c`
|
2288
|
+
# @return [Fixnum]
|
2289
|
+
attr_accessor :plaintext_crc32c
|
2290
|
+
|
2291
|
+
# The ProtectionLevel of the CryptoKeyVersion used in decryption.
|
2292
|
+
# Corresponds to the JSON property `protectionLevel`
|
2293
|
+
# @return [String]
|
2294
|
+
attr_accessor :protection_level
|
2295
|
+
|
2296
|
+
# Integrity verification field. A flag indicating whether RawDecryptRequest.
|
2297
|
+
# additional_authenticated_data_crc32c was received by KeyManagementService and
|
2298
|
+
# used for the integrity verification of additional_authenticated_data. A false
|
2299
|
+
# value of this field indicates either that // RawDecryptRequest.
|
2300
|
+
# additional_authenticated_data_crc32c was left unset or that it was not
|
2301
|
+
# delivered to KeyManagementService. If you've set RawDecryptRequest.
|
2302
|
+
# additional_authenticated_data_crc32c but this field is still false, discard
|
2303
|
+
# the response and perform a limited number of retries.
|
2304
|
+
# Corresponds to the JSON property `verifiedAdditionalAuthenticatedDataCrc32c`
|
2305
|
+
# @return [Boolean]
|
2306
|
+
attr_accessor :verified_additional_authenticated_data_crc32c
|
2307
|
+
alias_method :verified_additional_authenticated_data_crc32c?, :verified_additional_authenticated_data_crc32c
|
2308
|
+
|
2309
|
+
# Integrity verification field. A flag indicating whether RawDecryptRequest.
|
2310
|
+
# ciphertext_crc32c was received by KeyManagementService and used for the
|
2311
|
+
# integrity verification of the ciphertext. A false value of this field
|
2312
|
+
# indicates either that RawDecryptRequest.ciphertext_crc32c was left unset or
|
2313
|
+
# that it was not delivered to KeyManagementService. If you've set
|
2314
|
+
# RawDecryptRequest.ciphertext_crc32c but this field is still false, discard the
|
2315
|
+
# response and perform a limited number of retries.
|
2316
|
+
# Corresponds to the JSON property `verifiedCiphertextCrc32c`
|
2317
|
+
# @return [Boolean]
|
2318
|
+
attr_accessor :verified_ciphertext_crc32c
|
2319
|
+
alias_method :verified_ciphertext_crc32c?, :verified_ciphertext_crc32c
|
2320
|
+
|
2321
|
+
# Integrity verification field. A flag indicating whether RawDecryptRequest.
|
2322
|
+
# initialization_vector_crc32c was received by KeyManagementService and used for
|
2323
|
+
# the integrity verification of initialization_vector. A false value of this
|
2324
|
+
# field indicates either that RawDecryptRequest.initialization_vector_crc32c was
|
2325
|
+
# left unset or that it was not delivered to KeyManagementService. If you've set
|
2326
|
+
# RawDecryptRequest.initialization_vector_crc32c but this field is still false,
|
2327
|
+
# discard the response and perform a limited number of retries.
|
2328
|
+
# Corresponds to the JSON property `verifiedInitializationVectorCrc32c`
|
2329
|
+
# @return [Boolean]
|
2330
|
+
attr_accessor :verified_initialization_vector_crc32c
|
2331
|
+
alias_method :verified_initialization_vector_crc32c?, :verified_initialization_vector_crc32c
|
2332
|
+
|
2333
|
+
def initialize(**args)
|
2334
|
+
update!(**args)
|
2335
|
+
end
|
2336
|
+
|
2337
|
+
# Update properties of this object
|
2338
|
+
def update!(**args)
|
2339
|
+
@plaintext = args[:plaintext] if args.key?(:plaintext)
|
2340
|
+
@plaintext_crc32c = args[:plaintext_crc32c] if args.key?(:plaintext_crc32c)
|
2341
|
+
@protection_level = args[:protection_level] if args.key?(:protection_level)
|
2342
|
+
@verified_additional_authenticated_data_crc32c = args[:verified_additional_authenticated_data_crc32c] if args.key?(:verified_additional_authenticated_data_crc32c)
|
2343
|
+
@verified_ciphertext_crc32c = args[:verified_ciphertext_crc32c] if args.key?(:verified_ciphertext_crc32c)
|
2344
|
+
@verified_initialization_vector_crc32c = args[:verified_initialization_vector_crc32c] if args.key?(:verified_initialization_vector_crc32c)
|
2345
|
+
end
|
2346
|
+
end
|
2347
|
+
|
2348
|
+
# Request message for KeyManagementService.RawEncrypt.
|
2349
|
+
class RawEncryptRequest
|
2350
|
+
include Google::Apis::Core::Hashable
|
2351
|
+
|
2352
|
+
# Optional. Optional data that, if specified, must also be provided during
|
2353
|
+
# decryption through RawDecryptRequest.additional_authenticated_data. This field
|
2354
|
+
# may only be used in conjunction with an algorithm that accepts additional
|
2355
|
+
# authenticated data (for example, AES-GCM). The maximum size depends on the key
|
2356
|
+
# version's protection_level. For SOFTWARE keys, the plaintext must be no larger
|
2357
|
+
# than 64KiB. For HSM keys, the combined length of the plaintext and
|
2358
|
+
# additional_authenticated_data fields must be no larger than 8KiB.
|
2359
|
+
# Corresponds to the JSON property `additionalAuthenticatedData`
|
2360
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2361
|
+
# @return [String]
|
2362
|
+
attr_accessor :additional_authenticated_data
|
2363
|
+
|
2364
|
+
# Optional. An optional CRC32C checksum of the RawEncryptRequest.
|
2365
|
+
# additional_authenticated_data. If specified, KeyManagementService will verify
|
2366
|
+
# the integrity of the received additional_authenticated_data using this
|
2367
|
+
# checksum. KeyManagementService will report an error if the checksum
|
2368
|
+
# verification fails. If you receive a checksum error, your client should verify
|
2369
|
+
# that CRC32C(additional_authenticated_data) is equal to
|
2370
|
+
# additional_authenticated_data_crc32c, and if so, perform a limited number of
|
2371
|
+
# retries. A persistent mismatch may indicate an issue in your computation of
|
2372
|
+
# the CRC32C checksum. Note: This field is defined as int64 for reasons of
|
2373
|
+
# compatibility across different languages. However, it is a non-negative
|
2374
|
+
# integer, which will never exceed 2^32-1, and can be safely downconverted to
|
2375
|
+
# uint32 in languages that support this type.
|
2376
|
+
# Corresponds to the JSON property `additionalAuthenticatedDataCrc32c`
|
2377
|
+
# @return [Fixnum]
|
2378
|
+
attr_accessor :additional_authenticated_data_crc32c
|
2379
|
+
|
2380
|
+
# Optional. A customer-supplied initialization vector that will be used for
|
2381
|
+
# encryption. If it is not provided for AES-CBC and AES-CTR, one will be
|
2382
|
+
# generated. It will be returned in RawEncryptResponse.initialization_vector.
|
2383
|
+
# Corresponds to the JSON property `initializationVector`
|
2384
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2385
|
+
# @return [String]
|
2386
|
+
attr_accessor :initialization_vector
|
2387
|
+
|
2388
|
+
# Optional. An optional CRC32C checksum of the RawEncryptRequest.
|
2389
|
+
# initialization_vector. If specified, KeyManagementService will verify the
|
2390
|
+
# integrity of the received initialization_vector using this checksum.
|
2391
|
+
# KeyManagementService will report an error if the checksum verification fails.
|
2392
|
+
# If you receive a checksum error, your client should verify that CRC32C(
|
2393
|
+
# initialization_vector) is equal to initialization_vector_crc32c, and if so,
|
2394
|
+
# perform a limited number of retries. A persistent mismatch may indicate an
|
2395
|
+
# issue in your computation of the CRC32C checksum. Note: This field is defined
|
2396
|
+
# as int64 for reasons of compatibility across different languages. However, it
|
2397
|
+
# is a non-negative integer, which will never exceed 2^32-1, and can be safely
|
2398
|
+
# downconverted to uint32 in languages that support this type.
|
2399
|
+
# Corresponds to the JSON property `initializationVectorCrc32c`
|
2400
|
+
# @return [Fixnum]
|
2401
|
+
attr_accessor :initialization_vector_crc32c
|
2402
|
+
|
2403
|
+
# Required. The data to encrypt. Must be no larger than 64KiB. The maximum size
|
2404
|
+
# depends on the key version's protection_level. For SOFTWARE keys, the
|
2405
|
+
# plaintext must be no larger than 64KiB. For HSM keys, the combined length of
|
2406
|
+
# the plaintext and additional_authenticated_data fields must be no larger than
|
2407
|
+
# 8KiB.
|
2408
|
+
# Corresponds to the JSON property `plaintext`
|
2409
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2410
|
+
# @return [String]
|
2411
|
+
attr_accessor :plaintext
|
2412
|
+
|
2413
|
+
# Optional. An optional CRC32C checksum of the RawEncryptRequest.plaintext. If
|
2414
|
+
# specified, KeyManagementService will verify the integrity of the received
|
2415
|
+
# plaintext using this checksum. KeyManagementService will report an error if
|
2416
|
+
# the checksum verification fails. If you receive a checksum error, your client
|
2417
|
+
# should verify that CRC32C(plaintext) is equal to plaintext_crc32c, and if so,
|
2418
|
+
# perform a limited number of retries. A persistent mismatch may indicate an
|
2419
|
+
# issue in your computation of the CRC32C checksum. Note: This field is defined
|
2420
|
+
# as int64 for reasons of compatibility across different languages. However, it
|
2421
|
+
# is a non-negative integer, which will never exceed 2^32-1, and can be safely
|
2422
|
+
# downconverted to uint32 in languages that support this type.
|
2423
|
+
# Corresponds to the JSON property `plaintextCrc32c`
|
2424
|
+
# @return [Fixnum]
|
2425
|
+
attr_accessor :plaintext_crc32c
|
2426
|
+
|
2427
|
+
def initialize(**args)
|
2428
|
+
update!(**args)
|
2429
|
+
end
|
2430
|
+
|
2431
|
+
# Update properties of this object
|
2432
|
+
def update!(**args)
|
2433
|
+
@additional_authenticated_data = args[:additional_authenticated_data] if args.key?(:additional_authenticated_data)
|
2434
|
+
@additional_authenticated_data_crc32c = args[:additional_authenticated_data_crc32c] if args.key?(:additional_authenticated_data_crc32c)
|
2435
|
+
@initialization_vector = args[:initialization_vector] if args.key?(:initialization_vector)
|
2436
|
+
@initialization_vector_crc32c = args[:initialization_vector_crc32c] if args.key?(:initialization_vector_crc32c)
|
2437
|
+
@plaintext = args[:plaintext] if args.key?(:plaintext)
|
2438
|
+
@plaintext_crc32c = args[:plaintext_crc32c] if args.key?(:plaintext_crc32c)
|
2439
|
+
end
|
2440
|
+
end
|
2441
|
+
|
2442
|
+
# Response message for KeyManagementService.RawEncrypt.
|
2443
|
+
class RawEncryptResponse
|
2444
|
+
include Google::Apis::Core::Hashable
|
2445
|
+
|
2446
|
+
# The encrypted data. In the case of AES-GCM, the authentication tag is the
|
2447
|
+
# tag_length bytes at the end of this field.
|
2448
|
+
# Corresponds to the JSON property `ciphertext`
|
2449
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2450
|
+
# @return [String]
|
2451
|
+
attr_accessor :ciphertext
|
2452
|
+
|
2453
|
+
# Integrity verification field. A CRC32C checksum of the returned
|
2454
|
+
# RawEncryptResponse.ciphertext. An integrity check of ciphertext can be
|
2455
|
+
# performed by computing the CRC32C checksum of ciphertext and comparing your
|
2456
|
+
# results to this field. Discard the response in case of non-matching checksum
|
2457
|
+
# values, and perform a limited number of retries. A persistent mismatch may
|
2458
|
+
# indicate an issue in your computation of the CRC32C checksum. Note: This field
|
2459
|
+
# is defined as int64 for reasons of compatibility across different languages.
|
2460
|
+
# However, it is a non-negative integer, which will never exceed 2^32-1, and can
|
2461
|
+
# be safely downconverted to uint32 in languages that support this type.
|
2462
|
+
# Corresponds to the JSON property `ciphertextCrc32c`
|
2463
|
+
# @return [Fixnum]
|
2464
|
+
attr_accessor :ciphertext_crc32c
|
2465
|
+
|
2466
|
+
# The initialization vector (IV) generated by the service during encryption.
|
2467
|
+
# This value must be stored and provided in RawDecryptRequest.
|
2468
|
+
# initialization_vector at decryption time.
|
2469
|
+
# Corresponds to the JSON property `initializationVector`
|
2470
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2471
|
+
# @return [String]
|
2472
|
+
attr_accessor :initialization_vector
|
2473
|
+
|
2474
|
+
# Integrity verification field. A CRC32C checksum of the returned
|
2475
|
+
# RawEncryptResponse.initialization_vector. An integrity check of
|
2476
|
+
# initialization_vector can be performed by computing the CRC32C checksum of
|
2477
|
+
# initialization_vector and comparing your results to this field. Discard the
|
2478
|
+
# response in case of non-matching checksum values, and perform a limited number
|
2479
|
+
# of retries. A persistent mismatch may indicate an issue in your computation of
|
2480
|
+
# the CRC32C checksum. Note: This field is defined as int64 for reasons of
|
2481
|
+
# compatibility across different languages. However, it is a non-negative
|
2482
|
+
# integer, which will never exceed 2^32-1, and can be safely downconverted to
|
2483
|
+
# uint32 in languages that support this type.
|
2484
|
+
# Corresponds to the JSON property `initializationVectorCrc32c`
|
2485
|
+
# @return [Fixnum]
|
2486
|
+
attr_accessor :initialization_vector_crc32c
|
2487
|
+
|
2488
|
+
# The resource name of the CryptoKeyVersion used in encryption. Check this field
|
2489
|
+
# to verify that the intended resource was used for encryption.
|
2490
|
+
# Corresponds to the JSON property `name`
|
2491
|
+
# @return [String]
|
2492
|
+
attr_accessor :name
|
2493
|
+
|
2494
|
+
# The ProtectionLevel of the CryptoKeyVersion used in encryption.
|
2495
|
+
# Corresponds to the JSON property `protectionLevel`
|
2496
|
+
# @return [String]
|
2497
|
+
attr_accessor :protection_level
|
2498
|
+
|
2499
|
+
# The length of the authentication tag that is appended to the end of the
|
2500
|
+
# ciphertext.
|
2501
|
+
# Corresponds to the JSON property `tagLength`
|
2502
|
+
# @return [Fixnum]
|
2503
|
+
attr_accessor :tag_length
|
2504
|
+
|
2505
|
+
# Integrity verification field. A flag indicating whether RawEncryptRequest.
|
2506
|
+
# additional_authenticated_data_crc32c was received by KeyManagementService and
|
2507
|
+
# used for the integrity verification of additional_authenticated_data. A false
|
2508
|
+
# value of this field indicates either that // RawEncryptRequest.
|
2509
|
+
# additional_authenticated_data_crc32c was left unset or that it was not
|
2510
|
+
# delivered to KeyManagementService. If you've set RawEncryptRequest.
|
2511
|
+
# additional_authenticated_data_crc32c but this field is still false, discard
|
2512
|
+
# the response and perform a limited number of retries.
|
2513
|
+
# Corresponds to the JSON property `verifiedAdditionalAuthenticatedDataCrc32c`
|
2514
|
+
# @return [Boolean]
|
2515
|
+
attr_accessor :verified_additional_authenticated_data_crc32c
|
2516
|
+
alias_method :verified_additional_authenticated_data_crc32c?, :verified_additional_authenticated_data_crc32c
|
2517
|
+
|
2518
|
+
# Integrity verification field. A flag indicating whether RawEncryptRequest.
|
2519
|
+
# initialization_vector_crc32c was received by KeyManagementService and used for
|
2520
|
+
# the integrity verification of initialization_vector. A false value of this
|
2521
|
+
# field indicates either that RawEncryptRequest.initialization_vector_crc32c was
|
2522
|
+
# left unset or that it was not delivered to KeyManagementService. If you've set
|
2523
|
+
# RawEncryptRequest.initialization_vector_crc32c but this field is still false,
|
2524
|
+
# discard the response and perform a limited number of retries.
|
2525
|
+
# Corresponds to the JSON property `verifiedInitializationVectorCrc32c`
|
2526
|
+
# @return [Boolean]
|
2527
|
+
attr_accessor :verified_initialization_vector_crc32c
|
2528
|
+
alias_method :verified_initialization_vector_crc32c?, :verified_initialization_vector_crc32c
|
2529
|
+
|
2530
|
+
# Integrity verification field. A flag indicating whether RawEncryptRequest.
|
2531
|
+
# plaintext_crc32c was received by KeyManagementService and used for the
|
2532
|
+
# integrity verification of the plaintext. A false value of this field indicates
|
2533
|
+
# either that RawEncryptRequest.plaintext_crc32c was left unset or that it was
|
2534
|
+
# not delivered to KeyManagementService. If you've set RawEncryptRequest.
|
2535
|
+
# plaintext_crc32c but this field is still false, discard the response and
|
2536
|
+
# perform a limited number of retries.
|
2537
|
+
# Corresponds to the JSON property `verifiedPlaintextCrc32c`
|
2538
|
+
# @return [Boolean]
|
2539
|
+
attr_accessor :verified_plaintext_crc32c
|
2540
|
+
alias_method :verified_plaintext_crc32c?, :verified_plaintext_crc32c
|
2541
|
+
|
2542
|
+
def initialize(**args)
|
2543
|
+
update!(**args)
|
2544
|
+
end
|
2545
|
+
|
2546
|
+
# Update properties of this object
|
2547
|
+
def update!(**args)
|
2548
|
+
@ciphertext = args[:ciphertext] if args.key?(:ciphertext)
|
2549
|
+
@ciphertext_crc32c = args[:ciphertext_crc32c] if args.key?(:ciphertext_crc32c)
|
2550
|
+
@initialization_vector = args[:initialization_vector] if args.key?(:initialization_vector)
|
2551
|
+
@initialization_vector_crc32c = args[:initialization_vector_crc32c] if args.key?(:initialization_vector_crc32c)
|
2552
|
+
@name = args[:name] if args.key?(:name)
|
2553
|
+
@protection_level = args[:protection_level] if args.key?(:protection_level)
|
2554
|
+
@tag_length = args[:tag_length] if args.key?(:tag_length)
|
2555
|
+
@verified_additional_authenticated_data_crc32c = args[:verified_additional_authenticated_data_crc32c] if args.key?(:verified_additional_authenticated_data_crc32c)
|
2556
|
+
@verified_initialization_vector_crc32c = args[:verified_initialization_vector_crc32c] if args.key?(:verified_initialization_vector_crc32c)
|
2557
|
+
@verified_plaintext_crc32c = args[:verified_plaintext_crc32c] if args.key?(:verified_plaintext_crc32c)
|
2558
|
+
end
|
2559
|
+
end
|
2560
|
+
|
2173
2561
|
# Request message for KeyManagementService.RestoreCryptoKeyVersion.
|
2174
2562
|
class RestoreCryptoKeyVersionRequest
|
2175
2563
|
include Google::Apis::Core::Hashable
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module CloudkmsV1
|
18
18
|
# Version of the google-apis-cloudkms_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.40.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20230625"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -274,6 +274,30 @@ module Google
|
|
274
274
|
include Google::Apis::Core::JsonObjectSupport
|
275
275
|
end
|
276
276
|
|
277
|
+
class RawDecryptRequest
|
278
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
279
|
+
|
280
|
+
include Google::Apis::Core::JsonObjectSupport
|
281
|
+
end
|
282
|
+
|
283
|
+
class RawDecryptResponse
|
284
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
285
|
+
|
286
|
+
include Google::Apis::Core::JsonObjectSupport
|
287
|
+
end
|
288
|
+
|
289
|
+
class RawEncryptRequest
|
290
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
291
|
+
|
292
|
+
include Google::Apis::Core::JsonObjectSupport
|
293
|
+
end
|
294
|
+
|
295
|
+
class RawEncryptResponse
|
296
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
297
|
+
|
298
|
+
include Google::Apis::Core::JsonObjectSupport
|
299
|
+
end
|
300
|
+
|
277
301
|
class RestoreCryptoKeyVersionRequest
|
278
302
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
279
303
|
|
@@ -766,6 +790,59 @@ module Google
|
|
766
790
|
end
|
767
791
|
end
|
768
792
|
|
793
|
+
class RawDecryptRequest
|
794
|
+
# @private
|
795
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
796
|
+
property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData'
|
797
|
+
property :additional_authenticated_data_crc32c, :numeric_string => true, as: 'additionalAuthenticatedDataCrc32c'
|
798
|
+
property :ciphertext, :base64 => true, as: 'ciphertext'
|
799
|
+
property :ciphertext_crc32c, :numeric_string => true, as: 'ciphertextCrc32c'
|
800
|
+
property :initialization_vector, :base64 => true, as: 'initializationVector'
|
801
|
+
property :initialization_vector_crc32c, :numeric_string => true, as: 'initializationVectorCrc32c'
|
802
|
+
property :tag_length, as: 'tagLength'
|
803
|
+
end
|
804
|
+
end
|
805
|
+
|
806
|
+
class RawDecryptResponse
|
807
|
+
# @private
|
808
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
809
|
+
property :plaintext, :base64 => true, as: 'plaintext'
|
810
|
+
property :plaintext_crc32c, :numeric_string => true, as: 'plaintextCrc32c'
|
811
|
+
property :protection_level, as: 'protectionLevel'
|
812
|
+
property :verified_additional_authenticated_data_crc32c, as: 'verifiedAdditionalAuthenticatedDataCrc32c'
|
813
|
+
property :verified_ciphertext_crc32c, as: 'verifiedCiphertextCrc32c'
|
814
|
+
property :verified_initialization_vector_crc32c, as: 'verifiedInitializationVectorCrc32c'
|
815
|
+
end
|
816
|
+
end
|
817
|
+
|
818
|
+
class RawEncryptRequest
|
819
|
+
# @private
|
820
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
821
|
+
property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData'
|
822
|
+
property :additional_authenticated_data_crc32c, :numeric_string => true, as: 'additionalAuthenticatedDataCrc32c'
|
823
|
+
property :initialization_vector, :base64 => true, as: 'initializationVector'
|
824
|
+
property :initialization_vector_crc32c, :numeric_string => true, as: 'initializationVectorCrc32c'
|
825
|
+
property :plaintext, :base64 => true, as: 'plaintext'
|
826
|
+
property :plaintext_crc32c, :numeric_string => true, as: 'plaintextCrc32c'
|
827
|
+
end
|
828
|
+
end
|
829
|
+
|
830
|
+
class RawEncryptResponse
|
831
|
+
# @private
|
832
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
833
|
+
property :ciphertext, :base64 => true, as: 'ciphertext'
|
834
|
+
property :ciphertext_crc32c, :numeric_string => true, as: 'ciphertextCrc32c'
|
835
|
+
property :initialization_vector, :base64 => true, as: 'initializationVector'
|
836
|
+
property :initialization_vector_crc32c, :numeric_string => true, as: 'initializationVectorCrc32c'
|
837
|
+
property :name, as: 'name'
|
838
|
+
property :protection_level, as: 'protectionLevel'
|
839
|
+
property :tag_length, as: 'tagLength'
|
840
|
+
property :verified_additional_authenticated_data_crc32c, as: 'verifiedAdditionalAuthenticatedDataCrc32c'
|
841
|
+
property :verified_initialization_vector_crc32c, as: 'verifiedInitializationVectorCrc32c'
|
842
|
+
property :verified_plaintext_crc32c, as: 'verifiedPlaintextCrc32c'
|
843
|
+
end
|
844
|
+
end
|
845
|
+
|
769
846
|
class RestoreCryptoKeyVersionRequest
|
770
847
|
# @private
|
771
848
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1694,6 +1694,75 @@ module Google
|
|
1694
1694
|
execute_or_queue_command(command, &block)
|
1695
1695
|
end
|
1696
1696
|
|
1697
|
+
# Decrypts data that was originally encrypted using a raw cryptographic
|
1698
|
+
# mechanism. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.
|
1699
|
+
# @param [String] name
|
1700
|
+
# Required. The resource name of the CryptoKeyVersion to use for decryption.
|
1701
|
+
# @param [Google::Apis::CloudkmsV1::RawDecryptRequest] raw_decrypt_request_object
|
1702
|
+
# @param [String] fields
|
1703
|
+
# Selector specifying which fields to include in a partial response.
|
1704
|
+
# @param [String] quota_user
|
1705
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1706
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1707
|
+
# @param [Google::Apis::RequestOptions] options
|
1708
|
+
# Request-specific options
|
1709
|
+
#
|
1710
|
+
# @yield [result, err] Result & error if block supplied
|
1711
|
+
# @yieldparam result [Google::Apis::CloudkmsV1::RawDecryptResponse] parsed result object
|
1712
|
+
# @yieldparam err [StandardError] error object if request failed
|
1713
|
+
#
|
1714
|
+
# @return [Google::Apis::CloudkmsV1::RawDecryptResponse]
|
1715
|
+
#
|
1716
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1717
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1718
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1719
|
+
def raw_crypto_key_version_decrypt(name, raw_decrypt_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1720
|
+
command = make_simple_command(:post, 'v1/{+name}:rawDecrypt', options)
|
1721
|
+
command.request_representation = Google::Apis::CloudkmsV1::RawDecryptRequest::Representation
|
1722
|
+
command.request_object = raw_decrypt_request_object
|
1723
|
+
command.response_representation = Google::Apis::CloudkmsV1::RawDecryptResponse::Representation
|
1724
|
+
command.response_class = Google::Apis::CloudkmsV1::RawDecryptResponse
|
1725
|
+
command.params['name'] = name unless name.nil?
|
1726
|
+
command.query['fields'] = fields unless fields.nil?
|
1727
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1728
|
+
execute_or_queue_command(command, &block)
|
1729
|
+
end
|
1730
|
+
|
1731
|
+
# Encrypts data using portable cryptographic primitives. Most users should
|
1732
|
+
# choose Encrypt and Decrypt rather than their raw counterparts. The CryptoKey.
|
1733
|
+
# purpose must be RAW_ENCRYPT_DECRYPT.
|
1734
|
+
# @param [String] name
|
1735
|
+
# Required. The resource name of the CryptoKeyVersion to use for encryption.
|
1736
|
+
# @param [Google::Apis::CloudkmsV1::RawEncryptRequest] raw_encrypt_request_object
|
1737
|
+
# @param [String] fields
|
1738
|
+
# Selector specifying which fields to include in a partial response.
|
1739
|
+
# @param [String] quota_user
|
1740
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1741
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1742
|
+
# @param [Google::Apis::RequestOptions] options
|
1743
|
+
# Request-specific options
|
1744
|
+
#
|
1745
|
+
# @yield [result, err] Result & error if block supplied
|
1746
|
+
# @yieldparam result [Google::Apis::CloudkmsV1::RawEncryptResponse] parsed result object
|
1747
|
+
# @yieldparam err [StandardError] error object if request failed
|
1748
|
+
#
|
1749
|
+
# @return [Google::Apis::CloudkmsV1::RawEncryptResponse]
|
1750
|
+
#
|
1751
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1752
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1753
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1754
|
+
def raw_crypto_key_version_encrypt(name, raw_encrypt_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1755
|
+
command = make_simple_command(:post, 'v1/{+name}:rawEncrypt', options)
|
1756
|
+
command.request_representation = Google::Apis::CloudkmsV1::RawEncryptRequest::Representation
|
1757
|
+
command.request_object = raw_encrypt_request_object
|
1758
|
+
command.response_representation = Google::Apis::CloudkmsV1::RawEncryptResponse::Representation
|
1759
|
+
command.response_class = Google::Apis::CloudkmsV1::RawEncryptResponse
|
1760
|
+
command.params['name'] = name unless name.nil?
|
1761
|
+
command.query['fields'] = fields unless fields.nil?
|
1762
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1763
|
+
execute_or_queue_command(command, &block)
|
1764
|
+
end
|
1765
|
+
|
1697
1766
|
# Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of
|
1698
1767
|
# the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be
|
1699
1768
|
# cleared.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-cloudkms_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.40.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: 2023-
|
11
|
+
date: 2023-07-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudkms_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-cloudkms_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-cloudkms_v1/v0.40.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudkms_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|