secrets_parser 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30084b08de2283f2b2c3bb313c3dfbe3d57ca15d
+  data.tar.gz: 2715b1bc6044484f8a63f4b368c6c7223da8ae60
+SHA512:
+  metadata.gz: 0c8201ba248c880d24856bcb9b0499342ca2d854254af2779821997801ceeacfc894eddf90142811c5866d1a5808490d814f83fc0ce72c9c5b9717ddf5371701
+  data.tar.gz: ecf987be6b1e3f5eac87e55642e9636088d77ef7b7673dc48e3069d2e3853fb89c34f570f2025337ddb9a3f6248a3c9fadd7eebb35dc90288bc0bcb155cf184e

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 josacar@users.noreply.github.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'
+
+gem 'aws-sdk-s3', '~> 1'
+
+# Specify your gem's dependencies in secrets-parser.gemspec
+gemspec

data/README.md

@@ -0,0 +1,93 @@
+# Secrets Parser
+
+This gem parse the secrets reading a field in a JSON file, download the encrypted secrets file from S3 and change the values for the encrypted ones.
+
+## Usage
+
+For using correctly this gem, we will need 4 basic things: a JSON file to parse, an S3 bucket and a JSON file encrypted with a AWS KMS key that will store the secret values.
+
+#### JSON File to parse
+
+This file is where there are going to be the references to the secrets in S3. Example:
+
+```
+{
+    "variables": {
+      "MY_SECRET": "secret:bucket_name/path:my_secret",
+      "OTHER_SECRET": "secret:bucket_name/path:other_secret"
+    }
+}
+```
+
+The example has 2 secrets in it, these references have 3 parts:
+
+* `secret:` : This is needed to let the gem idetify that the value is a reference to a secret.
+* `bucket_name/path` : Path where is located the secret file, bucket_name + path, the extension of the file is inside the gem and it's `json.encrypted`, so in this case, there is a file in this bucket named *secret-testing.json.encrypted*.
+* `:my_secret` and `:other_secret` : That's the key that's inside the encrypted file.
+
+*This allow us to let the secret managers decide where to put those secrets*
+
+#### KMS Key
+
+AWS KMS key used to encrypt the secrets and the S3 bucket where secrets are going to be stored.
+
+#### S3 Bucket
+
+Just a AWS S3 Bucket, it's recommended to have it encrypted at rest too with the same KMS key.
+
+#### Encrypted JSON file
+
+Here is where secrets are going to be stored, a simple JSON with all the keys and secrets. Example:
+
+```
+{
+  "my_secret": "This is a secret weeee",
+  "other_secret": "PINCODE: 12345"
+}
+```
+
+After configuring it, encrypt it with:
+```
+aws kms encrypt --key-id $YOUR_KMS_KEY_ID --plaintext fileb://YOUR_FILE.json --output text --query CiphertextBlob | base64 --decode > YOUR_FILE.json.encrypted
+```
+
+After that, upload it to your S3 and copy the reference in your JSON.
+
+### Usage example
+
+First, set the AWS credentials needed for accesing the S3 bucket and decrypting files.
+
+**Ruby example code:**
+
+```
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'secrets_parser'
+require 'aws-sdk-s3'
+
+file_json = './app.json' #Path to your json file to be parsed, now using the described in the example
+field_to_parse = 'variables' # Field to parse
+
+parser = Secrets::Parser.new
+parser.set_config do |config|
+  config[:s3_client] = Aws::S3::Client.new(region: ENV['AWS_DEFAULT_REGION'])
+  config[:kms_client] = Aws::KMS::Client.new(region: ENV['AWS_DEFAULT_REGION'])
+end
+
+parsed_file = parser.parse(file_json, field_to_parse)
+
+puts JSON.pretty_generate(parsed_file)
+
+```
+
+**Output:**
+
+```
+{
+  "variables": {
+    "my_secret": "This is a secret weeee",
+    "other_secret": "PINCODE: 12345"
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/secrets_parser/helpers.rb

@@ -0,0 +1,12 @@
+module Secrets
+  module Helpers
+    def self.expand_param_from_env(value)
+      dollar_match_expression = /\$([A-Za-z0-9_]*)/
+      value.scan(dollar_match_expression).each do |match|
+        break unless ENV.include? match[0]
+        value = value.gsub("$#{match[0]}", ENV[match[0]])
+      end
+      value
+    end
+  end
+end

data/lib/secrets_parser/parser.rb

@@ -0,0 +1,101 @@
+require 'json'
+require 'aws-sdk-s3'
+require_relative 'helpers'
+
+module Secrets
+  class Parser
+    SECRETS_FILE_SUFFIX = '.json.encrypted'.freeze
+
+    def initialize
+      @config = {
+        s3_client: nil,
+        kms_client: nil
+      }
+    end
+
+    def set_config
+      yield @config
+    end
+
+    def parse(file_to_parse, field_to_parse)
+      Aws.config.update(
+        region: ENV['AWS_DEFAULT_REGION']
+      )
+
+      app_json = JSON.parse(IO.read(file_to_parse))
+      app_variables = app_json[field_to_parse]
+
+      app_json[field_to_parse] = parse_secrets_from app_variables
+
+      app_json
+    end
+
+    private
+
+    def secret?(string)
+      if string.is_a? String
+        string.start_with? 'secret:'
+      else
+        false
+      end
+    end
+
+    def secret_file_path_from(secret)
+      secret_file_path = secret[secret.index(':') + 1..secret.rindex(':') - 1]
+      Helpers.expand_param_from_env secret_file_path
+    end
+
+    def secret_key_from(secret)
+      secret[secret.rindex(':') + 1..secret.length]
+    end
+
+    def download(file)
+      bucket_name = file[0, file.index('/')]
+      file = file[file.index('/') + 1..file.length] + SECRETS_FILE_SUFFIX
+      tmp_file = "/tmp/secrets#{SECRETS_FILE_SUFFIX}"
+
+      File.open(tmp_file, 'wb') do |secret_file|
+        @config[:s3_client].get_object({ bucket: bucket_name, key: file }, target: secret_file)
+      end
+
+      tmp_file
+    end
+
+    def decrypt(file)
+      kms = @config[:kms_client]
+
+      kms.decrypt(
+        ciphertext_blob: IO.read(file)
+      )
+    end
+
+    def extract_secrets_from(secret_file)
+      encrypted_secrets_file = download secret_file
+      decrypted_secrets_file = decrypt encrypted_secrets_file
+
+      JSON.parse(decrypted_secrets_file.plaintext)
+    end
+
+    def parse_secrets_from(variables)
+      secret_variables = {}
+
+      variables.each_pair do |k, v|
+        next unless secret? v
+
+        secret = v
+
+        secret_file = secret_file_path_from(secret)
+        secret_key = secret_key_from(secret)
+
+        unless secret_variables.key? secret_file
+          secret_variables[secret_file] = extract_secrets_from secret_file
+        end
+
+        variables[k] = secret_variables[secret_file][secret_key]
+      end
+
+      variables
+    end
+
+  end
+end

data/lib/secrets_parser/version.rb

@@ -0,0 +1,3 @@
+module SecretsParser
+  VERSION = "0.0.5"
+end

data/lib/secrets_parser.rb

@@ -0,0 +1,2 @@
+require 'secrets_parser/version'
+require 'secrets_parser/parser'

data/secrets_parser.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'secrets_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'secrets_parser'
+  spec.version       = SecretsParser::VERSION
+  spec.license       = 'MIT'
+  spec.authors       = ['Paco Sanchez']
+  spec.email         = ['sanchezpaco@users.noreply.github.com']
+
+  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/peertransfer/secrets_parser'
+
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = 'https://travis-ci.org/'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  files = Dir['lib/**/*.rb', 'bin/*']
+  rootfiles = ['Gemfile', 'secrets_parser.gemspec', 'README.md', 'Rakefile', 'CODE_OF_CONDUCT.md']
+  dotfiles = []
+  spec.files = files + rootfiles + dotfiles
+
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: secrets_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Paco Sanchez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !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: Write a longer description or delete this line.
+email:
+- sanchezpaco@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/secrets_parser.rb
+- lib/secrets_parser/helpers.rb
+- lib/secrets_parser/parser.rb
+- lib/secrets_parser/version.rb
+- secrets_parser.gemspec
+homepage: https://github.com/peertransfer/secrets_parser
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []