An easy RubyMotion gem for utilizing secure storage
Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
lib
resources
spec
.gitignore
Gemfile
README.md
Rakefile
license
motion-keychain.gemspec

README.md

motion-keychain

Gem Version

Securely store data in RubyMotion.

The motion-keychain gem is a simple wrapper for Keychain on iOS and OS X. Makes using Keychain APIs as easy as NSUserDefaults.

Installation

Add this line to your application's Gemfile:

gem 'motion-keychain'

And then execute:

$ bundle

Or install it yourself as:

$ gem install motion-keychain

Usage

Store secure data:

  # Storing securely under key 'password'
  MotionKeychain.set('password', @password.text)

Retrieve secure data:

  # Retrieving 'password' content from keychain
  @password.text = MotionKeychain.get('password')

Wipe secure data:

  # User is logging out
  MotionKeychain.remove('password')

Keychain access groups

If you want the new keychain item to be shared among multiple applications, (i.e. include the kSecAttrAccessGroup key in the attributes dictionary), the value of your key must be the name of a keychain access group to which all of the programs that will share this item belong.

This area needs more field-testing but for RubyMotion this means setting the entitlements in your Rakefile. E.G.

  app.identifier = 'com.apple.myapp'
  app.seed_id = '659823F3DC53'
  app.entitlements['keychain-access-groups'] = [app.seed_id + '.' + app.identifier]

TODO

  • Remove cocoapod dependency and move to pure RubyMotion implementation. (v0.1.0)

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