Class: Google::Cloud::Kms::V1::KeyManagementServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/kms/v1/key_management_service_client.rb

Overview

Google Cloud Key Management Service

Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects:

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"cloudkms.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ KeyManagementServiceClient

Returns a new instance of KeyManagementServiceClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 217

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/cloud/kms/v1/service_services_pb"
  require "google/iam/v1/iam_policy_services_pb"

  credentials ||= Google::Cloud::Kms::V1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Kms::V1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-kms'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "key_management_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.kms.v1.KeyManagementService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @key_management_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Kms::V1::KeyManagementService::Stub.method(:new)
  )
  @iam_policy_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Iam::V1::IAMPolicy::Stub.method(:new)
  )

  @list_key_rings = Google::Gax.create_api_call(
    @key_management_service_stub.method(:list_key_rings),
    defaults["list_key_rings"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @list_crypto_keys = Google::Gax.create_api_call(
    @key_management_service_stub.method(:list_crypto_keys),
    defaults["list_crypto_keys"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @list_crypto_key_versions = Google::Gax.create_api_call(
    @key_management_service_stub.method(:list_crypto_key_versions),
    defaults["list_crypto_key_versions"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_key_ring = Google::Gax.create_api_call(
    @key_management_service_stub.method(:get_key_ring),
    defaults["get_key_ring"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_crypto_key = Google::Gax.create_api_call(
    @key_management_service_stub.method(:get_crypto_key),
    defaults["get_crypto_key"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_crypto_key_version = Google::Gax.create_api_call(
    @key_management_service_stub.method(:get_crypto_key_version),
    defaults["get_crypto_key_version"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_key_ring = Google::Gax.create_api_call(
    @key_management_service_stub.method(:create_key_ring),
    defaults["create_key_ring"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @create_crypto_key = Google::Gax.create_api_call(
    @key_management_service_stub.method(:create_crypto_key),
    defaults["create_crypto_key"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @create_crypto_key_version = Google::Gax.create_api_call(
    @key_management_service_stub.method(:create_crypto_key_version),
    defaults["create_crypto_key_version"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_crypto_key = Google::Gax.create_api_call(
    @key_management_service_stub.method(:update_crypto_key),
    defaults["update_crypto_key"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'crypto_key.name' => request.crypto_key.name}
    end
  )
  @update_crypto_key_version = Google::Gax.create_api_call(
    @key_management_service_stub.method(:update_crypto_key_version),
    defaults["update_crypto_key_version"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'crypto_key_version.name' => request.crypto_key_version.name}
    end
  )
  @encrypt = Google::Gax.create_api_call(
    @key_management_service_stub.method(:encrypt),
    defaults["encrypt"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @decrypt = Google::Gax.create_api_call(
    @key_management_service_stub.method(:decrypt),
    defaults["decrypt"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @update_crypto_key_primary_version = Google::Gax.create_api_call(
    @key_management_service_stub.method(:update_crypto_key_primary_version),
    defaults["update_crypto_key_primary_version"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @destroy_crypto_key_version = Google::Gax.create_api_call(
    @key_management_service_stub.method(:destroy_crypto_key_version),
    defaults["destroy_crypto_key_version"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @restore_crypto_key_version = Google::Gax.create_api_call(
    @key_management_service_stub.method(:restore_crypto_key_version),
    defaults["restore_crypto_key_version"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_iam_policy = Google::Gax.create_api_call(
    @iam_policy_stub.method(:set_iam_policy),
    defaults["set_iam_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @get_iam_policy = Google::Gax.create_api_call(
    @iam_policy_stub.method(:get_iam_policy),
    defaults["get_iam_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @test_iam_permissions = Google::Gax.create_api_call(
    @iam_policy_stub.method(:test_iam_permissions),
    defaults["test_iam_permissions"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
end

Class Method Details

.crypto_key_path(project, location, key_ring, crypto_key) ⇒ String

Returns a fully-qualified crypto_key resource name string.

Parameters:

  • project (String)
  • location (String)
  • key_ring (String)
  • crypto_key (String)

Returns:

  • (String) 


162
163
164
165
166
167
168
169
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 162

def self.crypto_key_path project, location, key_ring, crypto_key
  CRYPTO_KEY_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location,
    :"key_ring" => key_ring,
    :"crypto_key" => crypto_key
  )
end

.crypto_key_path_path(project, location, key_ring, crypto_key_path) ⇒ String

Returns a fully-qualified crypto_key_path resource name string.

Parameters:

  • project (String)
  • location (String)
  • key_ring (String)
  • crypto_key_path (String)

Returns:

  • (String) 


136
137
138
139
140
141
142
143
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 136

def self.crypto_key_path_path project, location, key_ring, crypto_key_path
  CRYPTO_KEY_PATH_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location,
    :"key_ring" => key_ring,
    :"crypto_key_path" => crypto_key_path
  )
end

.crypto_key_version_path(project, location, key_ring, crypto_key, crypto_key_version) ⇒ String

Returns a fully-qualified crypto_key_version resource name string.

Parameters:

  • project (String)
  • location (String)
  • key_ring (String)
  • crypto_key (String)
  • crypto_key_version (String)

Returns:

  • (String) 


178
179
180
181
182
183
184
185
186
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 178

def self.crypto_key_version_path project, location, key_ring, crypto_key, crypto_key_version
  CRYPTO_KEY_VERSION_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location,
    :"key_ring" => key_ring,
    :"crypto_key" => crypto_key,
    :"crypto_key_version" => crypto_key_version
  )
end

.key_ring_path(project, location, key_ring) ⇒ String

Returns a fully-qualified key_ring resource name string.

Parameters:

  • project (String)
  • location (String)
  • key_ring (String)

Returns:

  • (String) 


122
123
124
125
126
127
128
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 122

def self.key_ring_path project, location, key_ring
  KEY_RING_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location,
    :"key_ring" => key_ring
  )
end

.location_path(project, location) ⇒ String

Returns a fully-qualified location resource name string.

Parameters:

  • project (String)
  • location (String)

Returns:

  • (String) 


149
150
151
152
153
154
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 149

def self.location_path project, location
  LOCATION_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location
  )
end

Instance Method Details

#create_crypto_key(parent, crypto_key_id, crypto_key, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKey

Create a new CryptoKey within a KeyRing.

CryptoKey#purpose is required.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_parent = Google::Cloud::Kms::V1::KeyManagementServiceClient.key_ring_path("[PROJECT]", "[LOCATION]", "[KEY_RING]")
crypto_key_id = "my-app-key"
purpose = :ENCRYPT_DECRYPT
seconds = 2147483647
next_rotation_time = { seconds: seconds }
seconds_2 = 604800
rotation_period = { seconds: seconds_2 }
crypto_key = {
  purpose: purpose,
  next_rotation_time: next_rotation_time,
  rotation_period: rotation_period
}
response = key_management_service_client.create_crypto_key(formatted_parent, crypto_key_id, crypto_key)

Parameters:

  • parent (String) —

    Required. The name of the KeyRing associated with the CryptoKeys.

  • crypto_key_id (String) —

    Required. It must be unique within a KeyRing and match the regular expression +[a-zA-Z0-9_-]{1,63}+

  • crypto_key (Google::Cloud::Kms::V1::CryptoKey | Hash) —

    A CryptoKey with initial field values. A hash of the same form as Google::Cloud::Kms::V1::CryptoKey can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 802

def create_crypto_key \
    parent,
    crypto_key_id,
    crypto_key,
    options: nil,
    &block
  req = {
    parent: parent,
    crypto_key_id: crypto_key_id,
    crypto_key: crypto_key
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::CreateCryptoKeyRequest)
  @create_crypto_key.call(req, options, &block)
end

#create_crypto_key_version(parent, crypto_key_version, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion

Create a new CryptoKeyVersion in a CryptoKey.

The server will assign the next sequential id. If unset, state will be set to ENABLED.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_parent = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]")

# TODO: Initialize +crypto_key_version+:
crypto_key_version = {}
response = key_management_service_client.create_crypto_key_version(formatted_parent, crypto_key_version)

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 848

def create_crypto_key_version \
    parent,
    crypto_key_version,
    options: nil,
    &block
  req = {
    parent: parent,
    crypto_key_version: crypto_key_version
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::CreateCryptoKeyVersionRequest)
  @create_crypto_key_version.call(req, options, &block)
end

#create_key_ring(parent, key_ring_id, key_ring, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::KeyRing

Create a new KeyRing in a given Project and Location.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_parent = Google::Cloud::Kms::V1::KeyManagementServiceClient.location_path("[PROJECT]", "[LOCATION]")

# TODO: Initialize +key_ring_id+:
key_ring_id = ''

# TODO: Initialize +key_ring+:
key_ring = {}
response = key_management_service_client.create_key_ring(formatted_parent, key_ring_id, key_ring)

Parameters:

  • parent (String) —

    Required. The resource name of the location associated with the KeyRings, in the format +projects//locations/+.

  • key_ring_id (String) —

    Required. It must be unique within a location and match the regular expression +[a-zA-Z0-9_-]{1,63}+

  • key_ring (Google::Cloud::Kms::V1::KeyRing | Hash) —

    A KeyRing with initial field values. A hash of the same form as Google::Cloud::Kms::V1::KeyRing can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 747

def create_key_ring \
    parent,
    key_ring_id,
    key_ring,
    options: nil,
    &block
  req = {
    parent: parent,
    key_ring_id: key_ring_id,
    key_ring: key_ring
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::CreateKeyRingRequest)
  @create_key_ring.call(req, options, &block)
end

#decrypt(name, ciphertext, additional_authenticated_data: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::DecryptResponse

Decrypts data that was protected by Encrypt.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_name = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]")

# TODO: Initialize +ciphertext+:
ciphertext = ''
response = key_management_service_client.decrypt(formatted_name, ciphertext)

Parameters:

  • name (String) —

    Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.

  • ciphertext (String) —

    Required. The encrypted data originally returned in EncryptResponse#ciphertext.

  • additional_authenticated_data (String) —

    Optional data that must match the data originally supplied in EncryptRequest#additional_authenticated_data.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 1029

def decrypt \
    name,
    ciphertext,
    additional_authenticated_data: nil,
    options: nil,
    &block
  req = {
    name: name,
    ciphertext: ciphertext,
    additional_authenticated_data: additional_authenticated_data
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::DecryptRequest)
  @decrypt.call(req, options, &block)
end

#destroy_crypto_key_version(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion

Schedule a CryptoKeyVersion for destruction.

Upon calling this method, CryptoKeyVersion#state will be set to DESTROY_SCHEDULED and destroy_time will be set to a time 24 hours in the future, at which point the state will be changed to DESTROYED, and the key material will be irrevocably destroyed.

Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_name = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_version_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]", "[CRYPTO_KEY_VERSION]")
response = key_management_service_client.destroy_crypto_key_version(formatted_name)

Parameters:

  • name (String) —

    The resource name of the CryptoKeyVersion to destroy.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 1111

def destroy_crypto_key_version \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::DestroyCryptoKeyVersionRequest)
  @destroy_crypto_key_version.call(req, options, &block)
end

#encrypt(name, plaintext, additional_authenticated_data: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::EncryptResponse

Encrypts data, so that it can only be recovered by a call to Decrypt.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_name = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY_PATH]")

# TODO: Initialize +plaintext+:
plaintext = ''
response = key_management_service_client.encrypt(formatted_name, plaintext)

Parameters:

  • name (String) —

    Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption.

    If a CryptoKey is specified, the server will use its primary version.

  • plaintext (String) —

    Required. The data to encrypt. Must be no larger than 64KiB.

  • additional_authenticated_data (String) —

    Optional data that, if specified, must also be provided during decryption through DecryptRequest#additional_authenticated_data. Must be no larger than 64KiB.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



985
986
987
988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 985

def encrypt \
    name,
    plaintext,
    additional_authenticated_data: nil,
    options: nil,
    &block
  req = {
    name: name,
    plaintext: plaintext,
    additional_authenticated_data: additional_authenticated_data
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::EncryptRequest)
  @encrypt.call(req, options, &block)
end

#get_crypto_key(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKey

Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_name = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]")
response = key_management_service_client.get_crypto_key(formatted_name)

Parameters:

  • name (String) —

    The name of the CryptoKey to get.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



673
674
675
676
677
678
679
680
681
682
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 673

def get_crypto_key \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::GetCryptoKeyRequest)
  @get_crypto_key.call(req, options, &block)
end

#get_crypto_key_version(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion

Returns metadata for a given CryptoKeyVersion.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_name = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_version_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]", "[CRYPTO_KEY_VERSION]")
response = key_management_service_client.get_crypto_key_version(formatted_name)

Parameters:

  • name (String) —

    The name of the CryptoKeyVersion to get.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



703
704
705
706
707
708
709
710
711
712
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 703

def get_crypto_key_version \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::GetCryptoKeyVersionRequest)
  @get_crypto_key_version.call(req, options, &block)
end

#get_iam_policy(resource, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_resource = Google::Cloud::Kms::V1::KeyManagementServiceClient.key_ring_path("[PROJECT]", "[LOCATION]", "[KEY_RING]")
response = key_management_service_client.get_iam_policy(formatted_resource)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/{project}+.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 1226

def get_iam_policy \
    resource,
    options: nil,
    &block
  req = {
    resource: resource
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::GetIamPolicyRequest)
  @get_iam_policy.call(req, options, &block)
end

#get_key_ring(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::KeyRing

Returns metadata for a given KeyRing.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_name = Google::Cloud::Kms::V1::KeyManagementServiceClient.key_ring_path("[PROJECT]", "[LOCATION]", "[KEY_RING]")
response = key_management_service_client.get_key_ring(formatted_name)

Parameters:

  • name (String) —

    The name of the KeyRing to get.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



642
643
644
645
646
647
648
649
650
651
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 642

def get_key_ring \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::GetKeyRingRequest)
  @get_key_ring.call(req, options, &block)
end

#list_crypto_key_versions(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Kms::V1::CryptoKeyVersion>

Lists CryptoKeyVersions.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_parent = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]")

# Iterate over all results.
key_management_service_client.list_crypto_key_versions(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
key_management_service_client.list_crypto_key_versions(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required. The resource name of the CryptoKey to list, in the format +projects//locations//keyRings//cryptoKeys/+.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Kms::V1::CryptoKeyVersion>) —

    An enumerable of Google::Cloud::Kms::V1::CryptoKeyVersion instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 610

def list_crypto_key_versions \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest)
  @list_crypto_key_versions.call(req, options, &block)
end

#list_crypto_keys(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Kms::V1::CryptoKey>

Lists CryptoKeys.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_parent = Google::Cloud::Kms::V1::KeyManagementServiceClient.key_ring_path("[PROJECT]", "[LOCATION]", "[KEY_RING]")

# Iterate over all results.
key_management_service_client.list_crypto_keys(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
key_management_service_client.list_crypto_keys(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required. The resource name of the KeyRing to list, in the format +projects//locations//keyRings/*+.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Kms::V1::CryptoKey>) —

    An enumerable of Google::Cloud::Kms::V1::CryptoKey instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 555

def list_crypto_keys \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::ListCryptoKeysRequest)
  @list_crypto_keys.call(req, options, &block)
end

#list_key_rings(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Kms::V1::KeyRing>

Lists KeyRings.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_parent = Google::Cloud::Kms::V1::KeyManagementServiceClient.location_path("[PROJECT]", "[LOCATION]")

# Iterate over all results.
key_management_service_client.list_key_rings(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
key_management_service_client.list_key_rings(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required. The resource name of the location associated with the KeyRings, in the format +projects//locations/+.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Kms::V1::KeyRing>) —

    An enumerable of Google::Cloud::Kms::V1::KeyRing instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 500

def list_key_rings \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::ListKeyRingsRequest)
  @list_key_rings.call(req, options, &block)
end

#restore_crypto_key_version(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion

Restore a CryptoKeyVersion in the DESTROY_SCHEDULED, state.

Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_name = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_version_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]", "[CRYPTO_KEY_VERSION]")
response = key_management_service_client.restore_crypto_key_version(formatted_name)

Parameters:

  • name (String) —

    The resource name of the CryptoKeyVersion to restore.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 1147

def restore_crypto_key_version \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::RestoreCryptoKeyVersionRequest)
  @restore_crypto_key_version.call(req, options, &block)
end

#set_iam_policy(resource, policy, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_resource = Google::Cloud::Kms::V1::KeyManagementServiceClient.key_ring_path("[PROJECT]", "[LOCATION]", "[KEY_RING]")

# TODO: Initialize +policy+:
policy = {}
response = key_management_service_client.set_iam_policy(formatted_resource, policy)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/{project}+.

  • policy (Google::Iam::V1::Policy | Hash) —

    REQUIRED: The complete policy to be applied to the +resource+. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. A hash of the same form as Google::Iam::V1::Policy can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 1190

def set_iam_policy \
    resource,
    policy,
    options: nil,
    &block
  req = {
    resource: resource,
    policy: policy
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::SetIamPolicyRequest)
  @set_iam_policy.call(req, options, &block)
end

#test_iam_permissions(resource, permissions, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_resource = Google::Cloud::Kms::V1::KeyManagementServiceClient.key_ring_path("[PROJECT]", "[LOCATION]", "[KEY_RING]")

# TODO: Initialize +permissions+:
permissions = []
response = key_management_service_client.test_iam_permissions(formatted_resource, permissions)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/{project}+.

  • permissions (Array<String>) —

    The set of permissions to check for the +resource+. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 1268

def test_iam_permissions \
    resource,
    permissions,
    options: nil,
    &block
  req = {
    resource: resource,
    permissions: permissions
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
  @test_iam_permissions.call(req, options, &block)
end

#update_crypto_key(crypto_key, update_mask, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKey

Update a CryptoKey.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)

# TODO: Initialize +crypto_key+:
crypto_key = {}

# TODO: Initialize +update_mask+:
update_mask = {}
response = key_management_service_client.update_crypto_key(crypto_key, update_mask)

Parameters:

  • crypto_key (Google::Cloud::Kms::V1::CryptoKey | Hash) —

    CryptoKey with updated values. A hash of the same form as Google::Cloud::Kms::V1::CryptoKey can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    Required list of fields to be updated in this request. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 891

def update_crypto_key \
    crypto_key,
    update_mask,
    options: nil,
    &block
  req = {
    crypto_key: crypto_key,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::UpdateCryptoKeyRequest)
  @update_crypto_key.call(req, options, &block)
end

#update_crypto_key_primary_version(name, crypto_key_version_id, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKey

Update the version of a CryptoKey that will be used in Encrypt

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)
formatted_name = Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]")

# TODO: Initialize +crypto_key_version_id+:
crypto_key_version_id = ''
response = key_management_service_client.update_crypto_key_primary_version(formatted_name, crypto_key_version_id)

Parameters:

  • name (String) —

    The resource name of the CryptoKey to update.

  • crypto_key_version_id (String) —

    The id of the child CryptoKeyVersion to use as primary.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 1068

def update_crypto_key_primary_version \
    name,
    crypto_key_version_id,
    options: nil,
    &block
  req = {
    name: name,
    crypto_key_version_id: crypto_key_version_id
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::UpdateCryptoKeyPrimaryVersionRequest)
  @update_crypto_key_primary_version.call(req, options, &block)
end

#update_crypto_key_version(crypto_key_version, update_mask, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion

Update a CryptoKeyVersion's metadata.

state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.

Examples:

require "google/cloud/kms"

key_management_service_client = Google::Cloud::Kms.new(version: :v1)

# TODO: Initialize +crypto_key_version+:
crypto_key_version = {}

# TODO: Initialize +update_mask+:
update_mask = {}
response = key_management_service_client.update_crypto_key_version(crypto_key_version, update_mask)

Parameters:

  • crypto_key_version (Google::Cloud::Kms::V1::CryptoKeyVersion | Hash) —

    CryptoKeyVersion with updated values. A hash of the same form as Google::Cloud::Kms::V1::CryptoKeyVersion can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    Required list of fields to be updated in this request. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'lib/google/cloud/kms/v1/key_management_service_client.rb', line 940

def update_crypto_key_version \
    crypto_key_version,
    update_mask,
    options: nil,
    &block
  req = {
    crypto_key_version: crypto_key_version,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Kms::V1::UpdateCryptoKeyVersionRequest)
  @update_crypto_key_version.call(req, options, &block)
end