env_parameter_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbf25d569b937dcffde68920afecd4d5a06d7aee495b47e5f15c07fe9f1aa6c1
+  data.tar.gz: 9e7acde14c0a14c6a87c861c4a9926e5b07d8b0ab458f2545a4da53a3c2319dc
+SHA512:
+  metadata.gz: 4226cd3a2d3001463a344113df08e9a251288afc1a30f5f3a0fa84453c4a999fb9509cdb26faaca8fa2caf57fb5f9043bf8efa0874b96882347eb0215be9cc90
+  data.tar.gz: 5721a8c7972b624fd2058ab241dee5ee68a4900c1d0a401c945904164683f5030a12d50f344e8ac02efcb7518d531f6fc8ecff7e57f119efde3f1a4f95d43f90

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sangyong-sim@cookpad.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in env_parameter_store.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    env_parameter_store (0.1.0)
+      aws-sdk-ssm (~> 1.54)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.0.3)
+    aws-partitions (1.199.0)
+    aws-sdk-core (3.62.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ssm (1.54.0)
+      aws-sdk-core (~> 3, >= 3.61.1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    jmespath (1.4.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  env_parameter_store!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sangyong Sim
+
+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,65 @@
+# EnvParameterStore
+
+This gem aims to inject secrets to ENV from AWS Systems Manager Parameter Store
+on production envionment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'env_parameter_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install env_parameter_store
+
+## Usage
+
+```json
+// .secret.json
+{
+  "prefix": "/secrets/app/",
+  "parameters": [
+    "SECRET_KEY_BASE",
+    "DATABASE_PASSWORD"
+  ]
+}
+```
+
+This configuration try to inject below pairs to ENV:
+
+- `SECRET_KEY_BASE`: <parameter value from `/secrets/app/SECRET_KEY_BASE`>
+- `DATABASE_PASSWORD`: <parameter value from `/secrets/app/DATABASE_PASSWORD`>
+
+## Requirement
+
+Application which try to fetch secrets from Parameter Store should have proper
+permission of parameter. This gem uses `GetParameters`, so next 2 actions are
+enough in most cases.
+
+- `ssm:GetParameters`
+- `kms:Decrypt`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/riseshia/env_parameter_store. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EnvParameterStore project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/riseshia/env_parameter_store/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "env_parameter_store/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "env_parameter_store"
+  spec.version       = EnvParameterStore::VERSION
+  spec.authors       = ["Shia"]
+  spec.email         = ["rise.shia@gmail.com"]
+
+  spec.summary       = %q{Inject secrets to ENV.}
+  spec.description   = %q{Inject secrets to ENV from AWS Systems Manager Parameter Store.}
+  spec.homepage      = "https://github.com/riseshia/env_parameter_store"
+  spec.license       = "MIT"
+
+  # 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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "aws-sdk-ssm", "~> 1.54"
+end

data/lib/env_parameter_store.rb

@@ -0,0 +1,103 @@
+require "env_parameter_store/version"
+
+require "aws-sdk-ssm"
+require "json"
+
+module EnvParameterStore
+  class Error < StandardError; end
+
+  class NoSuchFileError < Error
+    def initialize(filename)
+      super("Can not find envfile: #{filename}")
+    end
+  end
+
+  class InvalidJSONError < Error
+    def initialize(filename)
+      super("`#{filename}` is not valid json.")
+    end
+  end
+
+  class InvalidFormatError < Error
+    def initialize
+      super("Configuration has invalid format. `prefix` (string) and `parameters` (string list) is required.")
+    end
+  end
+
+  class InvalidParameterError < Error
+    def initialize(invalid_parameters)
+      subjects = invalid_parameters.map { |s| "`#{s}`" }.join(', ')
+      super("Fail to fetch some parameters: #{subjects}.")
+    end
+  end
+
+
+  DEFAULT_ENV_FILENAME = ".secret.json".freeze
+
+  class << self
+    # Inject secrets from AWS Systems Manager Parameter Store to `ENV`.
+    # secrets list is listed on `.secret`.
+    # EnvParameterStore will be overwrite if corresponding value exists
+    # @param [String] filename
+    # @return [Hash] env
+    def inject(filename = DEFAULT_ENV_FILENAME)
+      filename = File.expand_path(filename.to_s)
+      config = load_config(filename)
+      secrets = fetch_secrets(config)
+      ENV.update(secrets)
+    end
+
+    private
+
+    def load_config(filename)
+      config_json = JSON.parse(File.read(filename))
+      EnvParameterStore::Config.new(config_json)
+    rescue Errno::ENOENT
+      raise NoSuchFileError.new(filename)
+    rescue JSON::ParserError
+      raise InvalidJSONError.new(filename)
+    end
+
+    def fetch_secrets(config)
+      client = Aws::SSM::Client.new
+      resp = client.get_parameters(
+        names: config.parameter_names,
+        with_decryption: true,
+      )
+      unless resp.invalid_parameters.empty?
+        raise InvalidParameterError.new(resp.invalid_parameters)
+      end
+      resp.parameters.each_with_object({}) do |parameter, secrets|
+        key = config.to_name(parameter.name)
+        secrets[key] = parameter.value
+      end
+    end
+  end
+
+  class Config
+    def initialize(config_json)
+      unless config_json.key?('prefix') \
+          && config_json.key?('parameters') \
+          && config_json.fetch('prefix').is_a?(String) \
+          && config_json.fetch('parameters').is_a?(Array) \
+          && config_json.fetch('parameters').all? { |key| key.is_a?(String) }
+        raise EnvParameterStore::InvalidJSONError.new
+      end
+
+      prefix = config_json.fetch('prefix')
+      @qualified_names_to_names = config_json.fetch('parameters').each_with_object({}) do |key, table|
+        table[prefix + key] = key
+      end
+    end
+
+    def to_name(qualified_name)
+      @qualified_names_to_names.fetch(qualified_name)
+    end
+
+    def parameter_names
+      @qualified_names_to_names.keys
+    end
+  end
+end
+
+require 'env_parameter_store/rails' if defined?(Rails)

data/lib/env_parameter_store/rails.rb

@@ -0,0 +1,14 @@
+module EnvParameterStore
+  class Railtie < ::Rails::Railtie
+
+    config.before_configuration { inject_secrets }
+
+    def inject_secrets
+			EnvParameterStore.inject(root.join(EnvParameterStore::DEFAULT_ENV_FILENAME))
+    end
+
+    def root
+      Rails.root || Pathname.new(ENV['RAILS_ROOT'] || Dir.pwd)
+    end
+  end
+end

data/lib/env_parameter_store/version.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: env_parameter_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+description: Inject secrets to ENV from AWS Systems Manager Parameter Store.
+email:
+- rise.shia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- env_parameter_store.gemspec
+- lib/env_parameter_store.rb
+- lib/env_parameter_store/rails.rb
+- lib/env_parameter_store/version.rb
+homepage: https://github.com/riseshia/env_parameter_store
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Inject secrets to ENV.
+test_files: []