pwss 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d81cc493cb6f1b3dc7f917cdfa7fcbb81c844af4
-  data.tar.gz: 44c566b64b9fc0cf9b72f00a0396a9a72a400180
+  metadata.gz: f0d6de35d7d59295771fff8e0710f121b9fcaf3c
+  data.tar.gz: 15b6b84a494a01fdb2c94833481dc1bbc5c08818
 SHA512:
-  metadata.gz: 33cbef0aa13c6f8cf89313fddb500a289917e4c0c1e380b77b9494b85eee0c446601091573d01525e11ac2c704ced7312283e7adb2e4b2c0c99873a27f315bcc
-  data.tar.gz: aab0df3a4bff00ec6157e442d878706312209f4085ffa96cab604e7208d6bed0f3269f2e01724a03211df77b9cda74d1026349674643e8bb4649968380623370
+  metadata.gz: 2a6951a825180bdda38b6a26da7895bbb422862466cadfc1ea95703a050ae2c542ba2b61fb45a489c2ed3af83f6429843bc8dec6a668933acba6f305258b077e
+  data.tar.gz: 1ce2596579e801b3313ec443a98aac562ec94b3c2a933b59b3ad51bc35f1c8bdcd730c0c3795a0ff8318be528fb1a37177e6c0ec7b9288ea6fc35f9fe05a25e4

data/README.textile

@@ -2,49 +2,72 @@ h1. Pwss
 
 A password manager in the spirit of "pws":https://github.com/janlelis/pws.
 
+PWSS can store multiple entries in a file and, more important, it allows user to specify various types of entries (e.g., BankAccount) and different infos for each entry (e.g., URL for Internet passwords).
+
 Features:
 
-* Each entry stores: title, username, password, url, description
-* A file (or safe) can store many entries
-* The user can manage different files (safes)
+* PWSS manages password files.  A password file store passwords and other
+  sensitive information
+
+* Entries in a password file can be of the following pre-defined types:
+  Entry, CreditCard, BankAccount, SoftwareLicense
+
+* Information stored for each type:
+
+  - Entry:           title, username, password, url, description
+  - CreditCard:      title, issuer, name_on_card, card_number, valid_from, 
+                     valid_till, verification_number, pin, url, notes
+  - BankAccount:     title, name, iban, url, description
+  - SoftwareLicense: title, version, license_number, licensed_to,
+                     email, purchased_on
+
 * CRUD (create, read, update, delete) commands are available to
-  operate on entries and safes
-* pwss can generate completely random passwords for you
-* Safes can be encrypted (to improve security)
-* Encrypted safes can be decrypted (for instance to batch process
-  entries, to migrate to another tool, or to manually edit entries)
-* Entries are human readable and editable (when not encrypted)
+  operate on entries and password files
+
+* The user can manage different password files (e.g., work, personal)
+* Password files can be encrypted
+* Encrypted password files can be decrypted, for instance, to batch process
+  entries, to migrate to another tool, or to manually edit entries
+* Entries are human-readable (and editable), when the password file is not
+  encrypted
 
 h2. Installation
 
-Add this line to your application's Gemfile:
+Type from the command line:
+
+bc. $ gem install pwss
 
-bc. gem 'pwss'
+h2. Quick Start
 
-And then execute:
+Try the following:
 
-bc. $ bundle
+bc. $ pwss init
+$ pwss add
+$ pwss get <title you gave with previous command>
 
-Or install it yourself as:
+For some more information:
 
-bc. $ gem install pwss
+bc. $ pwss help # get information from the command line
+$ pwss -h   # command syntax
 
-h2. Usage
+h2. Detailed Instructions
 
-*Getting started.* @pwss@ stores passwords in a YAML file (also called "password safe" in the following), possibly encrypted.
+*Getting started.* @pwss@ stores passwords in a YAML file (also called "safe" or "password file" in the following), possibly encrypted.
 
 A typical usage scenario is the following:
 
 # @pwss init@ will create a new encrypted password safe in @~/.pwss.yaml.enc@
 # @pwss add@ will add a new entry to the file
-# @pwss get entry@ will retrieve all entries whose *title* contains @entry@ and make the password of the chosen entry available in the clipboard
+# @pwss get string@ will retrieve all entries whose *title* contains @string@ and make the password of the chosen entry available in the clipboard for a given period (the default is 30 seconds; the option @-w@ controls the amount of time the password is available)
 
-*Using multiple safes.* If you want to create multiple password safes or store the password safe in a non-standard location, use the @-f@ (@--filename@) option:
+*Using multiple safes.* If you want to create multiple password files or store a password file in a non-standard location, use the @-f@ (@--filename@) option:
 
 # @pwss -f MYFILE init@
 # @pwss -f MYFILE add@
 # @pwss -f MYFILE get@
 
+*Do not forget to use the extension @.enc@, if your password file to be encrypted.* (See "Encrypted and Plain files", below.)
+
 *Controlling how long passwords are made available* Use the @-w@ option to determine how long the password is made available in the clipboard.  For instance:
 
 bc. $ pwss get my_email -w 3
@@ -53,7 +76,13 @@ will retrieve entry whose title is @my_email@ and make the password available in
 
 Use @0@ to keep the password in the clipboard till a key is pressed.
 
-*Automatically Generated Password* pwss can automatically generate passwords for entries which are added or updated, using the @-g LENGTH@ option, where @LENGTH@ is the length of the password to generate.  If you want to generate password including only alphabetic and numeric characters, use the @-a@ option.  *The passwords are made available in the clipboard, so that it can be used as needed*.
+*Automatically Generated Password* pwss can automatically generate passwords for entries which are added or updated.
+
+The generated passwords are random sequences of chars and symbols and no attempt is made to make them readable or simpler to remember.  You can use the @-a@ option to limit the generator to use only digits and letters ([0-9a-zA-Z]): this is useful, for instance, if the website you're generating the password for does not accept certain classes of characters.
+
+Use the @-g LENGTH@ option to determine the password length.
+
+*The automatically generated password is made available in the clipboard, so that it can be used as needed*.
 
 For instance:
 
@@ -61,27 +90,25 @@ bc. $ pwss update my_email -g 10 -a -w 20
 
 will update the @my_email@ entry, by replacing the existing password with one of length @10@ automatically generated by @pwss@; the password contains only alphabetic characters and digits.  The new password will be made available in the clipboard for @20@ seconds.
 
-*Encrypted and Plain Files.* @pwss@ works equally well with encrypted and plain files.  More in details, the file extension determines whether @pwss@ tries to decrypt/encrypt the file or not.  The @.enc@ extension tells @pwss@ that the file is encrypted; any other extension will tell @pwss@ to treat the file as plain text.
+*Encrypted and Plain Files.* @pwss@ works equally well with encrypted and plain files.  More in details, the file extension determines whether @pwss@ tries to decrypt/encrypt the file or not.  Use @.enc@ extension to tell @pwss@ the file is encrypted; any other extension will tell @pwss@ to treat the file as plain text.
 
 For instance:
 
-bc. $ pwss -f a.yaml.enc init 
+bc. $ pwss init -f a.yaml.enc
 
-will store the password in the *encrypted* file @a.yaml.enc@.
+will initialize an encrypted safe @a.yaml.enc@.
 
 By contrast,
 
-bc. $ pwss -f a.yaml get entry
+bc. $ pwss init -f a.yaml
 
-will try to retrieve @entry@ from file @a.yaml@; the file is assumed to be in plain text by @pwss@ which will not ask for a master password, nor will try to decrypt it.
+Encrypting sensitive information is a good idea. (Just in case you were looking for a witty statement.)  However, if you use @pwss@ to store non-critical infomation, prefer to edit the password safe with a text editor, or use another application for managing encryption and decryption, using @pwss@ with the file in plain format might be more convenient.
 
-Encrypting important passwords is a good idea. (Just in case you were looking for a witty statement.)  However, if you use @pwss@ to store non-critical infomation, prefer to edit the password safe with a text editor, or use another application for managing encryption and decryption, using @pwss@ with the file in plain format might be more convenient.
-
-*Moving from plain to encrypted.* Use the @encrypt@ and @decrypt@ commands at any time to move from the plain to the encrypted format.
+*Moving from plain to encrypted.* You can use the @encrypt@ and @decrypt@ commands at any time to move from the plain to the encrypted format.
 
 bc. $ pwss -f YOURFILE encrypt 
 
-will encrypt @YOURFILE@ while @decrypt@ will perform the opposite operation.
+will encrypt @YOURFILE@, while @decrypt@ will perform the opposite operation.
 
 *Starting from an Existing File.*  You can also start from an existing file, as long as it is an array of YAML records, each containing, at least, a @title@ and a @password@ field.  (See next section, for the file structure.)
 
@@ -136,20 +163,29 @@ Notice that only @title@ and @password@ are required.
 
 h2. Changelog
 
+* *Release 0.3.0*
+** internal refactoring: CLI parsing is now based on "Slop":https://github.com/leejarvis/slop.  The documentation has been revised and should now be simpler to understand.
+** added some controls to avoid overwriting existing files (in particular: init, encrypt, and decrypt).  The command is now less Unix-like, but I hope you will appreciate a bit more safety.
+
+* *Release 0.2.0* (never really made it to the public -- use version 0.3.0)
+** it is now possible to add entries of various types (= with different fields).  The supported types include: CreditCard, BankAccount, SoftwareLicense.  Use the -e (--entry) option to specify the type of entry to add
+** an empty string can now be used to exit (instead of -1) when multiple matches are found
+
 * *Release 0.1.0*
 ** the update command now allows one to update the password or any other field of existing entries
 ** a simple password generator allows pwss to generate a random password
 ** most commands make the password of the selected entry available in the clipboard (useful, for instance, if you automatically generate a password)
 ** a destroy command allows one to delete an entry from a safe.  Similar to get, all entries matching a query are shown.  The user is then asked to select which entry has to be deleted or stop.  User confirmation is required even in case of a single match.
 
-h2. License and Additional Disclaimer
+h2. License
 
 Licensed under the terms of the MIT License.
 
+
 h2. Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/pwss/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+1. Fork it (http://github.com/<my-github-username>/pwss/fork )
+2. Create your feature branch (@git checkout -b my-new-feature@)
+3. Commit your changes (@git commit -am 'Add some feature'@)
+4. Push to the branch (@git push origin my-new-feature@)
 5. Create new Pull Request

data/bin/pwss

@@ -1,45 +1,130 @@
 #!/usr/bin/env ruby
 
 require 'fileutils'
-require 'mercenary'
+require 'slop'
 require 'date'
 
 require "pwss"
 require "pwss/version"
 require "pwss/cipher"
 require "pwss/entry"
+require "pwss/credit_card"
+require "pwss/bank_account"
+require "pwss/software_license"
 require "pwss/fileops"
 
-Mercenary.program(:pwss) do |p|
-  DEFAULT_FILENAME = File.join(Dir.home, ".pwss.yaml.enc")
+# load filename and decrypt, if necessary
+# return the filename as string and the password (in case you need to save)
+def file2string filename
+  string = FileOps::load filename
+  if FileOps::encrypted? filename then
+    password = Cipher::ask_password
+    string = Cipher::decrypt string, password
+  end
+  [string, password]
+end
+
+
+version = Pwss::VERSION
+man = <<EOS
+NAME
+  pwss -- A command-line password manager
+
+SYNOPSYS
+  pwss [-h|-v]
+  pwss command [options] [args]
+
+DESCRIPTION
+  PWSS is a password manager, in the spirit of pws.
+
+  Features:
+
+  * PWSS manages password files.  A password file store passwords and other
+    sensitive information
+
+  * Entries in a password file can be of the following pre-defined types:
+    Entry, CreditCard, BankAccount, SoftwareLicense
+
+  * Information stored for each type:
+
+    - Entry:           title, username, password, url, description
+    - CreditCard:      title, issuer, name_on_card, card_number, valid_from, 
+                       valid_till, verification_number, pin, url, notes
+    - BankAccount:     title, name, iban, url, description
+    - SoftwareLicense: title, version, license_number, licensed_to,
+                       email, purchased_on
+
+  * CRUD (create, read, update, delete) commands are available to
+    operate on entries and password files
+
+  * The user can manage different password files (e.g., work, personal)
+  * Password files can be encrypted
+  * Encrypted password files can be decrypted, for instance, to batch process
+    entries, to migrate to another tool, or to manually edit entries
+  * Entries are human-readable (and editable), when the password file is not
+    encrypted
+
+EXAMPLES
+  pwss -h                               # get syntax of each command
+
+  # scenario
+  pwss init -f a.enc                    # generate an encrypted safe a.enc
+  pwss add -f a.enc -g 16 -a            # add an entry (generating a password)
+  pwss get -f a.enc my secret account   # find an entry
 
-  p.version Pwss::VERSION
-  p.description <<EOS
-PWSS is a password safe, in the spirit of pws
-
-Features:
-
-* Each entry stores: title, username, password, url, description
-* A file (or safe) can store many entries
-* The user can manage different files (safes)
-* CRUD (create, read, update, delete) commands are available to
-  operate on entries and safes
-* Safes can be encrypted
-* Encrypted safes can be decrypted, for instance, to batch process
-  entries, to migrate to another tool, or to manually edit entries
-* Entries are human-readable (and editable), when not encrypted
+VERSION
+  This is version #{version}
+
+LICENSE
+  MIT
+
+SEE ALSO
+  pwss -h
+  https://github.com/avillafiorita/pwss
 EOS
 
-  p.syntax "pwss <subcommand> [options] [args]"
-  p.option 'filename', '-f FILE', '--filename FILE', 'Password file'
-  p.option 'wait', '-w SECS', '--wait SECS', 'Number of seconds password is available in the clipboard (use 0 for interactive).'
 
-  p.command(:init) do |c|
-    c.syntax "init"
-    c.description 'Init a new password file (= password safe)'
 
-    c.action do |args, opts|
-      filename = opts['filename']  || DEFAULT_FILENAME
+#
+# Main App Starts Here!
+#
+opts = Slop.parse :help => true do
+  # the default filename
+  DEFAULT_FILENAME = File.join(Dir.home, ".pwss.yaml.enc")
+  # the default number of seconds password is available in the clipboard
+  DEFAULT_SECS = 30
+
+  banner "pwss [-h|-v]\npwss command [options] [args]"
+
+  ##############################################################################
+  on "-v", "--version", 'Print version information' do
+    puts "pwss version #{version}"
+  end
+
+  ##############################################################################
+  command :help do
+    banner "pwss help"
+    description "Print detailed information about how to use pwss"
+
+    run do |_, _|
+      puts man
+    end
+  end
+
+  ##############################################################################
+  command :init do
+    banner "pwss init [options]"
+    description "Init a new password file"
+
+    on "-f", "--filename=", "Password file to create. Use extension '.enc' to encrypt it."
+
+    run do |opts, args|
+      filename = opts.to_hash[:filename] || DEFAULT_FILENAME
+
+      if File.exists?(filename)
+        puts "Error: file #{filename} already exists."
+        exit 1
+      end
 
       empty_safe = "# safe created on #{Date.today}\n"
 
@@ -58,12 +143,15 @@ EOS
     end
   end
 
-  p.command(:list) do |c|
-    c.syntax "list"
-    c.description "List all entries in a safe"
-      
-    c.action do |args, opts|
-      filename = opts['filename']  || DEFAULT_FILENAME
+  ##############################################################################
+  command :list do
+    banner "pwss list [options]"
+    description "List all entries of a file (e.g., to decrypt or batch process)"
+
+    on "-f", "--filename=", "Password file to use."
+
+    run do |opts, args|
+      filename = opts.to_hash[:filename] || DEFAULT_FILENAME
 
       string, _ = file2string filename
       entries = YAML::load(string) || Array.new
@@ -72,39 +160,55 @@ EOS
     end
   end
 
-  p.command(:get) do |c|
-    c.syntax "get string"
-    c.description "Get password for entry matching <string> in the title field"
+  ##############################################################################
+  command :get do
+    banner "pwss get [options] string"
+    description "Get password for entry matching <string> in the title field"
+
+    on "-f", "--filename=", "Password file to use."
+    on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive).", as: Integer
+
+    run  do |opts, args|
+      filename = opts.to_hash[:filename] || DEFAULT_FILENAME
+      waiting = opts.to_hash[:wait] || DEFAULT_SECS
 
-    c.action do |args, opts|
-      filename = opts['filename'] || DEFAULT_FILENAME
-      waiting = opts['wait'] ? opts['wait'].to_i : 30
-      
       string, _ = file2string filename
       entries = YAML::load(string) || Array.new
 
       password = Pwss::get args.join(" "), entries
-      Cipher.password_to_clipboard password, waiting
+      if password
+        Cipher.password_to_clipboard password, waiting 
+      end
     end
   end
 
-  p.command(:add) do |c|
-    c.syntax "add"
-    c.description "Add an entry to a password safe"
+
+  ##############################################################################
+  command :add do
+    banner "pwss add [options]"
+    description "Add an entry and copy its password in the clipboard"
+
+    on "-f", "--filename=", "Password file to use."
+    on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive).", as: Integer
       
-    c.option "generate", "-g LENGTH", "--generate LENGTH", "automatically generate a password of length LENGTH"
-    c.option "alnum", "-a", "--alnum", "use only alphanumeric characters for the generated password"
+    on "-e", "--entry=", "Create an entry of type TYPE (Entry, CreditCard, BankAccount, SoftwareLicense).\n                        Default to 'Entry', which is good enough for websites credentials."
 
-    c.action do |args, opts|
-      filename = opts['filename'] || DEFAULT_FILENAME
-      waiting = opts['wait'] ? opts['wait'].to_i : 30
-      length = opts['generate'] ? opts['generate'].to_i : 0
+    on "-g", "--generate=", "Generate a random password of given length.", as: Integer
+    on "-a", "--alnum", "Use only alphanumeric chars for the randomly generated password."
+
+    run do |opts, args|
+      filename = opts.to_hash[:filename] || DEFAULT_FILENAME
+      waiting  = opts.to_hash[:wait]     || DEFAULT_SECS
+      length   = opts.to_hash[:generate] || 0
+      type     = opts.to_hash[:type]     || "Entry"
+      alnum    = opts.to_hash[:alnum]
 
       string, password = file2string filename
 
+      puts "Adding an entry of type: #{type}"
       # ask for a new entry
-      pe = Pwss::Entry.new
-      pe.ask length, opts['alnum']
+      pe = eval("Pwss::" + type).new
+      pe.ask length, alnum
 
       # add the entry to the safe
       entries = YAML::load(string) || Array.new
@@ -122,24 +226,30 @@ EOS
 
       puts "Entry added."
       
-      # make password available in the clipboard
-      Cipher.password_to_clipboard pe.entry["password"], waiting
+      # make password available in the clipboard, if there is a password to make available
+      if pe.entry["password"] 
+        Cipher.password_to_clipboard pe.entry["password"], waiting
+      end
     end
   end
 
-  p.command(:update) do |c|
-    c.syntax "update a field of an existing entry"
-    c.description "Update some field of an existing entry (default: password)"
+  ##############################################################################
+  command :update do
+    banner "pwss update [options] string"
+    description "Update given field of user-selected entry matching <string>"
 
-    c.option 'field', '--field FIELD', 'Field to update (if not specified, update the password field)'
-    c.option "generate", "-g LENGTH", "--generate LENGTH", "generate a password of length LENGTH"
-    c.option "alnum", "-a", "--alnum", "use only alphabetic and numeric characters for the generated password"
+    on "-f", "--filename=", "Password file to use."
+    on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive).", as: Integer
+    on "-g", "--generate=", "Generate a random password of given length.", as: Integer
+    on "-a", "--alnum", "Use only alphanumeric chars for the randomly generated password."
+    on '--field=', 'Field to update (if not specified, update the password field).'
 
-    c.action do |args, opts|
-      filename = opts['filename'] || DEFAULT_FILENAME
-      waiting = opts['wait'] ? opts['wait'].to_i : 30
-      length = opts['generate'] ? opts['generate'].to_i : 0
-      field = opts['field']
+    run do |opts, args|
+      filename = opts.to_hash[:filename] || DEFAULT_FILENAME
+      waiting  = opts.to_hash[:wait]     || DEFAULT_SECS
+      length   = opts.to_hash[:generate] || 0
+      alnum    = opts.to_hash[:alnum]
+      field    = opts.to_hash[:field]
 
       string, password = file2string filename
 
@@ -150,7 +260,7 @@ EOS
         entries, entry_password = Pwss::update_field args.join(" "), entries, field
       else
         # update password
-        entries, entry_password = Pwss::update args.join(" "), entries, length, opts["alnum"]
+        entries, entry_password = Pwss::update args.join(" "), entries, length, alnum
       end
 
       # check status of input file and encrypt if necessary
@@ -166,22 +276,25 @@ EOS
       puts "Entry updated."
 
       # copy to clipboard the new password
-      Cipher.password_to_clipboard entry_password, waiting
+      if entry_password
+        Cipher.password_to_clipboard entry_password, waiting
+      end
     end
   end    
 
+  ##############################################################################
+  # Look for entries matching string, offer the user to select one of the
+  # matching entries, and destroy the entry.  
+  # The command asks for confirmation even if there is only one matching entry.
+  # Destroyed entries cannot be recovered (unless you dig in the backup file).
+  command :destroy do
+    banner "pwss destroy [options] string"
+    description "Destroy a user-selected entry matching <string>, after user confirmation."
 
-  p.command(:destroy) do |c|
-    c.syntax "destroy string"
-    c.description "Show entries matching <string> and let the user select one to destroy"
+    on "-f", "--filename=", "Password file to create. Use extension '.enc' to encrypt it."
 
-    # Look for entries matching string, offer the user to select one of the
-    # matching entries, and destroy the entry.  
-    # The command asks for confirmation even if there is only one matching entry.
-    # Destroyed entries cannot be recovered (unless you dig in the backup file).
-      
-    c.action do |args, opts|
-      filename = opts['filename'] || DEFAULT_FILENAME
+    run do |opts, args|
+      filename = opts.to_hash[:filename] || DEFAULT_FILENAME
 
       string, password = file2string filename
       entries = YAML::load(string)
@@ -201,64 +314,71 @@ EOS
       puts "Entry deleted."
     end
   end
-  
 
-  #
-  # Operations on the master file
-  #
+  ##############################################################################
+  # OPERATIONS ON PASSWORD FILES
+  ##############################################################################
 
-  p.command(:encrypt) do |c|
-    c.syntax "encrypt"
-    c.description "Encrypt a password safe"
-      
-    c.action do |_, opts|
-      filename = opts['filename'] || DEFAULT_FILENAME.sub(/\.enc$/, "")
+  ##############################################################################
+  command :encrypt do
+    banner "pwss encrypt [options]"
+    description "Encrypt a password safe"
+    
+    on "-f", "--filename=", "Password file to encrypt. Write to <file>.enc."
+
+    run do |opts, _|
+      filename = opts.to_hash[:filename] || DEFAULT_FILENAME.sub(/\.enc$/, "")
+
+      if not File.exists?(filename)
+        puts "Error: file #{filename} does not exist."
+        exit 1
+      end
 
       password = Cipher::check_password
       data = FileOps::load filename
       encrypted = Cipher::encrypt data, password
 
       enc_filename = filename + ".enc"
+
+      if File.exists?(enc_filename)
+        FileOps::backup enc_filename
+        puts "Warning: existing #{enc_filename} backupped to #{enc_filename}~"
+      end
       FileOps::save enc_filename, encrypted
       puts "An encrypted copy now lives in #{enc_filename}"
       puts "You might want to check everything is ok and delete the plain file: #{filename}"
     end
   end
 
-  p.command(:decrypt) do |c|
-    c.syntax "decrypt"
-    c.description "Decrypt a password safe"
-      
-    c.action do |_, opts|
-      filename = opts['filename'] || DEFAULT_FILENAME
+  ##############################################################################
+  command :decrypt do
+    banner "pwss decrypt [options]"
+    description "Decrypt a password safe"
+
+    on "-f", "--filename=", "Password file to decrypt.  Write to <file>, without '.enc'."
+
+    run do |opts, _|
+      filename = opts.to_hash[:filename] || DEFAULT_FILENAME
+
+      if not File.exists?(filename)
+        puts "Error: file #{filename} does not exist."
+        exit 1
+      end
 
       password = Cipher::ask_password
       data = FileOps::load filename
       decrypted = Cipher::decrypt data, password
 
       dec_filename = filename.sub(/\.enc$/,"")
+      if File.exists?(dec_filename)
+        FileOps::backup dec_filename
+        puts "Warning: existing #{dec_filename} backupped to #{dec_filename}~"
+      end
+            
       FileOps::save dec_filename, decrypted
       puts "A decrypted copy now lives in #{dec_filename}"
       puts "You might want to check everything is ok and delete #{filename}, if you wish."
     end
   end
 
-  p.command(:help) do |c|
-    c.action do |_,_|
-      puts p.to_s
-    end
-  end
-
-  p.default_command(:help)
-
-  # load filename and decrypt, if necessary
-  # return the filename as string and the password (in case you need to save)
-  def file2string filename
-    string = FileOps::load filename
-    if FileOps::encrypted? filename then
-      password = Cipher::ask_password
-      string = Cipher::decrypt string, password
-    end
-    [string, password]
-  end
 end

data/lib/pwss.rb

@@ -85,12 +85,13 @@ module Pwss
 
     if found.size > 1 or confirm_even_if_one then
       printf "\nVarious matches." if found.size > 1
-      printf "\nSelect entry by ID (0..#{found.size-1}) or -1 to exit: "
+      printf "\nSelect entry by ID (0..#{found.size-1}); -1 or empty string to exit: "
 
       id = STDIN.gets.chomp.to_i
       while (id < -1 or id >= found.size)
-        printf "Select entry by ID (0..#{found.size-1}) or -1 to exit: "
-        id = STDIN.gets.chomp.to_i
+        printf "Select entry by ID (0..#{found.size-1}); -1 or empty string to exit: "
+        response = STDIN.gets.chomp
+        id = response == "" ? -1 : response.to_i
       end
       if id == -1 then
         exit -1

data/lib/pwss/bank_account.rb

@@ -0,0 +1,18 @@
+require 'pwss/entry'
+
+module Pwss
+  class BankAccount < Entry
+    def initialize
+      super
+      @fields = {
+        "title"       => ["Readline.readline('title: ')", "'title'"],
+        "name"        => ["Readline.readline('name: ')", "'name'"],
+        "iban"        => ["Readline.readline('iban: ')", "ITkk xaaa aabb bbbc cccc cccc ccc"],
+        "created_at"  => ["", "Date.today"],
+        "updated_at"  => ["", "nil"],
+        "url"         => ["Readline.readline('url: ')", "''"],
+        "description" => ["get_lines",   "''"]
+      }
+    end
+  end
+end

data/lib/pwss/credit_card.rb

@@ -0,0 +1,23 @@
+require 'pwss/entry'
+
+module Pwss
+  class CreditCard < Entry
+    def initialize
+      super
+      @fields = {
+        "title"        => ["Readline.readline('title: ')", "'title'"],
+        "issuer"       => ["Readline.readline('issuer: ')", "MasterCard"],
+        "name_on_card" => ["Readline.readline('name on card: ')", "'john doe'"],
+        "card_number"  => ["Readline.readline('number: ')", "000-0000-0000-0000"],
+        "valid_from"   => ["Readline.readline('valid from: ')", "Sep 2014"],
+        "valid_till"   => ["Readline.readline('valid till: ')", "Sep 2018"],
+        "verification_number" => ["Readline.readline('verification number: ')", "000"],
+        "pin"          => ["Readline.readline('pin: ')", "0000"],
+        "created_at"   => ["", "Date.today"],
+        "updated_at"   => ["", "nil"],
+        "url"          => ["Readline.readline('url: ')", "''"],
+        "notes"        => ["get_lines",   "''"]
+      }
+    end
+  end
+end

data/lib/pwss/entry.rb

@@ -1,4 +1,6 @@
 require 'readline'
+require 'pwss/cipher'
+require 'date'
 
 module Pwss
   #
@@ -6,41 +8,41 @@ module Pwss
   # It is a wrapper to a Hash
   #
   class Entry
-    INPUT_F=0
-    DEFAULT=1
-    PROMPT=2
+    INPUT_F = 0 
+    DEFAULT = 1
 
-    # the fields of an entry, together with the function to ask the and default value
-    FIELDS = {
-      "title"       => ["Readline.readline('title: ')", "'title'"],
-      "username"    => ["Readline.readline('username: ')", "''"],
-      "password"    => ["Cipher.check_or_generate('password for entry', length, alnum)", "''"],
-      "created_at"  => ["", "Date.today"],
-      "updated_at"  => ["", "nil"],
-      "url"         => ["Readline.readline('url: ')", "''"],
-      "description" => ["get_lines",   "''"]
-    }
-
-    # the values (a Hash) of this issue
-    attr_reader :entry
+    attr_reader :entry, :fields
 
     def initialize
       @entry = Hash.new
+
+      # the fields of an entry, together with:
+      # - the function to ask the 
+      # - the default value
+      @fields = {
+        "title"       => ["Readline.readline('title: ')", "'title'"],
+        "username"    => ["Readline.readline('username: ')", "''"],
+        "password"    => ["Cipher.check_or_generate('password for entry', length, alnum)", "''"],
+        "created_at"  => ["", "Date.today"],
+        "updated_at"  => ["", "nil"],
+        "url"         => ["Readline.readline('url: ')", "''"],
+        "description" => ["get_lines",   "''"]
+      }
     end
 
     # interactively ask from command line all fields specified in FIELDS
     # arguments length and alnum are for password generation
-    def ask length, alnum
-      FIELDS.keys.each do |key|
-        @entry[key] = (eval FIELDS[key][INPUT_F]) || (eval FIELDS[key][DEFAULT])
+    def ask length = 8, alnum = true
+      @fields.keys.each do |key|
+        @entry[key] = (eval @fields[key][INPUT_F]) || (eval @fields[key][DEFAULT])
       end
     end
     
     # initialize all fields with the default values
     # (and set title to the argument)
     # def set_fields title
-    #   FIELDS.keys.each do |k|
-    #     @entry[k] = eval(FIELDS[k][DEFAULT])
+    #   fields.keys.each do |k|
+    #     @entry[k] = eval(fields[k][DEFAULT])
     #   end
     #   @entry['title'] = title
     # end

data/lib/pwss/software_license.rb

@@ -0,0 +1,21 @@
+require 'pwss/entry'
+
+module Pwss
+  class SoftwareLicense < Entry
+    def initialize
+      super
+      @fields = {
+        "title"          => ["Readline.readline('title: ')", "'title'"],
+        "version"        => ["Readline.readline('version: ')", "0.0.1"],
+        "license_number" => ["Readline.readline('license number: ')", "000-0000-0000-0000"],
+        "licensed_to"    => ["Readline.readline('licensed to: ')", "'John Doe'"],
+        "email"          => ["Readline.readline('email: ')", "jdoe@example.com"],
+        "purchased_on"   => ["Readline.readline('purchased on: ')", "'Date.today'"],
+        "created_at"     => ["", "Date.today"],
+        "updated_at"     => ["", "nil"],
+        "url"            => ["Readline.readline('url: ')", "''"],
+        "notes"          => ["get_lines",   "''"]
+      }
+    end
+  end
+end

data/lib/pwss/version.rb

@@ -1,3 +1,3 @@
 module Pwss
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/pwss.gemspec

@@ -9,12 +9,14 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Adolfo Villafiorita"]
   spec.email         = ["adolfo.villafiorita@me.com"]
   spec.summary       = %q{A password manager in the spirit of pwss}
-  spec.description   = %q{PWSS is a password safe, in the spirit of pws
+  spec.description   = %q{PWSS is a command-line password manager, in the spirit of pws
 Distinguishing features:
-- all entries are stored in a single file
-- entries are "complex" records, with username, password, url, description
-- the safe file can be stored encrypted or not
-- decrypt and encrypt command allow to operate directly on the password file
+- the command manages different password files
+- a password file can store multiple entries
+- entries are of different types (Entry, CreditCard, BankAccount)
+- each type stores specific information (e.g., name, card_number for CreditCards)
+- a password file can be encrypted or in plain text (if you wish to do so)
+- decrypt and encrypt commands allow to edit password files directly
 }
   spec.homepage      = "http://www.github.com/avillafiorita/pwss"
   spec.license       = "MIT"
@@ -27,6 +29,6 @@ Distinguishing features:
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
 
-  spec.add_runtime_dependency 'mercenary', '~> 0.3.4', '>= 0.3.4'
+  spec.add_runtime_dependency 'slop', '~> 3.6.0', '>= 3.6.0'
   spec.add_runtime_dependency 'encryptor', '~> 1.3.0', '>= 1.3.0'     
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwss
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,25 +39,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mercenary
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 3.6.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 3.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 3.6.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: encryptor
   requirement: !ruby/object:Gem::Requirement
@@ -79,12 +79,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.0
 description: |
-  PWSS is a password safe, in the spirit of pws
+  PWSS is a command-line password manager, in the spirit of pws
   Distinguishing features:
-  - all entries are stored in a single file
-  - entries are "complex" records, with username, password, url, description
-  - the safe file can be stored encrypted or not
-  - decrypt and encrypt command allow to operate directly on the password file
+  - the command manages different password files
+  - a password file can store multiple entries
+  - entries are of different types (Entry, CreditCard, BankAccount)
+  - each type stores specific information (e.g., name, card_number for CreditCards)
+  - a password file can be encrypted or in plain text (if you wish to do so)
+  - decrypt and encrypt commands allow to edit password files directly
 email:
 - adolfo.villafiorita@me.com
 executables:
@@ -99,9 +101,12 @@ files:
 - Rakefile
 - bin/pwss
 - lib/pwss.rb
+- lib/pwss/bank_account.rb
 - lib/pwss/cipher.rb
+- lib/pwss/credit_card.rb
 - lib/pwss/entry.rb
 - lib/pwss/fileops.rb
+- lib/pwss/software_license.rb
 - lib/pwss/version.rb
 - pwss.gemspec
 homepage: http://www.github.com/avillafiorita/pwss
@@ -129,3 +134,4 @@ signing_key:
 specification_version: 4
 summary: A password manager in the spirit of pwss
 test_files: []
+has_rdoc: