secrets-manager 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9881f60a1a1f81f48e84d02a99ce4b99970ef8ca534415fb4b3a343833264609
+  data.tar.gz: 5203cca0dc0456e337e073fe141cf4f850bf2e680aef2952c2a3833505e0417a
+SHA512:
+  metadata.gz: cc8fca98711dcd170126c276da1809ab266d699726d8469712c3e0299acf833b798dacd6834a0ba56cbfb6c0450cf9c90ff45ecb1cb7dfb198b7baf5965f6c39
+  data.tar.gz: ceb8a360399a5bdf04c2ef38969ba88537a231b2a4b0c3f2066798e59adbed67fe5f8662bbf46dec2cc269b74e2324ab25d1d782d2ec7f5020f89308e1daefab

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    secrets-manager (1.0.0)
+      aws-sdk-secretsmanager (>= 1.31.0)
+      concurrent-ruby (>= 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.0.3)
+    aws-partitions (1.213.0)
+    aws-sdk-core (3.68.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-secretsmanager (1.31.0)
+      aws-sdk-core (~> 3, >= 3.61.1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    jmespath (1.4.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  secrets-manager!
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,71 @@
+# SecretsManager.rb
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'secrets-manager'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install secrets-manager
+
+## Usage
+
+To use this gem, you must have an AWS account and permissions to setup secret values using [Secrets Manager](https://aws.amazon.com/secrets-manager/)
+
+This gem makes assumptions and has requirements about how you should be storing your secrets.
+
+### Path Name
+This gem uses the concept of env specific secrets within the same account. While separate AWS accounts can be used to maintain separation, it can be desirable to use a single account.
+
+The path format is as follows: `{{secret_env}}/{{secret_path}}`. When using this gem you would leave the `secret_env` out of your request.
+
+For example, to access the secret `twlio-key`, `$secrets.fetch('twilio-key')`. This would be stored in AWS SM as `dev/twilio-key`.
+
+### Payload
+This gem expects your secret value to be a JSON object. The only required key is `value`. The following keys are optional:
+* `ttl` - Time to live in seconds. Describes how long the secret should live in in-memory cache.
+* `encoding` - Currently, only `base64` is supported as a value. If your `value` is base64 encoded, this will result in a returned secret that is base64 decoded.
+
+Example:
+```
+{"value": "secretvalue", "ttl": 60} // Will live in cache for 60 seconds.
+```
+
+```
+{"value": "c2VjcmV0dmFsdWU=", "ttl": 60, "encoding": "base64"} // Will live in cache for 60 seconds and is base64 encoded. Result will be "secretvalue"
+```
+
+### Configuration
+The follow ENV vars are expected:
+* `AWS_SECRETS_ENV` - preceeds all path lookups, ex: `dev`, `staging`, `qa`, `production`
+* `AWS_SECRETS_KEY` - AWS IAM access key
+* `AWS_SECRETS_SECRET` - AWS IAM access secret
+
+The manager should be created at boot time, in an initializer for example, and stored as a constant or global.
+```
+$secrets = SecretsManager.new
+```
+
+### Lookup
+```
+$secrets.fetch('services/twilio/api-key')
+$secrets['services/twilio/api-key']
+```
+
+## 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/[USERNAME]/secrets-manager.

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 "secrets-manager"
+
+# 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/secrets-manager.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "version"
+require "aws-sdk-secretsmanager"
+require "concurrent-ruby"
+require "json"
+
+module SecretsManager
+  class SecretNotFound < StandardError; end;
+
+  def self.new(**args)
+    Manager.new(**args)
+  end
+
+  class Cache
+    def initialize
+      @_cache = Concurrent::Map.new
+    end
+
+    def reset
+      @_cache = Concurrent::Map.new
+    end
+
+    def set(path, value, ttl = 86400)
+      @_cache[path] = {expires_at: (Time.now + ttl), value: value}
+      return self
+    end
+
+    def find(path)
+      fetched = @_cache[path]
+      return unless fetched
+      return unless !fetched[:expires_at].nil? && (fetched[:expires_at]) > Time.now
+      fetched[:value]
+    end
+  end
+
+  class Manager
+    attr_reader :cache
+
+    def initialize(client: nil)
+      @cache = Cache.new
+      @aws_client = client
+    end
+
+    def secret_env
+      ENV['AWS_SECRETS_ENV'] || ENV['RACK_ENV'] || dev
+    end
+
+    def client
+      return @aws_client if @aws_client
+
+      @_client ||= Aws::SecretsManager::Client.new({
+        region: ENV.fetch('AWS_SECRETS_REGION', 'us-east-1'),
+        credentials: Aws::Credentials.new(ENV['AWS_SECRETS_KEY'], ENV['AWS_SECRETS_SECRET'])
+      })
+    end
+
+    def fetch(secret_path)
+      resolved_path = secret_env + '/' + secret_path
+
+      cached_value = cache.find(resolved_path)
+      return cached_value if cached_value
+
+      response = client.get_secret_value(secret_id: resolved_path)
+      return nil unless response && response.secret_string
+      object = JSON.parse(response.secret_string, symbolize_names: true)
+
+      value = parse_value(object)
+      set_in_memory(resolved_path, value, parse_ttl(object))
+      return value
+    rescue Aws::SecretsManager::Errors::ResourceNotFoundException => e
+      raise SecretsManager::SecretNotFound, "Could not find secret with path #{resolved_path}"
+    end
+
+    def [](path)
+      fetch(path)
+    end
+
+    private
+    def parse_ttl(data)
+      ## Default to one day cache TTL
+      return 86400 unless data[:ttl].present?
+      data[:ttl].to_i
+    end
+
+    def parse_value(data)
+      value = data[:value]
+
+      if data[:encoding].present?
+        case data[:encoding]
+        when "base64"
+          value = Base64.strict_decode64(value)
+        end
+      end
+
+      return value
+    end
+
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module SecretsManager
+  VERSION = "1.0.0"
+end

data/secrets-manager.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "secrets-manager"
+  spec.version       = SecretsManager::VERSION
+  spec.authors       = ["Christopher Ostrowski", "Matt Hooks", "Evan Waters"]
+  spec.email         = ["chris@dutchie.com", "matt.hooks@dutchie.com", "evan.waters@dutchie.com"]
+
+  spec.summary       = %q{Ruby + AWS Secrets Manager}
+  spec.description   = %q{Ruby AWS Secrets Manager interface. Allows for env specific secrets, in-memory caching with custom TTL, file storage, and simple API.}
+  spec.homepage      = "https://github.com/GetDutchie/SecretsManager"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/GetDutchie/SecretsManager.git"
+  spec.metadata["changelog_uri"] = "https://github.com/GetDutchie/SecretsManager/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "concurrent-ruby", ">= 1.0"
+  spec.add_dependency 'aws-sdk-secretsmanager', '>= 1.31.0'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: secrets-manager
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christopher Ostrowski
+- Matt Hooks
+- Evan Waters
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-secretsmanager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Ruby AWS Secrets Manager interface. Allows for env specific secrets,
+  in-memory caching with custom TTL, file storage, and simple API.
+email:
+- chris@dutchie.com
+- matt.hooks@dutchie.com
+- evan.waters@dutchie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/secrets-manager.rb
+- lib/version.rb
+- secrets-manager.gemspec
+homepage: https://github.com/GetDutchie/SecretsManager
+licenses: []
+metadata:
+  homepage_uri: https://github.com/GetDutchie/SecretsManager
+  source_code_uri: https://github.com/GetDutchie/SecretsManager.git
+  changelog_uri: https://github.com/GetDutchie/SecretsManager/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby + AWS Secrets Manager
+test_files: []