tome 0.1.0.pre → 0.1.1.pre

data/README.md

@@ -1,6 +1,9 @@
 ## Tome
 
-Tome is a lightweight password manager with a humane command-line interface. It is meant to be simple and secure.
+Tome is a lightweight password manager with a humane command-line interface.
+
+Tome stores your passwords in an encrypted file which you manage with a single master password.
+You can keep track of multiple complex passwords without having to remember any of them.
 
 *Disclaimer* I am not a security expert. I've only had limited formal training in security and cryptography.
 Now that I've scared off all but the bravest, feel free to look [under the hood](#under-the-hood) or
@@ -9,13 +12,16 @@ at the security bits in [crypt.rb](https://github.com/schmich/tome/blob/master/l
 ## Installation
 
 * Requires [Ruby 1.9.3](http://www.ruby-lang.org/en/downloads/) or newer.
-* *Coming soon* `gem install tome`
+* `gem install tome --pre`
+* `tome` is now available on the command-line.
 
 ## Usage
 
 The first time you run `tome`, you'll be asked to create a master password for your encrypted password database.
 Any operations involving your password database will require this master password.
 
+Creating a new password is simple:
+
     > tome set linkedin.com
     Creating tome database.
     Master password:
@@ -24,7 +30,7 @@ Any operations involving your password database will require this master passwor
     Password (verify):
     Created password for linkedin.com.
 
-Recalling a password is easy:
+Recalling a password is just as easy:
 
     > tome get linkedin.com
     Master password:

data/lib/tome.rb

@@ -1,4 +1,6 @@
 require 'tome/tome'
 require 'tome/command'
 require 'tome/crypt'
+require 'tome/padding'
+require 'tome/usage'
 require 'tome/version'

data/lib/tome/command.rb

@@ -29,7 +29,12 @@ module Tome
       begin
         handle_command(args)
       rescue CommandError => error
-        @err.puts error.message
+        @err.puts "Error: #{error.message}"
+        return 1
+      rescue FileFormatError => error
+        # Fix file separators for Windows.
+        filename = @tome_filename.gsub(File::SEPARATOR, File::ALT_SEPARATOR || File::SEPARATOR)
+        @err.puts "Error: Cannot read #{filename}: #{error.message}"
         return 1
       end
 
@@ -53,9 +58,9 @@ module Tome
       commands = {
         /\A(help|-h|--help)\z/i => :help,
         /\A(version|ver|-v|--version)\z/i => :version,
-        /\A(set|s)\z/i => :set,
+        /\A(set|s|add)\z/i => :set,
         /\A(get|g|show)\z/i => :get,
-        /\A(delete|del|d|rm|remove)\z/i => :delete,
+        /\A(delete|del|rm|remove)\z/i => :delete,
         /\A(generate|gen)\z/i => :generate,
         /\A(copy|cp)\z/i => :copy,
         /\A(rename|ren|rn)\z/i => :rename,
@@ -340,12 +345,25 @@ module Tome
     end
 
     def input_password
-      @in.noecho { |stdin|
-        password = stdin.gets.sub(/[\r\n]+\z/, '')
-        @err.puts
+      input = proc { |stdin|
+        raw = stdin.gets
+        return nil if raw.nil?
+
+        password = raw.strip
+        @out.puts
 
         return password
       }
+
+      begin
+        @in.noecho { |stdin|
+          input.call stdin
+        }
+      rescue Errno::EBADF
+        # This can happen when stdin refers to a file or pipe.
+        # In this case, we ignore 'no echo' and do normal input.
+        input.call @in
+      end
     end
 
     def prompt_confirm(prompt)
@@ -381,7 +399,12 @@ module Tome
         tome = Tome.new(@tome_filename, master_password)
       rescue MasterPasswordError
         @err.puts 'Incorrect master password.'
-        retry
+
+        if master_password.nil?
+          raise CommandError, 'Authentication failed.'
+        else
+          retry
+        end
       end
 
       return tome
@@ -397,199 +420,4 @@ module Tome
       end
     end
   end
-
-# TODO: Complete these.
-$usage = <<END
-Usage:
-
-    tome set [user@]<domain> [password]
-
-        Create or update the password for an account.
-        Example: tome set foo@gmail.com
-
-    tome generate [user@]<domain>
-
-        Generate a random password for an account.
-        Example: tome generate reddit.com
-
-    tome get <pattern>
-
-        Show the passwords for all accounts matching the pattern.
-        Example: tome get youtube
-
-    tome copy <pattern>
-
-        Copy the password for the account matching the pattern.
-        Example: tome copy news.ycombinator.com
-
-    tome list
-
-        Show all stored accounts and passwords.
-        Example: tome list
-
-    tome delete [user@]<domain>
-
-        Delete the password for an account.
-        Example: tome delete foo@slashdot.org
-
-    tome rename <old> <new>
-
-        Rename the account information stored.
-        Example: tome rename twitter.com foo@twitter.com
-
-    tome help
-
-        Shows help for a specific command.
-        Example: tome help set
-
-    tome version
-
-        Shows the version of tome.
-        Example: tome version
-END
-
-$help_usage = <<END
-tome help
-
-    Shows help for a specific command.
-
-Usage:
-
-    tome help
-    tome help <command>
-
-Examples:
-
-    tome help
-    tome help set
-    tome help help (so meta)
-
-Alias: help, --help, -h
-END
-
-$set_usage = <<END
-tome set
-
-    Create or update the password for an account. The user is optional.
-    If you do not specify a password, you will be prompted for one.
-
-Usage:
-
-    tome set [user@]<domain> [password]
-
-Examples:
-
-    tome set gmail.com
-    tome set gmail.com p4ssw0rd
-    tome set foo@gmail.com
-    tome set foo@gmail.com p4ssw0rd
-
-Alias: set, s
-END
-
-$get_usage = <<END
-tome get
-
-    Show the passwords for all accounts matching the pattern.
-    Matching is done with substring search. Wildcards are not supported.
-
-Usage:
-
-    tome get <pattern>
-
-Examples:
-
-    tome get gmail
-    tome get foo@
-    tome get foo@gmail.com
-
-Alias: get, g, show
-END
-
-$delete_usage = <<END
-tome delete
-
-    Delete the password for an account.
-
-Usage:
-
-    tome delete [user@]<domain>
-
-Examples:
-
-    tome delete gmail.com
-    tome delete foo@gmail.com
-
-Alias: delete, del, d, remove, rm
-END
-
-$generate_usage = <<END
-tome generate
-
-    Generate a random password for an account. The user is optional.
-
-Usage:
-
-    tome generate [user@]<domain>
-
-Examples:
-
-    tome generate gmail.com
-    tome generate foo@gmail.com
-
-Alias: generate, gen
-END
-
-$copy_usage = <<END
-tome copy
-
-    Copy the password for the account matching the pattern.
-    If more than one account matches the pattern, nothing happens.
-    Matching is done with substring search. Wildcards are not supported.
-
-Usage:
-
-    tome copy <pattern>
-
-Examples:
-
-    tome copy gmail
-    tome copy foo@
-    tome copy foo@gmail.com
-
-Alias: copy, cp
-END
-
-$list_usage = <<END
-tome list
-
-    Show all stored accounts and passwords.
-
-Usage:
-
-    tome list
-
-Examples:
-
-    tome list
-
-Alias: list, ls
-END
-
-$rename_usage = <<END
-tome rename
-
-    Rename the account information stored.
-
-Usage:
-
-    tome rename <old> <new>
-
-Examples:
-
-    tome rename gmail.com foo@gmail.com
-    tome rename foo@gmail.com bar@gmail.com
-
-Alias: rename, ren, rn
-END
-end
+end

data/lib/tome/padding.rb

@@ -0,0 +1,16 @@
+require 'yaml'
+require 'securerandom'
+
+module Tome
+  class Padding
+    def self.pad(value, min_pad, max_pad)
+      padding = Random.rand(min_pad..max_pad)
+      YAML.dump(:value => value, :padding => SecureRandom.random_bytes(padding))
+    end
+
+    def self.unpad(inflated_value)
+      yaml = YAML.load(inflated_value)
+      yaml[:value]
+    end
+  end
+end

data/lib/tome/tome.rb

@@ -5,17 +5,36 @@ module Tome
   class MasterPasswordError < RuntimeError
   end
 
+  class FileFormatError < RuntimeError
+  end
+
   class Tome
     def self.exists?(tome_filename)
       return !load_tome(tome_filename).nil?
     end
 
     def self.create!(tome_filename, master_password, stretch = 100_000)
+      if tome_filename.nil? || tome_filename.empty?
+        raise ArgumentError
+      end
+
+      if master_password.nil? || master_password.empty?
+        raise MasterPasswordError
+      end
+
       save_tome(tome_filename, new_tome(stretch), {}, master_password)
       return Tome.new(tome_filename, master_password)
     end
 
     def initialize(tome_filename, master_password)
+      if tome_filename.nil? || tome_filename.empty?
+        raise ArgumentError
+      end
+      
+      if master_password.nil? || master_password.empty?
+        raise MasterPasswordError
+      end
+
       @tome_filename = tome_filename
       @master_password = master_password
 
@@ -145,23 +164,53 @@ module Tome
     end
 
     def self.load_tome(tome_filename)
+      if tome_filename.nil? || tome_filename.empty?
+        raise ArgumentError
+      end
+      
       return nil if !File.exist?(tome_filename)
 
       contents = File.open(tome_filename, 'rb') { |file| file.read }
       return nil if contents.length == 0
 
-      values = YAML.load(contents)
-      return nil if !values
-
-      # TODO: Throw if these values are nil.
-      # TODO: Verify version number, raise if incompatible.
-      return {
-        :version => values[:version],
-        :salt => values[:salt],
-        :iv => values[:iv],
-        :stretch => values[:stretch],
-        :store => values[:store] 
-      }
+      tome = YAML.load(contents)
+      return nil if !tome
+
+      validate_tome(tome)
+
+      return tome
+    end
+
+    def self.validate_tome(tome)
+      if tome[:version].nil? || tome[:version].class != Fixnum
+        raise FileFormatError, 'The tome database is invalid (missing or invalid version).'
+      end
+
+      if tome[:version] > FILE_VERSION
+        raise FileFormatError, "The tome database comes from a newer version of tome (v#{tome[:version]} > v#{FILE_VERSION}). Try updating tome."
+      end
+
+      if tome[:version] < FILE_VERSION
+        raise FileFormatError, "The tome database is incompatible with this version of tome (v#{tome[:version]} < v#{FILE_VERSION})."
+      end
+
+      # TODO: Check version number, do file format migration if necessary.
+
+      if tome[:salt].nil? || tome[:salt].class != String || tome[:salt].empty?
+        raise FileFormatError, 'The tome database is invalid (missing or invalid salt).'
+      end
+
+      if tome[:iv].nil? || tome[:iv].class != String || tome[:iv].empty?
+        raise FileFormatError, 'The tome database is invalid (missing or invalid IV).'
+      end
+
+      if tome[:stretch].nil? || tome[:stretch].class != Fixnum || tome[:stretch] < 0
+        raise FileFormatError, 'The tome database is invalid (missing or invalid key stretch).'
+      end
+
+      if tome[:store].nil? || tome[:store].class != String || tome[:store].empty?
+        raise FileFormatError, 'The tome database is invalid (missing or invalid store).'
+      end
     end
 
     def load_store(tome)
@@ -170,20 +219,19 @@ module Tome
       end
 
       begin
-        store_yaml = Crypt.decrypt(
+        padded_store_yaml = Crypt.decrypt(
           :value => tome[:store],
           :password => @master_password,
           :stretch => tome[:stretch],
           :salt => tome[:salt],
           :iv => tome[:iv]
         )
-      rescue ArgumentError
-        # TODO: Should probably be raising an error here.
-        return {}
       rescue OpenSSL::Cipher::CipherError
         raise MasterPasswordError
       end
 
+      store_yaml = Padding.unpad(padded_store_yaml)
+
       store = YAML.load(store_yaml)
       return store || {}
     end
@@ -194,12 +242,13 @@ module Tome
       end
 
       store_yaml = YAML.dump(store)
+      padded_store_yaml = Padding.pad(store_yaml, 1024, 4096)
 
       new_salt = Crypt.new_salt
       new_iv = Crypt.new_iv
 
       encrypted_store = Crypt.encrypt(
-        :value => store_yaml, 
+        :value => padded_store_yaml, 
         :password => master_password,
         :salt => new_salt,
         :iv => new_iv,
@@ -259,6 +308,6 @@ module Tome
       readable_store { }
     end
 
-    FILE_VERSION = 1
+    FILE_VERSION = 2
   end
 end

data/lib/tome/usage.rb

@@ -0,0 +1,193 @@
+$usage = <<END
+Usage:
+
+    tome set [user@]<domain> [password]
+
+        Create or update the password for an account.
+        Example: tome set foo@gmail.com
+
+    tome generate [user@]<domain>
+
+        Generate a random password for an account.
+        Example: tome generate reddit.com
+
+    tome get <pattern>
+
+        Show the passwords for all accounts matching the pattern.
+        Example: tome get youtube
+
+    tome copy <pattern>
+
+        Copy the password for the account matching the pattern.
+        Example: tome copy news.ycombinator.com
+
+    tome list
+
+        Show all stored accounts and passwords.
+        Example: tome list
+
+    tome delete [user@]<domain>
+
+        Delete the password for an account.
+        Example: tome delete foo@slashdot.org
+
+    tome rename <old> <new>
+
+        Rename the account information stored.
+        Example: tome rename twitter.com foo@twitter.com
+
+    tome help
+
+        Shows help for a specific command.
+        Example: tome help set
+
+    tome version
+
+        Shows the version of tome.
+        Example: tome version
+END
+
+$help_usage = <<END
+tome help
+
+    Shows help for a specific command.
+
+Usage:
+
+    tome help
+    tome help <command>
+
+Examples:
+
+    tome help
+    tome help set
+    tome help help (so meta)
+
+Alias: help, --help, -h
+END
+
+$set_usage = <<END
+tome set
+
+    Create or update the password for an account. The user is optional.
+    If you do not specify a password, you will be prompted for one.
+
+Usage:
+
+    tome set [user@]<domain> [password]
+
+Examples:
+
+    tome set gmail.com
+    tome set gmail.com p4ssw0rd
+    tome set foo@gmail.com
+    tome set foo@gmail.com p4ssw0rd
+
+Alias: set, s, add
+END
+
+$get_usage = <<END
+tome get
+
+    Show the passwords for all accounts matching the pattern.
+    Matching is done with substring search. Wildcards are not supported.
+
+Usage:
+
+    tome get <pattern>
+
+Examples:
+
+    tome get gmail
+    tome get foo@
+    tome get foo@gmail.com
+
+Alias: get, g, show
+END
+
+$delete_usage = <<END
+tome delete
+
+    Delete the password for an account.
+
+Usage:
+
+    tome delete [user@]<domain>
+
+Examples:
+
+    tome delete gmail.com
+    tome delete foo@gmail.com
+
+Alias: delete, del, remove, rm
+END
+
+$generate_usage = <<END
+tome generate
+
+    Generate a random password for an account. The user is optional.
+
+Usage:
+
+    tome generate [user@]<domain>
+
+Examples:
+
+    tome generate gmail.com
+    tome generate foo@gmail.com
+
+Alias: generate, gen
+END
+
+$copy_usage = <<END
+tome copy
+
+    Copy the password for the account matching the pattern.
+    If more than one account matches the pattern, nothing happens.
+    Matching is done with substring search. Wildcards are not supported.
+
+Usage:
+
+    tome copy <pattern>
+
+Examples:
+
+    tome copy gmail
+    tome copy foo@
+    tome copy foo@gmail.com
+
+Alias: copy, cp
+END
+
+$list_usage = <<END
+tome list
+
+    Show all stored accounts and passwords.
+
+Usage:
+
+    tome list
+
+Examples:
+
+    tome list
+
+Alias: list, ls
+END
+
+$rename_usage = <<END
+tome rename
+
+    Rename the account information stored.
+
+Usage:
+
+    tome rename <old> <new>
+
+Examples:
+
+    tome rename gmail.com foo@gmail.com
+    tome rename foo@gmail.com bar@gmail.com
+
+Alias: rename, ren, rn
+END

data/lib/tome/version.rb

@@ -1 +1 @@
-$version = '0.1.0.pre'
+$version = '0.1.1.pre'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tome
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.1.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -69,7 +69,9 @@ extra_rdoc_files: []
 files:
 - lib/tome/command.rb
 - lib/tome/crypt.rb
+- lib/tome/padding.rb
 - lib/tome/tome.rb
+- lib/tome/usage.rb
 - lib/tome/version.rb
 - lib/tome.rb
 - bin/tome