lockr 0.3.0 → 0.4.2

data/lib/lockr/action/add.rb

@@ -4,7 +4,7 @@ require 'lockr/pwdstore'
 class AddAction < AesAction
   
   def initialize(id,url,username,pwd,keyfile,vault)
-    keyfilehash = calculate_hash( keyfile)
+    keyfilehash = FileUtils.calculate_sha512_hash( keyfile)
     
     pwd_directory = load_from_vault( vault)
     

data/lib/lockr/action/base.rb

@@ -1,47 +1,12 @@
 require 'openssl'
 require 'lockr/encryption/aes'
+require 'lockr/fileutils'
 
 class BaseAction
-  def calculate_hash( filename)
-    sha1 = OpenSSL::Digest::SHA512.new
-
-    File.open( filename) do |file|
-      buffer = ''
-
-      # Read the file 512 bytes at a time
-      while not file.eof
-        file.read(512, buffer)
-        sha1.update(buffer)
-      end
-    end
-    
-    sha1.to_s
-  end
+  include FileUtils
   
   def save_to_vault( storelist, vault)
-    rotate_vault( vault)
-    
-    File.open( vault, 'w') do |f|
-      f.write( storelist.to_yaml)
-    end
-  end
-  
-  def rotate_vault( vault)
-    return unless File.exists?(vault)
-    
-    # move old files first
-    max_files = 2 # = 3 - 1
-    max_files.downto( 0) { |i|
-      
-      if i == 0
-        File.rename( vault, "#{vault}_#{i}")
-      else
-        j = i - 1
-        if File.exists?("#{vault}_#{j}")
-          File.rename( "#{vault}_#{j}", "#{vault}_#{i}")  
-        end
-      end
-    }
+    FileUtils.store_obj_yaml( vault, storelist)
   end
   
   # loads the datastructure for the password sets from the file
@@ -58,14 +23,6 @@ class BaseAction
   #   :username => PasswordStore
   # }
   def load_from_vault( vault)
-    storelist = {} 
-    
-    if File.exist?( vault)
-      File.open( vault, 'r') do |f|
-        storelist = YAML::load(f)
-      end
-    end
-    
-    storelist
+    FileUtils.load_obj_yaml( vault)
   end
 end

data/lib/lockr/action/list.rb

@@ -12,7 +12,7 @@ class ListAction < AesAction
         out << "Id: #{id}"
       }
     else
-      keyfilehash = calculate_hash( keyfile)
+      keyfilehash = FileUtils.calculate_sha512_hash( keyfile)
       pwd_directory.each { |oid,value|
         pwd_directory_id = YAML::load(decrypt( value[:enc], keyfilehash, value[:salt]))
         pwd_directory_id.each { |username, pwdstore|

data/lib/lockr/action/remove.rb

@@ -4,7 +4,7 @@ require 'lockr/pwdstore'
 class RemoveAction < AesAction
   
   def initialize(id,username,keyfile,vault)
-    keyfilehash = calculate_hash( keyfile)
+    keyfilehash = FileUtils.calculate_sha512_hash( keyfile)
     pwd_directory = load_from_vault( vault)
     
     unless pwd_directory.has_key?( id)

data/lib/lockr/action/show.rb

@@ -3,7 +3,7 @@ require 'lockr/action/aes'
 class ShowAction < AesAction
   
   def initialize(id,username,keyfile, vault)
-    keyfilehash = calculate_hash( keyfile)
+    keyfilehash = FileUtils.calculate_sha512_hash( keyfile)
     
     pwd_directory = load_from_vault( vault)
     

data/lib/lockr/fileutils.rb

@@ -0,0 +1,74 @@
+module FileUtils
+  
+  # rotate the provided file with a maximum of 'limit' backups
+  # renamed filed will be named file_0, file_1, ...
+  def FileUtils.rotate_file( file, limit)
+    return unless File.exists?(file)
+    
+    # move old files first
+    max_files = limit - 1 
+    max_files.downto( 0) { |i|
+      
+      if i == 0
+        FileUtils.copy( file, "#{file}_#{i}")
+      else
+        j = i - 1
+        if File.exists?("#{file}_#{j}")
+          FileUtils.copy( "#{file}_#{j}", "#{file}_#{i}")  
+        end
+      end
+    }
+    
+    puts "Rotated local vault file(s)"
+  end  
+  
+  # copy file_src to file_target
+  def FileUtils.copy( file_src, file_target)
+    return unless File.exists?( file_src)
+    
+    dst = File.new( file_target, 'w')
+    File.open( file_src, 'r') do |src|
+      dst.write( src.read)
+    end
+    dst.close
+  end
+  
+  # store an object as yaml to file
+  def FileUtils.store_obj_yaml( file, object)
+    File.open( file, 'w') do |f|
+      f.write( object.to_yaml)
+    end
+  end
+  
+  # load an yaml object from file
+  def FileUtils.load_obj_yaml( file)
+    object = {}
+    
+    unless File.exist?( file)
+      return object
+    end
+    
+    File.open( file, 'r') do |f|
+      object = YAML::load(f)
+    end
+    
+    object
+  end
+  
+  # calculate the sha512 hash of a file
+  def FileUtils.calculate_sha512_hash( filename)
+    sha512 = OpenSSL::Digest::SHA512.new
+
+    File.open( filename) do |file|
+      buffer = ''
+
+      # Read the file 512 bytes at a time
+      while not file.eof
+        file.read(512, buffer)
+        sha512.update(buffer)
+      end
+    end
+    
+    sha512.to_s
+  end
+end

data/lib/lockr/sftp.rb

@@ -0,0 +1,100 @@
+require 'lockr/config'
+require 'net/sftp'
+require 'set'
+require 'lockr/fileutils'
+
+class SFTP
+  include FileUtils
+  
+  # upload the vault via sftp to the location specified in the configuration
+  def upload( config, vault)
+    cfg_sftp = get_sftp_config( config)
+    remote_file = File.join( cfg_sftp[:directory], File.basename(vault))
+    Net::SFTP.start( cfg_sftp[:hostname], cfg_sftp[:username]) do |sftp|
+      
+      # TODO check remote checksum to make sure upload is necessary
+      rotate_sftp_file( sftp, remote_file, 3)
+      
+      # upload a file or directory to the remote host
+      sftp.upload!( vault, remote_file)
+      puts "Uploaded vault to host '#{cfg_sftp[:hostname]}' by SFTP"
+    end
+  end
+  
+  # rotate the provided file with a maximum of 'limit' backups
+  # renamed filed will be named file_0, file_1, ...
+  def rotate_sftp_file( sftp, file, limit)
+    return unless file_exists( sftp, file)
+    
+    # move old files first
+    max_files = limit - 1 
+    max_files.downto( 0) { |i|
+      
+      if i == 0
+        sftp.rename( file, "#{file}_#{i}")
+      else
+        j = i - 1
+        next unless file_exists( sftp, "#{file}_#{j}")
+        sftp.rename( "#{file}_#{j}", "#{file}_#{i}")  
+      end
+    }
+    
+    puts "Rotated remote vault file(s)"
+  end  
+  
+  # check if the file exists on the given sftp connection
+  def file_exists( sftp, file)
+    files = get_dir_listing( sftp, File.dirname(file))
+    files.include?( File.basename(file))
+  end
+  
+  # get the file listing of a remote directory
+  def get_dir_listing( sftp, dir)
+    list = []
+
+    sftp.dir.foreach(dir) do |entry|
+      list << entry.name
+    end
+
+    Set.new(list)
+  end
+  
+  # download the vault via sftp to the location specified in the configuration
+  def download( config, vault)
+    cfg_sftp = get_sftp_config( config)
+    
+    Net::SFTP.start( cfg_sftp[:hostname], cfg_sftp[:username]) do |sftp|
+      
+      # TODO check if remote file is same as local (checksum?)
+      rotate_file( vault, 3)
+      
+      # upload a file or directory to the remote host
+      sftp.download!( File.join( cfg_sftp[:directory], File.basename(vault)), vault)
+      puts "Downloaded vault from host '#{cfg_sftp[:hostname]}' by SFTP"
+    end
+  end
+  
+  # check config for section lockr and subsection sftp. then check for keys 
+  # :hostname, :username and :directory. if anything is missing, raise ArgumentError
+  # returns sftp configuration hash
+  def get_sftp_config( config)
+    unless config.config.has_key?( :lockr)
+      raise ArgumentError, 'config has no "lockr" section'
+    end
+    
+    cfg = config.config[:lockr]
+    
+    unless cfg.has_key?( :sftp)
+      raise ArgumentError, 'config has no "sftp" section'
+    end
+    
+    cfg_sftp = cfg[:sftp]
+    
+    unless cfg_sftp.has_key?( :hostname) and cfg_sftp.has_key?( :username) and cfg_sftp.has_key?( :directory)
+      raise ArgumentError, 'config "sftp" section must have keys :host, :username and :directory'
+    end
+     
+     cfg_sftp
+  end
+  
+end

data/lib/lockr/version.rb

@@ -1,4 +1,4 @@
 module LockrVer
-  VERSION = "0.3.0"
-  DATE = "2012-08-13"
+  VERSION = "0.4.2"
+  DATE = "2012-08-19"
 end

data/lib/lockr.rb

@@ -10,16 +10,19 @@ require 'lockr/action/remove'
 require 'lockr/action/show'
 require 'lockr/config'
 require 'lockr/pwdgen'
+require 'lockr/sftp'
 require 'lockr/version'
+require 'lockr/fileutils'
   
 class Lockr
   
   def run()
     options = parse_options()
-    merge_config( options)
+    configfile = Configuration.new()
+    merge_config( configfile, options)
     validate_options( options)
     acquire_additional_input( options)
-    process_actions( options)
+    process_actions( configfile, options)
   end
   
   def parse_options()
@@ -55,7 +58,17 @@ class Lockr
       opts.on( '-g', '--genpwd PARAMS', 'generate a random password (based on the optional PARAMS)') do |params|
         options[:generatepwd] = params
       end
+      
+      options[:download] = nil
+      opts.on( '-d', '--download', 'download latest vault from configured sftp location before executing action') do |d|
+        options[:download] = true
+      end
     
+      options[:upload] = nil
+      opts.on( '-u', '--upload', 'upload vault to configured sftp location after executing action') do |d|
+        options[:upload] = true
+      end
+
       # This displays the help screen, all programs are
       # assumed to have this option.
       opts.on( '-h', '--help', 'Display this screen' ) do
@@ -82,9 +95,7 @@ class Lockr
     options
   end
   
-  def merge_config( options)
-    configfile = Configuration.new()
-    
+  def merge_config( configfile, options)
     if configfile.config.nil? 
       return
     end
@@ -138,7 +149,15 @@ class Lockr
     end
   end
   
-  def process_actions( options)
+  def process_actions( configfile, options)
+    rotate_required = ( ! options[:download].nil? ) || ( ! %w{a add r remove}.index( options[:action]).nil? )
+    FileUtils.rotate_file( options[:vault], 3) if rotate_required
+    
+    unless options[:download].nil?
+      sftp = SFTP.new
+      sftp.download( configfile, options[:vault])
+    end
+    
     begin
       case options[:action]
       when 'a', 'add'
@@ -162,5 +181,10 @@ class Lockr
       say( "<%= color('Invalid keyfile', :red) %>")
       exit 42
     end
+    
+    unless options[:upload].nil?
+      sftp = SFTP.new
+      sftp.upload( configfile, options[:vault])
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lockr
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,31 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-13 00:00:00.000000000 Z
+date: 2012-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &70208522621980 !ruby/object:Gem::Requirement
+  requirement: &70292937547480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.13
   type: :runtime
   prerelease: false
-  version_requirements: *70208522621980
+  version_requirements: *70292937547480
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70208522620300 !ruby/object:Gem::Requirement
+  requirement: &70292937546980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *70208522620300
-description: Store your passwords AES encrypted in a simple yaml file
+  version_requirements: *70292937546980
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: &70292937546520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70292937546520
+description: Lockr is a command line based password manager. Passwords are stored
+  AES-encrypted in a file on your own system.
 email: info@byteblues.com
 executables:
 - lockr
@@ -49,8 +61,10 @@ files:
 - lib/lockr/action/show.rb
 - lib/lockr/encryption/aes.rb
 - lib/lockr/config.rb
+- lib/lockr/fileutils.rb
 - lib/lockr/pwdgen.rb
 - lib/lockr/pwdstore.rb
+- lib/lockr/sftp.rb
 - lib/lockr/version.rb
 - !binary |-
   YmluL2xvY2ty
@@ -77,5 +91,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Safe password storage
+summary: Command line based password manager
 test_files: []