keyring 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f67fb1efea2eb2eaa09bacafab9ef4e75fba84cd
-  data.tar.gz: 1a19d3f9507d0e606f08b0e60c9710d2e677432a
+  metadata.gz: ce4f04bde155cc548222940ab51bf72adc2e6357
+  data.tar.gz: 050a04df00a9229f8125081a79f99f7e2b5c5a05
 SHA512:
-  metadata.gz: 73ef48738d5a0193754a983abbce3d5d666ea619fe4d25044d0dfe7350ef4667847aa7085fe35c9bbc4dc6a777b4fb1f77f1c6296ec8bbde108e991f553056cb
-  data.tar.gz: af4063ca11ba35150b2a8697aa58a468e8fe86d773a94d2d8c4486eb2710980e886265b5acd9a9e20a41edc590b3432c08a91f37055d1b82506d176e1039d493
+  metadata.gz: 85f263a69ac38e96fca4ccba27afda79097d0f226e0fe93938c0fddfb5b703a507e995d3ba065ddc5daf7302083963033f715bfe91205cac2bead32fa0601aec
+  data.tar.gz: b4d625b3e639b98c9a8afed3a06c59ffd324271b7377f85da8593c284fdce8997788095ea9e57fab46fcae388dd344341debc82c138afad95487185277b6370c

data/README.md

@@ -6,14 +6,15 @@ This library provides a easy way to access the system keyring service from ruby.
 It can be used in any application that needs safe password storage.
 
 The keyring services supported by this library:
-* Mac OS X Keychain: the Apple Keychain service in Mac OS X.
+* Mac OS X Keychain: the Apple Keychain service in Mac OS X
+* GNOME 2 Keyring
 * In-memory keychain
 
 Additional keyring services we'd like to support:
 * KDE KWallet
-* GNOME 2 Keyring
-* SecretServiceKeyring: for newer GNOME and KDE environments.
+* SecretServiceKeyring: for newer GNOME and KDE environments
 * Windows Credential Manager
+* Windows Credential Manager, aka Windows Vault
 
 ## Installation
 
@@ -42,9 +43,20 @@ Keyring#get_password:
 
 'service' is an arbitrary string identifying your application.
 
+By default keyring will attempt to pick the best backend supported on your system.  You can specify a particular backend:
+
+    require 'keyring'
+    keyring = Keyring.new(Keyring::Backend::Memory.new)
+
+## Platform notes
+
+Gnome Keyring uses the [GirFFI](https://github.com/mvz/gir_ffi) bindings, which
+requires the introspection bindings to be installed (as well as gnome-keyring).
+`apt-get install gnome-keyring libgirepository1.0-dev` for Debian/Ubuntu.
+
 ## Credits
 
-Copyright 2013, Jason Heiss
+Copyright 2013-2014, Jason Heiss, wvengen
 
 Inspired by the keyring library for Python:
 https://bitbucket.org/kang/python-keyring-lib

data/keyring.gemspec

@@ -25,4 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'mocha'
   spec.add_dependency 'slop'
+
+  if RUBY_PLATFORM =~ /linux/
+    spec.add_dependency 'gir_ffi-gnome_keyring', '~> 0.0.3'
+  end
 end

data/lib/keyring/backend.rb

@@ -15,7 +15,7 @@ class Keyring::Backend
     if supported.empty?
       raise(NotImplementedError)
     end
-    supported.max{|b| b.priority}
+    supported.max{|a, b| a.priority <=> b.priority }
   end
   
   #

data/lib/keyring/backends/gnome_keyring.rb

@@ -0,0 +1,64 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+# This is a keyring backend for the Gnome Keyring
+# https://wiki.gnome.org/GnomeKeyring
+# http://en.wikipedia.org/wiki/GNOME_Keyring
+
+class Keyring::Backend::GnomeKeyring < Keyring::Backend
+  register_implementation(self)
+
+  def initialize
+    require 'gir_ffi-gnome_keyring'
+  rescue LoadError
+  end
+  def supported?
+    defined?(::GnomeKeyring) && true
+  end
+  def priority
+    1
+  end
+
+  def set_password(service, username, password)
+    attrs = get_attrs_for(service, username)
+    name = "#{service} (#{username})"
+    status, item_id = ::GnomeKeyring.item_create_sync nil, :generic_secret, name, attrs, password, true
+    item_id if status == :ok
+  end
+  def get_password(service, username)
+    if item = find_first(service, username)
+      item.secret
+    else
+      false
+    end
+  end
+  def delete_password(service, username)
+    if item = find_first(service, username)
+      status, info = ::GnomeKeyring.item_delete_sync nil, item.item_id
+      status == :ok
+    else
+      false
+    end
+  end
+
+  protected
+
+  def find_first(service, username)
+    if list = find(service, username)
+      list.first
+    end
+  end
+
+  def find(service, username)
+    attrs = get_attrs_for(service, username)
+    status, keys = ::GnomeKeyring.find_items_sync :generic_secret, attrs
+    keys if status == :ok
+  end
+
+  def get_attrs_for(service, username)
+    attrs = ::GnomeKeyring::AttributeList.new
+    attrs.append_string 'service', service.to_s
+    attrs.append_string 'username', username.to_s
+    attrs
+  end
+end

data/lib/keyring/backends/macosx_keychain.rb

@@ -4,6 +4,10 @@
 # This is a keyring backend for the Apple Keychain
 # http://en.wikipedia.org/wiki/Keychain_(Apple)
 
+# Consider switching to ruby-keychain gem to avoid password in command line
+# https://rubygems.org/gems/ruby-keychain
+# https://github.com/fcheung/keychain
+
 require 'open3'
 
 class Keyring::Backend::MacosxKeychain < Keyring::Backend

data/lib/keyring/version.rb

@@ -2,5 +2,5 @@
 # License: MIT (http://www.opensource.org/licenses/mit-license.php)
 
 class Keyring
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/test_backend.rb

@@ -8,18 +8,35 @@ class KeyringBackendTests < Test::Unit::TestCase
   def setup
     @backend = Keyring::Backend.new
   end
-  
+
   class Keyring::Backend::Test < Keyring::Backend; end
+  class BackendHighPriority < Keyring::Backend
+    def priority; 100 end
+    def supported?; true end
+  end
+  class BackendLowPriority < Keyring::Backend
+    def priority; 10 end
+    def supported?; true end
+  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
+
+    # check that backend with highest priority is selected
+    Keyring::Backend.register_implementation(BackendHighPriority)
+    Keyring::Backend.register_implementation(BackendLowPriority)
+    assert_kind_of BackendHighPriority, Keyring::Backend.create
+    Keyring::Backend.implementations.delete(BackendLowPriority)
+    Keyring::Backend.implementations.delete(BackendHighPriority)
   end
-  
+
   def test_supported
     refute @backend.supported?
   end

data/test/test_backend_gnome_keyring.rb

@@ -0,0 +1,56 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+# These tests require Gnome Keyring to be installed and are skipped otherwise
+
+require 'test/unit'
+require 'mocha/setup'
+require 'keyring'
+
+begin
+  require 'gir_ffi-gnome_keyring'
+
+  class KeyringBackendGnomeKeyringTests < Test::Unit::TestCase
+
+    def setup
+      @backend = Keyring::Backend::GnomeKeyring.new
+      @backend.delete_password('service', 'username')
+    end
+
+    def teardown
+      @backend.delete_password('service', 'username')
+    end
+
+    def test_supported
+      assert @backend.supported?
+    end
+
+    def test_priority
+      assert_equal 1, @backend.priority
+    end
+
+    def test_no_default_password
+      refute @backend.get_password('service', 'username')
+    end
+
+    def test_set_password
+      @backend.set_password('service', 'username', 'password')
+      assert_equal 'password', @backend.get_password('service', 'username')
+    end
+
+    def test_delete_nonexistent_password
+      refute @backend.delete_password('service', 'username')
+    end
+
+    def test_delete_existing_password
+      @backend.set_password('service', 'username', 'password')
+      @backend.delete_password('service', 'username')
+      refute @backend.get_password('service', 'username')
+    end
+
+  end
+
+
+rescue LoadError
+  puts "Skipping GnomeKeyring tests because the native bindings could not be loaded."
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keyring
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason Heiss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,12 +84,14 @@ files:
 - keyring.gemspec
 - lib/keyring.rb
 - lib/keyring/backend.rb
+- lib/keyring/backends/gnome_keyring.rb
 - lib/keyring/backends/macosx_keychain.rb
 - lib/keyring/backends/memory.rb
 - lib/keyring/cli.rb
 - lib/keyring/version.rb
 - test/keyring_tests.rb
 - test/test_backend.rb
+- test/test_backend_gnome_keyring.rb
 - test/test_backend_macosx_keychain.rb
 - test/test_backend_memory.rb
 - test/test_cli.rb
@@ -124,13 +126,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Store and access your passwords safely
 test_files:
 - test/keyring_tests.rb
 - test/test_backend.rb
+- test/test_backend_gnome_keyring.rb
 - test/test_backend_macosx_keychain.rb
 - test/test_backend_memory.rb
 - test/test_cli.rb
@@ -145,3 +148,4 @@ test_files:
 - test/testcmds/macosx/security-notfound
 - test/testcmds/macosx/security-righthelp
 - test/testcmds/macosx/security-wronghelp
+has_rdoc: