Latest 0.1.2
Homepage https://github.com/rauhul/Keychain
License MIT
Platforms ios 10.0, requires ARC
Frameworks Foundation

Keychain

A simple inteferace for using the iOS Keychain, written in Swift. Heavily based on the work done by Jason Rendel in SwiftKeychainWrapper.

Provides singleton instance Keychain.default that is setup to work for most needs.

If you need to customize the keychain access to use a custom identifier or access group, you can create your own instance instead of using the provided singleton.

By default, the Keychain saves data as a Generic Password type in the iOS Keychain. It saves items such that they can only be accessed when the app is unlocked and open. If you are not familiar with the iOS Keychain usage, this provides a safe default for using the keycain.

Users that want to deviate from this default implementation can specifiy keychain accessibility for each request (store, retrieve, etc…) to a Keychain instance.

General Usage

Store a string value to keychain:

let saveSuccessful = Keychain.default.store("exampleValue", forKey: "exampleKey")

Retrieve a string value from keychain:

let retrievedString = Keychain.default.retrieve(String.self, forKey: "exampleKey")

Delete a string value from keychain:

let removeSuccessful = Keychain.default.removeObject(forKey: "exampleKey")

Custom Instance

When the Keychain Wrapper is used, all keys are linked to a common identifier for your app, called the service name. By default this uses your main bundle identifier. However, you may also change it, or store multiple items to the keycahin under different identifiers.

To share keychain items between your applications, you may specify an access group and use that same access group in each application.

To set a custom service name identifier or access group, you may create your own keychain instance as follows:

let uniqueServiceName = "customServiceName"
let uniqueAccessGroup = "sharedAccessGroupName"
let customKeychainInstance = Keychain(serviceName: uniqueServiceName, accessGroup: uniqueAccessGroup)

The custom instance can then be used in place of the provided instance:

let saveSuccessful = customKeychainInstance.store("exampleValue", forKey: "exampleKey")
let retrievedString = customKeychainInstance.retrieve(String.self, forKey: "exampleKey")
let removeSuccessful = customKeychainInstance.removeObject(forKey: "exampleKey")

Accessibility Options

By default, all items saved to keychain can only be accessed when the device is unlocked. To change this accessibility, an optional "withAccessibility" param can be set on all requests. The enum Keychain.Accessibilty provides an easy way to select the accessibility level desired:

Keychain.default.store(<KeychainStorable>, forKey: "exampleKey", withAccessibility: .afterFirstUnlock)

Installation

CocoaPods

You can use CocoaPods to install SwiftKeychainAccess by adding it to your Podfile:

use_frameworks!
platform :ios, '10.0'

target 'target_name' do
   pod 'SwiftKeychainAccess'
end

To use the keychain in your app, import Keychain into the file(s) where you want to use it.

import Keychain

Manually

Download and drop Keychain.swift and KeychainStorable.swift into your project.

Latest podspec

{
    "name": "SwiftKeychainAccess",
    "version": "0.1.2",
    "summary": "Keychain Access in Swift made easy",
    "description": "A Pod for easily integrating keychain access into your iOS Project",
    "homepage": "https://github.com/rauhul/Keychain",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": "rauhul",
    "platforms": {
        "ios": "10.0"
    },
    "source": {
        "git": "https://github.com/rauhul/Keychain.git",
        "tag": "0.1.2"
    },
    "source_files": "Keychain/*.{swift}",
    "frameworks": "Foundation",
    "requires_arc": true,
    "pushed_with_swift_version": "3.0"
}

Pin It on Pinterest

Share This