keyring 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f67fb1efea2eb2eaa09bacafab9ef4e75fba84cd
+  data.tar.gz: 1a19d3f9507d0e606f08b0e60c9710d2e677432a
+SHA512:
+  metadata.gz: 73ef48738d5a0193754a983abbce3d5d666ea619fe4d25044d0dfe7350ef4667847aa7085fe35c9bbc4dc6a777b4fb1f77f1c6296ec8bbde108e991f553056cb
+  data.tar.gz: af4063ca11ba35150b2a8697aa58a468e8fe86d773a94d2d8c4486eb2710980e886265b5acd9a9e20a41edc590b3432c08a91f37055d1b82506d176e1039d493

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keyring.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jason Heiss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,70 +1,62 @@
-keyring
-===========
-
-A simple framework for storing passwords in certain keyring systems.
-This gem is heavily inspired by python-keyring.
-
-Examples
---------
-
-The simplest case is to use a single global keyring instance:
-
-    require "keyring"
-    Keyring.set_password("service", "user", "password")
-    Keyring.get_password("service", "user") == "password"
-    
-This instance parses ./.rbkeyringrc and ~/.rbkeyringrc (in that order)
-for a valid configuration. The configuration determines the default
-module to use along with some parameters, e.g., the following
-configuration uses the kwallet module (available as keyring-kwallet
-gem):
-
-    ---
-    module: keyring-kwallet
-    params: 
-       folder: myfolder
-       app: myapp
-       
-Alternatively you can create instances of your favourite keyring module:
-
-   simple = Keyring::SimpleKeyring.new
-   kwallet = Keyring::KWalletKeyring.new folder: "myfolder", app: "myapp"
-   simple.set_password("service", "user", kwallet.get_password("service", "user"))
-   
-The concrete parameters depend on the backend type.
-
-Install
--------
-
-gem install keyring
-
-Author
-------
-
-Original author: Frank Fischer
-
-License
--------
-
-(The MIT License) FIXME (different license?)
-
-Copyright (c) 2011 FIXME (author's name)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# Keyring
+
+Store and access your passwords safely
+
+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.
+* In-memory keychain
+
+Additional keyring services we'd like to support:
+* KDE KWallet
+* GNOME 2 Keyring
+* SecretServiceKeyring: for newer GNOME and KDE environments.
+* Windows Credential Manager
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keyring'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyring
+
+## Usage
+
+The basic usage of keyring is simple: just call Keyring#set_password and
+Keyring#get_password:
+
+    require 'keyring'
+    keyring = Keyring.new
+    keyring.set_password('service', 'username', 'password')
+    password = keyring.get_password('service', 'username')
+    keyring.delete_password('service', 'username')
+
+'service' is an arbitrary string identifying your application.
+
+## Credits
+
+Copyright 2013, Jason Heiss
+
+Inspired by the keyring library for Python:
+https://bitbucket.org/kang/python-keyring-lib
+
+## License
+
+MIT
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,17 +1,12 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
 
-begin
-    require 'bones'
-rescue LoadError
-    abort '### Please install the "bones" gem ###'
-end
-
-task :default => 'spec:run'
-task 'gem:release' => 'spec:run'
-
-Bones {
-    name     'keyring'
-    authors  'Frank Fischer'
-    email    'frank.fischer@mathematik.tu-chemnitz.de'
-    url      'http://darcsden.com/lyro/keyring'
-}
+require "bundler/gem_tasks"
+require 'rake/testtask'
 
+# Run a specific file:  rake test TEST=test/make.rb
+# Run a specific method:
+#   rake test TEST=test/test_make.rb TESTOPTS="--name=test_make_osarch_names"
+Rake::TestTask.new do |t|
+  t.verbose = true
+end

data/bin/keyring

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+# When run from the source repository or from an unpacked copy of the
+# distribution we want to find the local library, even if there's a copy
+# installed on the system.
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'keyring/cli'
+
+Keyring::CLI.new.main

data/keyring.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keyring/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyring"
+  spec.version       = Keyring::VERSION
+  spec.authors       = ["Jason Heiss"]
+  spec.email         = ["jheiss@aput.net"]
+  spec.description   = %q{This library provides a easy way to access the system keyring service from ruby}
+  spec.summary       = %q{Store and access your passwords safely}
+  spec.homepage      = "https://github.com/jheiss/keyring"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'mocha'
+  spec.add_dependency 'slop'
+end

data/lib/keyring.rb

@@ -1,15 +1,24 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
 
-module Keyring
-
-    # :stopdoc:
-    LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
-    PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-    VERSION = ::File.read(PATH + 'version.txt').strip
-
-    %w(Keyring.rb SimpleKeyring.rb).each do |fname|
-        require File.join(LIBPATH, "keyring", fname)
-    end
-
-end  # module Keyring
-
+require "keyring/version"
 
+class Keyring
+  require 'keyring/backend'
+  
+  # If you want a particular backend then use, for example,
+  # Keyring.new(Keyring::Backend::Memory.new)
+  def initialize(backend=nil)
+    @backend = backend || Keyring::Backend.create
+  end
+  
+  def get_password(service, username)
+    @backend.get_password(service, username)
+  end
+  def set_password(service, username, password)
+    @backend.set_password(service, username, password)
+  end
+  def delete_password(service, username)
+    @backend.delete_password(service, username)
+  end
+end

data/lib/keyring/backend.rb

@@ -0,0 +1,42 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+class Keyring::Backend
+  @implementations = []
+  class << self
+    attr_accessor :implementations
+  end
+  def self.register_implementation(impl)
+    Keyring::Backend.implementations << impl
+  end
+  Dir.glob(File.expand_path('backends/*.rb', File.dirname(__FILE__))).each {|b| require b}
+  def self.create
+    supported = implementations.collect{|i| b = i.new; b.supported? ? b : nil}.compact
+    if supported.empty?
+      raise(NotImplementedError)
+    end
+    supported.max{|b| b.priority}
+  end
+  
+  #
+  # Backend classes must implement these methods
+  #
+  
+  def supported?
+    false
+  end
+  # Returns a number between 0 and 1 (inclusive) indicating the relative
+  # preference for this backend.
+  def priority
+    0
+  end
+  def set_password(service, username, password)
+    raise NotImplementedError
+  end
+  def get_password(service, username)
+    raise NotImplementedError
+  end
+  def delete_password(service, username)
+    raise NotImplementedError
+  end
+end

data/lib/keyring/backends/macosx_keychain.rb

@@ -0,0 +1,91 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+# This is a keyring backend for the Apple Keychain
+# http://en.wikipedia.org/wiki/Keychain_(Apple)
+
+require 'open3'
+
+class Keyring::Backend::MacosxKeychain < Keyring::Backend
+  register_implementation(self)
+  
+  attr_accessor :security
+  def initialize
+    @security = '/usr/bin/security'
+  end
+  def supported?
+    File.exist?(@security) && `#{@security} -h`.include?('find-generic-password')
+  end
+  def priority
+    1
+  end
+  
+  def security_command(operation)
+    "#{operation}-generic-password"
+  end
+  
+  def set_password(service, username, password)
+    cmd = [
+      @security,
+      security_command('add'),
+      '-s', service,
+      '-a', username,
+      # FIXME: password in command line, sad panda!
+      '-w', password,
+      '-U',
+    ]
+    system(*cmd)
+    if !$?.success?
+      raise
+    end
+  end
+  def get_password(service, username)
+    password = nil
+    cmd = [
+      @security,
+      security_command('find'),
+      '-s', service,
+      '-a', username,
+      '-g',
+      # '-w',
+    ]
+    Open3.popen3(*cmd) do |stdin, stdout, stderr, wait_thr|
+      stderr.each do |line|
+        if line =~ /\Apassword: (.*)/
+          pw = $1
+          if pw == ''
+            password = pw
+          elsif pw =~ /\A"(.*)"\z/
+            password = $1
+          elsif pw =~ /\A0x(\h+)/
+            password = [$1].pack("H*")
+          end
+        end
+      end
+      # security exits with 44 if the entry does not exist.  We just want to return
+      # nil rather than raise an exception in that case.
+      if ![0,44].include?(wait_thr.value.exitstatus)
+        raise
+      end
+    end
+    password
+  end
+  def delete_password(service, username)
+    cmd = [
+      @security,
+      security_command('delete'),
+      '-s', service,
+      '-a', username,
+    ]
+    Open3.popen3(*cmd) do |stdin, stdout, stderr, wait_thr|
+      case wait_thr.value.exitstatus
+      when 0
+        return true
+      when 44
+        return false
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/keyring/backends/memory.rb

@@ -0,0 +1,29 @@
+# keyring:  System keyring abstraction library
+# License: MIT (http://www.opensource.org/licenses/mit-license.php)
+
+# Stores the keyring in-memory. Useful when you don't need permanant storage.
+
+class Keyring::Backend::Memory < Keyring::Backend
+  register_implementation(self)
+  
+  def initialize
+    @keyring = {}
+  end
+  def supported?
+    true
+  end
+  def priority
+    0.1
+  end
+  
+  def get_password(service, username)
+    @keyring[service] && @keyring[service][username]
+  end
+  def set_password(service, username, password)
+    @keyring[service] ||= {}
+    @keyring[service][username] = password
+  end
+  def delete_password(service, username)
+    @keyring[service] && @keyring[service].delete(username)
+  end
+end