ruby-keychain 0.1.0 → 0.1.1

data/{README → README.markdown}

@@ -1,5 +1,17 @@
+# @markup markdown
+
 A set of ruby bindings for the OS X keychain, written using ffi
 
+Installation
+============
+
+    gem install ruby-keychain
+
+or in your gemfile,
+
+    gem 'ruby-keychain', :require => 'keychain'
+
+
 Introduction
 ============
 
@@ -13,12 +25,12 @@ Most operations will act on either the default keychain, or the default keychain
 
     Keychain.default #the default keychain, usually /Users/<username>/Library/Keychains/<username>.keychain
     Keychain.open(path) #opens a keychain file
-    Keychain.create(path, password) #creates a new keychain at the specified path
-
+    Keychain.create(path, password) # creates a new keychain at the specified path, with the specified password
+                                    # omit the password to make the keychain prompt the user
 
 
 Searching for Keychain Items
-=========
+=============================
 
 The top level constant `Keychain` as well as individual keychain objects have two methods `internet_passwords` and `generic_passwords` that return scope like objects. You can do
 

data/lib/keychain.rb

@@ -14,17 +14,22 @@ module Keychain
     # See https://developer.apple.com/library/mac/documentation/security/Reference/keychainservices/Reference/reference.html#//apple_ref/c/func/SecKeychainCreate
     # @param [String] path The path to the keychain file to create
     #   If it is not absolute it is interpreted relative to ~/Library/Keychains
-    # @param [String] password The password to use for the keychain
+    # @param [optional, String] password The password to use for the keychain. if not supplied, the user will be prompted for a password
     # @return [Keychain::Keychain] a keychain object representing the newly created keychain
 
-    def create(path, password)
-      password = password.encode(Encoding::UTF_8)
+    def create(path, password=nil)
       path = path.encode(Encoding::UTF_8)
-
       out_buffer = FFI::MemoryPointer.new(:pointer)
-      status = Sec.SecKeychainCreate(path, password.bytesize, FFI::MemoryPointer.from_string(password), 0,
+
+      if password
+        password = password.encode(Encoding::UTF_8)
+        status = Sec.SecKeychainCreate(path, password.bytesize, FFI::MemoryPointer.from_string(password), 0,
                                           nil, out_buffer)
 
+      else
+        status = Sec.SecKeychainCreate(path, 0, nil, 1, nil, out_buffer)
+      end
+
       Sec.check_osstatus(status)
       Keychain.new(out_buffer.read_pointer).release_on_gc
     end
@@ -68,5 +73,26 @@ module Keychain
     def generic_passwords
       Scope.new(Sec::Classes::GENERIC)
     end
+
+    # sets whether user interaction is allowed
+    # If false then operations that would require user interaction (for example prompting the user for a password to unlock a keychain)
+    # will raise InteractionNotAllowedError
+    # @param [Boolean] value
+    def user_interaction_allowed= value
+      status = Sec.SecKeychainSetUserInteractionAllowed( value ? 1 : 0)
+      Sec.check_osstatus(status)
+      value
+    end
+
+    # Returns whether user interaction is allowed
+    # If false then operations that would require user interaction (for example prompting the user for a password to unlock a keychain)
+    # will raise InteractionNotAllowedError
+    # @return  whether interaction is allowed
+    def user_interaction_allowed?
+      out_buffer = FFI::MemoryPointer.new(:uchar)
+      status = Sec.SecKeychainGetUserInteractionAllowed(out_buffer)
+      Sec.check_osstatus(status)
+      out_buffer.read_uchar.nonzero?
+    end
   end
 end

data/lib/keychain/error.rb

@@ -31,4 +31,7 @@ class Keychain::AuthFailedError < Keychain::Error; end
 class Keychain::UserCancelledError < Keychain::Error; end
 # Raised when an action fails because the underlying keychain
 # does not exist
-class Keychain::NoSuchKeychainError < Keychain::Error; end
+class Keychain::NoSuchKeychainError < Keychain::Error; end
+# Raised when an action would rewuire user interaction but user interaction
+# is not allowed. See Keychain.user_interaction_allowed=
+class Keychain::InteractionNotAllowedError < Keychain::Error; end

data/lib/keychain/keychain.rb

@@ -24,6 +24,9 @@ module Sec
 
   attach_function 'SecKeychainGetStatus', [:keychainref, :pointer], :osstatus
 
+  attach_function 'SecKeychainSetUserInteractionAllowed', [:uchar], :osstatus
+
+  attach_function 'SecKeychainGetUserInteractionAllowed', [:pointer], :osstatus
   enum :keychainStatus, [
     :kSecUnlockStateStatus, 1,
     :kSecReadPermStatus,    2,

data/lib/keychain/scope.rb

@@ -5,7 +5,7 @@ class Keychain::Scope
   def initialize(kind, keychain=nil)
     @kind = kind
     @limit = nil
-    @keychains = [keychain]
+    @keychains = [keychain].compact
     @conditions = {}
   end
 

data/lib/keychain/sec.rb

@@ -11,7 +11,8 @@ module Sec
       :errSecDuplicateItem, -25299,
       :errSecAuthFailed, -25293,
       :errSecNoSuchKeychain, -25294,
-      :errCancelled, -128
+      :errCancelled, -128,
+      :errSecInteractionNotAllowed, -25308
   ]
 
   attach_variable 'kSecClassInternetPassword', :pointer
@@ -155,6 +156,8 @@ module Sec
         raise Keychain::AuthFailedError.new(result)
       when Sec.enum_value(:errSecNoSuchKeychain)
         raise Keychain::NoSuchKeychainError.new(result)
+      when Sec.enum_value(:errSecInteractionNotAllowed)
+        raise Keychain::InteractionNotAllowedError.new(result)
       else
         raise Keychain::Error.new(result)
       end

data/lib/keychain/version.rb

@@ -1,4 +1,4 @@
 module Keychain
   # The current version string
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/keychain_spec.rb

@@ -1,6 +1,20 @@
 require 'spec_helper'
 
 describe Keychain do
+
+  describe 'user interaction' do
+    it 'should be true by default' do
+      Keychain.user_interaction_allowed?.should be_true
+    end
+
+    it 'should be changeable' do
+      Keychain.user_interaction_allowed = false
+      Keychain.user_interaction_allowed?.should be_false
+      Keychain.user_interaction_allowed = true
+      Keychain.user_interaction_allowed?.should be_true
+    end
+  end
+
   describe 'default' do
     it "should return the login keychain" do
       Keychain.default.path.should == File.expand_path(File.join(ENV['HOME'], 'Library','Keychains', 'login.keychain'))
@@ -14,7 +28,7 @@ describe Keychain do
     end
   end
 
-  describe 'new' do
+  describe 'create' do
     it 'should create the keychain' do
       begin
         keychain = Keychain.create(File.join(Dir.tmpdir, "other_keychain_spec_#{Time.now.to_i}_#{Time.now.usec}_#{rand(1000)}.keychain"),
@@ -24,6 +38,14 @@ describe Keychain do
        keychain.delete
       end
     end
+
+    context 'no password supplied' do
+      #we have to stub this out as it would trigger a dialog box prompting for a password
+      it 'should create a keychain by prompting the user' do
+        Sec.should_receive('SecKeychainCreate').with('akeychain', 0, nil, 1, nil,kind_of(FFI::Pointer)).and_return(0)
+        Keychain.create('akeychain')
+      end
+    end
   end
 
   describe 'exists?' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-keychain
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-03 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -124,7 +124,7 @@ files:
 - spec/keychain_item_spec.rb
 - spec/keychain_spec.rb
 - spec/spec_helper.rb
-- README
+- README.markdown
 - LICENSE
 homepage: http://github.com/fcheung/keychain
 licenses: