vault-transit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 004a37c752276bf2aa4ac70971d89a239ed7965d
+  data.tar.gz: 6d7c43569b20fd47394f4482a1b9b7de39eb7475
+SHA512:
+  metadata.gz: c30339bb1cd88551ee2c68a68154776045815ef25f7982d6dabacf943ef937d8568efb6816d4fbef415c537083b7932009d11331e476c1dc5bfdfdddffc5623e
+  data.tar.gz: 699a031bb508b49ffdad3ab9c39649d97f1da43e0757c3cfdcee1eba64d626baf93e791c9617e471fb79fcfea3aef8816d016b4c48e282f879d99bdabdf982f9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vault-transit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Atkinson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Vault::Transit
+
+This gem wraps the endpoints for [HashiCorp's Vault Transit secret backend](https://www.vaultproject.io/docs/secrets/transit/). It is dependent upon the [vault gem](https://github.com/hashicorp/vault-ruby). This gem has patterns and code copied from HashiCorp's [vault-ruby gem](https://github.com/hashicorp/vault-rails). Use this gem when you simply want to use the Transit secret backend and you don't need the Rails integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vault-transit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vault-transit
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jgaxn/vault-transit.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vault/transit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vault/transit.rb

@@ -0,0 +1,302 @@
+
+require "base64"
+require "vault"
+require "vault/transit/configurable"
+require "vault/transit/version"
+
+#require_relative "transit/configurable"
+
+module Vault
+  module Transit
+
+    # The default encoding.
+    #
+    # @return [String]
+    DEFAULT_ENCODING = "utf-8".freeze
+
+    # The warning string to print when running in development mode.
+    DEV_WARNING = "[vault-transit] Using in-memory cipher - this is not secure " \
+      "and should never be used in production-like environments!".freeze
+
+    class << self
+      attr_reader :client
+
+      def setup!
+        ::Vault.setup!
+        @client = ::Vault.client
+        @client.class.instance_eval do
+          include ::Vault::Transit::Configurable
+        end
+
+        self
+      end
+
+      # Delegate all methods to the client object, essentially making the module
+      # object behave like a {Vault::Client}.
+      def method_missing(m, *args, &block)
+        if client.respond_to?(m)
+          client.public_send(m, *args, &block)
+        else
+          super
+        end
+      end
+
+      # Delegating `respond_to` to the {Vault::Client}.
+      def respond_to_missing?(m, include_private = false)
+        client.respond_to?(m, include_private) || super
+      end
+
+      # Decrypt the given ciphertext data using the provided key.
+      #
+      # @param [String] key
+      #   the key to decrypt at
+      # @param [String] ciphertext
+      #   the ciphertext to decrypt
+      # @param [Vault::Client] client
+      #   the Vault client to use
+      #
+      # @return [String]
+      #   the decrypted plaintext text
+      def decrypt(key, ciphertext, client = self.client)
+        if ciphertext.nil? || ciphertext.empty?
+          return ciphertext
+        end
+
+        key  = key.to_s if !key.is_a?(String)
+
+        with_retries_and_reauthentication do
+          if self.enabled?
+            result = self.vault_decrypt(key, ciphertext, client)
+          else
+            result = self.memory_decrypt(key, ciphertext, client)
+          end
+
+          return self.force_encoding(result)
+        end
+      end
+
+      # Encrypt the given plaintext data using the provided key.
+      #
+      # @param [String] key
+      #   the key to encrypt at
+      # @param [String] plaintext
+      #   the plaintext to encrypt
+      # @param [Vault::Client] client
+      #   the Vault client to use
+      #
+      # @return [String]
+      #   the encrypted cipher text
+      def encrypt(key, plaintext, client = self.client)
+        if plaintext.nil? || plaintext.empty?
+          return plaintext
+        end
+
+        key  = key.to_s if !key.is_a?(String)
+
+        with_retries_and_reauthentication do
+          if self.enabled?
+            result = self.vault_encrypt(key, plaintext, client)
+          else
+            result = self.memory_encrypt(key, plaintext, client)
+          end
+
+          return self.force_encoding(result)
+        end
+      end
+
+      # Rewrap the given ciphertext data using the provided key.
+      #
+      # @param [String] key
+      #   the key to rewrap at
+      # @param [String] ciphertext
+      #   the ciphertext to rewrap
+      # @param [Vault::Client] client
+      #   the Vault client to use
+      #
+      # @return [String]
+      #   the rewrapped ciphertext text
+      def rewrap(key, ciphertext, client = self.client)
+        if ciphertext.nil? || ciphertext.empty?
+          return ciphertext
+        end
+
+        key  = key.to_s unless key.is_a?(String)
+        route  = File.join("transit", "rewrap", key)
+
+        with_retries_and_reauthentication do
+          if self.enabled?
+            secret = client.logical.write(route,
+              ciphertext: ciphertext,
+            )
+            result = secret.data[:ciphertext]
+          else
+            result = ciphertext
+          end
+          return self.force_encoding(result)
+        end
+      end
+
+      # Rotate the key to a new version
+      #
+      # @param [String] key
+      #   the key to rotate
+      # @param [Vault::Client] client
+      #   the Vault client to use
+      #
+      def rotate(key, client = self.client)
+        key  = key.to_s unless key.is_a?(String)
+        route  = File.join("transit", "keys", key, "rotate")
+
+        with_retries_and_reauthentication do
+          if self.enabled?
+            client.logical.write(route)
+          end
+        end
+      end
+
+      # Set the minimum decryption version a using the provided key.
+      #
+      # @param [String] key
+      #   the key to configure
+      # @param [int] min_decryption_version
+      #   the new minimum decryption version
+      # @param [Vault::Client] client
+      #   the Vault client to use
+      #
+      def set_min_decryption_version(key, min_decryption_version, client = self.client)
+        key  = key.to_s unless key.is_a?(String)
+
+        with_retries_and_reauthentication do
+          if self.enabled?
+            route = File.join("transit", "keys", key, "config")
+            client.logical.write(route,
+              min_decryption_version: min_decryption_version,
+            )
+          end
+        end
+      end
+
+    protected
+
+      # Perform in-memory decryption. This is useful for testing and development.
+      def memory_decrypt(key, ciphertext, client)
+        log_warning(DEV_WARNING)
+
+        return nil if ciphertext.nil?
+
+        cipher = OpenSSL::Cipher::AES.new(128, :CBC)
+        cipher.decrypt
+        cipher.key = memory_key_for(key)
+        ciphertext = ciphertext.gsub("vault:v0:", "")
+        return cipher.update(Base64.strict_decode64(ciphertext)) + cipher.final
+      end
+
+      # Perform in-memory encryption. This is useful for testing and development.
+      def memory_encrypt(key, plaintext, client)
+        log_warning(DEV_WARNING)
+
+        return nil if plaintext.nil?
+
+        cipher = OpenSSL::Cipher::AES.new(128, :CBC)
+        cipher.encrypt
+        cipher.key = memory_key_for(key)
+        return "vault:v0:" + Base64.strict_encode64(cipher.update(plaintext) + cipher.final)
+      end
+
+      # Perform decryption using Vault. This will raise exceptions if Vault is
+      # unavailable.
+      def vault_decrypt(key, ciphertext, client)
+        return nil if ciphertext.nil?
+
+        route  = File.join("transit", "decrypt", key)
+        secret = client.logical.write(route, ciphertext: ciphertext)
+        return Base64.strict_decode64(secret.data[:plaintext])
+      end
+
+      # Perform encryption using Vault. This will raise exceptions if Vault is
+      # unavailable.
+      def vault_encrypt(key, plaintext, client)
+        return nil if plaintext.nil?
+
+        route  = File.join("transit", "encrypt", key)
+        secret = client.logical.write(route,
+          plaintext: Base64.strict_encode64(plaintext),
+        )
+        return secret.data[:ciphertext]
+      end
+
+      # The symmetric key for the given params.
+      # @return [String]
+      def memory_key_for(key)
+        return Base64.strict_encode64(key.ljust(32, "x"))
+      end
+
+      # Forces the encoding into the default Rails encoding and returns the
+      # newly encoded string.
+      # @return [String]
+      def force_encoding(str)
+        encoding = ::Rails.application.config.encoding if defined? ::Rails
+        encoding ||= DEFAULT_ENCODING
+        str.force_encoding(encoding).encode(encoding)
+      end
+
+    private
+
+      def log_warning(msg)
+        if defined?(::Rails) && ::Rails.logger != nil
+          ::Rails.logger.warn { msg }
+        end
+      end
+
+      def permission_denied?(error)
+        error.errors.include? "permission denied"
+      end
+
+      def reauthenticate!
+        return nil unless ENV["VAULT_APP_ID"] && ENV["VAULT_SYSTEM_ID"]
+        secret = ::Vault::Transit.auth.app_id(ENV["VAULT_APP_ID"], ENV["VAULT_SYSTEM_ID"])
+        ::Vault::Transit.token = secret.auth.client_token
+      end
+
+      def with_reauthentication(client = self.client, &block)
+        retries ||= 0
+        reauthenticate! if self.enabled? && self.token.nil?
+        yield
+      rescue ::Vault::HTTPError => error
+        raise unless permission_denied?(error)
+
+        reauthenticate!
+        retry if (retries += 1) < 2
+        raise
+      end
+
+      def with_retries(client = self.client, &block)
+        exceptions = [Vault::HTTPConnectionError, Vault::HTTPServerError]
+        options = {
+          attempts: self.retry_attempts,
+          base:     self.retry_base,
+          max_wait: self.retry_max_wait,
+        }
+
+        client.with_retries(*exceptions, options) do |i, e|
+          if !e.nil?
+            log_warning "[vault-transit] (#{i}) An error occurred when trying to " \
+              "communicate with Vault: #{e.message}"
+          end
+
+          yield
+        end
+      end
+
+      def with_retries_and_reauthentication(client = self.client, &block)
+        with_reauthentication do
+          with_retries do
+            yield
+          end
+        end
+      end
+    end
+  end
+end
+
+::Vault::Transit.setup!

data/lib/vault/transit/configurable.rb

@@ -0,0 +1,78 @@
+module Vault
+  module Transit
+    module Configurable
+      include Vault::Configurable
+
+      # Whether the connection to Vault is enabled. The default value is `false`,
+      # which means vault-rails will perform in-memory encryption/decryption and
+      # not attempt to talk to a real Vault server. This is useful for
+      # development and testing.
+      #
+      # @return [true, false]
+      def enabled?
+        if !defined?(@enabled) || @enabled.nil?
+          return false
+        end
+        return @enabled
+      end
+
+      # Sets whether Vault is enabled. Users can set this in an initializer
+      # depending on their Rails environment.
+      #
+      # @example
+      #   Vault.configure do |vault|
+      #     vault.enabled = Rails.env.production?
+      #   end
+      #
+      # @return [true, false]
+      def enabled=(val)
+        @enabled = !!val
+      end
+
+      # Gets the number of retry attempts.
+      #
+      # @return [Fixnum]
+      def retry_attempts
+        @retry_attempts ||= 0
+      end
+
+      # Sets the number of retry attempts. Please see the Vault documentation
+      # for more information.
+      #
+      # @param [Fixnum] val
+      def retry_attempts=(val)
+        @retry_attempts = val
+      end
+
+      # Gets the number of retry attempts.
+      #
+      # @return [Fixnum]
+      def retry_base
+        @retry_base ||= Vault::Defaults::RETRY_BASE
+      end
+
+      # Sets the retry interval. Please see the Vault documentation for more
+      # information.
+      #
+      # @param [Fixnum] val
+      def retry_base=(val)
+        @retry_base = val
+      end
+
+      # Gets the retry maximum wait.
+      #
+      # @return [Fixnum]
+      def retry_max_wait
+        @retry_max_wait ||= Vault::Defaults::RETRY_MAX_WAIT
+      end
+
+      # Sets the naximum amount of time for a single retry. Please see the Vault
+      # documentation for more information.
+      #
+      # @param [Fixnum] val
+      def retry_max_wait=(val)
+        @retry_max_wait = val
+      end
+    end
+  end
+end

data/lib/vault/transit/version.rb

@@ -0,0 +1,5 @@
+module Vault
+  module Transit
+    VERSION = "0.1.0"
+  end
+end

data/vault-transit.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vault/transit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vault-transit"
+  spec.version       = Vault::Transit::VERSION
+  spec.authors       = ["John Atkinson"]
+  spec.email         = ["jgaxn0@gmail.com"]
+
+  spec.summary       = "Ruby API client for interacting with the Vault Transit secret backend"
+  spec.homepage      = "https://github.com/jgaxn/vault-transit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "vault", "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: vault-transit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Atkinson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vault
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- jgaxn0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vault/transit.rb
+- lib/vault/transit/configurable.rb
+- lib/vault/transit/version.rb
+- vault-transit.gemspec
+homepage: https://github.com/jgaxn/vault-transit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby API client for interacting with the Vault Transit secret backend
+test_files: []