Air Native Extension for iOS – Keychain

This is an Air native extension to read and write to the device’s keychain.

This extension enables reading data from and writing data to the iOS device’s keychain. This extension stores data as strings.

Version

This is version 0.5 of this extension.

Binary files

The bin folder contains the compiled extension and the default swc, which can be used for local testing if required by your development environment (Flash Builder shouldn’t need it, but other IDEs may).

Building

Requirements – Adobe Air SDK 3.1 or later, XCode IDE

• Add the FlashRuntimeExtensions.h file from the Adobe Air sdk to the ios/KeychainIosExtension folder in the project.
• Create a copy of the build/example.build.config file in the build folder, calling it build.config and change the properties in this file to match your system.
  • A certificate is required by the build script. This may be a self-signed certificate created by Adobe Air. This should not be an Apple developer certificate.
• Run the ant build script build.xml. This creates the native extension and default swc file inside the bin folder.

The test project

A simple test project is included for testing the extension. To build this air project

• Set the access groups in the KeychainExtensionTest-app.xml file.
• Set the test access group in the KeychainExtensionTest.as file.
• Create a copy of the build/example.build.config file in the build folder, calling it build.config and change the properties in this file to match your system.
• Run the ant build script test/build.xml. This creates the test ipa inside the test/bin folder.

Using the extension

To store a value in the keychain -

Keychain.insertOrUpdate( key : String, value : String, accessGroup : String = null ) : int

If the key already exists in the keychain, the value will be set to the new value. If the key doesn’t exist, the key will be created and the value set.

The return value is an integer indicating success (KeychainErrors.success) or failure (any other value, see the KeychainErrors class for the possible errors).

If accessGroup is not specified then the first accessGroup in your app’s entitlements is used, or the default accessGroup if none are specified.

To store a value in the keychain only if it doesn’t exist already -

Keychain.insert( key : String, value : String, accessGroup : String = null ) : int

If the key already exists in the keychain, the insert will fail and the value for that key will not be altered.

The return value is an integer indicating success (KeychainErrors.success) or failure (any other value, see the KeychainErrors class for the possible errors).

If accessGroup is not specified then the first accessGroup in your app’s entitlements is used, or the default accessGroup if none are specified.

To update a value in the keychain only if it does exist already -

Keychain.update( key : String, value : String, accessGroup : String = null ) : int

If the key already exists in the keychain, the value is updated. If the key does not already exist, the update fails.

The return value is an integer indicating success (KeychainErrors.success) or failure (any other value, see the KeychainErrors class for the possible errors).

If accessGroup is not specified then the first accessGroup in your app’s entitlements is used, or the default accessGroup if none are specified.

To retrieve a value from the keychain -

Keychain.get( key : String, accessGroup : String = null ) : String

The return value is the value corresponding to the key in the keychain. If the key does not exist in the keychain, the returned value is null.

If accessGroup is not specified then all accessGroups in your app’s entitlements are checked until a value is found.

To delete a value from the keychain -

Keychain.remove( key : String, accessGroup : String = null ) : int

The return value is an integer indicating success (KeychainErrors.success) or failure (any other value, see the KeychainErrors class for the possible errors).

If accessGroup is not specified then the value is deleted from all accessGroups in your app’s entitlements.

Example code

You can see the feature in action in the source code of the test project.

Compiling your project

This is an Air 3.1 extension. Specify the path to the iPhone SDK when compiling the project, using the functionality built in to your IDE or the platformsdk parameter if building with adt from the command line or a build script.

Developers

• Stick Sports

License

Air Native Extension for iOS Keychain
……………………………….

Author: Richard Lord
Owner: Stick Sports Ltd.
http://www.sticksports.com

Copyright © 2011, Stick Sports Ltd.
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.
• Neither the name of Stick Sports Ltd. nor 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS “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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.