pwss 0.5.1 → 0.6.0

data/lib/pwss/cli/command_syntax.rb

@@ -0,0 +1,156 @@
+require 'slop'
+require 'pwss/password'
+
+module Pwss
+  module CommandSyntax
+    # return a hash with all the commands and their options 
+    def self.commands
+      h = Hash.new
+      self.methods.each do |method|
+        if method.to_s.include?("_opts") then
+          h = h.merge(eval(method.to_s))
+        end
+      end
+      return h
+    end
+
+    # the default number of seconds password is available in the clipboard
+    DEFAULT_WAIT = 45
+    # the default password length
+    DEFAULT_LENGTH = Pwss::Password::DEFAULT_PASSWORD_LENGTH
+
+    private
+
+    def self.version_opts
+      opts = Slop::Options.new
+      opts.banner = "version -- print version information"
+      return { :version => [opts, :version] }
+    end
+
+    def self.init_opts
+      opts = Slop::Options.new
+      opts.banner = "init [options] -- init a new password file"
+      opts.string "-f", "--filename", "Password file to create. Use '.enc' or '.gpg' for encryption"
+      return { :init => [opts, :init] }
+    end
+    
+    def self.list_opts
+      opts = Slop::Options.new
+      opts.banner = "list [options] -- list all entries in a file"
+      opts.string "-f", "--filename", "Password file to use"
+      opts.bool   "-c", "--clean", "Clean timestamps from entries"
+      return { :list => [opts, :list] }
+    end
+
+    def self.get_opts
+      opts = Slop::Options.new
+      opts.banner = "get [options] -- get a stored field of a record (it defaults to password)"
+
+      opts.string "-f", "--filename", "Password file to use"
+      opts.bool "--stdout", "Output the password to standard output"
+      opts.bool "-h", "--hide", "Hide sensitive fields"
+      opts.integer "-w", "--wait", "Number of seconds the field is available in the clipboard (0 = wait for user input)", default: DEFAULT_WAIT
+      opts.string "--field", "Field to make available on stdout or clipboard (password by default)"
+      return { :get => [opts, :get] }
+    end
+
+    def self.add_and_new_opts
+      opts = Slop::Options.new
+      opts.banner = "add|new [options] [entry title] -- add an entry and copy its password in the clipboard"
+      opts.string "-f", "--filename", "Password file to use"
+      opts.integer "-w", "--wait", "Seconds password is available in the clipboard (0 = interactive)", default: DEFAULT_WAIT
+      opts.string "-t", "--type", "Create an entry of type TYPE (Entry, CreditCard, BankAccount, SoftwareLicense, Sim).\n                        Default to 'Entry', which is good enough for websites credentials"
+      opts.string "-m", "--method", "Method to generate the password (one of: random, alpha, ask; default to random)"
+      opts.bool "--ask", "A shortcut for --method ask"
+      opts.integer "-l", "--length", "Password length (when random or alpha; default #{DEFAULT_LENGTH})", default: DEFAULT_LENGTH
+      return { :add => [opts, :add_entry],
+               :new => [opts, :add_entry] }
+    end
+
+    def self.update_opts
+      opts = Slop::Options.new
+      opts.banner = "update [options] string -- Update specified field of (user selected) entry matching <string>"
+      opts.string "-f", "--filename", "Password file to use"
+      opts.string "--field", "Field to update"
+      opts.bool "-p", "--password", "an alias for --field password"
+      opts.string "-m", "--method", "Method to generate the password (one of: random, alpha, ask; default to random)"
+      opts.bool "--ask", "A shortcut for [--field password] --method ask"
+      opts.integer "-l", "--length", "Password length (when random or alpha; default #{DEFAULT_LENGTH})", default: DEFAULT_LENGTH
+      opts.integer "-w", "--wait", "Seconds new field is available in the clipboard for (0 = interactive)", default: DEFAULT_WAIT
+      return { :update => [opts, :update] }
+    end
+
+    def self.destroy_opts
+      opts = Slop::Options.new
+      opts.banner = "destroy|rm [options] string -- Destroy a user-selected entry matching <string>, after user confirmation"
+      opts.string "-f", "--filename", "Password file to create. Use extension '.enc' to encrypt it"
+      return { :destroy => [opts, :destroy],
+               :rm => [opts, :destroy] }
+    end
+
+    def self.encrypt_opts
+      opts = Slop::Options.new
+      opts.banner = "encrypt [options] -- Encrypt a password file"
+      opts.bool "--symmetric", "Use symmetric encryption"
+      opts.bool "--gpg", "Use gpg (default: no need to specify it)"
+      opts.string "-f", "--filename", "Password file to encrypt. Write to <file>.[enc,gpg]"
+      return { :encrypt => [opts, :encrypt] }
+    end
+
+    def self.decrypt_opts
+      opts = Slop::Options.new
+      opts.banner = "decrypt [options] -- Decrypt a password file"
+      opts.string "-f", "--filename", "Password file to encrypt. Write to <file>.enc"
+      return { :decrypt => [opts, :decrypt] }
+    end
+
+    def self.console_opts
+      opts = Slop::Options.new
+      opts.banner = "console [options] -- Enter the console"
+      opts.string "-f", "--filename", "Password file to encrypt. Write to <file>.enc"
+      return { :console => [opts, :console] } 
+    end
+
+    def self.man_opts
+      opts = Slop::Options.new
+      opts.banner = "man -- print a manual page"
+      return { :man => [opts, :man] }
+    end
+
+    def self.help_opts
+      opts = Slop::Options.new
+      opts.banner = "help [command] -- print usage string"
+      return { :help => [opts, :help] }
+    end
+
+    def self.describe_opts
+      opts = Slop::Options.new
+      opts.banner = "describe [options] -- describe fields of an entry type or all types"
+      opts.string "-t", "--type", "Type to describe"
+      return { :describe => [opts, :describe] }
+    end
+    
+    #
+    # COMMANDS WHICH MAKE SENSE ONLY WITH THE CONSOLE
+    #
+
+    # change the default file
+    def self.open_opts
+      opts = Slop::Options.new
+      opts.banner = "open [options] -- change the default file used in the console"
+      opts.banner = "                  (makes sense only when launched from the console) "
+      opts.string "-f", "--filename", "Password file to use"
+      return { :open => [opts, :open] }
+    end
+
+    # which is the default file?
+    def self.default_opts
+      opts = Slop::Options.new
+      opts.banner = "default -- which file is the console currently operating on?"
+      opts.banner = "           (makes sense only when launched from the console) "
+      return { :default => [opts, :default] }
+    end
+    
+    
+  end
+end

data/lib/pwss/fileops.rb

@@ -1,33 +1,42 @@
 require 'fileutils'
+require 'gpgme'
 
 #
 # From file to string and back
 # There is no lower level than this
 #
-module FileOps
-  # load a file into a string
-  def self.load filename
-    file = File.open(filename, "rb")
-    file.read
-  end
+module Pwss
+  module FileOps
+    # load a file into a string
+    def self.load filename
+      file = File.open(filename, "rb")
+      file.read
+    end
 
-  # save a string to a file
-  def self.save filename, data
-    file = File.open(filename, "wb")
-    file.write data
-    file.close
-    # puts "Password safe #{filename} updated."
-  end
+    # save a string to a file
+    def self.save filename, data
+      file = File.open(filename, "wb")
+      file.write data
+      file.close
+    end
 
-  # check if the extension is ".enc"
-  def self.encrypted? filename
-    File.extname(filename) == ".enc"
-  end
+    # check if the extension is ".enc"
+    def self.encrypted? filename
+      gpg? filename or symmetric? filename
+    end
 
-  def self.backup filename
-    FileUtils::cp filename, filename + "~"
-    puts "Backup copy of password safe created in #{filename}~."
+    def self.symmetric? filename
+      File.extname(filename) == ".enc"
+    end
+
+    def self.gpg? filename
+     File.extname(filename) == ".gpg"
+    end    
+
+    def self.backup filename
+      FileUtils::cp filename, filename + "~"
+      puts "Backup copy of password safe created in #{filename}~."
+    end
+    
   end
-  
 end
-

data/lib/pwss/generators/bank_account.rb

@@ -0,0 +1,18 @@
+require 'pwss/generators/entry'
+
+module Pwss
+  class BankAccount < Entry
+    def initialize
+      super
+      @fields = [
+        "title",
+        "name",
+        "iban",
+        "url",
+        "username",
+        "password",
+        "description"
+      ]
+    end
+  end
+end

data/lib/pwss/generators/code.rb

@@ -0,0 +1,13 @@
+require 'pwss/generators/entry'
+
+module Pwss
+  class Code < Entry
+    def initialize
+      super
+      @fields = [
+        "title",
+        "code",
+      ]
+    end
+  end
+end

data/lib/pwss/generators/credit_card.rb

@@ -0,0 +1,23 @@
+require 'pwss/generators/entry'
+
+module Pwss
+  class CreditCard < Entry
+    def initialize
+      super
+      @fields = [
+        "title",
+        "issuer",
+        "name_on_card",
+        "card_number",
+        "valid_from",
+        "valid_till",
+        "verification_number",
+        "pin",
+        "url",
+        "username",
+        "password",
+        "description"
+      ]
+    end
+  end
+end

data/lib/pwss/generators/entry.rb

@@ -0,0 +1,36 @@
+module Pwss
+  #
+  # Entry generates an entry for the password safe
+  # It is a wrapper to a Hash
+  #
+  class Entry
+    attr_reader :entry
+    attr_reader :fields
+    
+    def initialize
+      @entry  = Hash.new
+      @fields = [
+        "title",
+        "url",
+        "username",
+        "password",
+        "recovery_email",
+        "description"
+      ]
+    end
+
+    # interactively ask the fields specified in +@fields+
+    #
+    # optional hash +arguments+ allows to pass arguments to the
+    # input-asking functions (including the default value for a key)
+    # See the documentation of Pwss::Fields::ask for more details.
+    #
+    def ask arguments = {}
+      @entry = Hash.new
+      @fields.each do |key|
+        @entry[key] = Fields.ask key, arguments
+      end
+    end
+
+  end
+end

data/lib/pwss/generators/fields.rb

@@ -0,0 +1,119 @@
+require 'readline'
+require 'date'
+
+require 'pwss/password'
+
+module Pwss
+  module Fields
+    INPUT_F = 0 
+    DEFAULT = 1
+    HIDDEN = 2
+
+    # this is a set of fields useful for different types of entries
+    # each entry will reference the symbols it needs to make sense
+    FIELDS = {
+      # everyone has...
+      "title"       => ["Readline.readline('title: ')", "''", false],
+      "url"         => ["Readline.readline('url: ')", "''", false],
+      "username"    => ["Readline.readline('username: ')", "''", false],
+      "recovery_email" => ["Readline.readline('email: ')", "''", false],
+      "password"    => ["Pwss::Password.password(arguments)", "Pwss::Password.password", true],
+      "description" => ["get_lines", "''", false],
+
+      # banks also have ...
+      "name"        => ["Readline.readline('name: ')", "''", false],
+      "iban"        => ["Readline.readline('iban: ')", "ITkk xaaa aabb bbbc cccc cccc ccc", false],
+
+      # cards also have
+      "issuer"       => ["Readline.readline('issuer: ')", "''", false],
+      "name_on_card" => ["Readline.readline('name on card: ')", "''", false],
+      "card_number"  => ["Readline.readline('number: ')", "''", true],
+      "valid_from"   => ["Readline.readline('valid from: ')", "''", false],
+      "valid_till"   => ["Readline.readline('valid till: ')", "''", false],
+      "verification_number" => ["Readline.readline('verification number: ')", "''", true],
+      "pin"          => ["Readline.readline('pin: ')", "''", true],
+
+      # SIMs also have
+      "puk"         => ["Readline.readline('puk: ')", "XXXX", true],
+      "phone"       => ["Readline.readline('phone: ')", "NNN NNN NNNN", false],
+
+      # Code has only title and code
+      "code"         => ["Readline.readline('code: ')", "XXXX", true],
+      
+      # useful for software licenses
+      "version"        => ["Readline.readline('version: ')", "''", false],
+      "licensed_to"    => ["Readline.readline('licensed to: ')", "''", false],
+      "license_number" => ["Readline.readline('license number: ')", "''", true],
+      "purchased_on"   => ["Readline.readline('purchased on: ')", "Date.today", false],
+    }
+
+    # ask the value for +key+
+    #
+    # This is performed by invoking the function defined for +key+ in the
+    # +FIELDS+, which typically asks for user input.  If the user enters a
+    # value this is the one the function returns, otherwise we return the
+    # default value defined for +key+ in +FIELDS+.
+    #
+    # Optional hash +arguments+ contains a list of arguments to be passed to
+    # the function in +FIELDS+.  This allows to customize the behaviour of the
+    # user-input function.
+    #
+    # **As a special case, if +arguments+ contains +key+, this is returned as
+    # the value.  This allows to set the default for a +key+ outside this
+    # module.**
+    #
+    # Thus, for instance: ask 'username', {'username' => 'a'} will return 'a'.
+    #
+    def self.ask key, arguments
+      # if the default is specified outside this class, return it!
+      return arguments[key] if arguments[key]
+
+      # ... otherwise, do some work and ask for the value!
+      input_f = FIELDS[key] ? FIELDS[key][INPUT_F] : "Readline.readline('#{key}: ')"
+      default = FIELDS[key] ? FIELDS[key][DEFAULT] : nil
+      value = eval input_f
+      if value != nil and value != "" then
+        value
+      else
+        default
+      end
+    end
+
+    # read n-lines (terminated by a ".")
+    def self.get_lines
+      puts "description (terminate with '.'):"
+      lines = []
+      line = ""
+      until line == "."
+        line = Readline.readline
+        lines << line if line != "."
+      end
+      lines.join("\n")
+    end
+
+    # take a hash as input and reorder the fields according to the order in
+    # which the fields are defined in the +FIELDS+ variable
+    #
+    # this function is used to present records in the YAML file always in the
+    # same order.
+    def self.to_clean_hash hash
+      output = Hash.new
+      FIELDS.keys.each do |field|
+        output[field] = hash[field] if hash[field]
+      end
+      # all the remaining fields (i.e., user-defined fields in records)
+      (hash.keys - FIELDS.keys).each do |field|
+        output[field] = hash[field]
+      end
+      output
+    end
+
+    def self.sensitive? field
+      FIELDS[field][HIDDEN]
+    end
+
+    def self.sensitive
+      FIELDS.select { |x| FIELDS[x][HIDDEN] }.keys
+    end
+  end
+end

data/lib/pwss/generators/sim.rb

@@ -0,0 +1,15 @@
+require 'pwss/generators/entry'
+
+module Pwss
+  class Sim < Entry
+    def initialize
+      super
+      @fields = [
+        "title",
+        "phone",
+        "pin",
+        "puk"
+      ]
+    end
+  end
+end