yak 1.0.2 → 1.0.3

data/History.txt

@@ -1,4 +1,24 @@
-=== 1.0.1 / 2010-02-22
+=== 1.0.3 / 2010-02-22
+
+  * Enhancements:
+
+    * Added Dropbox support
+
+    * Added setup routine for first run
+
+    * Added -p option to print to stdout
+
+    * Added delete data option
+
+    * Customizable data file location
+
+  * Bugfixes:
+
+    * First run has setup
+
+    * Cipher error catching updated
+
+=== 1.0.2 / 2010-02-22
 
   * Renaming to Yak
 

data/README.txt

@@ -15,7 +15,8 @@ Session is the length of time in seconds that Yak will remember the
 master password:
   :session: 30
 
-If using sessions is not desired and you want to enter the master, set:
+If using sessions is not desired and you want to enter the
+master password every time, set:
   :session: false
 
 Always set the password by default, use:

data/lib/yak.rb

@@ -20,10 +20,12 @@ require 'session'
 #   :password: plain_text_password
 # To turn off password confirmation prompts:
 #   :confirm_prompt: false
+# To set the path to the yak data file:
+#   :data_file: /path/to/file
 
 class Yak
 
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 
   DEFAULT_CONFIG = {:session => 30}
 
@@ -34,35 +36,83 @@ class Yak
   #   ...
 
   def self.run argv=ARGV
-    config = DEFAULT_CONFIG.merge load_config
+    user = `whoami`.chomp
+
+    check_user_setup user
+
+    config = DEFAULT_CONFIG.merge load_config(user)
 
     options = parse_args argv
 
-    yak = new `whoami`.chomp, config
+    yak = new user, config
+
+    yak.connect_data
+    yak.start_session
 
     args = [options[:action], yak, options[:key], options[:value]].compact
 
     self.send(*args)
 
-  rescue OpenSSL::CipherError => e
+  rescue OpenSSL::Cipher::CipherError => e
     $stderr << "Bad password.\n"
     exit 1
   end
 
 
   ##
-  # Load the ~/.yakrc file and return. Creates ~/.yakrc with the
-  # default config if missing.
+  # Setup yak for first run if it hasn't been.
+
+  def self.check_user_setup user
+    user_config_file = yak_config_file user
+
+    return if File.file? user_config_file
+
+    hl = HighLine.new $stdin, $stderr
+    hl.say "Thanks for installing Yak!"
+
+    data_file_opts = []
 
-  def self.load_config
-    config_file = File.expand_path "~/.yakrc"
+    usrhome = File.expand_path "~#{user}/"
+    dropbox = File.expand_path "~#{user}/Dropbox"
 
-    if !File.file?(config_file)
-      File.open(config_file, "w+"){|f| f.write DEFAULT_CONFIG.to_yaml }
-      $stderr << "Created Yak config file #{config_file}\n"
+    data_file_opts << dropbox if File.directory? dropbox
+    data_file_opts << usrhome if File.directory? usrhome
+
+    data_path = hl.choose do |menu|
+      menu.prompt = "Where would you like your data file to live?"
+      menu.choices(*data_file_opts)
+      menu.choice "other" do
+        hl.ask "Enter path:"
+      end
     end
 
-    YAML.load_file config_file
+    data_file  = File.join data_path, ".yakdata"
+    new_config = DEFAULT_CONFIG.merge(:data_file => data_file)
+
+    make_config_file user, new_config
+  end
+
+
+  ##
+  # Load the ~/.yakrc file and return.
+
+  def self.load_config user
+    user_config_file = yak_config_file user
+
+    YAML.load_file user_config_file
+  end
+
+
+  ##
+  # Create a new user config file.
+
+  def self.make_config_file user, new_config=DEFAULT_CONFIG
+    user_config_file = yak_config_file user
+    config_str = new_config.to_yaml
+
+    File.open(user_config_file, "w+"){|f| f.write config_str }
+    $stderr << "Created Yak config file #{user_config_file}:\n"
+    $stderr << "#{config_str}\n"
   end
 
 
@@ -83,6 +133,16 @@ class Yak
   end
 
 
+  def self.print_password yak, name
+    $stdout << "#{yak.retrieve(name)}\n"
+  end
+
+
+  def self.delete_data yak
+    yak.delete_data_file! true
+  end
+
+
   def self.list yak, name=nil
     key_regex = /#{name || ".+"}/
 
@@ -118,6 +178,11 @@ class Yak
   end
 
 
+  def self.yak_config_file user
+    File.expand_path "~#{user}/.yakrc"
+  end
+
+
   def self.parse_args argv
     options = {}
 
@@ -164,6 +229,17 @@ Retrieved passwords get copied to the clipboard by default.
              'Update the password used for encryption') do |value|
         options[:action] = :new_password
       end
+
+      opt.on('-p', '--print KEY',
+             'Print the password for the given key to stdout') do |key|
+        options[:action] = :print_password
+        options[:key]    = key
+      end
+
+      opt.on('--delete-data',
+             'Delete the data file - lose all saved info') do
+        options[:action] = :delete_data
+      end
     end
 
     opts.parse! argv
@@ -172,6 +248,11 @@ Retrieved passwords get copied to the clipboard by default.
     options[:key]    ||= argv.shift
     options[:value]  ||= argv.shift
 
+    if options[:action] == :retrieve && options[:key].nil?
+      $stderr << opts.to_s
+      exit 1
+    end
+
     options
   end
 
@@ -192,24 +273,21 @@ Retrieved passwords get copied to the clipboard by default.
     @confirm_prompt = options[:confirm_prompt] if
       options.has_key? :confirm_prompt
 
-    @yak_dir = File.expand_path "~#{@user}/.yak"
+    @yak_dir = File.expand_path "~#{user}/.yak"
     FileUtils.mkdir @yak_dir unless File.directory? @yak_dir
 
     @pid_file      = File.join @yak_dir, "pid"
     @password_file = File.join @yak_dir, "password"
-    @data_file     = File.join @yak_dir, "data"
+    @data_file     = options[:data_file] || File.join(@yak_dir, "data")
 
     @session_pid = nil
     @session_pid = File.read(@pid_file).to_i if File.file? @pid_file
 
-    @password = get_password options[:password]
+    @password = nil
 
     @cipher = OpenSSL::Cipher::Cipher.new "aes-256-cbc"
 
     @session_length = options.has_key?(:session) ? options[:session] : 30
-
-    connect_data
-    start_session
   end
 
 
@@ -227,7 +305,7 @@ Retrieved passwords get copied to the clipboard by default.
     end
 
     File.open(@pid_file,      "w+"){|f| f.write pid }
-    File.open(@password_file, "w+"){|f| f.write @password }
+    File.open(@password_file, "w+"){|f| f.write sha_password }
 
     Process.detach pid
   end
@@ -251,16 +329,43 @@ Retrieved passwords get copied to the clipboard by default.
   end
 
 
+  ##
+  # Check if the data file exists.
+
+  def data_file_exists?
+    File.file? @data_file
+  end
+
+
+  ##
+  # Deletes the user's data file forever!
+
+  def delete_data_file! confirm=false
+    confirmed = confirm ? @input.agree("Delete all passwords? (y/n)") : true
+    FileUtils.rm_f(@data_file) if confirmed
+  end
+
+
+  ##
+  # Get the SHA-encrypted password used for encoding data.
+
+  def sha_password
+    new_password unless data_file_exists?
+    @password ||= get_password
+  end
+
+
   ##
   # Get a password from either the password file or by prompting the
   # user if a password file is unavailable. Returns a sha1 of the password
   # passed as an arg.
 
-  def get_password plain_password=nil
-    password   = File.read @password_file if File.file? @password_file
+  def get_password plain_pswd=nil
+    password = File.read @password_file if File.file?(@password_file)
+
+    plain_pswd ||= request_password "Master Password" if !password
 
-    password ||=
-      Digest::SHA1.hexdigest(plain_password || request_password("Yak Password"))
+    password ||= Digest::SHA1.hexdigest plain_pswd
 
     password
   end
@@ -271,8 +376,8 @@ Retrieved passwords get copied to the clipboard by default.
   # Prompts for password confirmation as well.
 
   def new_password password=nil
-    password ||= request_new_password "New Password"
-    @password  = Digest::SHA1.hexdigest password if password
+    password ||= request_new_password "Set New Master Password"
+    @password  = Digest::SHA1.hexdigest password
   end
 
 
@@ -280,13 +385,14 @@ Retrieved passwords get copied to the clipboard by default.
   # Loads and decrypts the data file into the @data attribute.
 
   def connect_data
-    @data = if File.file? @data_file
-              data = ""
-              File.open(@data_file, "rb"){|f| data << f.read }
-              YAML.load decrypt(data)
-            else
-              {}
-            end
+    if data_file_exists?
+      data = ""
+      File.open(@data_file, "rb"){|f| data << f.read }
+      @data = YAML.load decrypt(data)
+    else
+      @data = {}
+      write_data
+    end
   end
 
 
@@ -318,27 +424,23 @@ Retrieved passwords get copied to the clipboard by default.
   ##
   # Decrypt a string with a given password.
 
-  def decrypt string, password=@password
-    @cipher.decrypt
-    @cipher.key = password
-    get_cypher_out string
+  def decrypt string, password=nil
+    get_cypher_out :decrypt, string, password
   end
 
 
   ##
   # Encrypt a string with a given password.
 
-  def encrypt string, password=@password
-    @cipher.encrypt
-    @cipher.key = password
-    get_cypher_out string
+  def encrypt string, password=nil
+    get_cypher_out :encrypt, string, password
   end
 
 
   ##
   # Encrypt and write the Yak data back to the data file.
 
-  def write_data password=@password
+  def write_data password=nil
     data = encrypt @data.to_yaml, password
     File.open(@data_file, "w+"){|f| f.write data}
   end
@@ -376,7 +478,12 @@ Retrieved passwords get copied to the clipboard by default.
   end
 
 
-  def get_cypher_out string
+  def get_cypher_out method, string, password=nil
+    password ||= sha_password
+
+    @cipher.send method
+    @cipher.key = password
+
     out = @cipher.update string
     out << @cipher.final
     out

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yak
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-22 00:00:00 -08:00
+date: 2010-02-23 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.4.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -40,7 +60,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
+        version: 2.5.0
     version: 
 description: |-
   Yak is a simple command line app to store and retrieve passwords securely