securenv 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f63107fbe5ac5b33005bfa4db97f1b3b987515ecbdcb648c09a3ccd023b03b6
-  data.tar.gz: c382b315f8b188efced85c4858712d0882dfe51967ea7cc2bf415b302fc71f40
+  metadata.gz: f98e4349739d04c45f76ef3065a0c1929910fe9e9b29332d0a1d384cd69a6a73
+  data.tar.gz: 23abb50be1835f36adea2c3a76d28aa7cda2997951d08bdfef49b4bbd1a1d969
 SHA512:
-  metadata.gz: 35025041a33a6b81ddfaff091739956c57bab545f508a22292ffa48b35850b1f1ed94f529fe4585f36299347060bbb702783c47069341196e80e5d91b25a769e
-  data.tar.gz: 17a32dc426af2967aced874ba9430b1432dc41861da4718dd69e991a03513e21c1c5124178c396f7e85e4f726fa63137d3ac946be0a558994f81424f37f548b4
+  metadata.gz: d0298049140580e3a89db7abf0a5dee76c14b5202e101a10fd41b2cd0946d9fdb835825397529fc30848e4b310f7e81d75eaa5a697a485ef6692de9b37d9a59c
+  data.tar.gz: 165c89584a73624004788ba1b11d4dbf9ca653ef60b1b3405b2417a3c614db5c5a6d94d9202138b45f75502c2da38d01351ad5d69daf083f54fb26151c992b13

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile.lock

@@ -1,13 +1,36 @@
 PATH
   remote: .
   specs:
-    securenv (0.1.0)
+    securenv (0.1.1)
+      aws-sdk-ssm
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aws-eventstream (1.1.1)
+    aws-partitions (1.471.0)
+    aws-sdk-core (3.115.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ssm (1.111.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.3)
+      aws-eventstream (~> 1, >= 1.0.2)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
+    docile (1.4.0)
+    hashdiff (1.0.1)
+    jmespath (1.4.0)
+    public_suffix (4.0.6)
     rake (12.3.3)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -21,6 +44,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    thor (1.1.0)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -29,6 +63,8 @@ DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
   securenv!
+  simplecov
+  webmock
 
 BUNDLED WITH
    2.1.4

data/exe/securenv

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../lib/securenv/cli/application"
+
+Securenv::CLI::Application.start(ARGV)

data/lib/securenv.rb

@@ -1,6 +1,9 @@
 require "securenv/version"
+require "securenv/client"
+require "securenv/parameter"
+
+require 'aws-sdk-ssm'
 
 module Securenv
-  class Error < StandardError; end
-  # Your code goes here...
+  class ParameterNotFoundError < StandardError; end
 end

data/lib/securenv/cli/application.rb

@@ -0,0 +1,88 @@
+require "thor"
+require "securenv"
+
+module Securenv
+  module CLI
+    class Application < Thor
+      # This makes thor report the correct exit code in the event of a failure.
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "set VAR=value", "set a secure environment variable"
+      option :app, :required => true, :aliases => "-a", :desc => "The name of the app."
+      option :stage, :required => true, :aliases => "-s", :desc => "The name of the stage."
+      def set(var)
+        variable, value = var.split('=')
+        if value.nil?
+          raise Thor::Error.new "You must supply a value for #{variable}. To unset a value you can use : securenv unset #{variable}"
+        end
+        client = Securenv::Client.new({
+          app: options[:app],
+          stage: options[:stage]
+        })
+        parameter = client.set({
+          variable: variable,
+          value: value,
+        })
+
+        puts "Set value for parameter name #{parameter.name} for version #{parameter.version}"
+      end
+
+      desc "get VAR", "get the current value of a secure environment variable"
+      option :app, :required => true, :aliases => "-a", :desc => "The name of the app."
+      option :stage, :required => true, :aliases => "-s", :desc => "The name of the stage."
+      def get(var)
+        client = Securenv::Client.new({
+          app: options[:app],
+          stage: options[:stage]
+        })
+        parameter = client.get({
+          variable: var
+        })
+
+        puts "#{parameter.var_name}: #{parameter.value}"
+      rescue Securenv::ParameterNotFoundError => e
+        puts e.to_s
+      end
+
+      desc "unset VAR", "remove a secure environment variable"
+      option :app, :required => true, :aliases => "-a", :desc => "The name of the app."
+      option :stage, :required => true, :aliases => "-s", :desc => "The name of the stage."
+      def unset(var)
+        client = Securenv::Client.new({
+          app: options[:app],
+          stage: options[:stage]
+        })
+        parameter = client.unset({
+          variable: var
+        })
+
+        puts "#{parameter.name} was removed"
+      rescue Securenv::ParameterNotFoundError => e
+        puts e.to_s
+      end
+
+      desc "list", "list all secure environment variables for an app and stage"
+      option :app, :required => true, :aliases => "-a", :desc => "The name of the app."
+      option :stage, :required => true, :aliases => "-s", :desc => "The name of the stage."
+      def list
+        client = Securenv::Client.new({
+          app: options[:app],
+          stage: options[:stage]
+        })
+        parameters = client.list
+        if parameters.any?
+          parameters.each do |param|
+            puts "#{param.var_name}: #{param.value}"
+          end
+        else
+          puts "No securenv variables are present for this app and stage"
+        end
+
+      rescue Securenv::ParameterNotFoundError => e
+        puts e.to_s
+      end
+    end
+  end
+end

data/lib/securenv/client.rb

@@ -0,0 +1,99 @@
+module Securenv
+  class Client
+    attr_reader :app
+    attr_reader :stage
+    def initialize(app:, stage:)
+      @app = app
+      @stage = stage
+    end
+
+    def set(variable:, value:)
+      parameter_name = parameter_name_for(variable)
+
+      resp = ssm_client.put_parameter({
+        name: parameter_name,
+        description: "Set via securenv",
+        value: value,
+        type: "SecureString",
+        #key_id: "ParameterKeyId",
+        overwrite: true,
+        tier: "Standard" # accepts Standard, Advanced, Intelligent-Tiering
+      })
+      parameter = Parameter.new(
+       name: parameter_name,
+       version: resp.version,
+       value: value
+      )
+
+      return parameter
+    end
+
+    def get(variable:)
+      parameter_name = parameter_name_for(variable)
+      resp = ssm_client.get_parameter({
+        name: parameter_name,
+        with_decryption: true
+      })
+      parameter = Parameter.new(
+       name: parameter_name,
+       version: resp.parameter.version,
+       value: resp.parameter.value
+      )
+
+      return parameter
+    rescue Aws::SSM::Errors::ParameterNotFound
+      raise ParameterNotFoundError.new "#{variable} is not set for app: #{app} and stage: #{stage}"
+    end
+
+    def unset(variable:)
+      parameter_name = parameter_name_for(variable)
+      ssm_client.delete_parameter({
+        name: parameter_name
+      })
+      parameter = Parameter.new(
+       name: parameter_name,
+       version: nil,
+       value: nil
+      )
+
+      return parameter
+    rescue Aws::SSM::Errors::ParameterNotFound
+      raise ParameterNotFoundError.new "#{variable} is not set for app: #{app} and stage: #{stage}"
+    end
+
+    def list
+      resp = ssm_client.get_parameters_by_path({
+        path: parameter_path,
+        with_decryption: true
+      })
+      parameters = resp.parameters.map do |param|
+        Parameter.new(
+          name: param.name,
+          version: param.version,
+          value: param.value
+        )
+      end
+
+      return parameters
+    end
+
+    def populate_env
+      parameters = list
+      parameters.each do |param|
+        ENV[param.var_name] = param.value
+      end
+    end
+
+    def parameter_path
+      "/#{app}/#{stage}"
+    end
+
+    def parameter_name_for(variable)
+      "#{parameter_path}/#{variable}"
+    end
+
+    def ssm_client
+      @ssm_client = Aws::SSM::Client.new
+    end
+  end
+end

data/lib/securenv/parameter.rb

@@ -0,0 +1,17 @@
+module Securenv
+  class Parameter
+    attr_reader :name
+    attr_reader :value
+    attr_reader :version
+
+    def initialize(name:, value:, version:)
+      @name = name
+      @value = value
+      @version = version
+    end
+
+    def var_name
+      name.split('/').last
+    end
+  end
+end

data/lib/securenv/version.rb

@@ -1,3 +1,3 @@
 module Securenv
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/securenv.gemspec

@@ -26,4 +26,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "thor" # Thor drives the CLI
+  spec.add_dependency "aws-sdk-ssm"
+
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,22 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: securenv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeremy Green
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
-dependencies: []
+date: 2021-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Securely store and set ENV variables via AWS SSM.
 email:
 - jeremy@octolabs.com
-executables: []
+executables:
+- securenv
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -28,7 +86,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/securenv
 - lib/securenv.rb
+- lib/securenv/cli/application.rb
+- lib/securenv/client.rb
+- lib/securenv/parameter.rb
 - lib/securenv/version.rb
 - securenv.gemspec
 homepage: https://github.com/Octo-Labs/securenv