shh 0.0.6 → 0.0.7

data/README.rdoc

@@ -5,3 +5,92 @@ Secret Squirrel
 This is a command line utility for managing secure information such as accounts, passwords as individual files so that they can be easily managed in a version control repository.
 
 You won't be hiding anything from the NSA with this level of encryption so it isn't recommended that you make your repository publicly accessible.
+
+Now with more tab completion!
+
+= Usage
+
+Here you sit expectantly in front of a computer at the command line.
+
+== Install
+
+  gem install shh
+
+(you may need to install gemcutter first)
+
+== Launch
+
+Open all 'secrets' stored in ~/.secret
+
+  > shh
+
+Opens all 'secrets' stored in foo/.secret
+
+  > shh foo
+
+== Authenticate
+
+  Enter your passphrase
+
+This passphrase will be used to encrypt and decrypt all of your secrets so don't make it too obvious.
+
+== Listing mode
+
+This mode allows you to view and edit 'entries' (which are encrypted hashes stored in files)
+
+  > list
+
+  bitbucket (260f34de-6779-4367-af2a-44184dec1cc1)
+  amazon (291a3e6c-2c7b-4960-a146-1f6635d9a74e)
+  yahoo (2fe408e7-7f2b-4dc0-854a-c92c21f131ae)
+  evernote (41ad0a21-eafc-4f70-9b0d-0251be207b9e)
+  gmail (8b35c1f2-851d-40fc-bd12-c2aad12c370a)
+  rememberthemilk (a499f612-d034-4e49-82a8-6967d29653a1)
+
+* list - show entries
+* edit <name> - edit or create entry
+* view <name> - view entry
+* quit
+
+== Viewing mode
+
+This mode allows you to view (but not edit) an existing entry
+
+  > view bitbucket
+  (bitbucket) > list
+  id,name,password,username
+  (bitbucket) > show username
+  markryall
+
+  list keys, show key, copy key or quit?  c password
+
+* list - show entry keys
+* show <key> - show entry value on screen
+* copy <key> - copy entry value to clipboard
+* quit
+
+== Editing mode
+
+This mode is viewing mode plus some editing commands
+
+  > edit bitbucket
+  (bitbucket) > edit foo
+  Enter new value for foo
+  bar
+  (bitbucket) > delete foo
+
+* edit <key> - edit or create key
+* delete <key> - remove a key
+
+== Quitting mode
+
+You don't want to be a quitter
+
+= Future plans for world domination
+
+* Add some color
+* Add help
+* Launch applications for urls
+* Add multi line values (edit with default text editor)
+* Include uuid as part of encryption key (and upgrade encryption on existing entries)
+* add some source control (hg/git) commands

data/bin/shh

@@ -2,4 +2,4 @@
 
 $:.unshift File.dirname(__FILE__)+'/../lib'
 require 'shh'
-Shh::Cli.new.execute(*ARGV)
+Shh::Cli.execute(*ARGV)

data/lib/shh/cli.rb

@@ -1,93 +1,16 @@
 require 'rubygems'
-require 'pathname2'
-require 'highline/import'
-require 'uuidtools'
-require 'yaml'
-require 'shh/crypt'
-require 'shh/clipboard'
+require 'shh/repository'
+require 'shh/prompt'
+require 'shh/entries_menu'
 
 module Shh
   class Cli
-    def execute *args
-      passphrase = ask('Enter your passphrase') { |q| q.echo = false }
+    def self.execute *args
+      prompt = Prompt.new
+      passphrase = prompt.get('Enter your passphrase', :silent => true)
+      path = args.shift || ('~')
 
-      path = args.shift
-      @folder = path ? Pathname.new(path) : Pathname.new(File.expand_path('~'))+'.secret'
-      @folder.mkdir_p
-      @crypt = Crypt.new(passphrase)
-      @clipboard = Shh.clipboard
-
-      loop do
-        choose do |menu|
-          menu.layout = :menu_only
-          menu.shell  = true
-          menu.choice('list entries') { list }
-          menu.choice('edit entry') { |command, details| edit details }
-          menu.choice('view entry') { |command, details| view details }
-          menu.choice('quit') { exit }
-        end
-      end
-    end
-
-    def list
-      each_entry {|entry| say "#{entry['name']} (#{entry['id']})" }
-    end
-
-    def edit name=''
-      entry = find_entry(check_name(name))
-      entry ||= {'name' => check_name(name), 'id' => UUIDTools::UUID.random_create.to_s}
-      persist_entry prompt_loop(entry)
-    end
-
-    def view name=''
-      prompt_loop find_entry(check_name(name)), true
-    end
-
-private
-
-    def each_entry
-      @folder.children.each do |child|
-        yield load_entry(child)
-      end
-    end
-
-    def check_name name
-      name = ask('Enter the entry name') unless name.size > 0
-      name
-    end
-
-    def find_entry name
-      each_entry {|e| return e if e['name'] == name}
-      nil
-    end
-
-    def load_entry path
-      entry = path.open('rb') {|io| @crypt.decrypt(io) }
-      YAML::load(entry)
-    end
-
-    def persist_entry entry
-      (@folder + entry['id']).open('wb') {|io| @crypt.encrypt(entry.to_yaml, io) }
-    end
-
-    def prompt_loop hash, read_only=false
-      loop do
-        choose do |menu|
-          menu.layout = :menu_only
-          menu.shell  = true
-          menu.choice('edit key') { |command, name| hash[name] = new_value(name) } unless read_only
-          menu.choice('list keys') { say(hash.keys.sort.join(',')) }
-          menu.choice('show key') { |command, name| say(hash[name]) if hash[name] }
-          menu.choice('delete key') { |command, name| hash[name] = nil } unless read_only
-          menu.choice('copy key') { |command, name| @clipboard.content = hash[name] } if @clipboard
-          menu.choice('quit') { return hash }
-        end
-      end
-    end
-
-    def new_value name
-      echo = (name =~ /pass/) ? false : true
-      ask("Enter new value for #{name}") {|q| q.echo = echo }
+      EntriesMenu.new(prompt, Repository.new(passphrase, path)).main_loop
     end
   end
 end

data/lib/shh/entries_menu.rb

@@ -0,0 +1,63 @@
+require 'uuidtools'
+require 'readline'
+require 'shh/entry_menu'
+
+module Shh
+  class EntriesMenu
+    def initialize prompt, repository
+      @prompt, @repository = prompt, repository
+      refresh
+    end
+
+    def main_loop
+      prompt_text = ' > '
+
+      begin
+        while line = Readline.readline(prompt_text, true).strip
+          case line
+            when 'quit'
+              return
+            when 'refresh'
+              refresh
+            when 'list'
+              list
+            when /^view (.*)/
+              view $1
+            when /^edit (.*)/
+              edit $1
+          end
+        end
+      rescue Interrupt => e
+        return
+      end
+    end
+
+    def refresh
+      commands = ['list', 'refresh', 'quit']
+      @repository.each_entry do |entry|
+        commands << "edit #{entry['name']}"
+        commands << "view #{entry['name']}"
+      end
+      Readline.completion_proc = lambda do |text|
+        commands.grep( /^#{Regexp.escape(text)}/ ).sort
+      end
+      Readline.completer_word_break_characters = ''
+    end
+
+    def list
+      @repository.each_entry {|entry| say "#{entry['name']} (#{entry['id']})" }
+    end
+
+    def edit name
+      entry = @repository.find_entry(name)
+      entry ||= {'name' => name, 'id' => UUIDTools::UUID.random_create.to_s}
+      @repository.persist_entry EntryMenu.new(@prompt, entry).main_loop
+      refresh
+    end
+
+    def view name
+      EntryMenu.new(@prompt, @repository.find_entry(name), true).main_loop
+      refresh
+    end
+  end
+end

data/lib/shh/entry_menu.rb

@@ -0,0 +1,60 @@
+require 'shh/clipboard'
+
+module Shh
+  class EntryMenu
+    def initialize prompt, hash, read_only=false
+      @prompt, @hash, @read_only = prompt, hash, read_only
+      @clipboard = Shh.clipboard
+      refresh
+    end
+
+    def main_loop
+      prompt_text = "(#{@hash['name']}) > "
+
+      begin
+        while line = Readline.readline(prompt_text, true).strip
+          case line
+            when 'quit'
+              return @hash
+            when 'list'
+              say(@hash.keys.sort.join(','))
+            when /^edit (.*)/
+              name = $1
+              @hash[name] = new_value(name) unless @read_only
+            when /^copy (.*)/
+              name = $1
+              @clipboard.content = @hash[name] if @clipboard and @hash[name]
+            when /^delete (.*)/
+              name = $1
+              @hash.delete(name) unless @read_only
+            when /^show (.*)/
+              name = $1
+              say(@hash[name]) if @hash[name]
+          end
+        end
+      rescue Interrupt => e
+        return @hash
+      end
+    end
+
+private
+
+    def refresh
+      commands = ['list', 'quit']
+      @hash.keys.each do |key|
+        commands << "edit #{key}" unless @read_only
+        commands << "delete #{key}" unless @read_only
+        commands << "show #{key}"
+        commands << "copy #{key}"
+      end
+      Readline.completion_proc = lambda do |text|
+        commands.grep( /^#{Regexp.escape(text)}/ ).sort
+      end
+      Readline.completer_word_break_characters = ''
+    end
+
+    def new_value name
+      @prompt.get "Enter new value for #{name}", :silent => (name =~ /pass/)
+    end
+  end
+end

data/lib/shh/prompt.rb

@@ -0,0 +1,11 @@
+require 'highline/import'
+
+module Shh
+  class Prompt
+    def get text, params={}
+       return params[:value] if params[:value] and params[:value].size > 0
+       echo = params[:silent] ? false : true
+       ask(text) { |q| q.echo = false }
+    end
+  end
+end

data/lib/shh/repository.rb

@@ -0,0 +1,39 @@
+require 'pathname2'
+require 'yaml'
+require 'shh/crypt'
+
+module Shh
+  class Repository
+    attr_reader :folder
+
+    def initialize passphrase, path
+      @folder = Pathname.new(File.expand_path(path)) + '.secret'
+      @folder.mkdir_p
+      @crypt = Crypt.new(passphrase)
+    end
+
+    def each_entry
+      @folder.children.each do |child|
+        entry = load_entry(child)
+        yield entry if entry
+      end
+    end
+
+    def find_entry name
+      each_entry {|e| return e if e['name'] == name}
+      nil
+    end
+
+    def load_entry path
+      return nil if path.directory?
+      yaml = path.open('rb') {|io| @crypt.decrypt(io) }
+      entry = YAML::load(yaml)
+      return nil unless entry
+      path.basename.to_s == entry['id'] ? entry : nil
+    end
+
+    def persist_entry entry
+      (@folder + entry['id']).open('wb') {|io| @crypt.encrypt(entry.to_yaml, io) }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shh
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Mark Ryall
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-18 00:00:00 +11:00
+date: 2009-12-26 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,10 @@ files:
 - lib/shh/clipboard.rb
 - lib/shh/crypt.rb
 - lib/shh/darwin10_clipboard.rb
+- lib/shh/entries_menu.rb
+- lib/shh/entry_menu.rb
+- lib/shh/prompt.rb
+- lib/shh/repository.rb
 - lib/shh/win32_clipboard.rb
 - lib/shh.rb
 - bin/shh