mac-keychain 0.0.1

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Li Xiao, iam@li-xiao.com
+
+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/Manifest

@@ -0,0 +1,7 @@
+MIT-LICENSE.txt
+Manifest
+README.rdoc
+Rakefile
+ext/bridgesupport/rakefile
+lib/mac_keychain.rb
+test/test_mac_keychain.rb

data/README.rdoc

@@ -0,0 +1,33 @@
+= Mac-Keychain -- Ruby interface to Mac OSX Keychain
+
+== SYNOPSIS
+
+  @keychain = MacKeychain.new('AppName')
+  @keychain.save('account name', 'password')
+  ....
+  @keychain.delete('account name')
+
+== Install
+
+gem install mac-keychain
+
+== Limitation
+
+It only works on Mac, and need RubyCocoa.
+
+= Other stuff
+
+Author: Li Xiao <iam@li-xiao.com>
+
+Requires: Ruby 1.8.6 or later
+
+License: Copyright 2010 by Li Xiao.
+         Released under an MIT-LICENSE.  See the MIT-LICENSE.txt file
+         included in the distribution.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/Rakefile

@@ -0,0 +1,22 @@
+
+require 'rubygems'
+require 'echoe'
+
+Echoe.new('mac-keychain', '0.0.1') do |p|
+  p.description     = "Mac-Keychain -- Ruby interface to Mac OSX Keychain"
+  p.url             = "https://github.com/xli/mac-keychain"
+  p.author          = "Li Xiao"
+  p.email           = "iam@li-xiao.com"
+  p.ignore_pattern  = ["*.gemspec", 'lib/Security.bridgesupport']
+  p.development_dependencies = ['rake', 'echoe']
+  p.test_pattern    = "test/test_*.rb"
+  p.rdoc_options    = %w(--main README.rdoc --inline-source --line-numbers --charset UTF-8)
+  p.extension_pattern = "ext/**/rakefile"
+end
+
+namespace :generate do
+  task :bridge do
+    puts "generating lib/Security.bridgesupport"
+    puts %x[gen_bridge_metadata -f Security -o lib/Security.bridgesupport]
+  end
+end

data/ext/bridgesupport/rakefile

@@ -0,0 +1,5 @@
+
+task :default do
+  cmd = "gen_bridge_metadata -f Security -o #{File.join(ENV['RUBYLIBDIR'], 'Security.bridgesupport')}"
+  puts %x[#{cmd}]
+end

data/lib/mac_keychain.rb

@@ -0,0 +1,81 @@
+require 'osx/cocoa'
+OSX.require_framework 'Security'
+OSX.load_bridge_support_file(File.join(File.dirname(__FILE__), 'Security.bridgesupport'))
+
+class MacKeychain
+  include OSX
+
+  # A Key is an existing item in Keychain, contains item reference and password
+  class Key
+    def self.create(data)
+      password_length = data.shift
+      password_data = data.shift #password data
+      item = data.shift #SecKeychainItemRef
+      password = if password_data
+        password_data.bytestr(password_length)
+      end
+      self.new(item, password)
+    end
+
+    attr_reader :item, :password
+
+    # :item     => Keychain item
+    # :password => password of item
+    def initialize(item, password)
+      @item = item
+      @password = password
+    end
+  end
+
+  # :service => Name of keychain item, Application name or service name
+  def initialize(service)
+    @service = service
+  end
+
+  # Find Key by username (Account of Keychain item)
+  def find(username)
+    status, *data = SecKeychainFindGenericPassword(nil, @service.length, @service, username.length, username)
+    case status
+    when ErrSecItemNotFound
+      nil
+    when 0
+      Key.create(data)
+    else
+      raise "Error when accessing Keychain looking for key: #{username} of #{@service}"
+    end
+  end
+
+  # Create Keychain item with username (Account of Keychain item) and password
+  # Returns creation status code, please see Keychain Services Result Codes.
+  def create(username, password)
+    SecKeychainAddGenericPassword(nil, @service.length, @service, username.length, username, password.length, password, nil)
+  end
+
+  # Delete Keychain item by username (Account of Keychain item)
+  # Raises error when delete failed
+  def delete(username)
+    if key = find(username)
+      unless SecKeychainItemDelete(key.item) == 0
+        raise "Could not delete Keychain item by #{username} of #{@service}"
+      end
+    end
+  end
+
+  # Update Keychain item by username with new password
+  # Returns update status code, please see Keychain Services Result Codes.
+  def update(username, password)
+    key = self.find(username)
+    SecKeychainItemModifyContent(key.item, nil, password.length, password)
+  end
+
+  # Create Keychain item if it does not exist, otherwise update it.
+  # Returns creation/update status code, please see Keychain Services Result Codes.
+  def save(username, password)
+    code = create(username, password)
+    if ErrSecDuplicateItem == code
+      update(username, password)
+    else
+      code
+    end
+  end
+end

data/mac-keychain.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mac-keychain}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Li Xiao"]
+  s.date = %q{2010-06-15}
+  s.description = %q{Mac-Keychain -- Ruby interface to Mac OSX Keychain}
+  s.email = %q{iam@li-xiao.com}
+  s.extensions = ["ext/bridgesupport/rakefile"]
+  s.extra_rdoc_files = ["README.rdoc", "ext/bridgesupport/rakefile", "lib/mac_keychain.rb"]
+  s.files = ["MIT-LICENSE.txt", "Manifest", "README.rdoc", "Rakefile", "ext/bridgesupport/rakefile", "lib/mac_keychain.rb", "test/test_mac_keychain.rb", "mac-keychain.gemspec"]
+  s.homepage = %q{https://github.com/xli/mac-keychain}
+  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers", "--charset", "UTF-8"]
+  s.require_paths = ["lib", "ext"]
+  s.rubyforge_project = %q{mac-keychain}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Mac-Keychain -- Ruby interface to Mac OSX Keychain}
+  s.test_files = ["test/test_mac_keychain.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/test/test_mac_keychain.rb

@@ -0,0 +1,37 @@
+require "test/unit"
+
+require "mac_keychain"
+
+class TestMacKeychain < Test::Unit::TestCase
+  def setup
+    @keychain = MacKeychain.new('TestKeychain')
+    @username = 'username'
+  end
+
+  def teardown
+    @keychain.delete(@username)
+  end
+
+  def test_delete
+    @keychain.create(@username, 'password')
+    @keychain.delete(@username)
+    assert_nil @keychain.find(@username)
+  end
+
+  def test_store
+    @keychain.create(@username, 'password')
+    assert_equal 'password', @keychain.find(@username).password
+  end
+
+  def test_find
+    assert_nil @keychain.find(@username)
+    @keychain.create(@username, 'password')
+    assert @keychain.find(@username)
+  end
+
+  def test_should_update_password_when_save_new_password
+    @keychain.save(@username, 'password')
+    @keychain.save(@username, 'new password')
+    assert_equal 'new password', @keychain.find(@username).password
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: mac-keychain
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Li Xiao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Mac-Keychain -- Ruby interface to Mac OSX Keychain
+email: iam@li-xiao.com
+executables: []
+
+extensions: 
+- ext/bridgesupport/rakefile
+extra_rdoc_files: 
+- README.rdoc
+- ext/bridgesupport/rakefile
+- lib/mac_keychain.rb
+files: 
+- MIT-LICENSE.txt
+- Manifest
+- README.rdoc
+- Rakefile
+- ext/bridgesupport/rakefile
+- lib/mac_keychain.rb
+- test/test_mac_keychain.rb
+- mac-keychain.gemspec
+has_rdoc: true
+homepage: https://github.com/xli/mac-keychain
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --line-numbers
+- --charset
+- UTF-8
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: mac-keychain
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Mac-Keychain -- Ruby interface to Mac OSX Keychain
+test_files: 
+- test/test_mac_keychain.rb