rapid-vaults 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a33025f28dcfc0be205d5a54c706192c06319a94
-  data.tar.gz: 428808ee49e8caa2791983be429fd232bf004e94
+SHA256:
+  metadata.gz: 928d90da27078d0b09c9a933e3054d8a3b26183dc5f0dc88e70fe84d2726c6cb
+  data.tar.gz: 1a4c48a2dbcba14708170f0209105a5523d6fd1286e7ee6ef5d6509c728fe96a
 SHA512:
-  metadata.gz: 0ad2fa93633085305393343d0583c5618047f424b2069854d1e482aa8abbec5b837e0b753a1a706abcd51d5f9035f81d32bafc98cf240fd838925f8991ac8e2c
-  data.tar.gz: 0e19f0774f6b94e63186401f7a37d43e499689d75201bcce153f453c32adf0c2d28cef6e14259147d2aedfa4a967af57c0ded96929d63d57ab7d52f6801d6676
+  metadata.gz: 248e094660ee327365c43feebd24361ef99038b83b8b52ad8efde76fa1f6727b2f275c1ca0e5a5caae39cefa5fc4423c1aeee6616e4798e3fb461e9507af3047
+  data.tar.gz: 4b56a0496557448fb94d6e4c4ba5277448972a0c1518bac0a0c21e2cdfb5f6aecbefb9e9dc4289b3575c20c63874cb3dc227e300a643e406eab71e0563cc7130

data/README.md

@@ -40,6 +40,7 @@ usage: rapid-vaults [options] file
     -t, --tag tag                    Tag file to be used for decryption (GPG: n/a).
     -p, --password password          (optional) Password to be used for encryption or decryption (GPG: required).
     -f, --file-password password.txt (optional) Text file containing a password to be used for encryption or decryption (GPG: required).
+    -b, --binding binding            Output files to support bindings for other software languages.
     --gpgparams                      GPG Key params input file used during generation of keys.
     -o --outdir                      Optional output directory for generated files (default: pwd). (GPG: optional)
 ```
@@ -84,9 +85,10 @@ Currently you set the path to the keys and other files via the environment varia
 
 `rapid-vaults --gpg -d -p password -o /output/dir encrypted.txt`
 
-#### Output an Integration
+#### Output a Binding
 
-`rapid-vaults --puppet -o /output/dir`
+`rapid-vaults -b puppet -o /output/dir`  
+`rapid-vaults -b chef -o /path/to/outdir`
 
 ### API
 
@@ -198,10 +200,6 @@ forthcoming
 
 Puppet bindings are presented as a 2x2 matrix of custom functions for encryption/decryption and SSL/GPG. The custom functions require a non-obsolete version of Puppet. Documentation pertaining to their usage is done via Puppet Strings within the functions. It is highly recommended to wrap the output of the decryption functions within a `Sensitive` data type so that decrypted secrets are not shown in logs.
 
-### Hiera
-
-forthcoming
-
 ### Chef
 
 Chef can access Rapid Vaults directly through the native Ruby API. Therefore, the Chef bindings are presented as example methods for doing so.
@@ -210,3 +208,5 @@ Chef can access Rapid Vaults directly through the native Ruby API. Therefore, th
 Code should pass all spec tests. New features should involve new spec tests. Adherence to Rubocop and Reek is expected where not overly onerous or where the check is of dubious cost/benefit.
 
 A [Dockerfile](Dockerfile) is provided for easy rake testing. A [Vagrantfile](Vagrantfile) is provided for easy gem building, installation, and post-installation testing.
+
+Please consult the GitHub Project for the current development roadmap.

data/lib/rapid-vaults.rb

@@ -1,6 +1,7 @@
 require_relative 'rapid-vaults/decrypt'
 require_relative 'rapid-vaults/encrypt'
 require_relative 'rapid-vaults/generate'
+require_relative 'rapid-vaults/binding'
 
 # interfaces from cli/api, validates settings, and then distributes actions to appropriate classes
 class RapidVaults
@@ -15,18 +16,20 @@ class RapidVaults
     when :generate then Generate.public_send(settings[:algorithm], settings)
     when :encrypt then Encrypt.public_send(settings[:algorithm], settings)
     when :decrypt then Decrypt.public_send(settings[:algorithm], settings)
-    when :integrate then Integrate.public_send(settings[:integrate], settings)
+    when :binding then Binding.public_send(settings[:binding], settings)
     end
   end
 
   # method for processing the settings and inputs
   def self.process(settings)
-    # default to openssl algorithm and `pwd` output directory
-    settings[:outdir] ||= Dir.pwd
-    raise "The output directory #{settings[:outdir]} does not exist or is not a directory!" unless File.directory?(settings[:outdir])
-    settings[:outdir] += '/' unless settings[:outdir][-1] == '/'
+    # :outdir only relevant for :cli
+    if settings[:ui] == :cli
+      # default to openssl algorithm and `pwd` output directory
+      settings[:outdir] ||= Dir.pwd
+      settings[:outdir] += '/' unless settings[:outdir][-1] == '/'
+    end
 
-    return if settings[:action] == :integrate
+    return if settings[:action] == :binding
     settings[:algorithm] ||= :openssl
 
     # check for problems with arguments and inputs

data/lib/rapid-vaults/binding.rb

@@ -0,0 +1,20 @@
+# class to output bindings with other software
+class Binding
+  # outputs puppet bindings
+  def self.puppet(settings)
+    # output puppet bindings to output directory
+    %w[gpg ssl].each do |algo|
+      %w[encrypt decrypt].each do |action|
+        content = File.read("#{__dir__}/bindings/puppet_#{algo}_#{action}.rb")
+        File.write("#{settings[:outdir]}puppet_#{algo}_#{action}.rb", content)
+      end
+    end
+  end
+
+  # outputs chef bindings
+  def self.chef(settings)
+    # output chef bindings to output directory
+    content = File.read("#{__dir__}/bindings/chef.rb")
+    File.write("#{settings[:outdir]}chef.rb", content)
+  end
+end

data/lib/rapid-vaults/{integrations → bindings}/chef.rb

@@ -42,7 +42,7 @@ def gpg_generate
 end
 
 # returns encrypted_contents
-def gpg_encryot
+def gpg_encrypt
   ENV['GNUPGHOME'] = '/home/bob/.gnupg'
 
   options = {}

data/lib/rapid-vaults/{integrations → bindings}/puppet_ssl_decrypt.rb

@@ -5,7 +5,7 @@ Puppet::Functions.create_function(:'ssl_decrypt') do
   # @param [String] key The key file to use for decryption.
   # @param [String] nonce The nonce file to use for decryption.
   # @param [String] tag The tag file to use for decryption.
-  # @param [String] password_file The optional password file to use for decryption.
+  # @optional_param [String] password_file The optional password file to use for decryption.
   # @return [String] Returns a string of decrypted contents.
   # @example Decrypting a file.
   # ssl_decrypt('/path/to/encrypted_data.txt', '/path/to/cert.key', '/path/to/nonce.txt', '/path/to/tag.txt', '/path/to/password.txt') => 'decrypted'

data/lib/rapid-vaults/{integrations → bindings}/puppet_ssl_encrypt.rb

@@ -4,7 +4,7 @@ Puppet::Functions.create_function(:'ssl_encrypt') do
   # @param [String] file The file to encrypt.
   # @param [String] key The key file to use for encryption.
   # @param [String] nonce The nonce file to use for encryption.
-  # @param [String] password_file The optional password file to use for encryption.
+  # @optional_param [String] password_file The optional password file to use for encryption.
   # @return [Hash] Returns a hash. First key-value is the encrypted contents and the second is the tag.
   # @example Encrypting a file.
   # ssl_encrypt('/path/to/data.txt', '/path/to/cert.key', '/path/to/nonce.txt', '/path/to/password.txt') => { encrypted_contents => 'asdfnlm34kl5m3lasdf34324fdnfsd', tag => 'fwr32r2ewf' }

data/lib/rapid-vaults/cli.rb

@@ -6,7 +6,7 @@ class RapidVaults::CLI
   def self.main(args)
     # parse args in cli and denote using cli
     settings = parse(args)
-    unless settings[:action] == :generate
+    if settings[:action] == :encrypt || settings[:action] == :decrypt
       args.empty? ? (raise 'rapid-vaults: no file specified; try using --help') : settings[:file] = args.first
     end
 
@@ -33,7 +33,7 @@ class RapidVaults::CLI
 
       # base options
       opts.on('--version', 'Display the current version.') do
-        puts 'rapid-vaults 1.1.1'
+        puts 'rapid-vaults 1.1.2'
         exit 0
       end
 
@@ -50,15 +50,26 @@ class RapidVaults::CLI
       opts.on('-n', '--nonce nonce', String, 'Nonce file to be used for encryption or decryption (GPG: n/a).') { |arg| settings[:nonce] = arg }
       opts.on('-t', '--tag tag', String, 'Tag file to be used for decryption (GPG: n/a).') { |arg| settings[:tag] = arg }
       opts.on('-p', '--password password', String, '(optional) Password to be used for encryption or decryption (GPG: required).') { |arg| settings[:pw] = arg }
-      opts.on('-f', '--file-password password.txt', String, '(optional) Text file containing a password to be used for encryption or decryption (GPG: required).') { |arg| settings[:pw] = File.read(arg) }
+      opts.on('-f', '--file-password password.txt', String, '(optional) Text file containing a password to be used for encryption or decryption (GPG: required).') do |arg|
+        raise "Password file #{arg} is not an existing file!" unless File.file?(arg)
+        settings[:pw] = File.read(arg)
+      end
 
-      # integrations
-      opts.on('--puppet', String, 'Output files to support Puppet integrations.') { settings[:action] = :integrate; settings[:integrate] = :puppet }
-      opts.on('--chef', String, 'Output files to support Chef integrations.') { settings[:action] = :integrate; settings[:integrate] = :chef }
+      # bindings
+      opts.on('-b', '--binding binding', String, 'Output files to support bindings for other software languages.') do |arg|
+        settings[:action] = :binding
+        settings[:binding] = arg.to_sym
+      end
 
       # other
-      opts.on('--gpgparams params.txt', String, 'GPG Key params input file used during generation of keys.') { |arg| settings[:gpgparams] = File.read(arg) }
-      opts.on('-o --outdir', String, 'Optional output directory for generated files (default: pwd). (GPG: optional)') { |arg| settings[:outdir] = arg }
+      opts.on('--gpgparams params.txt', String, 'GPG Key params input file used during generation of keys.') do |arg|
+        raise "GPG Parameters file #{arg} is not an existing file!" unless File.file?(arg)
+        settings[:gpgparams] = File.read(arg)
+      end
+      opts.on('-o --outdir', String, 'Optional output directory for generated files (default: pwd). (GPG: optional)') do |arg|
+        raise "The output directory #{arg} does not exist or is not a directory!" unless File.directory?(arg)
+        settings[:outdir] = arg
+      end
     end
 
     # parse args and return settings

data/spec/rapid-vaults/{integration_spec.rb → binding_spec.rb}

@@ -1,14 +1,14 @@
 require_relative '../spec_helper'
-require_relative '../../lib/rapid-vaults/integration'
+require_relative '../../lib/rapid-vaults/binding'
 
-describe Integration do
+describe Binding do
   context '.puppet' do
     after(:all) do
       %w[puppet_gpg_decrypt.rb puppet_gpg_encrypt.rb puppet_ssl_decrypt.rb puppet_ssl_encrypt.rb].each { |file| File.delete(file) }
     end
 
-    it 'outputs the puppet integrations to the specified directory' do
-      Integration.puppet({})
+    it 'outputs the puppet bindings to the specified directory' do
+      Binding.puppet({})
       %w[puppet_gpg_decrypt.rb puppet_gpg_encrypt.rb puppet_ssl_decrypt.rb puppet_ssl_encrypt.rb].each do |file|
         expect(File.file?(file)).to be true
       end
@@ -20,8 +20,8 @@ describe Integration do
       File.delete('chef.rb')
     end
 
-    it 'outputs the chef integrations to the specified directory' do
-      Integration.chef({})
+    it 'outputs the chef bindings to the specified directory' do
+      Binding.chef({})
       expect(File.file?('chef.rb')).to be true
     end
   end

data/spec/rapid-vaults/cli_spec.rb

@@ -13,13 +13,22 @@ describe RapidVaults::CLI do
       expect(RapidVaults::CLI.parse(%w[-d -k key.txt -n nonce.txt -t tag.txt -p secret file.txt])).to eq(ui: :cli, action: :decrypt, key: 'key.txt', nonce: 'nonce.txt', tag: 'tag.txt', pw: 'secret')
     end
     it 'correctly parses the arguments for openssl generate' do
-      expect(RapidVaults::CLI.parse(%w[-g -o /home/bob])).to eq(ui: :cli, action: :generate, outdir: '/home/bob')
+      expect(RapidVaults::CLI.parse(%w[-g -o .])).to eq(ui: :cli, action: :generate, outdir: '.')
     end
     it 'correctly parses the arguments for gpg generate' do
       expect(RapidVaults::CLI.parse(%W[--gpg -g --gpgparams #{fixtures_dir}/file.yaml])).to eq(algorithm: :gpgme, ui: :cli, action: :generate, gpgparams: "foo: bar\n")
     end
-    it 'correctly parses the arguments for puppet integrations' do
-      expect(RapidVaults::CLI.parse(%w[--puppet -o /dir])).to eq(ui: :cli, action: :integrate, integrate: :puppet, outdir: '/dir')
+    it 'correctly parses the arguments for puppet bindings' do
+      expect(RapidVaults::CLI.parse(%w[-b puppet -o .])).to eq(ui: :cli, action: :binding, binding: :puppet, outdir: '.')
+    end
+    it 'raises an error for a nonexistent password file' do
+      expect { RapidVaults::CLI.parse(%w[-f /nopasswordhere]) }.to raise_error('Password file /nopasswordhere is not an existing file!')
+    end
+    it 'raises an error for a nonexistent gpg parameters file' do
+      expect { RapidVaults::CLI.parse(%w[--gpgparams /foo/bar]) }.to raise_error('GPG Parameters file /foo/bar is not an existing file!')
+    end
+    it 'raises an error for a nonexistent output directory' do
+      expect { RapidVaults::CLI.parse(%w[-o /foo/bar/baz]) }.to raise_error('The output directory /foo/bar/baz does not exist or is not a directory!')
     end
   end
 end

data/spec/rapid-vaults_spec.rb

@@ -3,9 +3,6 @@ require_relative '../lib/rapid-vaults'
 
 describe RapidVaults do
   context '.process' do
-    it 'raises an error for a nonexistent output directory' do
-      expect { RapidVaults.process(outdir: '/foo/bar/baz') }.to raise_error('The output directory /foo/bar/baz does not exist or is not a directory!')
-    end
     it 'raises an error for a non-string password with openssl' do
       expect { RapidVaults.process(action: :encrypt, file: 'a', key: 'b', nonce: 'c', pw: 1) }.to raise_error('Password must be a string.')
     end

data/spec/system/system_spec.rb

@@ -6,9 +6,9 @@ describe RapidVaults do
   after(:all) do
     require 'fileutils'
 
-    %w[key.txt nonce.txt tag.txt encrypted.txt decrypted.txt].each { |file| File.delete(file) }
+    %w[key.txt nonce.txt tag.txt encrypted.txt decrypted.txt chef.rb puppet_gpg_decrypt.rb puppet_gpg_encrypt.rb puppet_ssl_decrypt.rb puppet_ssl_encrypt.rb].each { |file| File.delete(file) }
     unless File.directory?('/home/travis')
-      %w[S.gpg-agent random_seed pubring.kbx trustdb.gpg pubring.kbx~].each { |file| File.delete(file) }
+      %w[random_seed pubring.kbx trustdb.gpg pubring.kbx~ S.gpg-agent].each { |file| File.delete(file) }
       %w[openpgp-revocs.d private-keys-v1.d].each { |dir| FileUtils.rm_r(dir) }
     end
   end
@@ -110,4 +110,17 @@ describe RapidVaults do
       end
     end
   end
+
+  context 'executed as a system to output bindings from the CLI' do
+    it 'outputs the puppet and chef bindings' do
+      # generate and utilize files inside suitable directory
+      Dir.chdir(fixtures_dir)
+
+      # generate bindings
+      RapidVaults::CLI.main(%w[-b puppet])
+      RapidVaults::CLI.main(%w[-b chef])
+
+      %w[chef.rb puppet_gpg_decrypt.rb puppet_gpg_encrypt.rb puppet_ssl_decrypt.rb puppet_ssl_encrypt.rb].each { |file| expect(File.file?(file)).to be true }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rapid-vaults
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-24 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gpgme
@@ -48,16 +48,22 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,24 +104,24 @@ files:
 - bin/rapid-vaults
 - lib/rapid-vaults.rb
 - lib/rapid-vaults/api.rb
+- lib/rapid-vaults/binding.rb
+- lib/rapid-vaults/bindings/chef.rb
+- lib/rapid-vaults/bindings/puppet_gpg_decrypt.rb
+- lib/rapid-vaults/bindings/puppet_gpg_encrypt.rb
+- lib/rapid-vaults/bindings/puppet_ssl_decrypt.rb
+- lib/rapid-vaults/bindings/puppet_ssl_encrypt.rb
 - lib/rapid-vaults/cli.rb
 - lib/rapid-vaults/decrypt.rb
 - lib/rapid-vaults/encrypt.rb
 - lib/rapid-vaults/generate.rb
-- lib/rapid-vaults/integration.rb
-- lib/rapid-vaults/integrations/chef.rb
-- lib/rapid-vaults/integrations/puppet_gpg_decrypt.rb
-- lib/rapid-vaults/integrations/puppet_gpg_encrypt.rb
-- lib/rapid-vaults/integrations/puppet_ssl_decrypt.rb
-- lib/rapid-vaults/integrations/puppet_ssl_encrypt.rb
 - spec/fixtures/file.yaml
 - spec/fixtures/gpgparams.txt
 - spec/rapid-vaults/api_spec.rb
+- spec/rapid-vaults/binding_spec.rb
 - spec/rapid-vaults/cli_spec.rb
 - spec/rapid-vaults/decrypt_spec.rb
 - spec/rapid-vaults/encrypt_spec.rb
 - spec/rapid-vaults/generate_spec.rb
-- spec/rapid-vaults/integration_spec.rb
 - spec/rapid-vaults_spec.rb
 - spec/spec_helper.rb
 - spec/system/system_spec.rb
@@ -139,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ad-hoc encrypt and decrypt data.
@@ -147,11 +153,11 @@ test_files:
 - spec/fixtures/file.yaml
 - spec/fixtures/gpgparams.txt
 - spec/rapid-vaults/api_spec.rb
+- spec/rapid-vaults/binding_spec.rb
 - spec/rapid-vaults/cli_spec.rb
 - spec/rapid-vaults/decrypt_spec.rb
 - spec/rapid-vaults/encrypt_spec.rb
 - spec/rapid-vaults/generate_spec.rb
-- spec/rapid-vaults/integration_spec.rb
 - spec/rapid-vaults_spec.rb
 - spec/spec_helper.rb
 - spec/system/system_spec.rb

data/lib/rapid-vaults/integration.rb

@@ -1,20 +0,0 @@
-# class to output integrations with other software
-class Integration
-  # outputs puppet integrations
-  def self.puppet(settings)
-    # output puppet integrations to output directory
-    %w[gpg ssl].each do |algo|
-      %w[encrypt decrypt].each do |action|
-        content = File.read("#{__dir__}/integrations/puppet_#{algo}_#{action}.rb")
-        File.write("#{settings[:outdir]}puppet_#{algo}_#{action}.rb", content)
-      end
-    end
-  end
-
-  # outputs chef integrations
-  def self.chef(settings)
-    # output chef integrations to output directory
-    content = File.read("#{__dir__}/integrations/chef.rb")
-    File.write("#{settings[:outdir]}chef.rb", content)
-  end
-end