KeyClip
KeyClip is yet another Keychain library written in Swift.
Features
- Multi Types ( String / NSDictionary / NSData )
- Error Handling
- Settings ( kSecAttrAccessGroup / kSecAttrService / kSecAttrAccessible )
- Works fine with release ( Fastest [-O] ) build.
Usage
String
KeyClip.save("access_token", string: "********") // -> Bool
let token = KeyClip.load("access_token") as String?
KeyClip.delete("access_token") // Remove the data
KeyClip.clear() // Remove all the data
KeyClip.exists("access_token") // -> Bool
NSDictionary
Must be compatible to NSJSONSerialization.
Valid JSON elements are Dictionary, Array, String, Number, Boolean and null.
KeyClip.save("account", dictionary: ["name": "aska", "token": "******"]) // -> Bool
let dictionary = KeyClip.load("account") as NSDictionary?
NSData
KeyClip.save("data", data: NSData()) // -> Bool
let data = KeyClip.load("data") as NSData?
Your Class
KeyClip.save("account", dictionary: account.dictionaryValue)
let account = KeyClip.load("account") { (dictionary) -> Account in
return Account(dictionary)
}
class Account {
let name: String
let password: String
init(_ dictionary: NSDictionary) {
self.name = dictionary["name"] as String
self.password = dictionary["password"] as String
}
var dictionaryValue: [String: String] {
return ["name": name, "password": password]
}
}
Error Handling
Return value
let success = KeyClip.save("password", string: "********")
if !success {
// Show Alert "Saving password to keychain failed"
}
Clojure
KeyClip.save("password", string: "********") { error in
let status = error.code // OSStatus
// Show Alert "Saving failed \(error.localizedDescription)(\(error.code))"
}
Debug print
KeyClip.printError(true)
Settings
let clip = KeyClip.Builder()
// kSecAttrService
.service(NSBundle.mainBundle().bundleIdentifier) // default
// kSecAttrAccessible
.accessible(kSecAttrAccessibleAfterFirstUnlock) // default
// kSecAttrAccessGroup
.accessGroup("XXXX23F3DC53.com.example.share") // default is nil
.build()
Note to accessGroup
How to check the App Identifier
Entitlement.plist's keychain-access-groups or App Identifier.
KeyClip.defaultAccessGroup() // -> String (eg. XXXX23F3DC53.*)
Requirements
- iOS 8.0+ / Mac OS X 10.10+
- Xcode 8
Installation
Carthage
Add the following line to your Cartfile
github "s-aska/KeyClip"
CocoaPods
Add the following line to your Podfile
use_frameworks!
pod 'KeyClip'
License
KeyClip is released under the MIT license. See LICENSE for details.
1.5k Dec 30, 2022
2.9k Dec 21, 2022
0 Jan 13, 2022
7.2k Dec 30, 2022
56 Oct 25, 2022
2.3k Dec 28, 2022
56 Dec 29, 2022
5.4k Dec 29, 2022
0 Nov 27, 2021
2 Mar 29, 2022
472 Dec 12, 2022
162 Dec 15, 2022
679 Nov 26, 2022
203 Dec 6, 2022
183 Oct 15, 2022
607 Sep 18, 2022
246 Jan 4, 2023
45 Dec 17, 2022