add-vault-tokens 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2ea61f5ded8622f219284aa593c3bf3eadffc4f
+  data.tar.gz: a942ee2017815d29029d7ccec464e00fa8257dd3
+SHA512:
+  metadata.gz: 6e7a3201cf312533813f87dd2a3ccb9b1eef0136b0f1ea1b16c63b6e750ec0012f9da0bb503fda9f461c11d2053953f56f6a1c50113338c22dfab8d7158377e4
+  data.tar.gz: eb1ae0b74599ae7201ac2629478210e72461506a9eacf39658ba110594a049f3cb5a30def389cc262bc1c635dff92c4213207520961d79b616d5b7971925b882

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eric Kidd
+
+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,114 @@
+# `add-vault-tokens`
+
+This is a short script for use with [vault](https://vaultproject.io/) and
+[docker-compose](https://docs.docker.com/compose/).  Given a
+`docker-compose.yml` file and a `VAULT_MASTER_TOKEN` as input, this script
+will generate a new, limited vault token for each application described in
+the `docker-compose.yml` file.
+
+You can install this as:
+
+```sh
+gem install add-vault-tokens
+```
+
+## Usage
+
+Assume you have a `docker-compose.yml` containing:
+
+```yml
+app:
+  image: "example/app"
+
+service:
+  image: "example/service"
+```
+
+First, you need to create a security policy `master-token.hcl` for the
+master token:
+
+```hcl
+# Mandatory for all policies.
+path "auth/token/lookup-self" {
+  policy = "read"
+}
+
+# Allow listing all available policies, so we can decide which child tokens
+# to generate.
+path "sys/policy" {
+  policy = "sudo"
+}
+
+# Allow creation of child tokens.
+path "auth/token/create" {
+  policy = "write"
+}
+
+# Allow renewal of this token.
+#
+# SECURITY - HACK - We can't just allow renewal via `renew-self` in 0.3, so
+# allow renewal of _any_ token as the next best substitute.
+path "auth/token/renew/*" {
+  policy = "sudo"
+}
+```
+
+This can be loaded using:
+
+```sh
+vault policy-write master-token master-token.hcl
+```
+
+Then you need to define two new policies, `app` and `service`, specifying
+which secrets can be accessed by each container.  Once this is done, you
+can create your `VAULT_MASTER_TOKEN` for use with `add-vault-tokens`:
+
+```sh
+vault token-create -policy=master-token -policy=app -policy=service
+```
+
+Then you run `add-vault-tokens` as follows:
+
+```
+# The URL of your vault server.
+export VAULT_ADDR=https://...
+
+# The master token you just generated.
+export VAULT_MASTER_TOKEN=...
+
+# Generate tokens
+add-vault-tokens docker-compose.yml
+```
+
+This will update `docker-compose.yml` to include new environment variables:
+
+```yml
+app:
+  image: "example/app"
+  environment:
+    VAULT_ADDR="https://..."
+    # A new token with policy "app":
+    VAULT_TOKEN="..."
+
+service:
+  image: "example/service"
+  environment:
+    VAULT_ADDR="https://..."
+    # A new token with policy "service":
+    VAULT_TOKEN="..."
+```
+
+If a `VAULT_ENV` environment variable is present, it will also be added to
+the `docker-compose.yml` file, and the policy names will be prefixed by
+`$VAULT_ENV-`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/faradayio/add-vault-tokens.
+
+## 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/add-vault-tokens.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'add_vault_tokens/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "add-vault-tokens"
+  spec.version       = AddVaultTokens::VERSION
+  spec.authors       = ["Eric Kidd"]
+  spec.email         = ["git@randomhacks.net"]
+
+  spec.summary       = %q{Issue per-application Vault tokens to apps in docker-compose.yml}
+  spec.description   = %q{Given a master vault token, issue short-lived, per-application tokens to each app in a docker-compose.yml file, restricting each app the to corresponding security policy.}
+  spec.homepage      = "https://github.com/faradayio/add-vault-tokens"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "vault"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "add_vault_tokens"
+
+# 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

data/bin/setup

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

data/exe/add-vault-tokens

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "psych"
+require "add_vault_tokens"
+
+# Set up command-line option defaults.
+options = { prefix: '' }
+options[:prefix] = "#{ENV.fetch('VAULT_ENV')}-" if ENV.has_key?('VAULT_ENV')
+
+# Parse our command-line.
+OptionParser.new do |opts|
+  opts.banner = "Usage: example.rb [options]"
+
+  opts.on("-p", "--prefix", "Prefix to add to each app name") do |p|
+    options[:prefix] = p
+  end
+end.parse!
+paths = ARGV
+
+# Connect to our vault server.
+AddVaultTokens.connect
+
+# Renew our master token.
+STDERR.puts("Renewing VAULT_MASTER_TOKEN")
+AddVaultTokens.renew_master_token
+
+# For each input file, add the appropriate tokens to each app.
+paths.each do |path|
+  yml = Psych.load_file(path)
+  result = AddVaultTokens.add_tokens_to_apps(yml, prefix: options.fetch(:prefix))
+  File.write("#{path}.tmp", Psych.dump(result))
+  # Atomically overwrite existing file.
+  File.rename("#{path}.tmp", path)
+end

data/lib/add-vault-tokens.rb

@@ -0,0 +1,2 @@
+# Load our real main file.
+require 'add_vault_tokens'

data/lib/add_vault_tokens.rb

@@ -0,0 +1,58 @@
+require "vault"
+require "add_vault_tokens/version"
+
+module AddVaultTokens
+  class << self
+    # Connect if we haven't already.
+    def connect
+      return if @connected
+      @connected = true
+      Vault.address = ENV.fetch('VAULT_ADDR')
+      Vault.token = ENV.fetch('VAULT_MASTER_TOKEN')
+    end
+
+    # Does our vault have a policy for app_name?
+    def have_policy_for?(app_name)
+      @policies ||= Vault.sys.policies
+      @policies.include?(app_name)
+    end
+
+    # Renew our master token.  We do this in case it's getting old, in
+    # which case we don't want to risk our generated tokens expiring early.
+    def renew_master_token
+      # TODO: Use renew_self as soon as it's available, so we don't need
+      # the power to renew any arbitrary token.
+      Vault.auth_token.renew(ENV.fetch('VAULT_MASTER_TOKEN'))
+    end
+
+    # Create a token for app_name with the appropriate security policy.
+    def create_token_for(app_name)
+      Vault.auth_token.create(name: app_name,
+                              ttl: '720h',
+                              policies: [app_name])
+    end
+
+    # Given a parsed `docker-compose.yml` file, return a new version with
+    # appropriate vault-related environment variables injected.  If
+    # specified, append `prefix` to each service name in the file before
+    # looking up a policy.
+    def add_tokens_to_apps(parsed_yaml, prefix: "")
+      env = ENV.fetch('VAULT_ENV', nil)
+      result = Marshal.load(Marshal.dump(parsed_yaml))
+      result.each do |app_name, info|
+        full_app_name = prefix + app_name
+        if have_policy_for?(full_app_name)
+          STDERR.puts("Issuing token for #{full_app_name}")
+          token = create_token_for(full_app_name)
+          info['environment'] ||= {}
+          info['environment']['VAULT_ADDR'] = ENV.fetch('VAULT_ADDR')
+          info['environment']['VAULT_ENV'] = env if env
+          info['environment']['VAULT_TOKEN'] = token.auth.client_token
+        else
+          STDERR.puts("WARNING: No policy for #{full_app_name}, so no token issued")
+        end
+      end
+      result
+    end
+  end
+end

data/lib/add_vault_tokens/version.rb

@@ -0,0 +1,3 @@
+module AddVaultTokens
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: add-vault-tokens
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Kidd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vault
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Given a master vault token, issue short-lived, per-application tokens
+  to each app in a docker-compose.yml file, restricting each app the to corresponding
+  security policy.
+email:
+- git@randomhacks.net
+executables:
+- add-vault-tokens
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- add-vault-tokens.gemspec
+- bin/console
+- bin/setup
+- exe/add-vault-tokens
+- lib/add-vault-tokens.rb
+- lib/add_vault_tokens.rb
+- lib/add_vault_tokens/version.rb
+homepage: https://github.com/faradayio/add-vault-tokens
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Issue per-application Vault tokens to apps in docker-compose.yml
+test_files: []