rkeychain 0.1.0

data/CHANGELOG

@@ -0,0 +1,5 @@
+= CHANGELOG
+
+== Version 0.1.0
+
+Initial release.

data/INSTALL

@@ -0,0 +1,6 @@
+= Installation
+
+ # gem install rkeychain
+
+
+

data/LICENSE

@@ -0,0 +1,25 @@
+= License
+
+ Copyright (c) 2007, Oliver Lohmann
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+     * Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+     * Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+     * The names of its contributors may be used to endorse or promote products
+       derived from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY OLIVER LOHMANN ``AS IS'' AND ANY
+ EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL OLIVER LOHMANN BE LIABLE FOR ANY
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,7 @@
+= rkeychain 
+
+rkeychain provides access to MacOS X' keychain facilities which are part of the 
+security framework.
+
+== Author
+Oliver Lohmann (olohmann@gmail.com)

data/Rakefile

@@ -0,0 +1,61 @@
+require "rake/rdoctask"
+require "rake/testtask"
+require "rake/gempackagetask"
+
+require "rubygems"
+
+dir     = File.dirname(__FILE__)
+ext     = File.join(dir, "ext", "rkeychain.bundle")
+doc_extra_files = ["README", "INSTALL", "TODO", 
+                   "CHANGELOG", "LICENSE", "ext/rkeychain.c"]
+version = File.read("VERSION").chomp
+
+task :default => [:clean, :rdoc, :package]
+
+desc "Clean up project directory"
+task :clean do
+  rm_rf "doc"
+  rm_rf "pkg"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files = doc_extra_files
+  rdoc.main     = "README"
+  rdoc.rdoc_dir = "doc/html"
+  rdoc.title    = "Keychain Documentation"
+end
+
+spec = Gem::Specification.new do |spec|
+  spec.name     = "rkeychain"
+  spec.version  = version
+  spec.platform = Gem::Platform::RUBY
+  spec.summary  = "rkeychain provides access to MacOS X' keychain facilities."
+  spec.files    = Rake::FileList.new(["**/*"]) do |fl|
+    fl.exclude(".svn")
+    fl.exclude("doc")
+    fl.exclude("pkg")
+    fl.exclude("*.log")
+  end
+
+  spec.has_rdoc         =  true
+  spec.extra_rdoc_files =  doc_extra_files
+  spec.rdoc_options     << '--title' << 'Keychain Documentation' <<
+                           '--main'  << 'README'
+
+  spec.require_path      << "ext"
+  spec.extensions        = "ext/extconf.rb"
+
+  spec.author            = "Oliver Lohmann"
+  spec.email             = "olohmann@gmail.com"
+  spec.rubyforge_project = "rkeychain"
+  spec.homepage          = "http://rkeychain.rubyforge.org"
+  spec.description       = <<END_DESC
+rkeychain provides access to MacOS X' keychain facilities which are part of the 
+security framework.
+END_DESC
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/TODO

@@ -0,0 +1,3 @@
+= TODO
+
+* Support the full functionality of the Security Framework regarding keychain access. (Overview: http://developer.apple.com/documentation/Security/Reference/keychainservices/index.html#//apple_ref/doc/uid/TP30000898)

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/example/example.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+require "rkeychain"
+
+# lookup the password of the user's gmail account (if it is stored in
+# the standard "login" keychain.
+# Use it for accessing gcalendar, gmail or whatever...
+passwd = Keychain.lookup_internet_passwd({"serverName" =>"mail.google.com"})
+puts "Your passwd@mail.google.com is: #{passwd}"

data/ext/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+
+$CFLAGS += " -isysroot /Developer/SDKs/MacOSX10.4u.sdk"
+$LDFLAGS += " -framework CoreFoundation -framework Security -framework CoreServices -isysroot /Developer/SDKs/MacOSX10.4u.sdk "
+
+create_makefile("rkeychain")

data/ext/rkeychain.c

@@ -0,0 +1,179 @@
+#include <CoreFoundation/CoreFoundation.h>
+#include <Security/Security.h>
+#include <CoreServices/CoreServices.h>
+
+#include <ruby.h>
+
+static VALUE __s_generic_passwd(VALUE self, 
+                                VALUE keychain, 
+                                VALUE serviceName, 
+                                VALUE accontName)
+{
+	VALUE str;
+	
+	OSStatus status;
+	UInt32 passwordLength;
+	void *passwordData;
+	SecKeychainItemRef itemRef = nil;
+	SecKeychainRef s_keychain = NULL;
+	
+	if (keychain != Qnil) {
+		if (TYPE(keychain) != T_STRING) {
+			rb_raise(rb_eTypeError, "string value required");
+		}
+		
+		status = SecKeychainOpen(RSTRING(keychain)->ptr, &s_keychain);
+		if (status != noErr) {
+			return Qnil;
+		}
+	}
+
+	status = SecKeychainFindGenericPassword(s_keychain, 
+				RSTRING(serviceName)->len, RSTRING(serviceName)->ptr, 
+				RSTRING(accontName)->len, RSTRING(accontName)->ptr, 
+				&passwordLength, &passwordData, NULL);
+				
+	if (status == noErr) {
+		str = rb_str_new2(passwordData);
+		SecKeychainItemFreeContent(NULL, passwordData);
+	}
+	else {
+		str = Qnil;
+	}
+	
+	if (s_keychain != NULL) {
+		CFRelease(s_keychain);
+	}
+	
+	return str;
+}
+
+/*
+ * On success the lookup returns the *first* password string which
+ * matches the specified query else it returns nil. 
+ * Unless you granted the application permanent access to a keychain, 
+ * a dialog window will appear, asking for permission to read 
+ * the password information from it.
+ *
+ * A hash with following key/values is accepted (a serviceName OR an accountName is mandatory):
+ *  "keychain" => <path to keychain> (default: login.keychain)
+ *  "serviceName" => <service name string> (default: "")
+ *  "accountName" => <account name string> (default: "")
+ */
+static VALUE s_lookup_generic_passwd(VALUE self, VALUE hash)
+{
+	VALUE keychain = rb_hash_aref(hash, rb_str_new2("keychain"));
+	VALUE serviceName = rb_hash_aref(hash, rb_str_new2("serviceName"));
+	VALUE accountName = rb_hash_aref(hash, rb_str_new2("accountName"));
+
+	serviceName = serviceName == Qnil ? rb_str_new2("") : serviceName;
+	accountName = accountName == Qnil ? rb_str_new2("") : accountName;
+
+	if (TYPE(accountName) != T_STRING) {
+		rb_raise(rb_eTypeError, "string value required");
+	}
+	
+	if (TYPE(serviceName) != T_STRING) {
+		rb_raise(rb_eTypeError, "string value required");
+	}
+	
+
+	return __s_generic_passwd(self, keychain, serviceName, accountName);
+}
+
+
+static VALUE __s_internet_passwd(VALUE self, VALUE keychain, VALUE serverName, VALUE accountName)
+
+{
+	VALUE str;
+	
+	OSStatus status;
+	UInt32 passwordLength;
+	void *passwordData;
+	SecKeychainItemRef itemRef = nil;
+	SecKeychainRef s_keychain = NULL;
+	
+	if (keychain != Qnil) {
+		if (TYPE(keychain) != T_STRING) {
+			rb_raise(rb_eTypeError, "string value required");
+		}
+		
+		status = SecKeychainOpen(RSTRING(keychain)->ptr, &s_keychain);
+		if (status != noErr) {
+			return Qnil;
+		}
+	}
+	
+	status = SecKeychainFindInternetPassword(s_keychain, 
+				RSTRING(serverName)->len, RSTRING(serverName)->ptr, 
+				0, NULL, /* security domain */
+				RSTRING(accountName)->len, RSTRING(accountName)->ptr, 
+				0, NULL, /* path */
+				0, /* port */
+				0, /* protocol */
+				kSecAuthenticationTypeDefault, /* auth type */
+				&passwordLength, &passwordData, NULL);
+		
+		
+	if (status == noErr) {
+		str = rb_str_new2(passwordData);
+		SecKeychainItemFreeContent(NULL, passwordData);
+	}
+	else {
+		str = Qnil;
+	}
+	
+	if (s_keychain != NULL) {
+		CFRelease(s_keychain);
+	}
+
+	return str;
+
+	
+}
+
+/*
+ * On success the lookup returns the *first* password string which
+ * matches the specified query else it returns nil.
+ * Unless you granted the application permanent access to a keychain, 
+ * a dialog window will appear, asking for permission to read 
+ * the password information from it.
+ *
+ * A hash with following key/values is accepted (a serverName OR an accountName is mandatory):
+ *  "keychain" => <path to keychain> (default: login.keychain)
+ *  "serverName" => <service name string> (default: "")
+ *  "accountName" => <account name string> (default: "")
+ */
+static VALUE s_lookup_internet_passwd(VALUE self, VALUE hash)
+{
+	VALUE str;
+	
+	VALUE keychain = rb_hash_aref(hash, rb_str_new2("keychain"));
+	VALUE serverName = rb_hash_aref(hash, rb_str_new2("serverName"));
+	VALUE accountName = rb_hash_aref(hash, rb_str_new2("accountName"));
+
+	serverName = serverName == Qnil ? rb_str_new2("") : serverName;
+	accountName = accountName == Qnil ? rb_str_new2("") : accountName;
+	
+	if (TYPE(accountName) != T_STRING) {
+		rb_raise(rb_eTypeError, "string value required");
+	}
+	
+	if (TYPE(serverName) != T_STRING) {
+		rb_raise(rb_eTypeError, "string value required");
+	}
+	
+	return __s_internet_passwd(self, keychain, serverName, accountName);
+}
+
+/* 
+ * Module: Keychain
+ */
+VALUE cKeychain;
+void Init_rkeychain()
+{
+	cKeychain = rb_define_module("Keychain");
+	rb_define_module_function(cKeychain, "lookup_generic_passwd", s_lookup_generic_passwd, 1);
+	rb_define_module_function(cKeychain, "lookup_internet_passwd", s_lookup_internet_passwd, 1);	
+}
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.1
+specification_version: 1
+name: rkeychain
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-03-02 00:00:00 +13:00
+summary: rkeychain provides access to MacOS X' keychain facilities.
+require_paths: 
+- libext
+email: olohmann@gmail.com
+homepage: http://rkeychain.rubyforge.org
+rubyforge_project: rkeychain
+description: rkeychain provides access to MacOS X' keychain facilities which are part of the  security framework.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Oliver Lohmann
+files: 
+- CHANGELOG
+- example
+- ext
+- INSTALL
+- LICENSE
+- Rakefile
+- README
+- TODO
+- VERSION
+- example/example.rb
+- ext/extconf.rb
+- ext/rkeychain.c
+test_files: []
+
+rdoc_options: 
+- --title
+- Keychain Documentation
+- --main
+- README
+extra_rdoc_files: 
+- README
+- INSTALL
+- TODO
+- CHANGELOG
+- LICENSE
+- ext/rkeychain.c
+executables: []
+
+extensions: 
+- ext/extconf.rb
+requirements: []
+
+dependencies: []
+