Ruby Client for Cloud Key Management Service (KMS) API (GA)

Cloud Key Management Service (KMS) API: Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Key Management Service (KMS) API.
  4. Setup Authentication.


$ gem install google-cloud-kms


require "google/cloud/kms"

# Create a client for a project and given credentials
kms = credentials: "/path/to/keyfile.json"

# Where to create key rings
key_ring_parent = kms.class.location_path "my-project", "us-central1"

# Create a new key ring
key_ring = kms.create_key_ring key_ring_parent, "my-ring", {}
puts "Created at #{ key_ring.create_time.seconds}"

# Iterate over created key rings
kms.list_key_rings(key_ring_parent).each do |key_ring|
  puts "Found ring called #{}"

Next Steps

Enabling Logging

To enable logging for this library, set the logger for the underlying gRPC library. The logger that you set may be a Ruby stdlib Logger as shown below, or a Google::Cloud::Logging::Logger that will write logs to Stackdriver Logging. See grpc/logconfig.rb and the gRPC spec_helper.rb for additional information.

Configuring a Ruby stdlib logger:

require "logger"

module MyLogger
  LOGGER = $stderr, level: Logger::WARN
  def logger

# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
module GRPC
  extend MyLogger

Supported Ruby Versions

This library is supported on Ruby 2.3+.

Google provides official support for Ruby versions that are actively supported by Ruby Core—that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.3 and later. Older versions of Ruby may still work, but are unsupported and not recommended. See for details about the Ruby support schedule.