shhh 1.6.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0dbd7d3e5bcbeafe77c1b0c1bc9b65a43cd1e5e
-  data.tar.gz: 0826054665ac7542bf8fb8db7c2c6266e04723e1
+  metadata.gz: bdb6b7b759d1eb7c94e0fe9cb51c51bfb0668fde
+  data.tar.gz: 9bdfa75a4c43d67b4cd3c2ec4fa724793760c60e
 SHA512:
-  metadata.gz: f726a8afd274a478fd3c439a5758c810db1ca28aeef380d9961ee670a822284f72b7b836c5e0b743a9be83f871d3c281f276e71157f8b0ec636f30dd00bd34cc
-  data.tar.gz: 417a3995ac55bc82a00d3398d37be3202c85a41c19dfcffbf5c3801c094db74e02a09bc3052f8a9f293371e23d2abae24f5b3729e2cc47e00eef05f068427364
+  metadata.gz: 9997274e437d55c7477a8c57d490b7fc67c4272150c4f98af7a3c146b45950e3253cfb638daebc76ee9de16f71256588ccadbcf3f6ffff7257a52ae60ac2fa0e
+  data.tar.gz: e641b7bbc34c1ff95e3240a1e52bfca023735478080193fd59c8e22e6c94c5aa65467ad496c751d14d188a041c7f8729f935d2e0942aa1d73493ef646bfb4be6

data/exe/shhh

@@ -4,6 +4,7 @@ lib_path = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path)
 
 require 'shhh'
+require 'shhh/app'
 
 #ARGV.any?{ |a| a =~ /^-/ } ?
 begin

data/lib/shhh.rb

@@ -1,6 +1,6 @@
-require 'require_dir'
 require 'colored2'
 require 'zlib'
+require 'coin'
 
 require_relative 'shhh/configuration'
 
@@ -10,7 +10,6 @@ Shhh::Configuration.configure do |config|
   config.private_key_cipher = config.data_cipher
   config.compression_enabled = true
   config.compression_level = Zlib::BEST_COMPRESSION
-  config.password_cache = { provider: :drb, timeout: 30 }
 end
 
 #
@@ -78,12 +77,18 @@ end
 #
 #
 
-module Shhh
-  extend RequireDir
-  init(__FILE__)
+module Kernel
+  def require_dir(___dir)
+    @___dir ||= File.dirname(__FILE__)
+    # require files using a consistent order based on the dir/file name.
+    # this should be OS-neutral
+    Dir["#{@___dir}/#{___dir}/*.rb"].sort.each do |___file|
+      require(___file)
+    end
+  end
 end
 
-Shhh.dir 'shhh/extensions'
+require_dir 'shhh/extensions'
 
 module Shhh
   def self.included(klass)
@@ -106,5 +111,3 @@ module Shhh
   end
 end
 
-Shhh.dir 'shhh'
-Shhh.dir 'shhh/app/commands'

data/lib/shhh/app.rb

@@ -1,9 +1,12 @@
-require 'shhh/data'
+require 'shhh'
 require 'active_support/inflector'
+
 module Shhh
 
   # The {Shhh::App} Module is responsible for handing user input and executing commands.
-  # Central class in this module is the {Shhh::App::CLI} class.
+  # Central class in this module is the {Shhh::App::CLI} class. However, it is
+  # recommended that ruby integration with the {Shhh::App} module functionality
+  # is done via the {Shhh::Application} class.
   #
   # Methods in this module are responsible for reporting errors and
   # maintaining the future exit code class-global variable.
@@ -48,4 +51,6 @@ module Shhh
   end
 end
 
-Shhh.dir_r 'shhh/app'
+require 'shhh/app/short_name'
+require 'shhh/version'
+require_dir 'shhh/app'

data/lib/shhh/app/args.rb

@@ -3,8 +3,8 @@ module Shhh
 
     class Args
 
-      OPTIONS_MODE_SELECTED  = %i(encrypt decrypt generate edit keychain)
       OPTIONS_REQUIRE_KEY    = %i(encrypt decrypt edit)
+      OPTIONS_KEY_CREATED    = %i(generate)
       OPTIONS_SPECIFY_KEY    = %i(private_key interactive keyfile keychain)
       OPTIONS_SPECIFY_OUTPUT = %i(output quiet)
 
@@ -15,19 +15,18 @@ module Shhh
         self.selected_options = opts.keys.reject { |k| !opts[k] }
       end
 
-      # TODO: generate these methods dynamically
-      def do_options_specify_mode?
-        do?(OPTIONS_MODE_SELECTED)
-      end
-
-      def do_options_specify_key?
+      def specify_key?
         do?(OPTIONS_SPECIFY_KEY)
       end
 
-      def do_options_require_key?
+      def require_key?
         do?(OPTIONS_REQUIRE_KEY)
       end
 
+      def generate_key?
+        do?(OPTIONS_KEY_CREATED)
+      end
+
       def output_class
         output_type = OPTIONS_SPECIFY_OUTPUT.find { |o| opts[o] } # includes nil
         Shhh::App::Output.outputs[output_type]

data/lib/shhh/app/cli.rb

@@ -70,7 +70,7 @@ module Shhh
           self.opts = parse(argv_copy)
           if dict
             options = opts.parser.unused_options + opts.parser.used_options
-            puts options.map{|o| o.to_s.gsub(/.*(--[\w-]+).*/, '\1') }.sort.join(' ')
+            puts options.map { |o| o.to_s.gsub(/.*(--[\w-]+).*/, '\1') }.sort.join(' ')
             exit 0
           end
         rescue StandardError => e
@@ -81,9 +81,7 @@ module Shhh
         configure_color(argv)
 
         self.application = ::Shhh::Application.new(opts)
-
         select_output_stream
-
       end
 
       def execute
@@ -126,31 +124,40 @@ module Shhh
           o.banner = "Shhh (#{Shhh::VERSION}) – encrypt/decrypt data with a private key\n".bold.white
           o.separator 'Usage:'.yellow
           o.separator '   # Generate a new key:'.dark
-          o.separator '   shhh -g '.green.bold +
-                      '[ -c ] [ -p ] [ -x keychain ] [ -o keyfile | -q | ]  '.green
+          o.separator '   shhh -g '.green.bold + '[ -c ] [ -p ] [ -x keychain ] [ -o keyfile | -q | ]  '.green
           o.separator ''
           o.separator '   # Encrypt/Decrypt '.dark
-          o.separator '   shhh [ -d | -e ] '.green.bold +
-          '[ -f <file> | -s <string> ] '.green
+          o.separator '   shhh [ -d | -e ] '.green.bold + '[ -f <file> | -s <string> ] '.green
           o.separator '        [ -k key | -K keyfile | -x keychain | -i ] '.green
           o.separator '        [ -o <output file> ] '.green
           o.separator ' '
           o.separator '   # Edit an encrypted file in $EDITOR '.dark
-          o.separator '   shhh -t -f <file> [ -b ]'.green.bold +
-          '[ -k key | -K keyfile | -x keychain | -i ] '.green
+          o.separator '   shhh -t -f <file> [ -b ]'.green.bold + '[ -k key | -K keyfile | -x keychain | -i ] '.green
+
           o.separator ' '
           o.separator 'Modes:'.yellow
+
           o.bool '-e', '--encrypt', '           encrypt mode'
           o.bool '-d', '--decrypt', '           decrypt mode'
-          o.bool '-t', '--edit', '           decrypt, open an encr. file in an $EDITOR'
+          o.bool '-t', '--edit',    '           decrypt, open an encr. file in an $EDITOR'
+
           o.separator ' '
           o.separator 'Create a private key:'.yellow
+
           o.bool '-g', '--generate', '           generate a new private key'
           o.bool '-p', '--password', '           encrypt the key with a password'
-          o.bool '-c', '--copy', '           copy the new key to the clipboard'
+          o.bool '-c', '--copy',     '           copy the new key to the clipboard'
+
           if Shhh::App.is_osx?
             o.string '-x', '--keychain', '[key-name] '.blue + 'add to (or read from) the OS-X Keychain'
           end
+
+          o.separator ' '
+          o.separator 'Password Caching:'.yellow
+
+          o.integer '-M', '--password-timeout', '[timeout]'.blue + '  when passwords expire (in seconds)'
+          o.bool '-P', '--no-password-cache', '           disables key password caching'
+
           o.separator ' '
           o.separator 'Provide a private key:'.yellow
           o.bool '-i', '--interactive', '           Paste or type the key interactively'

data/lib/shhh/app/commands.rb

@@ -53,3 +53,4 @@ module Shhh
   end
 end
 
+require_dir 'shhh/app/commands'

data/lib/shhh/app/commands/command.rb

@@ -1,6 +1,8 @@
-require 'shhh/app/short_name'
-require 'shhh/app/commands'
+require 'shhh'
+require 'shhh/app'
+
 require 'active_support/inflector'
+
 module Shhh
   module App
     module Commands

data/lib/shhh/app/commands/generate_key.rb

@@ -11,17 +11,13 @@ module Shhh
         def execute
           retries         ||= 0
           new_private_key = self.class.create_private_key
-
-          if opts[:password]
-            new_private_key = encr_password(new_private_key,
-                                            application.input_handler.new_password)
-          end
+          new_private_key = encr_password(new_private_key,
+                                          application.input_handler.new_password) if opts[:password]
 
           clipboard_copy(new_private_key) if opts[:copy]
 
-          if opts[:keychain] && Shhh::App.is_osx?
-            Shhh::App::KeyChain.new(opts[:keychain], opts).add(new_private_key)
-          end
+          Shhh::App::KeyChain.new(opts[:keychain], opts).
+            add(new_private_key) if opts[:keychain] && Shhh::App.is_osx?
 
           new_private_key
         rescue Shhh::Errors::PasswordsDontMatch, Shhh::Errors::PasswordTooShort => e

data/lib/shhh/app/commands/open_editor.rb

@@ -22,6 +22,7 @@ module Shhh
           begin
             self.tempfile = ::Tempfile.new(::Base64.urlsafe_encode64(opts[:file]))
             decrypt_content(self.tempfile)
+
             result = process launch_editor
           ensure
             self.tempfile.close if tempfile

data/lib/shhh/app/input/handler.rb

@@ -4,6 +4,7 @@ module Shhh
   module App
     module Input
       class Handler
+
         def ask
           retries ||= 0
           prompt('Password: ', :green)
@@ -22,7 +23,7 @@ module Shhh
         end
 
         def new_password
-          password         = prompt('New Password     :  ', :blue)
+          password = prompt('New Password     :  ', :blue)
 
           raise Shhh::Errors::PasswordTooShort.new(
             'Minimum length is 7 characters.') if password.length < 7
@@ -30,7 +31,7 @@ module Shhh
           password_confirm = prompt('Confirm Password :  ', :blue)
 
           raise Shhh::Errors::PasswordsDontMatch.new(
-          'The passwords you entered do not match.') if password != password_confirm
+            'The passwords you entered do not match.') if password != password_confirm
 
           password
         end

data/lib/shhh/app/password/cache.rb

@@ -0,0 +1,63 @@
+require 'coin'
+require 'digest'
+require 'singleton'
+require 'colored2'
+
+module Shhh
+  module App
+    module Password
+      class Cache
+        URI             = 'druby://127.0.0.1:24924'
+        DEFAULT_TIMEOUT = 300
+
+        include Singleton
+
+        attr_accessor :provider, :enabled, :timeout
+
+        def configure(provider: Coin, enabled: true, timeout: DEFAULT_TIMEOUT)
+          Coin.uri = URI if provider == Coin
+
+          self.provider = provider
+          self.enabled  = enabled
+          self.timeout  = timeout
+
+          self
+        end
+
+        TRIES = 2
+
+        def operation
+          retries ||= TRIES
+          yield if self.enabled
+        rescue StandardError => e
+          if retries == TRIES && Coin.remote_uri.nil?
+            Coin.remote_uri = URI if provider == Coin
+            retries         -= 1
+            retry
+          end
+          puts 'WARNING: error reading from DRB server: ' + e.message.red
+          nil
+        end
+
+
+        def [] (key)
+          cache = self
+          operation do
+            cache.provider.read(cache.md5(key))
+          end
+        end
+
+        def []=(key, value)
+          cache = self
+          operation do
+            cache.provider.write(cache.md5(key), value, cache.timeout)
+          end
+        end
+
+        def md5(string)
+          Digest::MD5.base64digest(string)
+        end
+      end
+    end
+  end
+end

data/lib/shhh/app/private_key/decryptor.rb

@@ -1,17 +1,18 @@
-require_relative 'decryptor'
-require 'shhh/app/cache'
+require 'shhh/app/private_key/decryptor'
+require 'shhh/app/password/cache'
 module Shhh
   module App
     module PrivateKey
       class Decryptor
         include Shhh
 
-        attr_accessor :encrypted_key, :input_handler
+        attr_accessor :encrypted_key, :input_handler, :password_cache
 
-        def initialize(encrypted_key, input_handler)
-          self.encrypted_key = encrypted_key
-          self.input_handler = input_handler
-          @cache_checked = false
+        def initialize(encrypted_key, input_handler, password_cache)
+          self.encrypted_key  = encrypted_key
+          self.input_handler  = input_handler
+          self.password_cache = password_cache
+          @cache_checked      = false
         end
 
         def key
@@ -19,16 +20,21 @@ module Shhh
           decrypted_key = nil
           if should_decrypt?
             begin
-              retries ||= 0
+              retries                                   ||= 0
+              p                                         = determine_key_password
+              decrypted_key                             = decrypt(p)
 
-              p = password
-              decrypted_key = decrypt(p)
               # if the password is valid, let's add it to the cache.
-              Shhh::App::Cache.instance[encrypted_key] = p
+              password_cache[encrypted_key] = p
 
             rescue ::OpenSSL::Cipher::CipherError => e
               input_handler.puts 'Invalid password. Please try again.'
-              ((retries += 1) < 3) ? retry : raise(Shhh::Errors::InvalidPasswordPrivateKey.new('Invalid password.'))
+
+              if ((retries += 1) < 3)
+                retry
+              else
+                raise(Shhh::Errors::InvalidPasswordPrivateKey.new('Invalid password.'))
+              end
             end
           else
             decrypted_key = encrypted_key
@@ -46,7 +52,7 @@ module Shhh
           decr_password(encrypted_key, password)
         end
 
-        def password
+        def determine_key_password
           check_cache || ask_user
         end
 
@@ -57,9 +63,8 @@ module Shhh
         def check_cache
           return nil if @cache_checked
           @cache_checked = true
-          Shhh::App::Cache.instance[encrypted_key]
+          password_cache[encrypted_key]
         end
-
       end
     end
   end

data/lib/shhh/app/private_key/detector.rb

@@ -26,7 +26,7 @@ module Shhh
                         ->(*, detector) { detector.input_handler.prompt('Please paste your private key: ', :magenta) }
 
       Detector.register :keychain,
-                        ->(key_name, * ) { KeyChain.new(key_name).find }
+                        ->(key_name, * ) { KeyChain.new(key_name).find rescue nil }
 
       Detector.register :keyfile,
                         ->(file, *) {

data/lib/shhh/app/private_key/handler.rb

@@ -10,12 +10,13 @@ module Shhh
       class Handler
         include Shhh
 
-        attr_accessor :opts, :input_handler
+        attr_accessor :opts, :input_handler, :password_cache
         attr_writer :key
 
-        def initialize(opts, input_handler)
-          self.opts          = opts
-          self.input_handler = input_handler
+        def initialize(opts, input_handler, password_cache)
+          self.opts           = opts
+          self.input_handler  = input_handler
+          self.password_cache = password_cache
         end
 
 
@@ -26,13 +27,13 @@ module Shhh
           @key = begin
             Detector.new(opts, input_handler).key
           rescue Shhh::Errors::Error => e
-            if Shhh::App::Args.new(opts).do_options_specify_key? && key.nil?
+            if Shhh::App::Args.new(opts).specify_key? && key.nil?
               raise e
             end
           end
 
           if @key && @key.length > 45
-            @key = Decryptor.new(Base64Decoder.new(key).key, input_handler).key
+            @key = Decryptor.new(Base64Decoder.new(key).key, input_handler, password_cache).key
           end
 
           @key

data/lib/shhh/application.rb

@@ -1,5 +1,7 @@
-require 'shhh'
 require 'colored2'
+require 'shhh'
+require_dir 'shhh/app'
+
 module Shhh
   class Application
 
@@ -10,12 +12,15 @@ module Shhh
                   :key,
                   :input_handler,
                   :key_handler,
-                  :result
+                  :result,
+                  :password_cache
 
     def initialize(opts)
       self.opts      = opts
       self.opts_hash = opts.respond_to?(:to_hash) ? opts.to_hash : opts
       self.args      = ::Shhh::App::Args.new(opts_hash)
+
+      initialize_password_cache
       initialize_input_handler
       initialize_key_handler
       initialize_action
@@ -30,8 +35,9 @@ module Shhh
     end
 
     def execute!
-      if args.do_options_require_key? || args.do_options_specify_key?
-        self.key = Shhh::App::PrivateKey::Handler.new(opts, input_handler).key
+      if !args.generate_key? &&
+        (args.require_key? || args.specify_key?)
+        self.key = Shhh::App::PrivateKey::Handler.new(opts, input_handler, password_cache).key
         raise Shhh::Errors::NoPrivateKeyFound.new('Private key is required') unless self.key
       end
 
@@ -62,10 +68,26 @@ module Shhh
     def command
       @command_class ||= Shhh::App::Commands.find_command_class(opts)
       @command       ||= @command_class.new(self) if @command_class
+      @command
     end
 
     def editor
-      ENV['EDITOR'] || '/bin/vi'
+      editors_to_try.find { |editor| File.exist?(editor) }
+    end
+
+    def editors_to_try
+      [
+        ENV['EDITOR'],
+        '/usr/bin/vim',
+        '/usr/local/bin/vim',
+        '/bin/vim',
+        '/sbin/vim',
+        '/usr/sbin/vim',
+        '/usr/bin/vi',
+        '/usr/local/bin/vi',
+        '/bin/vi',
+        '/sbin/vi'
+      ]
     end
 
     def error(hash)
@@ -77,8 +99,16 @@ module Shhh
     end
 
     def initialize_key_handler
-      self.key_handler = ::Shhh::App::PrivateKey::Handler.new(self.opts, input_handler)
+      self.key_handler = ::Shhh::App::PrivateKey::Handler.new(self.opts, input_handler, password_cache)
     end
 
+    def initialize_password_cache
+      args            = {}
+      args[:provider] = Coin
+      args[:timeout]  = opts[:password_timeout].to_i if opts[:password_timeout]
+      args[:enabled]  = false if opts[:no_password_cache]
+
+      self.password_cache = Shhh::App::Password::Cache.instance.configure(args)
+    end
   end
 end

data/lib/shhh/configuration.rb

@@ -34,6 +34,6 @@ module Shhh
     end
 
     attr_accessor :data_cipher, :password_cipher, :private_key_cipher
-    attr_accessor :compression_enabled, :compression_level, :password_cache
+    attr_accessor :compression_enabled, :compression_level
   end
 end

data/lib/shhh/version.rb

@@ -1,3 +1,3 @@
 module Shhh
-  VERSION = '1.6.5'
+  VERSION = '1.7.0'
 end

data/shhh.gemspec

@@ -29,7 +29,6 @@ Thank you for installing Shhh!
    -- KG (github.com/kigster)
 "
 
-  spec.add_dependency 'require_dir', '~> 0.1'
   spec.add_dependency 'colored2', '~> 2.0'
   spec.add_dependency 'slop', '~> 4.3'
   spec.add_dependency 'activesupport'
@@ -42,4 +41,5 @@ Thank you for installing Shhh!
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'irbtools'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: shhh
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.7.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: require_dir
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: colored2
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: irbtools
+  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: Store sensitive data safely as encrypted strings or entire files, using
   symmetric aes-256-cbc encryption/decryption with a secret key and an IV vector,
   and YAML-friendly base64-encoded encrypted result.
@@ -209,7 +209,6 @@ files:
 - lib/shhh.rb
 - lib/shhh/app.rb
 - lib/shhh/app/args.rb
-- lib/shhh/app/cache.rb
 - lib/shhh/app/cli.rb
 - lib/shhh/app/commands.rb
 - lib/shhh/app/commands/command.rb
@@ -233,6 +232,7 @@ files:
 - lib/shhh/app/output/file.rb
 - lib/shhh/app/output/noop.rb
 - lib/shhh/app/output/stdout.rb
+- lib/shhh/app/password/cache.rb
 - lib/shhh/app/private_key/base64_decoder.rb
 - lib/shhh/app/private_key/decryptor.rb
 - lib/shhh/app/private_key/detector.rb

data/lib/shhh/app/cache.rb

@@ -1,47 +0,0 @@
-require 'coin'
-require 'digest'
-require 'singleton'
-
-module Shhh
-  module App
-    #
-    # +Cache+ looks like a hash, but is a singleton, and provides
-    # access to the shared across processes Cache.
-    #
-    # The current implementation is based on DRb, which creates a
-    # server process that then manages the data structure.
-    #
-    class Cache
-      include Singleton
-
-      class << self
-        def cache
-          self.instance
-        end
-
-        def configure
-          # configure the URI that the DRb server runs on
-          Coin.uri = 'druby://127.0.0.1:24924'
-        end
-      end
-
-      self.configure
-
-      def [] (key)
-        Coin.read(md5(key))
-      end
-
-      def []=(key, value)
-        Coin.write(md5(key), value)
-      end
-
-      private
-
-      def md5(string)
-        Digest::MD5.base64digest(string)
-      end
-
-    end
-  end
-end
-