ruby-keychain 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c2ee5b2ee12fb40fcc21b22df81639cb35104bf
-  data.tar.gz: c0863f638b7b25276ea88dfabe29ed20be92b72f
+SHA256:
+  metadata.gz: 975d6235851fe0cd963efc71e15fd9d6f0211c02bf915d54ea1cabad53540bab
+  data.tar.gz: 4a224ad5e1b4bd9672f3a52ec9881a13911b3f349971183c53adc72514ae5efd
 SHA512:
-  metadata.gz: 2096c6908718c18c3cb741305e75141519a94f49c3439a98ceee5e780713fff9f684e8ee9962e670953eb848c8a28bfa5bcbe73ce7754d0dd679a96c91b3d6b7
-  data.tar.gz: 3b8f5d1789f5183ce0abac2cdad770b92f8b21ccf01998ce8dba185700e183e1f935053e11a4bae75a60e8541f5fec682f97bcfc8018f21a942bd51d74a30a90
+  metadata.gz: 92c752ba4a0c6927ae5cc5f0c13f88bae3b0844f439a60378e16b9ce61dd7241c30dd82051a9d9715f54c87816af53664a5d3503886a0188411209eb864eaa80
+  data.tar.gz: 250445e3577cb88179ba7033948e576c0ff65950f13bd84c97524da539a71a6e62be7022da2e5c54b3763e71a16bd782662d89b46d54c2a6e6abca931b2be88b

data/README.markdown

@@ -1,16 +1,19 @@
-[![Build Status](https://travis-ci.org/fcheung/keychain.png)](https://travis-ci.org/fcheung/keychain)
+[![Build Status](https://travis-ci.org/fcheung/keychain.svg?branch=master)](https://travis-ci.org/fcheung/keychain)
 
-A set of ruby bindings for the OS X keychain, written using ffi
+A set of ruby bindings for the OS X keychain, written using ffi.
 
 Installation
 ============
 
-    gem install ruby-keychain
+```
+$ gem install ruby-keychain
+```
 
-or in your gemfile,
-
-    gem 'ruby-keychain', :require => 'keychain'
+or in your `Gemfile`:
 
+```ruby
+gem 'ruby-keychain', :require => 'keychain'
+```
 
 Introduction
 ============
@@ -23,26 +26,33 @@ Working with keychains
 
 Most operations will act on either the default keychain, or the default keychain search list. You can obtain specific keychains with
 
-    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, with the specified password
-                                    # omit the password to make the keychain prompt the user
-
+```ruby
+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, 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
 
-    Keychain.internet_passwords.where(:server => 'example.com').all
+```ruby
+Keychain.internet_passwords.where(server: 'example.com').all
+```
 
 to return Keychain::Item objects for that server
 
-    Keychain.internet_passwords.where(:server => 'example.com').first
+```ruby
+Keychain.internet_passwords.where(server: 'example.com').first
+```
 
 to return the first Keychain::Item for that server or
 
-    Keychain.internet_passwords.where(:server => 'example.com').limit(4).all
+```ruby
+Keychain.internet_passwords.where(server: 'example.com').limit(4).all
+```
 
 to return up to 4 Keychain::Item for that server.
 
@@ -50,14 +60,17 @@ to return up to 4 Keychain::Item for that server.
 
 You can restrict the search to a specific keychain with
 
-    some_keychain.internet_passwords.where(:server => 'example.com').all
+```ruby
+some_keychain.internet_passwords.where(server: 'example.com').all
+```
 
 returns matching `Keychain::Item` from the specified keychain.
 
 or to an arbitrary list of keychains with
 
-    Keychain.internet_passwords.in(keychain_1, keychain2).all
-
+```ruby
+Keychain.internet_passwords.in(keychain_1, keychain2).all
+```
 
 Finding a Keychain::Item won't prompt the user for a password if the keychain is unlocked. Calling the password accessor method of the item may prompt the user for their password depending on the keychain item access settings.
 
@@ -69,22 +82,39 @@ Creating keychain items
 
 In the default keychain:
 
-    Keychain.internet_passwords.create(:server => 'example.com', :protocol => Keychain::Protocols::HTTP, :password => 'secret', :account => 'bob')
+```ruby
+Keychain.internet_passwords.create(server: 'example.com', protocol: Keychain::Protocols::HTTP, password: 'secret', account: 'bob')
 
-    or
+# or
 
-    Keychain.generic_passwords.create(:service => 'AWS', :password => 'secret', :account => 'bob')
+Keychain.generic_passwords.create(service: 'AWS', password: 'secret', account: 'bob')
+```
 
 In a specific keychain
 
-    some_keychain.internet_passwords.create(...)
+```ruby
+some_keychain.internet_passwords.create(...)
+```
 
 by default keychain items are only readable by the application that created them, however when running a ruby script the application is ruby: by default other ruby scripts will be able to read the items (if the keychain is unlocked).
 
+Updating keychain items
+=========================
+
+Example:
+```
+Keychain.generic_passwords.create(service: 'AWS', password: 'secret', account: 'bob')
+item = Keychain.generic_passwords.where(service: 'AWS')
+item.password # outputs 'secret'
+item.password = 'better_secret'
+item.save!
+item.password # outputs 'better_secret'
+```
+
 Using keychain items
 =====================
 
-The `Keychain::Item` class has accessors for all its attributes, for the full list of attributes see `Sec::ATTR_MAP`
+The `Keychain::Item` class has accessors for all its attributes, for the full list of attributes see [`Keychain::Item::ATTR_MAP`](https://github.com/fcheung/keychain/blob/master/lib/keychain/item.rb)
 
 All strings returned are utf-8 encoded. Be careful not to set attribute values to strings with the ASCII_8BIT encoding as this will cause them to be treated as raw data rather than string. The exception to this is password data which the keychain api defines as being arbitrary binary data. When storing an actual password it is customary to use utf-8. The password data will always be returned as raw binary data
 
@@ -99,4 +129,3 @@ Compatibility
 =============
 Requires ruby 1.9 due to use of encoding related methods. Should work in MRI and jruby. Not compatible with rubinius due to rubinius' ffi implemenation
 not supporting certain features
-

data/lib/keychain/identity.rb

@@ -37,7 +37,7 @@ module Keychain
       Key.new(key_ref.read_pointer).release_on_gc
     end
 
-    def pkcs12(passphrase='')
+    def pkcs12(passphrase = '')
       flags = Sec::SecItemImportExportKeyParameters.new
       flags[:version] = Sec::SEC_KEY_IMPORT_EXPORT_PARAMS_VERSION
       flags[:passphrase] = CF::String.from_string(passphrase).to_ptr
@@ -47,9 +47,9 @@ module Keychain
       Sec.check_osstatus(status)
 
       data = CF::Data.new(data_ptr.read_pointer)
-      result = OpenSSL::PKCS12.new(data.to_s)
+      result = OpenSSL::PKCS12.new(data.to_s, passphrase)
       data.release
       result
     end
   end
-end
+end

data/lib/keychain/keychain.rb

@@ -136,7 +136,7 @@ module Keychain
       key_params[:accessRef] = access
 
       # Import item to the keychain
-      cf_data = CF::Data.from_string(input).release_on_gc
+      cf_data = CF::Data.from_string(input)
       cf_array = FFI::MemoryPointer.new(:pointer)
       status = Sec.SecItemImport(cf_data, nil, :kSecFormatUnknown, :kSecItemTypeUnknown, :kSecItemPemArmour, key_params, self, cf_array)
       access.release

data/lib/keychain/version.rb

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

data/spec/key_spec.rb

@@ -11,7 +11,7 @@ describe Keychain::Key do
   end
 
   describe 'identify' do
-    it 'should be exportable to a string' do
+    pending 'should be exportable to a string' do
       scope = Keychain::Scope.new(Sec::Classes::KEY)
       key = scope.first
       expect(key.export).to be_kind_of(String)

data/spec/keychain_spec.rb

@@ -17,7 +17,7 @@ describe Keychain do
 
   describe 'default' do
     it "should return the login keychain" do
-      expect(Keychain.default.path).to eq(File.expand_path(File.join(ENV['HOME'], 'Library','Keychains', 'login.keychain')))
+      expect(Keychain.default.path).to eq(File.expand_path(File.join(ENV['HOME'], 'Library','Keychains', 'login.keychain-db')))
     end
   end
 
@@ -45,14 +45,21 @@ describe Keychain do
 
     context 'no password supplied' do
       #we have to stub this out as it would trigger a dialog box prompting for a password
+      let(:result) do
+        instance_double(Keychain::Keychain)
+      end
+
       it 'should create a keychain by prompting the user' do
         #we can't just use a kind_of matcher becaue FFI::Pointer#== raises an exception
         #when compared to non pointer values
-        mock_pointer = double(FFI::MemoryPointer, :read_pointer => 0)
+        mock_pointer = double(FFI::MemoryPointer, :read_pointer => 123456)
         allow(FFI::MemoryPointer).to receive(:new).with(:pointer).and_return(mock_pointer)
 
         expect(Sec).to receive('SecKeychainCreate').with('akeychain', 0, nil, 1, nil,mock_pointer).and_return(0)
-        Keychain.create('akeychain')
+
+        expect(Keychain::Keychain).to receive(:new).with(mock_pointer.read_pointer).and_return(result)
+        expect(result).to receive(:release_on_gc).and_return(result)
+        expect(Keychain.create('akeychain')).to eq(result)
       end
     end
   end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: ruby-keychain
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Frederick Cheung
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-07-09 00:00:00.000000000 Z
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: corefoundation
+  name: og-corefoundation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -64,34 +64,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +138,7 @@ homepage: http://github.com/fcheung/keychain
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,10 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for  OS X's keychain
 test_files: []
-has_rdoc: