veil 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfc065388eeda8de97ced25becd31b968eaebd1c
+  data.tar.gz: 4f254696b35ccd7924bb84db6a18b65629570533
+SHA512:
+  metadata.gz: 858dd8cba868d10bc3559b7ea6e4467a6cbeb9a3316244c0289b87adeef13709306a9c909d8dd8b1a1593b54a3541dd7cda1b3dce6ece469c937db2e83990270
+  data.tar.gz: 831847b81b49f810c5b37e4f7a4211723f9fa84bcf5a26cce62a76ef9861d7288cd31bcfea08992aaee068b001c157ed1757e78311487f98d330cdc68d5fdea7

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2017 Chef Software, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "veil"
+require "pry"
+Pry.start

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/bin/veil-env-helper

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'veil'
+require 'optparse'
+
+options = {
+  secrets_file: "/etc/opscode/private-chef-secrets.json"
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: veil-env-helper [options] COMMAND"
+
+  opts.on("--[no-]debug", "Emit diagnostic messages.  This will print secrets. Do not use this in production") do |d|
+    options[:debug] = d
+  end
+
+  opts.on("-s SECRETS_SPEC", "--secrets SECRETS_SPEC", "A comma seperated list of secrets to put in the environment") do |spec|
+    options[:secrets] = spec.split(",")
+  end
+
+  opts.on("-f SECRETS_FILE", "--secrets-file SECRETS_FILE", "Location of veil-managed secrets file. Default: /etc/opscode/private-chef-secrets.json") do |file|
+    options[:secrets_file] = file
+  end
+end.parse!
+
+def env_name_from_secret_spec(secret)
+  parts = secret.split("=")
+  case parts.length
+  when 1
+    ["CHEF_SECRET_#{parts[0].upcase}", parts[0]]
+  when 2
+    [parts[0].upcase, parts[1]]
+  else
+    raise "Bad secret spec: #{secret}"
+  end
+end
+
+veil = Veil::CredentialCollection::ChefSecretsFile.from_file(options[:secrets_file])
+Array(options[:secrets]).each do |secret|
+  env_name, secret_name = env_name_from_secret_spec(secret)
+  veil_args = secret_name.split(".")
+  secret_value = veil.get(*veil_args)
+  STDERR.puts "Setting #{env_name}=#{secret_value}" if options[:debug]
+  ENV[env_name] = secret_value
+end
+
+exec(*ARGV)

data/bin/veil-ingest-secret

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+require 'veil'
+require 'json'
+require 'optparse'
+
+options = { debug: false }
+
+OptionParser.new do |opts|
+  opts.banner = <<EOF
+Usage: veil-ingest-secret [options] [SECTION.]NAME
+
+Manually add secrets to a secrets provider. This is configured via environment
+variables:
+
+  * PROVIDER=chef-secrets-file       Secrets provider to use
+  * PROVIDER_CONFIG                  Configuration for the secrets provider (JSON)
+                                     - defaults differ according to providers
+
+  Options:
+EOF
+
+  opts.on("--[no-]debug", "Emit diagnostic messages.  This will print secrets. Do not use this in production") do |d|
+    options[:debug] = d
+  end
+end.parse!
+
+config = JSON.parse(ENV['PROVIDER_CONFIG'] || "{}", symbolize_names: true)
+config[:provider] = ENV['PROVIDER'] || 'chef-secrets-file'
+STDERR.puts "Using config #{config}" if options[:debug]
+
+veil = Veil::CredentialCollection.from_config(config)
+
+secret = ARGV.first
+veil_args = secret.split(".")
+STDERR.puts "veil_args = #{veil_args}" if options[:debug]
+
+STDERR.puts "Reading from stdin" if options[:debug]
+value = STDIN.read.chomp
+
+veil.add(*veil_args, value: value, frozen: true, force: true)
+veil.save

data/lib/veil.rb

@@ -0,0 +1,6 @@
+require "veil/version"
+require "veil/exceptions"
+require "veil/utils"
+require "veil/hasher"
+require "veil/credential"
+require "veil/credential_collection"

data/lib/veil/credential.rb

@@ -0,0 +1,75 @@
+require "veil/exceptions"
+
+module Veil
+  class Credential
+    class << self
+      def create(hash = {})
+        new(hash)
+      end
+    end
+
+    attr_reader :version, :value, :name, :group, :length, :frozen
+    alias_method :credential, :value
+
+    def initialize(opts = {})
+      validate_opts!(opts)
+      @name = opts[:name]
+      @version = opts[:version] || 0
+      @group = opts[:group] || nil
+      @length = opts[:length] || opts[:value].length
+      @value = opts[:value][0...@length]
+      @frozen = opts[:frozen] || false
+    end
+
+    def length
+      @value.length
+    end
+
+    def eql?(other)
+      (@name == other.name) &&
+        (@group == other.group) &&
+        (@value == other.value) &&
+        (@version == other.version)
+    end
+
+    def hash
+      [@name, @group, @value, @version].hash
+    end
+
+    def rotate(hasher)
+      return false unless !frozen && hasher.respond_to?(:encrypt)
+      _rotate(hasher)
+    end
+
+    def rotate!(hasher)
+      raise "You cannot rotate a frozen credential" if frozen
+      raise InvalidHasher.new("You must supply a valid hasher to rotate a credential") unless hasher.respond_to?(:encrypt)
+      _rotate(hasher)
+    end
+
+    def to_hash
+      {
+        type: self.class.name,
+        name: name,
+        group: group,
+        value: value,
+        version: version,
+        length: length,
+        frozen: frozen
+      }
+    end
+    alias_method :to_h, :to_hash
+
+    private
+
+    def _rotate(hasher)
+      @version += 1
+      @value = hasher.encrypt(group, name, version)[0...@length]
+    end
+
+    def validate_opts!(opts)
+      raise ArgumentError, "You must provide a credential name" unless opts[:name]
+      raise ArgumentError, "You must provide a credential value" unless opts[:value]
+    end
+  end
+end

data/lib/veil/credential_collection.rb

@@ -0,0 +1,18 @@
+require "veil/credential_collection/base"
+require "veil/credential_collection/chef_secrets_file"
+
+module Veil
+  class CredentialCollection
+
+    def self.from_config(opts)
+      klass = case opts[:provider]
+              when 'chef-secrets-file'
+                ChefSecretsFile
+              else
+                raise UnknownProvider, "Unknown provider: #{opts[:provider]}"
+              end
+
+      klass.new(opts)
+    end
+  end
+end

data/lib/veil/credential_collection/base.rb

@@ -0,0 +1,240 @@
+require "veil/hasher"
+require "veil/credential"
+require "forwardable"
+
+module Veil
+  class CredentialCollection
+    class Base
+      class << self
+        def create(hash = {})
+          new(hash)
+        end
+      end
+
+      extend Forwardable
+
+      attr_reader :credentials, :hasher, :version
+
+      def_delegators :@credentials, :size, :length, :find, :map, :select, :each, :[], :keys
+
+      def initialize(opts = {})
+        @hasher = Veil::Hasher.create(opts[:hasher] || {})
+        @credentials = expand_credentials_hash(opts[:credentials] || {})
+        @version = opts[:version] || 1
+      end
+
+      def to_hash
+        {
+          type: self.class.name,
+          version: version,
+          hasher: hasher.to_h,
+          credentials: credentials_as_hash
+        }
+      end
+      alias_method :to_h, :to_hash
+
+      def save
+        raise "Save has not been implemented for this class"
+      end
+
+      def rotate(group_or_cred, cred = nil)
+        if cred && credentials.key?(group_or_cred) && credentials[group_or_cred].key?(cred)
+          credentials[group_or_cred][cred].rotate(hasher)
+        elsif credentials.key?(group_or_cred)
+          if credentials[group_or_cred].is_a?(Hash)
+            credentials[group_or_cred].each { |_s, c| c.rotate(hasher) }
+          else
+            credentials[group_or_cred].rotate(hasher)
+          end
+        end
+      end
+
+      #
+      # Retrieves a credential from the credential store:
+      #
+      #  get(name)
+      #  get(group, name)
+      #
+      def get(*args)
+        case args.length
+        when 1
+          cred_name = args[0]
+          c = credentials[cred_name]
+          if c.nil?
+            raise Veil::CredentialNotFound, "Credential '#{cred_name}' not found."
+          else
+            c.value
+          end
+        when 2
+          group_name = args[0]
+          cred_name = args[1]
+
+          g = credentials[group_name]
+          if g.nil?
+            raise Veil::GroupNotFound, "Credential group '#{group_name}' not found."
+          else
+            c = g[cred_name]
+            if c.nil?
+              raise Veil::CredentialNotFound, "Credential '#{cred_name}' not found in group '#{group_name}'."
+            else
+              c.value
+            end
+          end
+        else
+          raise ArgumentError, "wrong number of arguments (given #{args.length}, expected 1 or 2)"
+        end
+      end
+
+      # TODO mp 2017/03/01 replace usage to prefer get_credential
+      alias_method :get_credential, :get
+
+      #
+      # Check to see if a given credential has been added.
+      #
+      def exist?(*args)
+        get(*args)
+        true
+      rescue Veil::GroupNotFound, Veil::CredentialNotFound
+        false
+      end
+
+
+      # Add a new credential to the credentials
+      #
+      # @param [Hash] args
+      #
+      def add(*args)
+        params = { name: nil, group: nil, length: 128, value: nil, force: false }
+        case args.length
+        when 1
+          # add('foo')
+          params[:name] = args.first
+        when 2
+          if args.all? { |a| a.is_a?(String) }
+            # add('my_app', 'foo')
+            params[:group], params[:name] = args
+          elsif args[1].is_a?(Hash)
+            # add('my_app', value: 'something')
+            # add('foo', length: 50)
+            params[:name] = args.first
+            params.merge!(args[1])
+          end
+        when 3
+          # add('my_app', 'foo', value: 'something')
+          # add('my_app', 'foo', length: 50)
+          params[:group], params[:name] = args[0], args[1]
+          params.merge!(args[2])
+        else
+          raise ArgumentError, "wrong number of arguments (given #{args.length}, expected 1-3)"
+        end
+
+        add_from_params(params)
+      end
+      alias_method :<<, :add
+
+      # Add the contents of a file as a credential after
+      # verifying that the file can be read.
+      # Usage:
+      #   add_from_file(filename, "secretname")
+      #   add_from_file(filename, "groupname", "secretname")
+      #
+      #  Anything added from file will automatically be frozen.
+      #`add`'s options are not supported.
+      #
+      def add_from_file(filepath, *args)
+        unless File.readable?(filepath)
+          raise Veil::FileNotReadable.new("Cannot read #{filepath}")
+        end
+        add(*args, value: File.read(filepath),
+                   frozen: true)
+      end
+
+      def remove(group_or_cred, cred = nil)
+        if group_or_cred && cred && credentials.key?(group_or_cred)
+          credentials[group_or_cred].delete(cred)
+        else
+          credentials.delete(group_or_cred)
+        end
+      end
+      alias_method :delete, :remove
+
+      def rotate_hasher
+        @hasher = Veil::Hasher.create
+        rotate_credentials
+      end
+
+      def rotate_credentials
+        credentials.each do |cred_or_group_name, cred_or_group|
+          if cred_or_group.is_a?(Veil::Credential)
+            cred_or_group.rotate(hasher)
+          else
+            cred_or_group.each { |_group, cred| cred.rotate(hasher) }
+          end
+        end
+      end
+
+      private
+
+      def add_from_params(params)
+        params[:name] = params[:name].to_s
+
+        if params[:value]
+          params[:length] = params[:value].length
+        else
+          params[:value] = hasher.encrypt(params[:group], params[:name], 0)
+        end
+
+        # Set frozen to true if force has been set and frozen hasn't otherwise been set
+        params[:frozen] ||= (params[:force] && params[:frozen].nil?)
+        v = Veil::Credential.new(params)
+
+        if params[:group]
+          credentials[params[:group]] ||= {}
+
+          return credentials[params[:group]][params[:name]] if credentials[params[:group]].key?(params[:name]) && !params[:force]
+
+          credentials[params[:group]][params[:name]] = v
+        else
+          return credentials[params[:name]] if credentials.key?(params[:name]) && !params[:force]
+
+          credentials[params[:name]] = v
+        end
+      end
+
+
+      def expand_credentials_hash(creds_hash)
+        expanded = Hash.new
+
+        creds_hash.each do |cred_or_group_name, cred_or_group_attrs|
+          if cred_or_group_attrs.key?(:type) && cred_or_group_attrs[:type] == "Veil::Credential"
+            expanded[cred_or_group_name.to_s] = Veil::Credential.create(cred_or_group_attrs)
+          else
+            cred_or_group_attrs.each do |name, opts|
+              expanded[cred_or_group_name.to_s] ||= Hash.new
+              expanded[cred_or_group_name.to_s][name.to_s] = Veil::Credential.create(opts)
+            end
+          end
+        end
+
+        expanded
+      end
+
+      def credentials_as_hash
+        hash = Hash.new
+
+        credentials.each do |cred_or_group_name, cred_or_group_attrs|
+          if cred_or_group_attrs.is_a?(Hash)
+            cred_or_group_attrs.each do |name, cred|
+              hash[cred_or_group_name] ||= Hash.new
+              hash[cred_or_group_name][name] = cred.to_hash
+            end
+          else
+            hash[cred_or_group_name] = cred_or_group_attrs.to_hash
+          end
+        end
+
+        hash
+      end
+    end
+  end
+end