README.md

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.

• Client Library Documentation
• Product Documentation

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.

Installation

$ gem install google-cloud-kms

Example

require "google/cloud/kms"

# Create a client for a project and given credentials
kms = Google::Cloud::Kms.new 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 #{Time.new 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 #{key_ring.name}"
end

Next Steps

• Read the Client Library Documentation for Cloud Key Management Service (KMS) API to see other available methods on the client.
• Read the Cloud Key Management Service (KMS) API Product documentation to learn more about the product and see How-to Guides.
• View this repository's main README to see the full list of Cloud APIs that we cover.

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 = Logger.new $stderr, level: Logger::WARN
  def logger
    LOGGER
  end
end

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

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 https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.