shadowpass 0.0.1

data/README.md

@@ -0,0 +1,72 @@
+# ShadowPass
+
+A tool for keeping a GnuPG encrypted password store.
+
+## A brief history
+
+I have, for a long time, kept a gpg encrypted password file in markdown format
+in a private git repo that I have appropriately named, 'shadow'.  It follows me
+everywhere.  When I need a password, I vi the file, and with the help of the
+gpg vim plugin, I can quickly access my secret.  This has worked for a long
+time.  However, as the file grows it can become a bit unwieldy.  Thus,
+'shadowpass'.
+
+### But what about the other tools?
+
+For the past couple years I have been working on a mac as my primary desktop.
+This has its benefits in the world of password storage.  Namely, keychain.
+Keychain is awesome.  It allows the system, utilities or the user, to directly
+read and write to the password store, with some mild 'would you like to grant
+access' style security methods.  The database is encrypted and such, which is
+basically a must for any password storage utility.  I've also been using
+another great utility on the Mac called '1Password'.  1Password is a gui
+application that stores your passwords in an encrypted password store, giving
+you a gui and some browser plugins so that you can store per site passwords for
+some auto fill magic.  Cool stuff, but its outside the scope of this tool.
+
+### So why?
+
+Having password storage tools locally on your desktop does wonders for you...
+when you are local.  But what if you are working on a remote system that isn't
+of the Apple variety?  For my case, I want `offlineimap` to be able to lookup a
+password automatically with one simple command line utility on a box where I
+don't have my common desktop tools like the `security` tool on OS X.  There are
+some other tools out there like Keypass, kwallet, gnome-pass, python-keyring,
+etc, but to my knowledge none of these support GPG.  I am big on GPG, and since
+I am not using X on a remote system they do me little good, with the exception
+of python-keyring.
+
+## Usage
+
+Getting and setting a record is easy.  Jus specify the path with either the `-g` or `-s` flags.
+
+    shadowpass -c ~/.shadow.yaml -s sites/forge
+
+You will be prompted for the secret that you would like to store at this path.
+Then to retrieve the value that you stored there, just use the get flag.
+
+    shadowpass -c ~/.shadow.yaml -g sites/forge
+
+Easy, right?  Paths can be of any length, so you are free to organize your
+passwords in any way you like.
+
+## Storage format
+
+Its all just json.  The path gets translated into a hash of hashes structures
+converting the path keys into hash keys, before getting or setting the value
+for those keys.
+
+Want to get the entire database?  Easy.
+
+    shadowpass -c ~/.shadow.yaml -g /
+
+This tells shadowpass to get the root, and therfore everything beneath it.  You
+can follow the same logic to get everything below a certain point.  For
+example:
+
+    shadowpass -c ~/.shadow.yaml -g sites/social/github
+
+Will return you all the items you have stored beneath the key `github`.  This
+is useful so you can store username, password, and any extras, like api key,
+etc.
+

data/bin/shadowpass

@@ -0,0 +1,62 @@
+#! /usr/bin/env ruby
+
+begin
+  require 'json'
+  require 'yaml'
+  require 'optparse'
+  require 'pp'
+  require 'gpgme'
+  require 'cri'
+  require 'shadowpass'
+  require 'io/console'
+rescue LoadError => e
+  puts "Unable to load library: #{e}"
+  exit 1
+end
+
+command = Cri::Command.define do
+  name 'shadowpass'
+  usage 'shadowpass [options]'
+  aliases :pws, :spass
+  summary 'maintain a password database'
+
+  flag   :h, :help,  'show help for this command' do |value, cmd|
+    puts cmd.help
+    exit 0
+  end
+  flag   :v, :verbose,  'Be less quiet'
+  option :c, :conf,     'Specify the configuration file', :argument => :required
+  option :s, :set,    'set a record', :argument => :required
+  option :g, :get,    'get a record', :argument => :required
+
+  run do |opts, args, cmd|
+    configfile = opts[:conf] || 'etc/shadowpass.yaml'
+
+    if opts[:verbose]
+      starttime = Time.now
+      puts "Initializing at #{starttime}"
+    end
+
+    puts "Loading configuration #{configfile}" if opts[:verbose]
+    config = YAML::load(File.read(configfile))
+    config[:opts] = opts
+
+    p = ShadowPass.new(config)
+
+    if opts[:set]
+      path = opts[:set].split('/')
+      puts "secret: "
+      path << STDIN.noecho {|i| i.gets}.chomp
+      p.set(path)
+    end
+
+    if opts[:get]
+      path = opts[:get].split('/')
+      value = p.get(path)
+      puts value
+    end
+
+  end
+end
+
+command.run(ARGV)

data/etc/shadowpass.yaml.sample

@@ -0,0 +1,3 @@
+---
+:pwfile: '~/.pw.asc'
+:keyid: 'ABCD1234'

data/lib/shadowpass.rb

@@ -0,0 +1,107 @@
+require 'pp'
+require 'gpgme'
+require 'json'
+require 'awesome_print'
+require 'io/console'
+
+
+# @author Zach Leslie
+class ShadowPass
+  VERSION = '0.0.1'
+
+  def initialize (config)
+    @config = config
+    @pwfile = File.expand_path(@config[:pwfile])
+    @keyid = config[:keyid]
+    @verbose = config[:opts][:verbose]
+    # determine of this is a new database
+    if File.exists?(@pwfile)
+      @shadows = loadShadow
+    else
+      @shadows = initShadow
+    end
+  end
+
+  def get (path)
+    speak("looking for value at #{path.join('/')}")
+    value = path.inject(@shadows) {|result, element|
+      if result[element]
+        result[element]
+      else
+        result
+      end
+    }
+  end
+
+  def set (path)
+    value = path.pop
+
+    # Build the new data object with the supplied path
+    speak("building new data object")
+    data = path.reverse.inject(value) {|result, element|
+      { element => result }
+    }
+
+    # Merge the new data object into the existing shadow
+    speak("merging new data object into shadows")
+    if @shadows.empty?
+      flush data
+    else
+      newshadows = merge_gently(@shadows,data)
+      flush newshadows
+    end
+  end
+
+  def merge_gently(a,b)
+    speak('received original data object')
+    speak('received new data object')
+    data = Hash.new
+    a.each do |k,v|
+      if k == b.keys.first
+        # Ig data[k] is a string, then we are likely replacing something here.
+        data[k] = merge_gently(a[k],b[k]) unless data[k].is_a? String
+        data
+      else
+        data[k] = a[k]
+        data[b.keys.first] = b[b.keys.first]
+        data
+      end
+    end
+    speak('here is the merged data object to be returned')
+    data
+  end
+
+  def speak(what)
+    puts what if @verbose
+  end
+
+  # Encrypt the data object and flush to disk
+  def flush( data )
+    # Build ciphertext
+    crypto = GPGME::Crypto.new(:armor => true)
+    cipher = crypto.encrypt "#{data.to_json}", :recipients => @keyid
+    # Write te cypertext to the file
+    speak("write the shadow data to file at #{@pwfile}")
+    File.open(@pwfile, 'w') {|f| f.write( cipher.read ) }
+  end
+
+  private
+
+  # initialize the shadow data
+  def initShadow
+    speak("initializing #{@pwfile}")
+    # Build and return the initial data object
+    data = Hash.new
+    data
+  end
+
+  def loadShadow
+    # decrypt and read the shadow file
+    speak("loading datafile #{@pwfile}")
+    crypto = GPGME::Crypto.new(:armor => true)
+    clear = crypto.decrypt(File.open(@pwfile))
+    # returns cleartext object
+    JSON.parse( clear.read )
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: shadowpass
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Zach Leslie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gpgme
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: xaque208@gmail.com
+executables:
+- shadowpass
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/shadowpass
+- lib/shadowpass.rb
+- etc/shadowpass.yaml.sample
+- README.md
+homepage: https://github.com/xaque208/shadowpass
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A tool for keeping a GnuPG password store.
+test_files: []
+has_rdoc: