pwss 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: beca8e8821633787a38795eeff8ede8471aae201
-  data.tar.gz: 5fe7c3c6926bd4646af646cf5f5b6d94110263bc
+  metadata.gz: 2553a7a2e55ca432b8237846c9ca874415ed7f11
+  data.tar.gz: 49bb878f3ef6444b3138c498246280d1ad090e12
 SHA512:
-  metadata.gz: 81f03cb7c8c3d1fc9f5c5cd43be63039a1d916f1d4ef107df38fb13953c82bde320db9b95b3147e95ed0dacda5f200e651517552f0f332e48e000c2557e189ac
-  data.tar.gz: c5189e3f75c9b4fcf0aa2ce05aa79330c19e7e4c0de790e0ba8e0995e25c100bc08fe881238a045a6d9bbed1f257524d57a64dea10bed009d0d15f46662dac5b
+  metadata.gz: 44735ee5e8235b212e37d75b9e167743bcf375af8dcb2bd822b895aef1b266b37e2e565c090278e83f5f0ebd6d920aa95c74e71314d7dd85a2da7cd8cd49db28
+  data.tar.gz: 1b20540be432cec70e2dae8bc940976570516a453790a8453d8f8f5dcb13dbf53c071cc867ade7e94be9f8412c9d9054a9ea0964d894800cd0c692681dab8499

data/README.textile

@@ -2,34 +2,19 @@ h1. Pwss
 
 A password manager in the spirit of "pws":https://github.com/janlelis/pws.
 
-PWSS can store multiple entries in a file and 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:
 
-* 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)
+* PWSS manages password *files*:
+** A password file can store different entries (password and other sensitive information)
+** The user can manage different password files (e.g., work, personal)
+* Entries in a password file can be any of Entry, CreditCard, BankAccount, SoftwareLicense.  Each type stores a different set of infos:
+** *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
 * 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
+* 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
 
@@ -42,12 +27,12 @@ h2. Quick Start
 Try the following:
 
 bc. $ pwss init
-$ pwss add
-$ pwss get <title you gave with previous command>
+$ pwss add First Entry
+$ pwss get First
 
 For some more information:
 
-bc. $ pwss help # get information from the command line
+bc. $ pwss man # get information from the command line
 $ pwss -h   # command syntax
 
 h2. Detailed Instructions
@@ -56,9 +41,9 @@ h2. Detailed Instructions
 
 A typical usage scenario is the following:
 
-# @pwss init@ will create a new encrypted password safe in @~/.pwss.yaml.enc@
+# @pwss init@ will create a new encrypted password safe in @~/.pwss.yaml.enc@. If you specify a filename without the @.enc@ extension, the password safe will be stored in plain text (see below).
 # @pwss add@ will add a new entry to the file
-# @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)
+# @pwss get string@ will retrieve all entries whose *title* contains @string@, let the user choose an entry, 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 files or store a password file in a non-standard location, use the @-f@ (@--filename@) option:
 
@@ -68,17 +53,17 @@ A typical usage scenario is the following:
 
 *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:
+*Controlling how long passwords are made available for* 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
 
-will retrieve entry whose title is @my_email@ and make the password available in the clipboard for @3@ seconds.
+will retrieve a user selected entry whose title is @my_email@ and make the password available in the clipboard for @3@ seconds.
 
 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.
 
-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.
+The generated passwords are random sequences of chars and symbols.  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, for websites which do accept certain classes of characters.
 
 Use the @-g LENGTH@ option to determine the password length.
 
@@ -102,7 +87,7 @@ By contrast,
 
 bc. $ pwss init -f a.yaml
 
-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 sensitive information is a good idea. (Just in case you were expecting 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.* You can use the @encrypt@ and @decrypt@ commands at any time to move from the plain to the encrypted format.
 
@@ -163,6 +148,15 @@ Notice that only @title@ and @password@ are required.
 
 h2. Changelog
 
+* *Release 0.5.0* This is mainly a release focused on improving interaction. Small changes to the command syntax and improved exit conditions. In details:
+** *add* now accepts the title in the command line.  For instance @pwss add New Entry@
+** *new* is now an alias for the *add* command
+** *update* now requires to specify the field: use @-p@, @--password@, or @--field password@, if you want to update the password
+** show the usage summary, if no arguments are given 
+** *C-c* is now trapped and properly managed (clearing the clipboard)
+** decryption errors are now properly managed
+** the content of the clipboard is now restored after the waiting period
+
 * *Release 0.4.0*
 ** New @--stdout@ option will output password to standard output (useful for integration with other applications)
 ** New @--select N@ option will automatically select the @N@th entry (rather than asking the user to select an entry).

data/bin/pwss

@@ -24,6 +24,47 @@ def file2string filename
   [string, password]
 end
 
+# this is to support command aliases: add and new
+# maybe not the the best of places where to define a function
+def add 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]
+
+  default_title = args.join(" ")
+  string, password = file2string filename
+
+  puts "Adding #{default_title != "" ? "entry '" + default_title + "'" : "an entry"} of type '#{type}' to #{filename}"
+  # ask for a new entry
+  if default_title != "" then
+    overrides = {"title" => ["Readline.readline('title (leave empty for \"#{default_title}\"): ')", "'#{default_title}'"]}
+  end
+  pe = eval("Pwss::" + type).new
+  pe.ask length, alnum, overrides
+
+  # add the entry to the safe
+  entries = YAML::load(string) || Array.new
+  entries << pe.entry
+
+  # check status of input file and encrypt if necessary
+  if FileOps::encrypted? filename then
+    new_string = Cipher::encrypt entries.to_yaml, password
+  else
+    new_string = entries.to_yaml
+  end
+
+  FileOps::backup filename
+  FileOps::save filename, new_string
+
+  puts "Entry added."
+  
+  # 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
 
 version = Pwss::VERSION
 man = <<EOS
@@ -39,13 +80,13 @@ DESCRIPTION
 
   Features:
 
-  * PWSS manages password files.  A password file store passwords and other
-    sensitive information
+  * PWSS manages password *files*:
+    - A password file can store different entries (password and other
+      sensitive information)
+    - The user can manage different password files (e.g., work, personal)
 
-  * Entries in a password file can be of the following pre-defined types:
-    Entry, CreditCard, BankAccount, SoftwareLicense
-
-  * Information stored for each type:
+  * Entries in a password file can be any of Entry, CreditCard, BankAccount, 
+    SoftwareLicense.  Each type stores a different set of infos:
 
     - Entry:           title, username, password, url, description
     - CreditCard:      title, issuer, name_on_card, card_number, valid_from, 
@@ -54,13 +95,11 @@ 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
 
@@ -69,7 +108,7 @@ EXAMPLES
 
   # 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 add -f a.enc -g 16 -a            # add an entry (pwss will generate a random 16-char password)
   pwss get -f a.enc my secret account   # find an entry
 
 VERSION
@@ -80,6 +119,7 @@ LICENSE
 
 SEE ALSO
   pwss -h
+  pwss man
   https://github.com/avillafiorita/pwss
 EOS
 
@@ -88,7 +128,8 @@ EOS
 #
 # Main App Starts Here!
 #
-opts = Slop.parse :help => true do
+cmd = nil
+opts = Slop.parse :help => true, :strict => 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
@@ -98,15 +139,17 @@ opts = Slop.parse :help => true do
 
   ##############################################################################
   on "-v", "--version", 'Print version information' do
+    cmd = "version"
     puts "pwss version #{version}"
   end
 
   ##############################################################################
-  command :help do
-    banner "pwss help"
+  command :man do
+    banner "pwss man"
     description "Print detailed information about how to use pwss"
 
     run do |_, _|
+      cmd = "man"
       puts man
     end
   end
@@ -119,6 +162,7 @@ opts = Slop.parse :help => true do
     on "-f", "--filename=", "Password file to create. Use extension '.enc' to encrypt it."
 
     run do |opts, args|
+      cmd = "init"
       filename = opts.to_hash[:filename] || DEFAULT_FILENAME
 
       if File.exists?(filename)
@@ -151,6 +195,8 @@ opts = Slop.parse :help => true do
     on "-f", "--filename=", "Password file to use."
 
     run do |opts, args|
+      cmd = "list"
+
       filename = opts.to_hash[:filename] || DEFAULT_FILENAME
 
       string, _ = file2string filename
@@ -171,6 +217,8 @@ opts = Slop.parse :help => true do
     on "--select=", "Select the N-th matching entry", as: Integer
 
     run  do |opts, args|
+      cmd = "get"
+
       filename = opts.to_hash[:filename] || DEFAULT_FILENAME
       waiting = opts.to_hash[:wait] || DEFAULT_SECS
       stdout_opt = opts.to_hash[:stdout]
@@ -191,51 +239,38 @@ opts = Slop.parse :help => true do
 
   ##############################################################################
   command :add do
-    banner "pwss add [options]"
+    banner "pwss add [options] [entry title]"
     description "Add an entry and copy its password in the clipboard"
 
-    on "-f", "--filename=", "Password file to use."
+    on "-f", "--filename=", "Password file to use"
     on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive)", as: Integer
-      
+    
     on "-e", "--entry=", "Create an entry of type TYPE (Entry, CreditCard, BankAccount, SoftwareLicense).\n                        Default to 'Entry', which is good enough for websites credentials"
 
     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 = eval("Pwss::" + type).new
-      pe.ask length, alnum
+      cmd = "add"
+      add opts, args
+    end
+  end
 
-      # add the entry to the safe
-      entries = YAML::load(string) || Array.new
-      entries << pe.entry
+  command :new do
+    banner "pwss new [options] [entry title]"
+    description "An alias for add"
 
-      # check status of input file and encrypt if necessary
-      if FileOps::encrypted? filename then
-        new_string = Cipher::encrypt entries.to_yaml, password
-      else
-        new_string = entries.to_yaml
-      end
+    on "-f", "--filename=", "Password file to use"
+    on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive)", as: Integer
+    
+    on "-e", "--entry=", "Create an entry of type TYPE (Entry, CreditCard, BankAccount, SoftwareLicense).\n                        Default to 'Entry', which is good enough for websites credentials"
 
-      FileOps::backup filename
-      FileOps::save filename, new_string
+    on "-g", "--generate=", "Generate a random password of given length.", as: Integer
+    on "-a", "--alnum", "Use only alphanumeric chars for the randomly generated password"
 
-      puts "Entry added."
-      
-      # 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
+    run do |opts, args|
+      cmd = "new"
+      add opts, args
     end
   end
 
@@ -244,29 +279,37 @@ opts = Slop.parse :help => true do
     banner "pwss update [options] string"
     description "Update given field of user-selected entry matching <string>"
 
-    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).'
+    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'
+    on "-p", "--password", "an alias for --field password"
 
     run do |opts, args|
+      cmd = "update"
+
       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]
+      field    = opts.to_hash[:password] ? "password" : opts.to_hash[:field]
+
+      if not field then
+        puts "Please specify a field to update (used --field ... or -p)"
+        exit 1
+      end
 
       string, password = file2string filename
 
       # load entries and update 
       entries = YAML::load(string) || Array.new
 
-      if field then
-        entries, entry_password = Pwss::update_field args.join(" "), entries, field
-      else
+      if field == "password" then
         # update password
         entries, entry_password = Pwss::update args.join(" "), entries, length, alnum
+      else
+        entries, entry_password = Pwss::update_field args.join(" "), entries, field
       end
 
       # check status of input file and encrypt if necessary
@@ -300,6 +343,8 @@ opts = Slop.parse :help => true do
     on "-f", "--filename=", "Password file to create. Use extension '.enc' to encrypt it."
 
     run do |opts, args|
+      cmd = "destroy"
+      
       filename = opts.to_hash[:filename] || DEFAULT_FILENAME
 
       string, password = file2string filename
@@ -333,6 +378,8 @@ opts = Slop.parse :help => true do
     on "-f", "--filename=", "Password file to encrypt. Write to <file>.enc."
 
     run do |opts, _|
+      cmd = "encrypt"
+      
       filename = opts.to_hash[:filename] || DEFAULT_FILENAME.sub(/\.enc$/, "")
 
       if not File.exists?(filename)
@@ -364,6 +411,8 @@ opts = Slop.parse :help => true do
     on "-f", "--filename=", "Password file to decrypt.  Write to <file>, without '.enc'."
 
     run do |opts, _|
+      cmd = "decrypt"
+
       filename = opts.to_hash[:filename] || DEFAULT_FILENAME
 
       if not File.exists?(filename)
@@ -380,7 +429,7 @@ opts = Slop.parse :help => true do
         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."
@@ -388,3 +437,7 @@ opts = Slop.parse :help => true do
   end
 
 end
+
+if cmd == nil then
+  puts opts
+end

data/lib/pwss.rb

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

data/lib/pwss/cipher.rb

@@ -10,7 +10,12 @@ module Cipher
   end
 
   def self.decrypt string, password
-    Encryptor.decrypt(:value => string, :key => password)
+    begin
+      Encryptor.decrypt(:value => string, :key => password)
+    rescue Exception => e
+      puts "Unable to decrypt. Exiting"
+      exit 1
+    end
   end
 
   # Ask for a password fom the command line
@@ -47,17 +52,23 @@ module Cipher
   # make the password available to the clipboard.
   #
   def self.password_to_clipboard password, counter = 30
+    old_clipboard = `pbpaste`
     system("printf \"%s\" \"#{password}\" | pbcopy")
 
-    if counter <= 0
-      puts "\nPassword available in clipboard: press enter when you are done."
-      STDIN.getc
-    else
-      puts "\nPassword available in clipboard for #{counter} seconds."
-      sleep(counter)
+    begin
+      if counter <= 0
+        STDIN.flush
+        puts "\nPassword available in clipboard: press enter when you are done."
+        STDIN.getc
+      else
+        puts "\nPassword available in clipboard for #{counter} seconds."
+        sleep(counter)
+      end
+      system("printf \"#{old_clipboard}\" | pbcopy")
+    rescue Exception => e
+      system("printf \"#{old_clipboard}\" | pbcopy")
+      puts "Clipboard restored. Exiting."
     end
-
-    system("echo ahahahahaha | pbcopy")
   end
 
   private

data/lib/pwss/entry.rb

@@ -17,7 +17,7 @@ module Pwss
       @entry = Hash.new
 
       # the fields of an entry, together with:
-      # - the function to ask the 
+      # - the function to ask the value 
       # - the default value
       @fields = {
         "title"       => ["Readline.readline('title: ')", "'title'"],
@@ -32,9 +32,15 @@ module Pwss
 
     # interactively ask from command line all fields specified in FIELDS
     # arguments length and alnum are for password generation
-    def ask length = 8, alnum = true
+    def ask length = 8, alnum = true, overrides = {}
+      @fields.merge! overrides
       @fields.keys.each do |key|
-        @entry[key] = (eval @fields[key][INPUT_F]) || (eval @fields[key][DEFAULT])
+        value = eval @fields[key][INPUT_F]
+        if value == nil or value == "" then
+          @entry[key] = eval @fields[key][DEFAULT]
+        else
+          @entry[key] = value
+        end
       end
     end
     

data/lib/pwss/fileops.rb

@@ -16,7 +16,7 @@ module FileOps
     file = File.open(filename, "wb")
     file.write data
     file.close
-    puts "Password safe #{filename} updated."
+    # puts "Password safe #{filename} updated."
   end
 
   # check if the extension is ".enc"

data/lib/pwss/version.rb

@@ -1,3 +1,3 @@
 module Pwss
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwss
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A password manager in the spirit of pwss