sfn-vault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afddfb50a567945cd55c510fc814a1c76bd61fef
+  data.tar.gz: 27af7c5cf81476ee3dff5f5491d2830a239e47bc
+SHA512:
+  metadata.gz: 908d0c89f8864fc7931baf40c684a75921ddd632b1f1057456eb088ee7acfde5e6fd303e0c9f360c381ee764ae89dc370497b1584db7f9ec6e96def7aed0b03b
+  data.tar.gz: 8dde9774a60ae9d7f566b9f3fe2e6ee7c11566b5201f51a3a9149e4e5c67f0b77d1fdf3defcb5ba4f9738d4533a49827c13e9ab51e75be82e879bdf9ede3b53b

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.1.0
+* Initial release

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 2016 Chris Roberts
+
+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/README.md

@@ -0,0 +1,68 @@
+# SparkleFormation Vault Read Callback
+
+Provides a mechanism to read dynamic credentials for use with AWS Orchestration
+APIs from a [Vault](https://www.vaultproject.io/intro/getting-started/dynamic-secrets.html) secret backend.
+
+Currently supported cloud providers:
+
+* AWS
+
+On initial usage this will read the configured vault path to obtain temporary
+aws credentials and cache them locally in `.sfn-vault`. When the lease expires a
+new credential will be requested.
+
+## Usage
+
+Make the callback available by adding it to the bundle via the
+project's Gemfile:
+
+~~~ruby
+group :sfn do
+  gem 'sfn-vault
+end
+~~~
+
+### Vault Read
+
+#### Enable
+
+The `sfn-vault` callback is configured via the `.sfn`
+configuration file. First the callback must be enabled:
+
+~~~ruby
+Configuration.new do
+  callbacks do
+    require ['sfn-vault]
+    default ['vault_read]
+  end
+end
+~~~
+
+#### Configuration
+
+The default read path is `aws/creds/deploy` and will be used without
+configuration but it is customizable. 
+
+Vault read configuration is controlled within the `.sfn` file:
+
+~~~ruby
+
+Configuration.new
+  credentials do
+    #  Remote provider name
+    provider :aws
+    #  AWS credentials information can be empty
+    aws_access_key_id ""
+    aws_secret_access_key ""
+    aws_region 'us-east-1'
+    aws_bucket_region 'us-east-1'
+    # read path for vault client
+    vault_read_path 'awsqa/creds/auto_deploy'
+  end
+end
+~~~
+
+# Info
+
+* Repository: https://github.com/webframp/sfn-vault
+* IRC: Freenode @ #sparkleformation

data/bin/coderay

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("coderay", "coderay")

data/bin/generate_sparkle_docs

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'generate_sparkle_docs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("sparkle_formation", "generate_sparkle_docs")

data/bin/graph

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'graph' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("graph", "graph")

data/bin/pry

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("pry", "pry")

data/bin/sfn

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'sfn' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("sfn", "sfn")

data/lib/sfn-vault.rb

@@ -0,0 +1,152 @@
+require 'sfn'
+require 'vault'
+
+require 'sfn-vault/version'
+
+# Modeled after the Assume Role callback
+module Sfn
+  class Callback
+    class VaultRead < Callback
+
+      # Cache credentials for re-use to prevent re-generation of temporary
+      # credentials on every command request.
+      VAULT_CACHED_ITEMS = [
+        :vault_lease_id,
+        :vault_lease_expiration,
+        :aws_access_key_id,
+        :aws_secret_access_key
+      ]
+
+      # Inject credentials read from vault path
+      # into API provider configuration
+      def after_config(*_)
+        # if credentials block contains vault_read_path
+        if(enabled? && config.fetch(:credentials, :vault_read_path))
+          load_stored_session
+        end
+      end
+
+      # Store session credentials until lease expires
+      def after(*_)
+        if(enabled?)
+          if(config.fetch(:credentials, :vault_read_path) && api.connection.aws_region)
+            path = cache_file
+            FileUtils.touch(path)
+            File.chmod(0600, path)
+            values = load_stored_values(path)
+            VAULT_CACHED_ITEMS.map do |key|
+              values[key] = api.connection.data[key]
+            end
+            File.open(path, 'w') do |file|
+              file.puts MultiJson.dump(values)
+            end
+          end
+        end
+      end
+
+      # @return [TrueClass, FalseClass]
+      def enabled?
+        config.fetch(:vault, :status, 'enabled').to_s == 'enabled'
+      end
+
+      # @return String path
+     def cache_file
+        config.fetch(:vault, :cache_file, '.sfn-vault')
+     end
+
+      # @param [FixNum] expiration
+      # @return [TrueClass, FalseClass]
+      # check lease is just: time.now greater than lease expires?
+      def expired?(expiration)
+        Time.now.to_i > expiration
+      end
+
+      def vault_addr
+        address = config.fetch(:vault, :vault_addr, ENV['VAULT_ADDR'])
+        if address.nil?
+          ui.error 'Set vault_addr in .sfn or VAULT_ADDR in environment'
+        end
+        address
+      end
+
+      def vault_token
+        token = config.fetch(:vault, :vault_token, ENV['VAULT_TOKEN'])
+        if token.nil?
+          ui.error 'Set :vault_token in .sfn or VAULT_TOKEN in environment'
+        end
+        token
+      end
+
+      # @return [Object] of type Vault::Secret
+      def vault_read
+        require 'vault'
+        client = Vault::Client.new(address: vault_addr, token: vault_token)
+        read_path = config.fetch(:credentials, :vault_read_path, "aws/creds/deploy") # save this value?
+        retries = config.fetch(:vault, :retries, 5)
+        credential = client.with_retries(Vault::HTTPError, attempts: retries) do
+          client.logical.read(read_path)
+        end
+        credential
+      end
+
+      # Load stored configuration data into the api connection
+      # or read retrieve with Vault client
+      # @return [TrueClass, FalseClass]
+      def load_stored_session
+        path = cache_file
+        FileUtils.touch(path)
+        if(File.exist?(path))
+          values = load_stored_values(path)
+          VAULT_CACHED_ITEMS.each do |key|
+            api.connection.data[key] = values[key]
+          end
+          if values[:vault_lease_expiration].nil?
+            values[:vault_lease_expiration] = 0
+          end
+          if(expired?(values[:vault_lease_expiration]))
+            ui.debug "No credential or lease expired"
+            begin
+              secret = vault_read
+              ui.debug "vault lease: #{secret.lease_id}"
+              # without the sleep the credentials are not ready
+              ui.info "Sleeping 30s for first time credentials system wide activation"
+              # this is arbitrary
+              sleep(30)
+              api.connection.data[:vault_lease_id] = secret.lease_id # maybe unused?
+              api.connection.data[:vault_lease_expiration] = Time.now.to_i + secret.lease_duration
+              # update keys in api connection
+              api.connection.data[:aws_access_key_id] = secret.data[:access_key]
+              api.connection.data[:aws_secret_access_key] = secret.data[:secret_key]
+            rescue
+            end
+          end
+          true
+        else
+          false
+        end
+      end
+
+      # Load stored values
+      #
+      # @param path [String]
+      # @return [Hash]
+      def load_stored_values(path)
+        begin
+          if(File.exist?(path))
+            MultiJson.load(File.read(path)).to_smash
+          else
+            Smash.new
+          end
+        rescue MultiJson::ParseError
+          Smash.new
+        end
+      end
+
+      # Default quiet mode
+      def quiet
+        true unless config[:debug]
+      end
+
+    end
+  end
+end

data/lib/sfn-vault/utils.rb

@@ -0,0 +1,37 @@
+require 'sfn-parameters'
+
+module SfnParameters
+  # Common helper methods
+  module Utils
+
+    # Lock the given content
+    #
+    # @param content [Hash] content to lock
+    # @return [Hash] locked content
+    def lock_content(content)
+      content = content.to_smash
+      content.merge!(:sfn_lock_enabled => true)
+      safe = SfnParameters::Safe.build(
+        config.fetch(:sfn_parameters, :safe, Smash.new)
+      )
+      safe.lock(dump_json(content))
+    end
+
+    # Unlock given content
+    #
+    # @param content [Hash] content to unlock
+    # @return [Hash] unlocked content
+    def unlock_content(content)
+      content = content.to_smash
+      if(content[:sfn_parameters_lock])
+        safe = SfnParameters::Safe.build(
+          config.fetch(:sfn_parameters, :safe, Smash.new)
+        )
+        load_json(safe.unlock(content)).to_smash.merge(:sfn_lock_enabled => true)
+      else
+        content
+      end
+    end
+
+  end
+end

data/lib/sfn-vault/version.rb

@@ -0,0 +1,3 @@
+module SfnVault
+  VERSION = Gem::Version.new('0.1.0')
+end

data/sfn-vault.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'sfn-vault/version'
+Gem::Specification.new do |s|
+  s.name = 'sfn-vault'
+  s.version = SfnVault::VERSION.version
+  s.summary = 'SparkleFormation Vault Callback'
+  s.author = 'Sean Escriva'
+  s.email = 'sean.escriva@gmail.com'
+  s.homepage = 'http://github.com/webframp/sfn-vault'
+  s.description = 'SparkleFormation Vault Callback'
+  s.license = 'Apache-2.0'
+  s.require_path = 'lib'
+  s.add_dependency 'sfn', '>= 3.0', '< 4.0'
+  s.add_dependency 'vault', '~> 0.7.3'
+  s.add_development_dependency 'pry', '~> 0.10.4'
+  s.add_development_dependency 'pry-coolline'
+  s.files = Dir['{lib,bin,docs}/**/*'] + %w(sfn-vault.gemspec README.md CHANGELOG.md LICENSE)
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: sfn-vault
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Escriva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sfn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: vault
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  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: SparkleFormation Vault Callback
+email: sean.escriva@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/coderay
+- bin/generate_sparkle_docs
+- bin/graph
+- bin/pry
+- bin/sfn
+- lib/sfn-vault.rb
+- lib/sfn-vault/utils.rb
+- lib/sfn-vault/version.rb
+- sfn-vault.gemspec
+homepage: http://github.com/webframp/sfn-vault
+licenses:
+- Apache-2.0
+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.6.8
+signing_key: 
+specification_version: 4
+summary: SparkleFormation Vault Callback
+test_files: []