shh 0.1.7 → 0.1.8

data/README.rdoc

@@ -2,7 +2,7 @@
 
 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.
+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 either a hg or git 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.
 
@@ -12,6 +12,8 @@ Now with more tab completion and multi line editing!
 
 Here you sit expectantly in front of a computer at the command line.
 
+Either read the explanation below or checkout the following gist: 
+
 == Install
 
   gem install shh
@@ -26,6 +28,8 @@ Opens all 'secrets' stored in foo/.secret
 
   > shh foo
 
+Note that shh will crash if the parent directory of .secret does not contain either a .hg or .git.
+
 == Authenticate
 
   Enter your passphrase
@@ -36,52 +40,37 @@ This passphrase will be used to encrypt and decrypt all of your secrets so don't
 
 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 - list 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) > view username
-  markryall
+  > ls
 
-  list keys, show key, copy key or quit?  c password
+  amazon
+  bitbucket
+  evernote
+  gmail
+  rememberthemilk
+  yahoo
 
-* list - show entry keys
-* view <key> - view entry value on screen
-* copy <key> - copy entry value to clipboard
-* launch <key> - launch entry value in default browser (available if it starts with http)
-* run <key> - execute ruby script (available if it starts with #!/usr/bin/env ruby)
+* ls - list entries
+* cd <name> - edit or create entry
+* history <name> - view changes related to an entry
+* exhume <cs> <name> - view entry as at the specified changeset
 * quit
 
 == Editing mode
 
-This mode is viewing mode plus some editing commands
-
-  > edit bitbucket
-  (bitbucket) > set foo
+  > cd bitbucket
+  shh:bitbucket > set foo
   Enter new value for foo
   bar
   (bitbucket) > delete foo
 
+* ls - list keys
 * edit <key> - edit or create key using text editor (notepad or EDITOR)
 * set <key> - edit or create key from prompt
-* delete <key> - remove a key
+* cat/less/more - show the value associated with a key
+* cp - copies the value of a key to the system clipboard
+* launch - launches the value associated with the key (really only useful for launching a url)
+* exec - executes the value associated with the key as a script (see scripting below)
+* rm <key> - remove a key
 
 == Quitting mode
 
@@ -89,13 +78,9 @@ You don't want to be a quitter
 
 == Scripting
 
-In a script the following objects are available:
-
-* splat.clipboard = <text> - allows content to be copied to the clipboard
-* splat.browser - a watir compatible browser
-* hash - the current selected entry
+In a script the current entry is available as a variable called 'entry'
 
-Example: 
+Very Contrived Example: 
 
   browser = 'http://www.github.com/login'.to_browser
   browser.text_field(:id, 'login_field').set hash['username']
@@ -105,6 +90,5 @@ Example:
 = Future plans for world domination
 
 * Add some color
-* Add help
-* add some source control (hg/git) commands
-* add commands for displaying history of entries
+* Add more history commands using source control (hg/git) commands
+* Support other source control systems

data/bin/shh

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.dirname(__FILE__)+'/../lib'
+$:.unshift File.expand_path(File.dirname(__FILE__))+'/../lib'
 require 'shh/cli'
-Shh::Cli.execute(*ARGV)
+Shh::Cli.execute(*ARGV)

data/lib/shh/blowfish_serialiser.rb

@@ -0,0 +1,28 @@
+require 'crypt/blowfish'
+
+module Shh
+  class BlowfishSerialiser
+    def initialize serialiser, passphrase
+      @blowfish = ::Crypt::Blowfish.new(passphrase)
+      @serialiser = serialiser
+    end
+
+    def read io
+      decrypted_io = StringIO.new
+      while l = io.read(8) do
+        decrypted_io.print @blowfish.decrypt_block(l)
+      end
+      @serialiser.read StringIO.new(decrypted_io.string.gsub("\0",''))
+    end
+
+    def write io, hash
+      serialised_io = StringIO.new
+      @serialiser.write serialised_io, hash
+      serialised_io.rewind
+      while l = serialised_io.read(8) do
+        while l.size < 8 do l += "\0" end
+        io.print @blowfish.encrypt_block(l)
+      end
+    end
+  end
+end

data/lib/shh/cli.rb

@@ -1,16 +1,20 @@
 require 'rubygems'
-require 'shh/repository'
 require 'shh/prompt'
 require 'shh/entries_menu'
+require 'shh/blowfish_serialiser'
+require 'flat_hash/serialiser'
+require 'flat_hash/repository'
 
 module Shh
   class Cli
     def self.execute *args
       prompt = Prompt.new
       passphrase = prompt.ask('Enter your passphrase', :silent => true)
-      path = args.shift || ('~')
-
-      EntriesMenu.new(prompt, Repository.new(passphrase, path)).push
+      path = args.shift || '~'
+      Dir.chdir(File.expand_path(path)) do
+        serialiser = BlowfishSerialiser.new(FlatHash::Serialiser.new, passphrase)
+        EntriesMenu.new(prompt, FlatHash::Repository.new(serialiser, '.secret')).push
+      end
     end
   end
 end

data/lib/shh/command/commit_changes.rb

@@ -0,0 +1,13 @@
+class Shh::Command::CommitChanges
+  attr_reader :help
+
+  def initialize repository, io
+    @io, @repository = io, repository
+    @help = "Commits all pending changes to vcs (note that this will add _all_ pending changes not only cards)"
+    @usage = "<commit message>"
+  end
+
+  def execute text=nil
+    @repository.addremovecommit text
+  end
+end

data/lib/shh/command/diff_entry.rb

@@ -0,0 +1,26 @@
+require 'active_support/core_ext/hash'
+require 'shh/command/historic_entry_command'
+  
+class Shh::Command::DiffEntry
+  include Shh::Command::HistoricEntryCommand
+
+  def help
+    "Displays changes made since the specified revision of the entry\nRevision is a number representing the number of changesets to go back in history (ie. 0 is the most recently committed version)"
+  end
+
+  def execute text=nil
+    with_current_and_historic_entry(text) do |current, changeset, historic|
+      diff = current.diff(historic)
+      if diff.empty?
+        puts "no changes"
+      else
+        added = current.keys - historic.keys
+        removed = historic.keys-current.keys
+        modified = diff.keys - (added + removed)
+        puts "added #{added.join(',')}" unless added.empty?
+        puts "removed #{removed.join(',')}" unless removed.empty?
+        puts "modified #{modified.join(',')}" unless modified.empty?
+      end
+    end
+  end
+end

data/lib/shh/command/entries_command.rb

@@ -0,0 +1,13 @@
+module Shh::Command::EntriesCommand
+  def initialize entry, io
+    @entry, @io = entry, io
+  end
+
+  def usage
+    "<key name>"
+  end
+
+  def completion text
+    @entry.keys.grep(/^#{text}/).sort || []
+  end
+end

data/lib/shh/command/exhume_entry.rb

@@ -0,0 +1,18 @@
+require 'uuidtools'
+require 'shh/command/historic_entry_command'
+require 'shh/entry_menu'
+
+class Shh::Command::ExhumeEntry
+  include Shh::Command::HistoricEntryCommand
+
+  def help
+    "Enters a subshell for viewing the specifed entry as it was at the specified revision\nRevision is a number representing the number of changesets to go back in history (ie. 0 is the most recently committed version)"
+  end
+
+  def execute text=nil
+    with_current_and_historic_entry(text) do |current, changeset, historic|
+      puts "warning: you are viewing #{historic['name']} as at #{changeset.id}, any changes you make will be discarded"
+      Shh::EntryMenu.new(@io, historic).push
+    end
+  end
+end

data/lib/shh/command/historic_entry_command.rb

@@ -0,0 +1,26 @@
+module Shh::Command::HistoricEntryCommand
+  def initialize repository, io
+    @repository, @io = repository, io
+  end
+
+  def usage
+    "<entry name> <revision>"
+  end
+
+  def completion text
+    @repository.map{|entry| entry['name']}.grep(/^#{text}/).sort || []
+  end
+private
+  def with_current_and_historic_entry text
+    if text =~ /^(.*) (\d+)$/
+      name, rev = $1, $2.to_i
+      return unless name
+      return if name.empty?
+      current = @repository.find { |entry| entry['name'] == name }
+      return unless current
+      cs = @repository.history(current.id)[rev]
+      return unless cs
+      yield current, cs, @repository.element_at(cs.id, current.id)
+    end
+  end
+end

data/lib/shh/command/list_entries.rb

@@ -9,8 +9,15 @@ class Shh::Command::ListEntries
 
   def execute text=nil
     @repository.each do |entry|
-      next if text and !(entry['name'] =~ /#{text}/)
-      @io.say "#{entry['name']} (#{entry['id']})"
+      unless entry.id == entry['id']
+        puts "Encryption failure! Did you enter the correct password?"
+        return
+      end
+    end
+    @repository.sort{|l,r| (l['name']) <=> (r['name'])}.each do |entry|
+      description = "#{entry['name']} (#{entry.id})"
+      next if text and !(description =~ /#{text}/)
+      @io.say description
     end
   end
 end

data/lib/shh/command/open_entry.rb

@@ -15,9 +15,11 @@ class Shh::Command::OpenEntry
   end
 
   def execute name=nil
-    entry = @repository.find_by_name(name)
-    entry ||= {'name' => name, 'id' => UUIDTools::UUID.random_create.to_s}
+    return unless name
+    return if name.empty?
+    entry = @repository.find { |entry| entry['name'] == name }
+    entry ||= {'name' => name, 'id' => UUIDTools::UUID.random_create.to_s }
     Shh::EntryMenu.new(@io, entry).push
-    @repository.persist entry
+    @repository[entry['id']] = entry
   end
 end

data/lib/shh/command/show_history.rb

@@ -0,0 +1,26 @@
+class Shh::Command::ShowHistory
+  attr_reader :usage, :help
+
+  def initialize repository, io
+    @repository, @io = repository, io
+    @usage = "(<substring>)"
+    @help = "Shows history for a given entry"
+  end
+
+  def completion text
+    @repository.map{|entry| entry['name']}.grep(/^#{text}/).sort || []
+  end
+
+  def execute name=nil
+    entry = @repository.find { |entry| entry['name'] == name }
+    id = entry ? entry.id : nil
+    first = true
+    @repository.history(id).each do |cs|
+      puts '-------' unless first
+      puts "#{cs.id} #{cs.time}"
+      puts "#{cs.author}"
+      puts "#{cs.description}"
+      first = false
+    end
+  end
+end

data/lib/shh/entries_menu.rb

@@ -12,5 +12,11 @@ class Shh::EntriesMenu
       'ls'   => load_command(:list_entries, @repository, @io),
       'cd'   => load_command(:open_entry, @repository, @io)
     }
+    if @repository.vcs_supported?
+      @commands['history'] = load_command(:show_history, @repository, @io)
+      @commands['exhume'] = load_command(:exhume_entry, @repository, @io)
+      @commands['diff'] = load_command(:diff_entry, @repository, @io)
+      @commands['ci'] = load_command(:commit_changes, @repository, @io)
+    end
   end
 end

data/lib/shh/entry_menu.rb

@@ -7,11 +7,15 @@ class Shh::EntryMenu
 
   def initialize io, entry
     @io, @entry = io, entry
+    show_command = load_command(:show_key, entry, io)
+    edit_command = load_command(:edit_key, entry, io)
     @commands = {
       'ls'     => load_command(:list_keys, entry, io),
       'set'    => load_command(:set_key, entry, io),
-      'edit'   => load_command(:edit_key, entry, io),
-      'cat'    => load_command(:show_key, entry, io),
+      'edit'   => edit_command,
+      'cat'    => show_command,
+      'less'   => show_command,
+      'more'   => show_command,
       'cp'     => load_command(:copy_key, entry, io),
       'launch' => load_command(:launch_key, entry, io),
       'rm'     => load_command(:remove_key, entry, io),

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shh
 version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Mark Ryall
@@ -14,121 +15,169 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 +10:00
+date: 2010-08-21 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: highline
+  name: flat_hash
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
-        - 1
-        - 5
+        - 0
+        - 0
         - 2
-        version: 1.5.2
+        version: 0.0.2
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: uuidtools
+  name: highline
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 2
         - 1
         - 1
         version: 2.1.1
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: crypt
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 1
         - 1
         - 4
         version: 1.1.4
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: splat
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 0
         - 1
         - 0
         version: 0.1.0
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: shell_shock
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
         - 0
         - 0
         - 3
         version: 0.0.3
   type: :runtime
-  version_requirements: *id005
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 49
         segments: 
         - 0
         - 8
         - 7
         version: 0.8.7
   type: :development
-  version_requirements: *id006
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: gemesis
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
         - 0
         - 0
         - 3
         version: 0.0.3
   type: :development
-  version_requirements: *id007
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: orangutan
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 0
         - 0
         - 7
         version: 0.0.7
   type: :development
-  version_requirements: *id008
+  version_requirements: *id010
 description: |
   A command line utility that manages accounts and passwords as individual encypted files
 
@@ -140,10 +189,16 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/shh/blowfish_serialiser.rb
 - lib/shh/cli.rb
+- lib/shh/command/commit_changes.rb
 - lib/shh/command/copy_key.rb
+- lib/shh/command/diff_entry.rb
 - lib/shh/command/edit_key.rb
+- lib/shh/command/entries_command.rb
 - lib/shh/command/execute_key.rb
+- lib/shh/command/exhume_entry.rb
+- lib/shh/command/historic_entry_command.rb
 - lib/shh/command/key_command.rb
 - lib/shh/command/launch_key.rb
 - lib/shh/command/list_entries.rb
@@ -151,13 +206,12 @@ files:
 - lib/shh/command/open_entry.rb
 - lib/shh/command/remove_key.rb
 - lib/shh/command/set_key.rb
+- lib/shh/command/show_history.rb
 - lib/shh/command/show_key.rb
 - lib/shh/commands.rb
-- lib/shh/crypt.rb
 - lib/shh/entries_menu.rb
 - lib/shh/entry_menu.rb
 - lib/shh/prompt.rb
-- lib/shh/repository.rb
 - bin/shh
 - README.rdoc
 - MIT-LICENSE
@@ -171,23 +225,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: command line utility for managing secure information

data/lib/shh/crypt.rb

@@ -1,25 +0,0 @@
-require 'crypt/blowfish'
-
-module Shh
-  class Crypt
-    def initialize passphrase
-      @blowfish = ::Crypt::Blowfish.new(passphrase)
-    end
-
-    def encrypt text, out_io
-      in_io = StringIO.new(text)
-      while l = in_io.read(8) do
-        while l.size < 8 do l += "\0" end
-        out_io.print @blowfish.encrypt_block(l)
-      end
-    end
-
-    def decrypt in_io
-      out_io = StringIO.new
-      while l = in_io.read(8) do
-        out_io.print @blowfish.decrypt_block(l)
-      end
-      out_io.string.gsub("\0",'')
-    end
-  end
-end

data/lib/shh/repository.rb

@@ -1,44 +0,0 @@
-require 'yaml'
-require 'shh/crypt'
-require 'fileutils'
-
-module Shh
-  class Repository
-    include Enumerable
-
-    attr_reader :folder
-
-    def initialize passphrase, path
-      @folder = Pathname.new(File.expand_path(path)) + '.secret'
-      @folder.mkpath
-      @crypt = Crypt.new(passphrase)
-    end
-
-    def each
-      @folder.children.each do |child|
-        entry = load(child)
-        yield entry if entry
-      end
-    end
-
-    def find_by_name name
-      each {|e| return e if e['name'] == name}
-      nil
-    end
-
-    def load path
-      return nil if path.directory?
-      yaml = path.open('rb') {|io| @crypt.decrypt(io) }
-      entry = YAML::load(yaml)
-      unless entry and path.basename.to_s == entry['id']
-        $stderr.puts "failed to deserialise #{path}"
-        return nil
-      end
-      entry
-    end
-
-    def persist entry
-      (@folder + entry['id']).open('wb') {|io| @crypt.encrypt(entry.to_yaml, io) }
-    end
-  end
-end