pwl 0.0.2 → 0.0.3

data/Gemfile

@@ -3,7 +3,8 @@ source "http://rubygems.org"
 gem 'encryptor', "~> 1.1"
 gem 'commander', "~> 4.1"
 gem 'activesupport', "~> 3.2"
-gem 'jbuilder', '~> 0.4'
+gem 'activemodel', "~> 3.2"
+gem 'uuid', "~> 2.3"
 
 group :test do
   gem "rake", '~> 0.9'
@@ -15,6 +16,7 @@ end
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rdoc", "~> 3.1"
+  gem "pry" #, "~> 3.1"
   gem "bundler", "~> 1.1"
   gem "jeweler", "~> 1.8"
 end

data/Gemfile.lock

@@ -1,30 +1,38 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
     activesupport (3.2.3)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    blankslate (2.1.2.4)
+    builder (3.0.0)
+    coderay (1.0.6)
     commander (4.1.2)
       highline (~> 1.6.11)
     encryptor (1.1.3)
     git (1.2.5)
     highline (1.6.11)
     i18n (0.6.0)
-    jbuilder (0.4.0)
-      activesupport (>= 3.0.0)
-      blankslate (>= 2.1.2.4)
     jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
     json (1.7.0)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
+    method_source (0.7.1)
     multi_json (1.3.4)
     nokogiri (1.4.7)
     nokogiri-diff (0.1.0)
       nokogiri (~> 1.4.1)
       tdiff (~> 0.3.2)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -32,19 +40,25 @@ GEM
       multi_json (~> 1.3)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
+    slop (2.4.4)
+    systemu (2.5.1)
     tdiff (0.3.2)
+    uuid (2.3.5)
+      macaddr (~> 1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activemodel (~> 3.2)
   activesupport (~> 3.2)
   bundler (~> 1.1)
   commander (~> 4.1)
   encryptor (~> 1.1)
-  jbuilder (~> 0.4)
   jeweler (~> 1.8)
   nokogiri-diff (~> 0.1)
+  pry
   rake (~> 0.9)
   rdoc (~> 3.1)
   simplecov (~> 0.6)
+  uuid (~> 2.3)

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/bin/pwl

@@ -1,166 +1,29 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
-require 'commander/import'
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'commander/import'
 require 'pwl'
+include Pwl::Commands
 
 program :version, Pwl::VERSION
 program :description, "#{program(:name)} is a secure password locker for the command line."
-
-EXIT_CODES = {
-  :success               => Pwl::Message.new('Success.'),
-  :aborted               => Pwl::Message.new('Aborted by user.', 1),
-  :passwords_dont_match  => Pwl::ErrorMessage.new('Passwords do not match.', 2),
-  :no_value_found        => Pwl::Message.new('No value found for <%= name %>.', 3, :name => 'NAME'),
-  :file_exists           => Pwl::ErrorMessage.new('There already exists a locker at <%= file %>. Use --force to overwrite it or --file to specify a different locker.', 4, :file => 'FILE'),
-  :file_not_found        => Pwl::ErrorMessage.new('Locker file <%= file %> could not be found.', 5, :file => 'FILE'),
-  :name_blank            => Pwl::ErrorMessage.new('Name may not be blank.', 6),
-  :value_blank           => Pwl::ErrorMessage.new('Value may not be blank.', 7),
-  :list_empty            => Pwl::Message.new('List is empty.', 8),
-  :list_empty_filter     => Pwl::Message.new('No names found that match filter <%= filter %>.', 9, :filter => 'FILTER'),
-  :validation_new_failed => Pwl::ErrorMessage.new('<%= message %>.', 10, :message => 'Validation of new master password failed'),
-  :unknown_export_format => Pwl::ErrorMessage.new('<%= format %> is not a known export format.', 11, :format => 'FORMAT'),
-}
-
-program :help, 'Exit Status',  "#{program(:name)} sets the following exit status:\n\n" + EXIT_CODES.values.sort{|l,r| l.exit_code <=> r.exit_code}.collect{|m| "      #{m.exit_code.to_s.rjust(EXIT_CODES.size.to_s.size)}: #{m.to_s}"}.join("\n")
+program :help, 'Exit Status',  "#{program(:name)} sets the following exit status:\n\n" + Pwl::Commands::Base.exit_codes_help
 program :help, 'Author', 'Nicholas E. Rabenau <nerab@gmx.at>'
 
-DEFAULT_LOCKER_FILE = File.expand_path("~/.#{program(:name)}.pstore")
-DEFAULT_EXPORT_TEMPLATE = File.join(File.dirname(__FILE__), *%w[.. templates export.html.erb])
-
-locker_file = DEFAULT_LOCKER_FILE
-
 global_option '-V', '--verbose', 'Enable verbose output'
-global_option('-f', '--file FILE', 'Determine the file that holds the locker'){|file| locker_file = file}
+global_option('-f', '--file FILE', 'Determine the file that holds the locker')
 global_option '-g', '--gui', 'Request the master password using an OS-specific GUI dialog. This option takes precedence over STDIN.'
 
-command :init do |c|
-  c.syntax = "#{program(:name)} #{c.name}"
-  c.summary = 'Initializes a new locker'
-  c.description = 'This command initializes a new password locker. Password quality is enforced using validation rules.'
-  c.example "Initializes a new password locker in #{DEFAULT_LOCKER_FILE}", "#{program(:name)} #{c.name}"
-  c.example "Initializes a new password locker in /tmp/crackme.txt", "#{program(:name)} #{c.name} --file /tmp/crackme.txt"
-  c.option '--force', 'Force-overwrite an existing locker file'
-  c.action do |args, options|
-    # Locker checks this too, but we want to fail fast.
-    exit_with(:file_exists, options.verbose, :file => locker_file) if File.exists?(locker_file) && !options.force
-
-    begin
-      begin
-        master_password = get_password('Enter new master password:', options.gui)
-      end while begin
-        validate!(master_password) # Basic idea from http://stackoverflow.com/questions/136793/is-there-a-do-while-loop-in-ruby
-      rescue Pwl::InvalidMasterPasswordError => e
-        STDERR.puts e.message
-        options.gui || STDIN.tty? # only continue the loop when in interactive mode
-      end
-
-      # Ask for password confirmation if running in interactive mode (terminal)
-      if STDIN.tty? && master_password != get_password('Enter master password again:', options.gui)
-        exit_with(:passwords_dont_match, options.verbose)
-      end
-    rescue Pwl::Dialog::Cancelled
-      exit_with(:aborted, options.verbose)
-    end
-
-    Pwl::Locker.new(locker_file, master_password, {:force => options.force})
-    STDERR.puts "Successfully initialized new locker at #{locker_file}" if options.verbose
-  end
-end
-
-command :get do |c|
-  c.syntax = "#{program(:name)} #{c.name} NAME"
-  c.summary = 'Retrieves the value for NAME and prints it to STDOUT.'
-  c.description = 'This command retrieves the value stored under NAME and prints it on STDOUT.'
-  c.example 'Reads the value stored under the name "foo" and prints it to STDOUT', "#{program(:name)} #{c.name} foo"
-  c.action do |args, options|
-    # Locker checks this too, but we want to fail fast and provide a message.
-    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
-    exit_with(:name_blank, options.verbose) if 0 == args.size || args[0].blank?
-
-    begin
-      result = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui)).get(args[0])
-      if result.blank?
-        exit_with(:no_value_found, options.verbose, :name => args[0])
-      else
-        puts result
-      end
-    rescue Pwl::Dialog::Cancelled
-      exit_with(:aborted, options.verbose)
-    end
-  end
-end
-
-command :list do |c|
-  c.syntax = "#{program(:name)} #{c.name} [FILTER]"
-  c.summary = 'Lists all names with optional FILTER.'
-  c.description = 'This command prints all names to STDOUT. If present, only those names matching FILTER will be returned.'
-  c.example 'Prints all names', "#{program(:name)} #{c.name}"
-  c.example 'Prints all names which start with "foo"', "#{program(:name)} #{c.name} foo"
-  c.example 'Prints all names separated by comma', "#{program(:name)} #{c.name} --separator ,"
-  c.option '-s', '--separator SEPARATOR', String, 'Separate names by SEPARATOR'
-  c.action do |args, options|
-    # Locker checks this too, but we want to fail fast and provide a message.
-    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
-
-    options.default :separator => ' '
-
-    begin
-      result = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui)).list(args[0]).join(options.separator)
-      if !result.blank?
-        puts result
-      else
-        if args[0] # filter given
-          exit_with(:list_empty_filter, options.verbose, args[0])
-        else
-          exit_with(:list_empty, options.verbose)
-        end
-      end
-    rescue Pwl::Dialog::Cancelled
-      exit_with(:aborted, options.verbose)
-    end
-  end
-end
-
 command :add do |c|
   c.syntax = "#{program(:name)} #{c.name} NAME [VALUE]"
   c.summary = 'Stores VALUE under NAME'
   c.description = 'Adds or updates the entry stored under NAME. If NAME is already present in the locker, it will be updated with VALUE. If NAME is not already present in the locker, a new entry will be created. If VALUE is not given, it will be read from STDIN.'
   c.example 'Stores the value "bar" under the name "foo"', "#{program(:name)} #{c.name} foo bar"
   c.example 'Reads STDIN and stores that as value under the name "foo"', "#{program(:name)} #{c.name} foo"
-  c.action do |args, options|
-    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
-    exit_with(:name_blank, options.verbose) if 0 == args.size || args[0].blank?
-
-    # Ask for the master password _before_ it may be necessary to ask for the value in a terminal
-    begin
-      locker = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui))
-    rescue Pwl::Dialog::Cancelled
-      exit_with(:aborted, options.verbose)
-    end
-
-    value = args[1]
-
-    if !value
-      exit_with(:value_blank, options.verbose) unless STDIN.tty? || options.gui
-
-      begin
-        value = get_text("Enter value for name '#{args[0]}':", options.gui)
-      rescue Pwl::Dialog::Cancelled
-        exit_with(:aborted, options.verbose)
-      end
-
-      # still blank, even after asking for it?
-      if value.blank?
-        exit_with(:value_blank, true)
-      end
-    end
-
-    locker.add(args[0], value)
-    STDERR.puts "Successfully stored new value under #{args[0]}." if options.verbose
-  end
+  c.action Add.new
 end
 
 command :delete do |c|
@@ -168,63 +31,7 @@ command :delete do |c|
   c.summary = 'Deletes the entry stored under NAME'
   c.description = 'Deletes the complete entry that is stored under NAME. If NAME is not present in the locker, an error will thrown.'
   c.example 'Deletes what was stored under the name "foo"', "#{program(:name)} #{c.name} foo"
-  c.action do |args, options|
-    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
-    exit_with(:name_blank, options.verbose) if 0 == args.size || args[0].blank?
-
-    begin
-      locker = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui))
-    rescue Pwl::Dialog::Cancelled
-      exit_with(:aborted, options.verbose)
-    end
-
-    locker.delete(args[0])
-    STDERR.puts "Successfully deleted the value under #{args[0]}." if options.verbose
-  end
-end
-
-command :passwd do |c|
-  c.syntax = "#{program(:name)} #{c.name} [NEW_MASTER_PASSWORD]"
-  c.summary = 'Changes the master password to NEW_MASTER_PASSWORD.'
-  c.description = 'This command changes the master password of the locker. Password quality is enforced using validation rules.'
-  c.action do |args, options|
-    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
-
-    begin
-      locker = Pwl::Locker.open(locker_file, get_password("Enter the current master password for #{program(:name)}:", options.gui))
-
-      if !STDIN.tty? && !options.gui
-        # If we are in a pipe and do not run in GUI mode, we accept the new master password as args[0]
-        new_master_password = args[0]
-
-        begin
-          validate!(new_master_password)
-        rescue Pwl::InvalidMasterPasswordError => e
-          exit_with(:validation_new_failed, options.verbose, :message => e.message)
-        end
-      else
-        # If running interactively (console or gui), we loop until we get a valid password or break
-        begin
-          new_master_password = get_password("Enter the new master password for #{program(:name)}:", options.gui)
-        end while begin
-          validate!(new_master_password)
-        rescue Pwl::InvalidMasterPasswordError => e
-          STDERR.puts e.message
-          options.gui || STDIN.tty? # only continue the loop when in interactive mode
-        end
-
-        # Confirm new password
-        if new_master_password != get_password("Enter the new master password for #{program(:name)} again:", options.gui)
-          exit_with(:passwords_dont_match, options.verbose)
-        end
-      end
-    rescue Pwl::Dialog::Cancelled
-      exit_with(:aborted, options.verbose)
-    end
-
-    locker.change_password!(new_master_password)
-    STDERR.puts "Successfully changed master password for #{program(:name)}." if options.verbose
-  end
+  c.action Delete.new
 end
 
 command :export do |c|
@@ -236,41 +43,53 @@ command :export do |c|
   c.example 'Prints all entries in HTML format (default)', "#{program(:name)} #{c.name} --format html"
   c.example 'Prints all entries in JSON format', "#{program(:name)} #{c.name} --format json"
   c.example 'Prints all entries in YAML format', "#{program(:name)} #{c.name} --format yaml"
-  c.action do |args, options|
-    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
-    options.default :format => 'html'
-
-    presenter = {:html => Pwl::Presenter::Html, :json => Pwl::Presenter::Json, :yaml => Pwl::Presenter::Yaml}[options.format.to_sym]
-    exit_with(:unknown_export_format, options.verbose, :format => options.format) if presenter.nil?
-    
-    begin
-      locker = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui))
-      puts presenter.new(locker).to_s
-    rescue Pwl::Dialog::Cancelled
-      exit_with(:aborted, options.verbose)
-    end
-  end
+  c.action Export.new
 end
 
-def exit_with(error_code, verbose, msg_args = {})
-  msg = EXIT_CODES[error_code]
-  raise "No message defined for error #{error_code}" if !msg
-
-  if msg.error? || verbose # always print errors; messages only when verbose
-    STDERR.puts msg.to_s(msg_args)
-  end
+command :get do |c|
+  c.syntax = "#{program(:name)} #{c.name} NAME [FIELD]"
+  c.summary = 'Retrieves the value for NAME and prints it to STDOUT.'
+  c.description = 'This command retrieves the value stored under NAME and prints it on STDOUT.'
+  c.example 'Reads the value stored under the name "foo" and prints it to STDOUT', "#{program(:name)} #{c.name} foo"
+  c.action Get.new
+end
 
-  exit(msg.exit_code)
+command :init do |c|
+  c.syntax = "#{program(:name)} #{c.name}"
+  c.summary = 'Initializes a new locker'
+  c.description = 'This command initializes a new password locker. Password quality is enforced using validation rules.'
+  c.example "Initializes a new password locker in #{Base.default_locker_file}", "#{program(:name)} #{c.name}"
+  c.example "Initializes a new password locker in /tmp/crackme.txt", "#{program(:name)} #{c.name} --file /tmp/crackme.txt"
+  c.option '--force', 'Force-overwrite an existing locker file'
+  c.action Init.new
 end
 
-def get_password(prompt, gui = false)
-  (gui ? Pwl::Dialog::Password.new(program(:name), prompt) : Pwl::Dialog::ConsolePasswordDialog.new(prompt)).get_input
+command :list do |c|
+  c.syntax = "#{program(:name)} #{c.name} [FILTER]"
+  c.summary = 'Lists all names with optional FILTER.'
+  c.description = 'This command prints all names to STDOUT. If FILTER is present, only matching names will be printed.'
+  c.option '--long', 'List in long format.'
+  c.example 'Prints all names', "#{program(:name)} #{c.name}"
+  c.example 'Prints all names which start with "foo"', "#{program(:name)} #{c.name} foo"
+  c.example 'Prints all names separated by comma', "#{program(:name)} #{c.name} --separator ,"
+  c.option '-s', '--separator SEPARATOR', String, 'Separate names by SEPARATOR. Not applicable in long format.'
+  c.action List.new
 end
 
-def get_text(prompt, gui = false)
-  (gui ? Pwl::Dialog::Text.new(program(:name), prompt) : Pwl::Dialog::ConsoleTextDialog.new(prompt)).get_input
+command :passwd do |c|
+  c.syntax = "#{program(:name)} #{c.name} [NEW_MASTER_PASSWORD]"
+  c.summary = 'Changes the master password to NEW_MASTER_PASSWORD.'
+  c.description = 'This command changes the master password of the locker. Password quality is enforced using validation rules.'
+  c.action Passwd.new
 end
 
-def validate!(pwd)
-  Pwl::Locker.password_policy.validate!(pwd)
+command :stats do |c|
+  c.syntax = "#{program(:name)} #{c.name}"
+  c.summary = 'Provides simple statistics'
+  c.description = 'This command provides basic statistical information about a password locker.'
+  c.option '--format [FORMAT]', String, 'Specify format. If this option is not present, text format is assumed.'
+  c.example 'Prints stats in HTML format (default)', "#{program(:name)} #{c.name} --format html"
+  c.example 'Prints stats in JSON format', "#{program(:name)} #{c.name} --format json"
+  c.example 'Prints stats in YAML format', "#{program(:name)} #{c.name} --format yaml"
+  c.action Stats.new
 end

data/lib/pwl.rb

@@ -8,11 +8,23 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[pwl])
 require 'message'
 require 'password_policy'
 require 'locker'
+require 'entry'
+require 'entry_mapper'
 require 'dialog'
 require 'presenter/html'
 require 'presenter/json'
 require 'presenter/yaml'
 
+require 'commands/base'
+require 'commands/add'
+require 'commands/delete'
+require 'commands/export'
+require 'commands/get'
+require 'commands/init'
+require 'commands/list'
+require 'commands/passwd'
+require 'commands/stats'
+
 module Pwl
   VERSION = File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION]))
 end

data/lib/pwl/commands/add.rb

@@ -0,0 +1,36 @@
+module Pwl
+  module Commands
+    class Add < Base
+      def call(args, options)
+        exit_with(:name_blank, options.verbose) if 0 == args.size || args[0].blank?
+
+        # Ask for the master password _before_ it may be necessary to ask for the value in a terminal
+        begin
+          locker = open_locker(options)
+        rescue Pwl::Dialog::Cancelled
+          exit_with(:aborted, options.verbose)
+        end
+
+        value = args[1]
+
+        if !value
+          exit_with(:value_blank, options.verbose) unless STDIN.tty? || options.gui
+
+          begin
+            value = get_text("Enter value for name '#{args[0]}':", options.gui)
+          rescue Pwl::Dialog::Cancelled
+            exit_with(:aborted, options.verbose)
+          end
+
+          # still blank, even after asking for it?
+          if value.blank?
+            exit_with(:value_blank, true)
+          end
+        end
+
+        locker.add(args[0], value)
+        msg "Successfully stored new value under #{args[0]}." if options.verbose
+      end
+    end
+  end
+end