Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/evgenyneu/keychain-swift

Helper functions for saving text in Keychain securely for iOS, OS X, tvOS and watchOS.
https://github.com/evgenyneu/keychain-swift

ios keychain swift

Last synced: 25 days ago
JSON representation

Helper functions for saving text in Keychain securely for iOS, OS X, tvOS and watchOS.

Awesome Lists containing this project

README 

        
# Helper functions for storing text in Keychain for iOS, macOS, tvOS and WatchOS



[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![CocoaPods Version](https://img.shields.io/cocoapods/v/KeychainSwift.svg?style=flat)](http://cocoadocs.org/docsets/KeychainSwift)

[![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

[![License](https://img.shields.io/cocoapods/l/KeychainSwift.svg?style=flat)](http://cocoadocs.org/docsets/KeychainSwift)

[![Platform](https://img.shields.io/cocoapods/p/KeychainSwift.svg?style=flat)](http://cocoadocs.org/docsets/KeychainSwift)



This is a collection of helper functions for saving text and data in the Keychain.

 As you probably noticed Apple's keychain API is a bit verbose. This library was designed to provide shorter syntax for accomplishing a simple task: reading/writing text values for specified keys:



 ```Swift

let keychain = KeychainSwift()

keychain.set("hello world", forKey: "my key")

keychain.get("my key")

 ```



The Keychain library includes the following features:



 * Get, set and delete string, boolean and Data Keychain items

 * Specify item access security level

 * Synchronize items through iCloud

 * Share Keychain items with other apps



## What's Keychain?



Keychain is a secure storage. You can store all kind of sensitive data in it: user passwords, credit card numbers, secret tokens etc. Once stored in Keychain this information is only available to your app, other apps can't see it. Besides that, operating system makes sure this information is kept and processed securely. For example, text stored in Keychain can not be extracted from iPhone backup or from its file system. Apple recommends storing only small amount of data in the Keychain. If you need to secure something big you can encrypt it manually, save to a file and store the key in the Keychain.



## Setup



There are four ways you can add KeychainSwift to your project.



#### Add source (iOS 7+)



Simply add [KeychainSwiftDistrib.swift](https://github.com/evgenyneu/keychain-swift/blob/master/Distrib/KeychainSwiftDistrib.swift) file into your Xcode project.



#### Setup with Carthage (iOS 8+)



Alternatively, add `github "evgenyneu/keychain-swift" ~> 24.0` to your Cartfile and run `carthage update`.



#### Setup with CocoaPods (iOS 8+)



If you are using CocoaPods add this text to your Podfile and run `pod install`.



```

use_frameworks!

target 'Your target name'

pod 'KeychainSwift', '~> 24.0'

```



#### Setup with Swift Package Manager (in project)



* In Xcode select *File > Add Packages*.

* Enter this project's URL: https://github.com/evgenyneu/keychain-swift.git



#### Setup with Swift Package Manager (in Swift Package)



If you're using KeychainSwift in a Swift package, make sure to specify a `name`. This is because SPM cannot automatically resolve a name for a package that has a different Target name in its `Package.swift` (namely `KeychainSwift`) that differs from the repo link (`keychain-swift`).



```

.package(name: "KeychainSwift", url: "https://github.com/evgenyneu/keychain-swift.git", from: "24.0.0")

```



## Legacy Swift versions



Setup a [previous version](https://github.com/evgenyneu/keychain-swift/wiki/Legacy-Swift-versions) of the library if you use an older version of Swift.



## Usage



Add `import KeychainSwift` to your source code unless you used the file setup method.



#### String values



```Swift

let keychain = KeychainSwift()

keychain.set("hello world", forKey: "my key")

keychain.get("my key")

```



#### Boolean values



```Swift

let keychain = KeychainSwift()

keychain.set(true, forKey: "my key")

keychain.getBool("my key")

```



#### Data values



```Swift

let keychain = KeychainSwift()

keychain.set(dataObject, forKey: "my key")

keychain.getData("my key")

```



#### Removing keys from Keychain



```Swift

keychain.delete("my key") // Remove single key

keychain.clear() // Delete everything from app's Keychain. Does not work on macOS.

```



#### Return all keys



```Swift

let keychain = KeychainSwift()

keychain.allKeys // Returns the names of all keys

```



## Advanced options



Keychain item access



Use `withAccess` parameter to specify the security level of the keychain storage.

By default the `.accessibleWhenUnlocked` option is used. It is one of the most restrictive options and provides good data protection.



```

let keychain = KeychainSwift()

keychain.set("Hello world", forKey: "key 1", withAccess: .accessibleWhenUnlocked)

```



You can use `.accessibleAfterFirstUnlock` if you need your app to access the keychain item while in the background. Note that it is less secure than the `.accessibleWhenUnlocked` option.



See the list of all available [access options](https://github.com/evgenyneu/keychain-swift/blob/master/Sources/KeychainSwiftAccessOptions.swift).



Synchronizing keychain items with other devices



Set `synchronizable` property to `true` to enable keychain items synchronization across user's multiple devices. The synchronization will work for users who have the "Keychain" enabled in the iCloud settings on their devices.



Setting `synchronizable` property to `true` will add the item to other devices with the `set` method and obtain synchronizable items with the `get` command. Deleting a synchronizable item will remove it from all devices.



Note that you do NOT need to enable iCloud or Keychain Sharing capabilities in your app's target for this feature to work.



```Swift

// First device

let keychain = KeychainSwift()

keychain.synchronizable = true

keychain.set("hello world", forKey: "my key")



// Second device

let keychain = KeychainSwift()

keychain.synchronizable = true

keychain.get("my key") // Returns "hello world"

```



We could not get the Keychain synchronization work on macOS.



Sharing keychain items with other apps



In order to share keychain items between apps on the same device they need to have common *Keychain Groups* registered in *Capabilities > Keychain Sharing* settings. [This tutorial](http://evgenii.com/blog/sharing-keychain-in-ios/) shows how to set it up.



Use `accessGroup` property to access shared keychain items. In the following example we specify an access group "CS671JRA62.com.myapp.KeychainGroup" that will be used to set, get and delete an item "my key".



```Swift

let keychain = KeychainSwift()

keychain.accessGroup = "CS671JRA62.com.myapp.KeychainGroup" // Use your own access goup



keychain.set("hello world", forKey: "my key")

keychain.get("my key")

keychain.delete("my key")

keychain.clear()

```



*Note*: there is no way of sharing a keychain item between the watchOS 2.0 and its paired device: https://forums.developer.apple.com/thread/5938



### Setting key prefix



One can pass a `keyPrefix` argument when initializing a `KeychainSwift` object. The string passed in `keyPrefix` argument will be used as a prefix to **all the keys** used in `set`, `get`, `getData` and `delete` methods. Adding a prefix to the keychain keys can be useful in unit tests. This prevents the tests from changing the Keychain keys that are used when the app is launched manually.



Note that `clear` method still clears everything from the Keychain regardless of the prefix used.



```Swift

let keychain = KeychainSwift(keyPrefix: "myTestKey_")

keychain.set("hello world", forKey: "hello")

// Value will be stored under "myTestKey_hello" key

```



### Check if operation was successful



One can verify if `set`, `delete` and `clear` methods finished successfully by checking their return values. Those methods return `true` on success and `false` on error.



```Swift

if keychain.set("hello world", forKey: "my key") {

  // Keychain item is saved successfully

} else {

  // Report error

}

```



To get a specific failure reason use the `lastResultCode` property containing result code for the last operation. See [Keychain Result Codes](https://developer.apple.com/documentation/security/1542001-security_framework_result_codes).



```Swift

keychain.set("hello world", forKey: "my key")

if keychain.lastResultCode != noErr { /* Report error */ }

```



### Returning data as reference



Use the `asReference: true` parameter to return the data as reference, which is needed for  [NEVPNProtocol](https://developer.apple.com/documentation/networkextension/nevpnprotocol).



```Swift

let keychain = KeychainSwift()

keychain.set(dataObject, forKey: "my key")

keychain.getData("my key", asReference: true)

```



## Using KeychainSwift from Objective-C



[This manual](https://github.com/evgenyneu/keychain-swift/wiki/Using-KeychainSwift-in-Objective-C-project) describes how to use KeychainSwift in Objective-C apps.



## ❗️Known critical issue - call to action❗️



It [has been reported](https://github.com/evgenyneu/keychain-swift/issues/15) that the library sometimes returns `nil`  instead of the stored Keychain value. It may be connected with [the Keychain issue](https://forums.developer.apple.com/thread/4743) reported on Apple developer forums. The issue is random and hard to reproduce. If you experienced this problem feel free to create an issue and share your story, so we can find solutions.



## Video tutorial



Thanks to Alex Nagy from [rebeloper.com](https://rebeloper.com/) for creating this two-part [video tutorial](https://www.youtube.com/watch?v=1R-VIzjD4yo&list=PL_csAAO9PQ8bLfPF7JsnF-t4q63WKZ9O9).



Keychain Swift video tutorial



## Demo app



Keychain Swift demo app



## Alternative solutions



Here are some other Keychain libraries.



* [DanielTomlinson/Latch](https://github.com/DanielTomlinson/Latch)

* [jrendel/SwiftKeychainWrapper](https://github.com/jrendel/SwiftKeychainWrapper)

* [kishikawakatsumi/KeychainAccess](https://github.com/kishikawakatsumi/KeychainAccess)

* [matthewpalmer/Locksmith](https://github.com/matthewpalmer/Locksmith)

* [s-aska/KeyClip](https://github.com/s-aska/KeyClip)

* [yankodimitrov/SwiftKeychain](https://github.com/yankodimitrov/SwiftKeychain)



## Thanks 👍



* The code is based on this example: [https://gist.github.com/s-aska/e7ad24175fb7b04f78e7](https://gist.github.com/s-aska/e7ad24175fb7b04f78e7)

* Thanks to [diogoguimaraes](https://github.com/diogoguimaraes) for adding Swift Package Manager setup option.

* Thanks to [glyuck](https://github.com/glyuck) for taming booleans.

* Thanks to [pepibumur](https://github.com/pepibumur) for adding macOS, watchOS and tvOS support.

* Thanks to [ezura](https://github.com/ezura) for iOS 7 support.

* Thanks to [mikaoj](https://github.com/mikaoj) for adding keychain synchronization.

* Thanks to [tcirwin](https://github.com/tcirwin) for adding Swift 3.0 support.

* Thanks to [Tulleb](https://github.com/Tulleb) for adding Xcode 8 beta 6 support.

* Thanks to [CraigSiemens](https://github.com/CraigSiemens) for adding Swift 3.1 support.

* Thanks to [maxkramerbcgdv](https://github.com/maxkramerbcgdv) for fixing Package Manager setup in Xcode 8.2.

* Thanks to [elikohen](https://github.com/elikohen) for fixing concurrency issues.

* Thanks to [beny](https://github.com/beny) for adding Swift 4.2 support.

* Thanks to [xuaninbox](https://github.com/xuaninbox) for fixing watchOS deployment target for Xcode 10.

* Thanks to [schayes04](https://github.com/schayes04) for adding Swift 5.0 support.

* Thanks to [mediym41](https://github.com/mediym41) for adding ability to return data as reference.

* Thanks to [AnthonyOliveri](https://github.com/AnthonyOliveri) for adding ability to run unit tests from Swift Package Manager.

* Thanks to [philippec](https://github.com/philippec) for removing deprecated access options.

* Thanks to [lucasmpaim](https://github.com/lucasmpaim) for adding ability to return the names of all keys.



## Feedback is welcome



If you notice any issue, got stuck or just want to chat feel free to create an issue. We will be happy to help you.



## License



Keychain Swift is released under the [MIT License](LICENSE).