shh 0.0.9 → 0.1.0

data/MIT-LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 Mark Ryall
- 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
- 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
- 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2009 Mark Ryall
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,96 +1,96 @@
-= SHH
-
-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)
+= SHH
+
+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 - 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
+
+  list keys, show key, copy key or quit?  c password
+
+* 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)
+* 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
+* 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

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

data/lib/shh/cli.rb

@@ -1,16 +1,16 @@
-require 'rubygems'
-require 'shh/repository'
-require 'shh/prompt'
-require 'shh/entries_menu'
-
-module Shh
-  class Cli
-    def self.execute *args
-      prompt = Prompt.new
-      passphrase = prompt.get('Enter your passphrase', :silent => true)
-      path = args.shift || ('~')
-
-      EntriesMenu.new(prompt, Repository.new(passphrase, path)).main_loop
-    end
-  end
-end
+require 'rubygems'
+require 'shh/repository'
+require 'shh/prompt'
+require 'shh/entries_menu'
+
+module Shh
+  class Cli
+    def self.execute *args
+      prompt = Prompt.new
+      passphrase = prompt.get('Enter your passphrase', :silent => true)
+      path = args.shift || ('~')
+
+      EntriesMenu.new(prompt, Repository.new(passphrase, path)).main_loop
+    end
+  end
+end

data/lib/shh/clipboard.rb

@@ -0,0 +1,13 @@
+module Shh
+  def self.clipboard
+     if RUBY_PLATFORM =~ /mswin32/
+       require 'shh/win32_clipboard'
+       return Win32Clipboard.new
+     end
+     if RUBY_PLATFORM =~ /darwin10/
+       require 'shh/darwin10_clipboard'
+       return Darwin10Clipboard.new
+     end
+     nil
+  end
+end

data/lib/shh/crypt.rb

@@ -1,25 +1,25 @@
-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
+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/darwin10_clipboard.rb

@@ -1,5 +1,5 @@
-class Darwin10Clipboard
-  def content= text
-    `echo "#{text}" | pbcopy`
-  end
+class Darwin10Clipboard
+  def content= text
+    `echo "#{text}" | pbcopy`
+  end
 end

data/lib/shh/darwin10_launcher.rb

@@ -1,5 +1,5 @@
-class Darwin10Launcher
-  def launch text
-    `open #{text}`
-  end
-end
+class Darwin10Launcher
+  def launch text
+    `open #{text}`
+  end
+end

data/lib/shh/entries_menu.rb

@@ -1,64 +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 = 'shh > '
-
-      begin
-        while line = Readline.readline(prompt_text, true)
-          line.strip!
-          case line
-            when 'quit'
-              break
-            when 'refresh'
-              refresh
-            when 'list'
-              @entries.each {|entry| say entry }
-            when /^view (.*)/
-              view $1
-            when /^edit (.*)/
-              edit $1
-          end
-          puts
-        end
-      rescue Interrupt => e
-        exit
-      end
-      puts
-    end
-
-    def refresh
-      commands = ['list', 'refresh', 'quit']
-      @entries = []
-      @repository.each_entry do |entry|
-        @entries << "#{entry['name']} (#{entry['id']})"
-        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 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
+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 = 'shh > '
+
+      begin
+        while line = Readline.readline(prompt_text, true)
+          line.strip!
+          case line
+            when 'quit'
+              return
+            when 'refresh'
+              refresh
+            when 'list'
+              @entries.sort.each {|entry| say entry }
+            when /^view,(.*)/
+              view $1
+            when /^edit,(.*)/
+              edit $1
+          end
+          puts
+        end
+      rescue Interrupt => e
+        exit
+      end
+      puts
+    end
+
+    def refresh
+      commands = ['list', 'refresh', 'quit']
+      @entries = []
+      @repository.each_entry do |entry|
+        @entries << "#{entry['name']} (#{entry['id']})"
+        commands << "edit,#{entry['name']}"
+        commands << "view,#{entry['name']}"
+      end
+      Readline.completion_proc = lambda do |text|
+        commands.grep( /^#{Regexp.escape(text)}/ ).sort
+      end
+    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

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

data/lib/shh/prompt.rb

@@ -1,11 +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 = echo }
-    end
-  end
+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 = echo }
+    end
+  end
 end

data/lib/shh/repository.rb

@@ -1,39 +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
+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

data/lib/shh/win32_clipboard.rb

@@ -1,7 +1,7 @@
-require 'win32/clipboard'
-
-class Win32Clipboard
-  def content= text
-    Win32::Clipboard.set_data(text)
-  end
+require 'win32/clipboard'
+
+class Win32Clipboard
+  def content= text
+    Win32::Clipboard.set_data(text)
+  end
 end

data/lib/shh/win32_launcher.rb

@@ -1,5 +1,5 @@
-class Win32Launcher
-  def launch text
-    `start #{text}`
-  end
-end
+class Win32Launcher
+  def launch text
+    `start #{text}`
+  end
+end

data/lib/shh.rb

@@ -1,25 +1,25 @@
-module Shh
-  def self.clipboard
-     if RUBY_PLATFORM =~ /mswin32/
-       require 'shh/win32_clipboard'
-       return Win32Clipboard.new
-     end
-     if RUBY_PLATFORM =~ /darwin10/
-       require 'shh/darwin10_clipboard'
-       return Darwin10Clipboard.new
-     end
-     nil
-  end
-
-  def self.launcher
-     if RUBY_PLATFORM =~ /mswin32/
-       require 'shh/win32_launcher'
-       return Win32Launcher.new
-     end
-     if RUBY_PLATFORM =~ /darwin10/
-       require 'shh/darwin10_launcher'
-       return Darwin10Launcher.new
-     end
-     nil
-  end
-end
+module Shh
+  def self.clipboard
+     if RUBY_PLATFORM =~ /mswin32/
+       require 'shh/win32_clipboard'
+       return Win32Clipboard.new
+     end
+     if RUBY_PLATFORM =~ /darwin10/
+       require 'shh/darwin10_clipboard'
+       return Darwin10Clipboard.new
+     end
+     nil
+  end
+
+  def self.launcher
+     if RUBY_PLATFORM =~ /mswin32/
+       require 'shh/win32_launcher'
+       return Win32Launcher.new
+     end
+     if RUBY_PLATFORM =~ /darwin10/
+       require 'shh/darwin10_launcher'
+       return Darwin10Launcher.new
+     end
+     nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shh
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Mark Ryall
@@ -64,6 +64,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/shh/cli.rb
+- lib/shh/clipboard.rb
 - lib/shh/crypt.rb
 - lib/shh/darwin10_clipboard.rb
 - lib/shh/darwin10_launcher.rb