keyring 0.1.0 → 0.2.0

data/lib/keyring/cli.rb

@@ -0,0 +1,79 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+require 'slop'
+require 'keyring'
+
+class Keyring::CLI
+  def initialize(options={})
+    @options = options
+    
+    @method = @arg = nil
+    @opts = Slop.parse(:help => true) do
+      banner 'Usage: keyring get|set|delete <service> <username> [password (for set)]'
+      
+      on :v, :version, 'Print the version' do
+        puts Keyring::VERSION
+        exit
+      end
+      
+      command 'set' do
+        # FIXME: option to prompt for password
+        run do |opts, args|
+          @method = :set
+          @arg = args
+        end
+      end
+      command 'get' do
+        run do |opts, args|
+          @method = :get
+          @arg = args
+        end
+      end
+      command 'delete' do
+        run do |opts, args|
+          @method = :delete
+          @arg = args
+        end
+      end
+    end
+  end
+  
+  def main
+    if @method && respond_to?(@method)
+      send(@method, @arg)
+    else
+      puts @opts
+      exit 1
+    end
+  end
+  
+  def set(args)
+    ensure_arg_presence(args, 3)
+    keyring = Keyring.new
+    keyring.set_password(args[0], args[1], args[2])
+  end
+  def get(args)
+    ensure_arg_presence(args, 2)
+    keyring = Keyring.new
+    puts keyring.get_password(args[0], args[1])
+  end
+  def delete(args)
+    ensure_arg_presence(args, 2)
+    keyring = Keyring.new
+    keyring.delete_password(args[0], args[1])
+  end
+  
+  def ensure_arg_presence(args, count)
+    0.upto(count-1) do |i|
+      if !args[i] || args[i].empty?
+        if !@options[:testing]
+          puts @opts
+          exit 1
+        else
+          raise ArgumentError
+        end
+      end
+    end
+  end
+end

data/lib/keyring/version.rb

@@ -0,0 +1,6 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+class Keyring
+  VERSION = "0.2.0"
+end

data/test/keyring_tests.rb

@@ -0,0 +1,7 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+module KeyringTestConstants
+  # Fake commands used in place of system commands
+  TESTCMDDIR = File.expand_path('testcmds', File.dirname(__FILE__))
+end

data/test/test_backend.rb

@@ -0,0 +1,38 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+require 'test/unit'
+require 'keyring'
+
+class KeyringBackendTests < Test::Unit::TestCase
+  def setup
+    @backend = Keyring::Backend.new
+  end
+  
+  class Keyring::Backend::Test < Keyring::Backend; end
+  def test_register_implementation
+    Keyring::Backend.register_implementation(Keyring::Backend::Test)
+    assert Keyring::Backend.implementations.include?(Keyring::Backend::Test)
+    Keyring::Backend.implementations.delete(Keyring::Backend::Test)
+  end
+  def test_create
+    # This should be a bit more thorough
+    assert_kind_of Keyring::Backend, Keyring::Backend.create
+  end
+  
+  def test_supported
+    refute @backend.supported?
+  end
+  def test_priority
+    assert_equal 0, @backend.priority
+  end
+  def test_set_password
+    assert_raises(NotImplementedError) {@backend.set_password('service', 'username', 'password')}
+  end
+  def test_get_password
+    assert_raises(NotImplementedError) {@backend.get_password('service', 'username')}
+  end
+  def test_delete_password
+    assert_raises(NotImplementedError) {@backend.delete_password('service', 'username')}
+  end
+end

data/test/test_backend_macosx_keychain.rb

@@ -0,0 +1,73 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+require File.expand_path('keyring_tests', File.dirname(__FILE__))
+require 'test/unit'
+require 'mocha/setup'
+require 'keyring'
+
+class KeyringBackendMacosxKeychainTests < Test::Unit::TestCase
+  include KeyringTestConstants
+  
+  def setup
+    @backend = Keyring::Backend::MacosxKeychain.new
+  end
+  
+  def test_supported
+    @backend.security = File.join(TESTCMDDIR, 'macosx/security-wronghelp')
+    refute @backend.supported?
+    @backend.security = File.join(TESTCMDDIR, 'macosx/bogus')
+    refute @backend.supported?
+    @backend.security = File.join(TESTCMDDIR, 'macosx/security-righthelp')
+    assert @backend.supported?
+  end
+  def test_priority
+    assert_equal 1, @backend.priority
+  end
+  
+  def test_security_command
+    assert_equal 'add-generic-password', @backend.security_command('add')
+    assert_equal 'find-generic-password', @backend.security_command('find')
+    assert_equal 'delete-generic-password', @backend.security_command('delete')
+  end
+  
+  def test_set_password
+    @backend.expects(:system).with(
+      '/usr/bin/security', 'add-generic-password', '-s', 'service', '-a', 'username', '-w', 'password', '-U')
+    # We need to set $? to make up for the fact that system was not actually run
+    # FIXME: surely there's a better way?
+    `true`
+    @backend.set_password('service', 'username', 'password')
+  end
+  
+  def test_get_password
+    @backend.security = File.join(TESTCMDDIR, 'macosx/security-find')
+    assert_equal 'password', @backend.get_password('service', 'username')
+  end
+  def test_get_password_hex
+    @backend.security = File.join(TESTCMDDIR, 'macosx/security-findhex')
+    assert_equal "\0100\0101\0100\0101\0100\0101\0100\0101", @backend.get_password('service', 'hexuser')
+  end
+  def test_get_password_empty
+    @backend.security = File.join(TESTCMDDIR, 'macosx/security-findempty')
+    assert_equal '', @backend.get_password('service', 'emptyuser')
+  end
+  def test_get_password_notfound
+    @backend.security = File.join(TESTCMDDIR, 'macosx/security-notfound')
+    assert_nil @backend.get_password('bogus', 'bogus')
+  end
+  
+  def test_delete_password_options
+    Open3.expects(:popen3).with(
+      '/usr/bin/security', 'delete-generic-password', '-s', 'service', '-a', 'username')
+    @backend.delete_password('service', 'username')
+  end
+  def test_delete_password_output
+    @backend.security = File.join(TESTCMDDIR, 'macosx/security-delete')
+    assert @backend.delete_password('service', 'gooduser')
+  end
+  def test_delete_password_errors
+    @backend.security = File.join(TESTCMDDIR, 'macosx/security-notfound')
+    refute @backend.delete_password('bogus', 'bogus')
+  end
+end

data/test/test_backend_memory.rb

@@ -0,0 +1,43 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+require 'test/unit'
+require 'keyring'
+
+class KeyringBackendMemoryTests < Test::Unit::TestCase
+  def setup
+    @backend = Keyring::Backend::Memory.new
+  end
+  
+  def test_supported
+    assert @backend.supported?
+  end
+  def test_priority
+    assert_equal 0.1, @backend.priority
+  end
+  
+  def test_set_password
+    @backend.set_password('service', 'username', 'password')
+    assert_equal 'password', @backend.instance_variable_get('@keyring')['service']['username']
+  end
+  def test_get_password
+    @backend.set_password('service', 'username', 'password')
+    assert_equal 'password', @backend.get_password('service', 'username')
+    
+    # Ensure that get_password behaves properly when asked for things that
+    # have not been set
+    assert_nil @backend.get_password('service', 'bogus')
+    assert_nil @backend.get_password('bogus', 'bogus')
+  end
+  def test_delete_password
+    @backend.set_password('service', 'username', 'password')
+    @backend.delete_password('service', 'username')
+    assert_nil @backend.instance_variable_get('@keyring')['service']['username']
+    assert_nil @backend.get_password('service', 'username')
+    
+    # Ensure that delete_password behaves properly when asked to delete
+    # things that have not been set
+    @backend.delete_password('service', 'bogus')
+    @backend.delete_password('bogus', 'bogus')
+  end
+end

data/test/test_cli.rb

@@ -0,0 +1,58 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+require 'keyring/cli'
+require 'test/unit'
+require 'mocha/setup'
+
+class KeyringCLITests < Test::Unit::TestCase
+  def setup
+    @cli = Keyring::CLI.new(testing: true)
+  end
+  
+  EXE = File.expand_path('../bin/keyring', File.dirname(__FILE__))
+  def test_help_option
+    assert_match /\AUsage:/, `#{EXE} --help`
+    assert $?.success?
+  end
+  def test_version_option
+    assert_equal "#{Keyring::VERSION}\n", `#{EXE} --version`
+    assert $?.success?
+  end
+  
+  def test_set
+    assert_raise(ArgumentError) {@cli.set([])}
+    assert_raise(ArgumentError) {@cli.set(['service'])}
+    assert_raise(ArgumentError) {@cli.set(['service', 'username'])}
+    
+    Keyring.any_instance.expects(:set_password).with('service', 'username', 'password')
+    @cli.set(['service', 'username', 'password'])
+  end
+  def test_get
+    assert_raise(ArgumentError) {@cli.get([])}
+    assert_raise(ArgumentError) {@cli.get(['service'])}
+    
+    Keyring.any_instance.expects(:get_password).with('service', 'username').returns('password')
+    $stdout = output = StringIO.new
+    @cli.get(['service', 'username'])
+    $stdout = STDOUT
+    assert_equal "password\n", output.string
+  end
+  def test_delete
+    assert_raise(ArgumentError) {@cli.delete([])}
+    assert_raise(ArgumentError) {@cli.delete(['service'])}
+    
+    Keyring.any_instance.expects(:delete_password).with('service', 'username')
+    @cli.delete(['service', 'username'])
+  end
+  
+  def test_ensure_arg_presence
+    assert_nothing_raised      {@cli.ensure_arg_presence([], 0)}
+    assert_raise(ArgumentError) {@cli.ensure_arg_presence([], 1)}
+    assert_raise(ArgumentError) {@cli.ensure_arg_presence([''], 1)}
+    
+    assert_nothing_raised      {@cli.ensure_arg_presence(['a'], 1)}
+    assert_raise(ArgumentError) {@cli.ensure_arg_presence(['a'], 2)}
+    assert_raise(ArgumentError) {@cli.ensure_arg_presence(['a', ''], 2)}
+  end
+end

data/test/test_keyring.rb

@@ -0,0 +1,36 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+require 'test/unit'
+require 'mocha/setup'
+require 'keyring'
+
+class KeyringTests < Test::Unit::TestCase
+  def setup
+    @backend = Keyring::Backend::Memory.new
+    @keyring = Keyring.new(@backend)
+  end
+  
+  def test_initialize
+    keyring = Keyring.new
+    assert_kind_of Keyring::Backend, keyring.instance_variable_get(:@backend)
+    
+    backend = Keyring::Backend::Memory.new
+    keyring = Keyring.new(backend)
+    assert_equal backend, keyring.instance_variable_get(:@backend)
+  end
+  
+  def test_get_password
+    @backend.expects(:get_password).with('service', 'username').returns('password')
+    password = @keyring.get_password('service', 'username')
+    assert_equal 'password', password
+  end
+  def test_set_password
+    @backend.expects(:set_password).with('service', 'username', 'password')
+    @keyring.set_password('service', 'username', 'password')
+  end
+  def test_delete_password
+    @backend.expects(:delete_password).with('service', 'username')
+    @keyring.delete_password('service', 'username')
+  end
+end

data/test/testcmds/macosx/binary

@@ -0,0 +1 @@
+01010101

data/test/testcmds/macosx/emptything

@@ -0,0 +1 @@
+password: 

data/test/testcmds/macosx/random

@@ -0,0 +1 @@
+ô%A���t;.	u�@r

data/test/testcmds/macosx/security-delete

@@ -0,0 +1,27 @@
+#!/bin/sh
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+cat <<-EOF
+keychain: "/Users/jheiss/Library/Keychains/login.keychain"
+class: "genp"
+attributes:
+    0x00000007 <blob>="service"
+    0x00000008 <blob>=<NULL>
+    "acct"<blob>="username"
+    "cdat"<timedate>=0x32303133313132303233353532395A00  "20131120235529Z\000"
+    "crtr"<uint32>=<NULL>
+    "cusi"<sint32>=<NULL>
+    "desc"<blob>=<NULL>
+    "gena"<blob>=<NULL>
+    "icmt"<blob>=<NULL>
+    "invi"<sint32>=<NULL>
+    "mdat"<timedate>=0x32303133313132313232353534395A00  "20131121225549Z\000"
+    "nega"<sint32>=<NULL>
+    "prot"<blob>=<NULL>
+    "scrp"<sint32>=<NULL>
+    "svce"<blob>="service"
+    "type"<uint32>=<NULL>
+EOF
+
+printf "password has been deleted.\n" >&2

data/test/testcmds/macosx/security-find

@@ -0,0 +1,26 @@
+#!/bin/sh
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+cat <<-EOF
+keychain: "/Users/example/Library/Keychains/login.keychain"
+class: "genp"
+attributes:
+    0x00000007 <blob>="service"
+    0x00000008 <blob>=<NULL>
+    "acct"<blob>="username"
+    "cdat"<timedate>=0x32303133313132303233353532395A00  "20131120235529Z\000"
+    "crtr"<uint32>=<NULL>
+    "cusi"<sint32>=<NULL>
+    "desc"<blob>=<NULL>
+    "gena"<blob>=<NULL>
+    "icmt"<blob>=<NULL>
+    "invi"<sint32>=<NULL>
+    "mdat"<timedate>=0x32303133313132313132343834315A00  "20131121124841Z\000"
+    "nega"<sint32>=<NULL>
+    "prot"<blob>=<NULL>
+    "scrp"<sint32>=<NULL>
+    "svce"<blob>="service"
+    "type"<uint32>=<NULL>
+EOF
+printf "password: \"password\"\n" >&2

data/test/testcmds/macosx/security-findempty

@@ -0,0 +1,26 @@
+#!/bin/sh
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+cat <<-EOF
+keychain: "/Users/example/Library/Keychains/login.keychain"
+class: "genp"
+attributes:
+    0x00000007 <blob>="service"
+    0x00000008 <blob>=<NULL>
+    "acct"<blob>="emptyuser"
+    "cdat"<timedate>=0x32303133313132303233353532395A00  "20131120235529Z\000"
+    "crtr"<uint32>=<NULL>
+    "cusi"<sint32>=<NULL>
+    "desc"<blob>=<NULL>
+    "gena"<blob>=<NULL>
+    "icmt"<blob>=<NULL>
+    "invi"<sint32>=<NULL>
+    "mdat"<timedate>=0x32303133313132313132343834315A00  "20131121124841Z\000"
+    "nega"<sint32>=<NULL>
+    "prot"<blob>=<NULL>
+    "scrp"<sint32>=<NULL>
+    "svce"<blob>="service"
+    "type"<uint32>=<NULL>
+EOF
+printf "password: \n" >&2

data/test/testcmds/macosx/security-findhex

@@ -0,0 +1,26 @@
+#!/bin/sh
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+cat <<-EOF
+keychain: "/Users/example/Library/Keychains/login.keychain"
+class: "genp"
+attributes:
+    0x00000007 <blob>="service"
+    0x00000008 <blob>=<NULL>
+    "acct"<blob>="hexuser"
+    "cdat"<timedate>=0x32303133313132303233353532395A00  "20131120235529Z\000"
+    "crtr"<uint32>=<NULL>
+    "cusi"<sint32>=<NULL>
+    "desc"<blob>=<NULL>
+    "gena"<blob>=<NULL>
+    "icmt"<blob>=<NULL>
+    "invi"<sint32>=<NULL>
+    "mdat"<timedate>=0x32303133313132313132343834315A00  "20131121124841Z\000"
+    "nega"<sint32>=<NULL>
+    "prot"<blob>=<NULL>
+    "scrp"<sint32>=<NULL>
+    "svce"<blob>="service"
+    "type"<uint32>=<NULL>
+EOF
+printf "password: 0x08300831083008310830083108300831  \"\0100\0101\0100\0101\0100\0101\0100\0101\"\n" >&2