safe 0.4 → 0.5

data/README

@@ -4,6 +4,34 @@ user IDs and passwords using a single password as the master key. It stores the
 master key as a hash (SHA2), and uses it to encrypt the rest of the data using
 Blowfish.
 
+== A Note About Moving from 0.3 to 0.4 ==
+The format of the file changed slightly. Specifically, the salt and hash values
+were changed to be attributes of the root safe element. You must edit your
+.safe.xml file accordingly.
+
+Example:
+0.3 version:
+<safe>
+<salt>
+foo
+</salt>
+<hash>
+bar
+</hash>
+<entries>
+...
+</entries>
+</salt>
+
+0.4 version:
+<safe salt="foo" hash="bar">
+<entries>
+...
+</entries>
+</salt>
+
+This is a one-time operation.
+
 == License ==
 Safe is licensed under the BSD License. Copyright (c) 2007, Rob Warner
 
@@ -37,7 +65,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 To install safe, you must have Ruby and Ruby Gems installed. From the command
 line, type:
 
-  gem install safe --include-dependencies
+  gem install safe
 
 safe depends on two gems:
 
@@ -59,6 +87,7 @@ Windows:
 0.2 -- August 19, 2007
 0.3 -- September 7, 2007
 0.4 -- April 4, 2008
+0.5 -- April 6, 2008
 
 See Release-Notes.txt for more information
 
@@ -107,7 +136,9 @@ Options:
     -l, --list NAME                  List an entry
     -v, --version                    Print version
     -p, --password                   Change password
-    
+    -f, --diff DIR                   Diff against password file in directory DIR
+    -m, --merge DIR                  Merge with password file in directory DIR
+
 For example, to add an entry to your password file for Rubyforge.org, you type:
 
   safe -a Rubyforge.org
@@ -147,6 +178,21 @@ You will be prompted for your master password, and then your Rubyforge.org
 password is irretrievably deleted. You will not be asked to confirm the
 deletion.
 
+== Diff and Merge ==
+Diffing and merging deviates slightly from diffing and merging other types of
+files, since typically users want a union of the files without deleting any
+entries. Consequently, instead of Add/Delete/Change, the output of diff will
+indicate Master/Other/Change, meaning the entry is only in the Master copy
+(the one in the directory pointed to by SAFE_DIR), the Other copy (the one in
+the directory passed on the command line), or is in both but has been Changed,
+respectively.
+
+Merge does two things:
+1) Adds all entries from the Other copy that don't exist in the Master copy
+   to the Master copy
+2) Interactively performs requested changes to changed entries on the Master
+   copy
+
 == Backups ==
 Please back up your .safe.xml file! See License section for disclaimer
 information.

data/Rakefile

@@ -7,7 +7,7 @@ gem_spec = Gem::Specification.new do |spec|
   spec.summary = 'A command-line password storage program'
   spec.description = %{safe safely stores all your user IDs and passwords,
   encrypted by a password of your choosing.}
-  spec.version = '0.4'
+  spec.version = '0.5'
   
   # Author information
   spec.author = 'Rob Warner'

data/Release-Notes.txt

@@ -1,5 +1,11 @@
 Safe Release Notes
 ------------------
+0.5 (April 6, 2008)
+-------------------
+[FIXED] Version number in help output corrected
+[NEW] Added diff and merge capabilities
+[CHANGE] Incorrect password no longer displays stack trace
+
 0.4 (April 4, 2008)
 -------------------
 [FIXED] Passwords stopped authenticating (change in REXML perhaps?--whitespace returned in salt and hash), so moved salt

data/bin/safe

@@ -41,7 +41,7 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'safeutils')
 # TODO support list <NAME> without -l flag
 
 class Safe
-  SAFE_VERSION = '0.3'
+  SAFE_VERSION = '0.5'
   
   # Gets the command line
   def self.get_command_line
@@ -76,6 +76,14 @@ class Safe
     opts.on('-p', '--password', 'Change password') do
       options[:action] = 'password'
     end
+    opts.on('-f', '--diff DIR', 'Diff against password file in directory DIR') do |val|
+      options[:name] = val
+      options[:action] = 'diff'
+    end
+    opts.on('-m', '--merge DIR', 'Merge with password file in directory DIR') do |val|
+      options[:name] = val
+      options[:action] = 'merge'
+    end
     opts.parse! rescue abort [$!.message, opts].join("\n")
     options
   end
@@ -88,21 +96,22 @@ class Safe
     else
       begin
         dir = SafeUtils::get_safe_dir
+        file = SafeUtils::get_safe_file(dir)
+
+        # Perform the requested action
+        case options[:action]
+          when 'list': file.list(options[:name])
+          when 'add': file.add(options[:name])
+          when 'delete': file.delete(options[:name])
+          when 'count': puts file.count
+          when 'password': file.change_password
+          when 'import': SafeUtils::import(file, options[:name])
+          when 'diff': SafeUtils::diff(file, options[:name])
+          when 'merge': SafeUtils::merge(file, options[:name])
+        end
       rescue
         abort $!.message
       end
-      password = SafeUtils::get_password
-      file = SafeFile.new(password, dir)
-    
-    # Perform the requested action
-      case options[:action]
-        when 'list': file.list(options[:name])
-        when 'add': file.add(options[:name])
-        when 'delete': file.delete(options[:name])
-        when 'count': puts file.count
-        when 'password': file.change_password
-        when 'import': SafeUtils::import(file, options[:name])
-      end
     end
   end
 end

data/lib/safediff.rb

@@ -0,0 +1,80 @@
+########################################################################
+# safediff.rb
+# Copyright (c) 2007, Rob Warner
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#   * Neither the name of Rob Warner nor the names of its contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+########################################################################
+
+##
+# SafeDiff
+# Contains a difference between two safe entries
+##
+class SafeDiff
+  attr_accessor :operation, :master, :other
+
+  MASTER = "m"
+  OTHER = "o"
+  CHANGE = "c"
+
+  def initialize(master, other)
+    self.master = master
+    self.other = other
+    compare
+  end
+
+  def compare
+    if self.master != nil && self.master.equals?(self.other)
+      raise "Entries are not different:\n#{self.master.to_s}\n#{self.other.to_s}"
+    elsif self.master != nil && self.other == nil
+      self.operation = MASTER
+    elsif self.master == nil && self.other != nil
+      self.operation = OTHER
+    else
+      self.operation = CHANGE
+    end
+  end
+
+  def to_s
+    s = ""
+    s << self.operation
+    s << "\n"
+    if self.operation == MASTER || self.operation == CHANGE
+      s << "< "
+      s << self.master.to_s
+      s << "\n"
+    end
+    if self.operation == CHANGE
+      s << "---\n"
+    end
+    if self.operation == OTHER || self.operation == CHANGE
+      s << "> "
+      s << self.other.to_s
+      s << "\n"
+    end
+    s
+  end
+end

data/lib/safeentry.rb

@@ -37,9 +37,9 @@ class SafeEntry
   attr_accessor :name, :id, :password
 
   def initialize(name, id, password)
-    @name = name
-    @id = id
-    @password = password
+    self.name = name
+    self.id = id
+    self.password = password
   end
   
   def to_s
@@ -49,5 +49,13 @@ class SafeEntry
   def <=>(other)
     self.name.upcase <=> other.name.upcase
   end
+
+  def equals? other
+    if other == nil
+      false
+    else
+      self.name == other.name && self.id == other.id && self.password == other.password
+    end
+  end
 end
 

data/lib/safeutils.rb

@@ -28,6 +28,7 @@
 # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ########################################################################
+require File.join(File.dirname(__FILE__), 'safediff')
 require 'highline/import'
 
 ##
@@ -73,4 +74,67 @@ class SafeUtils
       raise "Problem importing file #{import_file}"
     end
   end
+
+  def SafeUtils.get_safe_file(dir, prompt = 'Password: ')
+    password = SafeUtils::get_password(prompt)
+    SafeFile.new(password, dir)
+  end
+
+  # Diffs two .safe.xml files
+  def SafeUtils.diff(safe_file, dir)
+    other_file = get_safe_file(dir, "#{dir} Password: ")
+    diffs = get_diffs(safe_file, other_file)
+    puts diffs
+  end
+
+  # Merges two .safe.xml files
+  def SafeUtils.merge(safe_file, dir)
+    other_file = get_safe_file(dir, "#{dir} Password: ")
+    diffs = get_diffs(safe_file, other_file)
+    do_merge safe_file, diffs
+    safe_file.save
+  end
+
+  # Returns the SafeDiff objects in an Array
+  def SafeUtils.get_diffs(safe_file, other_file)
+    diffs = Array.new
+
+    # Find master-only and changes
+    safe_file.entries.each_value do |entry|
+      if other_file.entries.has_key? entry.name
+        other_entry = other_file.entries[entry.name]
+        diffs << SafeDiff.new(entry, other_entry) unless entry.equals? other_entry
+      else
+        diffs << SafeDiff.new(entry, nil)
+      end
+    end
+
+    # Find other-only
+    other_file.entries.each_value do |entry|
+      if !safe_file.entries.has_key? entry.name
+        diffs << SafeDiff.new(nil, entry)
+      end
+    end
+    
+    diffs
+  end
+
+  def SafeUtils.do_merge(safe_file, diffs, override_master = false)
+    diffs.each do |diff|
+      case diff.operation
+      when SafeDiff::MASTER: # Do nothing
+      when SafeDiff::OTHER:  # Add to safe file
+        safe_file.insert(diff.other.name, diff.other.id, diff.other.password)
+      when SafeDiff::CHANGE: # Update safe file
+        if override_master || replace_master?(diff)
+          safe_file.insert(diff.other.name, diff.other.id, diff.other.password)
+        end
+      end
+    end
+  end
+
+  def SafeUtils.replace_master?(diff)
+    print "Replace:\n\t#{diff.master.to_s}\nWith:\n\t#{diff.other.to_s}\n?"
+    gets.chomp == 'y'
+  end
 end

data/test/tc_safediff.rb

@@ -0,0 +1,52 @@
+########################################################################
+# tc_safediff.rb
+# Copyright (c) 2007 Rob Warner.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+########################################################################
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'safediff')
+require 'test/unit'
+
+class SafeDiffTest < Test::Unit::TestCase
+  def test_diff
+    e1 = SafeEntry.new('apple', 'baker', 'charlie')
+    e2 = SafeEntry.new('apple', 'baker', 'charlie')
+    e3 = SafeEntry.new('apple1', 'baker', 'charlie')
+    e4 = SafeEntry.new('apple', 'baker1', 'charlie')
+    e5 = SafeEntry.new('apple', 'baker', 'charlie1')
+
+    # Test two equal entries
+    begin
+      diff = SafeDiff.new e1, e2
+    rescue RuntimeError
+      assert_equal "Entries are not different:\n#{e1.to_s}\n#{e2.to_s}", $!.message
+    end
+
+    # Test an OTHER
+    diff = SafeDiff.new nil, e1
+    assert_equal diff.operation, SafeDiff::OTHER
+    assert_equal diff.to_s, "#{SafeDiff::OTHER}\n> #{e1.to_s}\n"
+
+    # Test a MASTER
+    diff = SafeDiff.new e1, nil
+    assert_equal diff.operation, SafeDiff::MASTER
+    assert_equal diff.to_s, "#{SafeDiff::MASTER}\n< #{e1.to_s}\n"
+
+    # Test a change
+    diff = SafeDiff.new e1, e3
+    assert_equal diff.operation, SafeDiff::CHANGE
+    assert_equal diff.to_s, "#{SafeDiff::CHANGE}\n< #{e1.to_s}\n---\n> #{e3.to_s}\n"
+
+    # Test various changes
+    diff = SafeDiff.new e1, e4
+    assert_equal diff.operation, SafeDiff::CHANGE
+    assert_equal diff.to_s, "#{SafeDiff::CHANGE}\n< #{e1.to_s}\n---\n> #{e4.to_s}\n"
+
+    diff = SafeDiff.new e1, e5
+    assert_equal diff.operation, SafeDiff::CHANGE
+    assert_equal diff.to_s, "#{SafeDiff::CHANGE}\n< #{e1.to_s}\n---\n> #{e5.to_s}\n"
+  end
+end

data/test/tc_safeutils.rb

@@ -42,4 +42,60 @@ class SafeUtilsTest < Test::Unit::TestCase
     # Make sure the directory exists
     FileUtils::cd dir
   end
+
+  def test_diff
+    f1 = SafeFile.new("password", ".")
+    f2 = SafeFile.new("password", ".", ".safe2.xml")
+
+    f1.insert('apple', 'baker', 'charlie')
+    diffs = SafeUtils.get_diffs(f1, f2)
+    assert_equal 1, diffs.length
+    assert_equal "m\n< apple\tbaker\tcharlie\n", diffs[0].to_s
+
+    f2.insert('apple', 'baker', 'charlie')
+    diffs = SafeUtils.get_diffs(f1, f2)
+    assert_equal 0, diffs.length
+
+    f2.insert('foo', 'bar', 'baz')
+    diffs = SafeUtils.get_diffs(f1, f2)
+    assert_equal 1, diffs.length
+    assert_equal "o\n> foo\tbar\tbaz\n", diffs[0].to_s
+
+    f2.insert('apple', 'ibm', 'compaq')
+    f2.delete('foo')
+    diffs = SafeUtils.get_diffs(f1, f2)
+    assert_equal 1, diffs.length
+    assert_equal "c\n< apple\tbaker\tcharlie\n---\n> apple\tibm\tcompaq\n", diffs[0].to_s
+    
+    FileUtils::rm("./.safe2.xml")
+    FileUtils::rm("./.safe.xml")
+  end
+
+  def test_merge
+    f1 = SafeFile.new("password", ".")
+    f2 = SafeFile.new("password", ".", ".safe2.xml")
+
+    f1.insert('apple', 'baker', 'charlie')
+    f1.insert('one', 'baker', 'charlie')
+    f1.insert('two', 'baker', 'charlie')
+    f1.insert('three', 'baker', 'charlie')
+    f1.insert('four', 'baker', 'charlie')
+    f1.insert('five', 'baker', 'charlie')
+
+    f2.insert('three', 'baker', 'charlie')
+    f2.insert('four', 'goober', 'raisinet')
+    f2.insert('five', 'coke', 'pepsi')
+    f2.insert('six', 'baker', 'charlie')
+    f2.insert('seven', 'baker', 'charlie')
+    f2.insert('eight', 'baker', 'charlie')
+    
+    diffs = SafeUtils.get_diffs(f1, f2)
+    SafeUtils.do_merge(f1, diffs, true)
+    assert_equal 9, f1.count
+    assert_equal "four\tgoober\traisinet", f1.entries['four'].to_s
+    assert_equal "five\tcoke\tpepsi", f1.entries['five'].to_s
+
+    FileUtils::rm("./.safe2.xml")
+    FileUtils::rm("./.safe.xml")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: safe
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: "0.5"
 platform: ruby
 authors: 
 - Rob Warner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-04 00:00:00 -04:00
+date: 2008-04-06 00:00:00 -04:00
 default_executable: safe
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,6 +40,7 @@ extra_rdoc_files: []
 
 files: 
 - README
+- lib/safediff.rb
 - lib/safeentry.rb
 - lib/safefile.rb
 - lib/safeutils.rb
@@ -73,6 +74,7 @@ signing_key:
 specification_version: 2
 summary: A command-line password storage program
 test_files: 
+- test/tc_safediff.rb
 - test/tc_safeentry.rb
 - test/tc_safefile.rb
 - test/tc_safeutils.rb