pwss 0.5.1 → 0.6.0

data/lib/pwss/generators/software_license.rb

@@ -0,0 +1,19 @@
+require 'pwss/generators/entry'
+
+module Pwss
+  class SoftwareLicense < Entry
+    def initialize
+      super
+      @fields = [
+        "title",
+        "version",
+        "licensed_to",
+        "license_number",
+        "email",
+        "purchased_on",
+        "url",
+        "description"
+      ]
+    end
+  end
+end

data/lib/pwss/password.rb

@@ -0,0 +1,94 @@
+require 'clipboard'
+
+module Pwss
+  # some functions to manage password generation and clipboard
+  module Password
+    DEFAULT_PASSWORD_LENGTH=16
+    
+    # generate a password
+    #
+    # optional hash +arguments+ allows to define a strategy for
+    # generating a password and the password length of automatically
+    # generated passwords)
+    #
+    #
+    def self.password arguments = {}
+      strategy = arguments[:strategy] || 'random'
+      length = arguments[:length] || DEFAULT_PASSWORD_LENGTH
+
+      case strategy
+      when 'random'
+        return Pwss::Password.random_password(length, false)
+      when 'alpha'
+        return Pwss::Password.random_password(length, true)
+      when 'ask'
+        return Pwss::Password.ask_password_twice "new password for entry"
+      when 'pwgen'
+        begin
+          password = %x(pwgen -N1 #{length}).chomp
+          return password
+        rescue
+          raise "Error: pwgen not found.  Use one of random, alpha, or ask."
+        end
+      else
+        raise "Error: strategy not understood.  Use one of random, alpha, pwgen, or ask"
+      end
+    end
+
+    # Ask for a password fom the command line
+    def self.ask_password prompt="Enter master password: "
+      printf prompt
+      system "stty -echo"
+      password = $stdin.gets.chomp
+      system "stty echo"
+      puts ""
+      password
+    end
+
+    # Ask for a password twice and make sure it is entered the same
+    def self.ask_password_twice prompt="master password"
+      match = false
+      while ! match
+        password = ask_password "Enter #{prompt}: "
+        repeat = ask_password "Repeat #{prompt}: "
+        match = (password == repeat)
+
+        if match == false then
+          puts "Error! Password do not match.  Please enter them again."
+        end
+      end
+      password
+    end
+
+    # Generate a random password
+    # (Adapted from: http://randompasswordsgenerator.net/tutorials/ruby-random-password-generator.html)
+    def self.random_password length=DEFAULT_PASSWORD_LENGTH, alnum=false
+      chars = 'abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNOPQRSTUVWXYZ1234567890'  
+      chars += '!@#$%^&*()_+=[]{}<>/~,.;:|' if not alnum
+      Array.new(length) { chars[rand(chars.length)].chr }.join  
+    end
+
+    #
+    # make a field available to the clipboard for a given time (in seconds).
+    #
+    def self.to_clipboard field_name, value, counter = 30
+      old_clipboard = Clipboard.paste
+      Clipboard.copy value
+
+      begin
+        if counter <= 0
+          STDIN.flush
+          puts "\n#{field_name.capitalize} available in clipboard: press enter when you are done."
+          STDIN.getc
+        else
+          puts "\n#{field_name.capitalize} available in clipboard for #{counter} seconds."
+          sleep(counter)
+        end
+        Clipboard.copy old_clipboard
+      rescue Exception => e
+        Clipboard.copy old_clipboard
+        puts "Clipboard restored"
+      end
+    end
+  end
+end

data/lib/pwss/safe.rb

@@ -0,0 +1,183 @@
+require 'yaml'
+
+#
+# A password safe is a list of entries
+#
+
+module Pwss
+  class Safe
+    attr_reader :filename, :entries, :password
+    
+    def initialize filename
+      @filename = filename
+      @password = nil
+      @entries = Array.new
+    end
+
+    def rename new_filename
+      @filename = new_filename
+    end
+    
+    def load
+      string = FileOps::load @filename
+      if FileOps::symmetric? filename then
+        @password = Password::ask_password
+        string = Cipher::decrypt string, password
+      elsif FileOps::gpg? filename then
+        crypto = GPGME::Crypto.new
+        cipher = crypto.decrypt string
+        string = cipher.to_s
+      end
+      @entries = YAML::load(string) || Array.new
+    end
+
+    
+    def save
+      if FileOps::symmetric? filename then
+        if not @password
+          @password = Password::ask_password_twice
+        end
+        new_string = Cipher::encrypt @entries.to_yaml, @password
+      elsif FileOps::gpg? filename then
+        crypto = GPGME::Crypto.new
+        cipher = crypto.encrypt @entries.to_yaml, :recipients => "pwss-agent@example.com"
+        new_string = cipher.to_s
+      else
+        new_string = entries.to_yaml
+      end
+      FileOps::backup filename if File.exist? filename
+      FileOps::save filename, new_string
+    end
+
+    
+    # switch from plain to encrypted file
+    # the function changes the filename and sets a password (if needed)
+    # this function requires the file to be loaded since it changes the filename
+    def toggle_encryption hash = Hash.new
+      password = hash[:password] || nil
+      schema = hash[:schema] || :gpg
+      
+      if FileOps::encrypted? filename then
+        @password = nil
+        @filename = @filename.sub(/\.(gpg|enc)$/, "")
+      else
+        @password = password
+        @filename = schema == :gpg ? @filename + ".gpg" : @filename + ".enc"
+      end
+    end
+
+    
+    def add new_entry
+      @entries << new_entry
+    end
+
+    
+    def update id, field, new_value
+      @entries[id][field] = new_value
+    end
+
+    
+    def destroy id
+      @entries.delete_at(id) if id != -1
+    end
+
+    
+    # return the pairs [entry, id] matching a string
+    def match string
+      entries.each_with_index.select { |e, i| e["title"].downcase.include?(string.downcase) }
+    end
+
+    
+    def get id
+      entries[id]
+    end
+
+    def get_pruned id
+      entry = entries[id]
+      new_entry = entry.dup
+      entry.keys.map { |x| new_entry[x] = "********" if Pwss::Fields::sensitive? x }
+      new_entry
+    end
+    
+    def get_field id, field
+      entries[id][field]
+    end
+
+    def [](id)
+      entries[id]
+    end
+
+    # return the entries after pruning some fields
+    # fields is an array of strings
+    def prune fields
+      entries.map { |x| Safe.prune_entry x, fields }
+    end
+
+    # prune fields (array of strings) from entry, by deleting the corresponding key
+    # this is used to clean databases when support for some fields is dropeed (e.g.,
+    # created_at, updated_at)
+    def self.prune_entry entry, fields
+      @new_entry = entry.dup
+      fields.map { |x| @new_entry.delete(x) }
+      @new_entry
+    end
+
+    # return the entries showing only some fields
+    # fields is an array of strings
+    #def pick fields
+    #  entries.map { |x| Safe.cherry_pick_entry x, fields }
+    #end
+
+    # return only some fields from entry
+    # def self.cherry_pick_entry entry, fields
+    #   @new_entry = Hash.new
+    #   fields.each do |f|
+    #     @new_entry[f] = entry[f]
+    #   end
+    #   @new_entry
+    # end
+
+    #
+    # Let the user select an id from a list 
+    #
+    # entries_with_ids is a array of [entry, id] (e.g. the output of match)
+    # even_if_one requires to select the entry even if there is one match
+    #
+    def self.choose_entry entries_with_ids, even_if_one = false
+      if entries_with_ids == nil or entries_with_ids.size == 0
+        puts "No entry matches your search criteria. Exiting."
+        return -1
+      end
+
+      entries = entries_with_ids.map { |x| x[0] }
+      ids = entries_with_ids.map { |x| x[1] }
+
+      if even_if_one or entries.size > 1
+        entries.size > 1 ? puts("pwss matches:") : puts("pwss match:")
+        # pruned = entries.map { |x| Pwss::Safe.prune_entry x, ["password", "pin", "verification_number"] }
+        entries.each_with_index do |e, i|
+          puts  Pwss::Safe.entry_to_s ids[i], e
+        end
+        id = nil
+        puts "\n"
+        while (id != -1 and not ids.include?(id))
+          response = Readline.readline "Select entry by ID (#{ids.join(", ")}); -1 or empty string to exit: "
+          id = response == "" ? -1 : response.to_i
+        end
+      else
+        puts "pwss has one match:"
+        # pruned = Pwss::Safe.prune_entry entries[0], ["password", "pin", "verification_number"]
+        puts Pwss::Safe.entry_to_s ids[0], entries[0]
+        id = ids[0]
+      end
+      id
+    end
+
+    private
+
+    def self.entry_to_s id, entry
+      "#{"%4d" % id}. #{entry["title"]}"
+    end
+
+  end
+end

data/lib/pwss/version.rb

@@ -1,3 +1,3 @@
 module Pwss
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/pwss.gemspec

@@ -8,27 +8,33 @@ Gem::Specification.new do |spec|
   spec.version       = Pwss::VERSION
   spec.authors       = ["Adolfo Villafiorita"]
   spec.email         = ["adolfo.villafiorita@me.com"]
-  spec.summary       = %q{A password manager in the spirit of pwss}
+
+  spec.summary       = %q{A password manager in the spirit of pass and pws}
   spec.description   = %q{PWSS is a command-line password manager, in the spirit of pws
 Distinguishing features:
-- the command manages different password files
+- pwss 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
+- entries can be of different types (e.g., Entry, CreditCard, BankAccount)
+- each type stores specific information (e.g., card_number for CreditCards)
+- a password file can be encrypted or stored in plain text (if you wish to do so)
+- decrypt and encrypt commands allow one to edit password files with a text editor
+- clipboard integration
+- multi-platform
 }
   spec.homepage      = "http://www.github.com/avillafiorita/pwss"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
 
-  spec.add_runtime_dependency 'slop', '~> 3.6.0', '>= 3.6.0'
-  spec.add_runtime_dependency 'encryptor', '~> 1.3.0', '>= 1.3.0'     
+  spec.add_runtime_dependency 'slop', '~> 4.3.0', '>= 4.3.0'
+  spec.add_runtime_dependency 'encryptor', '~> 1.3.0', '~> 1.3.0'     
+  spec.add_runtime_dependency 'clipboard', '~> 1.0.6', '>= 1.0.6'     
+  spec.add_runtime_dependency 'gpgme', '~> 2.0.12', '>= 2.0.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwss
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,16 +16,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -44,20 +58,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 4.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 4.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 4.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: encryptor
   requirement: !ruby/object:Gem::Requirement
@@ -65,28 +79,64 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
-    - - ">="
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.6
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.6
+- !ruby/object:Gem::Dependency
+  name: gpgme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.12
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.12
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.12
 description: |
   PWSS is a command-line password manager, in the spirit of pws
   Distinguishing features:
-  - the command manages different password files
+  - pwss 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
+  - entries can be of different types (e.g., Entry, CreditCard, BankAccount)
+  - each type stores specific information (e.g., card_number for CreditCards)
+  - a password file can be encrypted or stored in plain text (if you wish to do so)
+  - decrypt and encrypt commands allow one to edit password files with a text editor
+  - clipboard integration
+  - multi-platform
 email:
 - adolfo.villafiorita@me.com
 executables:
@@ -95,18 +145,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
-- README.textile
+- README.md
 - Rakefile
-- bin/pwss
+- bin/console
+- bin/setup
+- exe/pwss
 - lib/pwss.rb
-- lib/pwss/bank_account.rb
 - lib/pwss/cipher.rb
-- lib/pwss/credit_card.rb
-- lib/pwss/entry.rb
+- lib/pwss/cli/command_semantics.rb
+- lib/pwss/cli/command_syntax.rb
 - lib/pwss/fileops.rb
-- lib/pwss/software_license.rb
+- lib/pwss/generators/bank_account.rb
+- lib/pwss/generators/code.rb
+- lib/pwss/generators/credit_card.rb
+- lib/pwss/generators/entry.rb
+- lib/pwss/generators/fields.rb
+- lib/pwss/generators/sim.rb
+- lib/pwss/generators/software_license.rb
+- lib/pwss/password.rb
+- lib/pwss/safe.rb
 - lib/pwss/version.rb
 - pwss.gemspec
 homepage: http://www.github.com/avillafiorita/pwss
@@ -129,8 +189,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A password manager in the spirit of pwss
+summary: A password manager in the spirit of pass and pws
 test_files: []