SwiftyKeychainKit
SwiftyKeychainKit is a simple Swift wrapper for Keychain Services API with the benefits of static typing. Define your keys in one place, use value types easily, and get extra safety and convenient compile-time checks for free.
Features
- Static typing and compile-time checks
- Support Gereric and Internet passwords
- Throwing and Result type get methods
- Easy way to implement support for custom types
Usage
Basic
let keychain = Keychain(service: "com.swifty.keychain")
let accessTokenKey = KeychainKey<String>(key: "accessToken")
// Save or modify value
try? keychain.save("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9", for : accessTokenKey)
// Get value
let value = try keychain.get(accessTokenKey)
// Remove value
try keychain.remove(accessTokenKey)
// Remove all values
try keychain.removeAll()
Instantiation
// Generic password
let keychain = Keychain(service: "com.swifty.keychainkit")
// Internet password
let keychain = Keychain(server: URL(string: "https://www.google.com")!, protocolType: .https)
Define keys
For extra convenience, define your keys by extending KeychainKeys class and adding static properties:
extension KeychainKeys {
static let username = KeychainKey<String>(key: "username")
static let age = KeychainKey<Int>(key: "age")
}
and later in the code use shortcut dot syntax:
// save
try? keychain.save("John Snow", for: .username)
// get
let username = try keychain.get(.username)
Geting values
You can use subscripts and dynamicCallable syntax sugar to get value as Result<ValueType, KeychainError>
let username = try keychain[.username].get()
// or
if case .success(let age) = keychain[.age] {
...
}
let username = try keychain(.username).get()
// or
if case .success(let age) = keychain(.age) {
...
}
Both subscripts and dynamicCallable syntaxt available only for geting values. Currently Swift language limitation do not allow implement setter with error handling.
Default values
You can provide default value for get method and it will used than keychain key is nil and no error throw.
try keychain.get(.username, default: "Daenerys Targaryen")
// or
try keychain[.age, default: 18].get()
Supported types
- Int
- String
- Double
- Float
- Bool
- Data
Codable
struct MyStruct: Codable, KeychainSerializable { ... }
NSCoding
class MyClass: NSObject, NSCoding, KeychainSerializable { ... }
Custom types
In order to save/get your own custom type that we don't support, you need to confirm it KeychainSerializable and implement KeychainBridge for this type.
As an example saving Array<String> using JSONSerialization:
extension Array: KeychainSerializable where Element == String {
public static var bridge: KeychainBridge<[String]> { return KeychainBridgeStringArray() }
}
class KeychainBridgeStringArray: KeychainBridge<[String]> {
public override func set(_ value: [String], forKey key: String, in keychain: Keychain) throws {
guard let data = try? JSONSerialization.data(withJSONObject: value, options: []) else {
fatalError()
}
try? persist(value: data, key: key, keychain: keychain)
}
public override func get(key: String, from keychain: Keychain) throws -> [String]? {
guard let data = try? find(key: key, keychain: keychain) else {
return nil
}
return (try? JSONSerialization.jsonObject(with: data, options: [])) as? [String]
}
}
Supported attributes
Common
- kSecAttrAccessGroup
- kSecAttrAccessible
- kSecAttrDescription
- kSecAttrComment
- kSecAttrCreator
- kSecAttrType
- kSecAttrLabel
- kSecAttrIsInvisible
- kSecAttrIsNegative
- kSecAttrAccount
- kSecAttrSynchronizable
Generic password
- kSecAttrAccessControl
- kSecAttrService
- kSecAttrGeneric
Internet password
- kSecAttrSecurityDomain
- kSecAttrServer
- kSecAttrProtocol
- kSecAttrAuthenticationType
- kSecAttrPort
- kSecAttrPath
Requirement
Swift version 5.0
| Platform | Availability |
|---|---|
| iOS | >= 8.0 |
| macOS | - |
| tvOS | - |
| watchOS | - |
Installation
CocoaPods
pod 'SwiftyKeychainKit', '1.0.0-beta.2'
Swift Package Manager
let package = Package(
dependencies: [
.Package(url: "https://github.com/andriyslyusar/SwiftyKeychainKit.git", .exact("1.0.0-beta.2"))
]
)
Carthage
github "andriyslyusar/SwiftyKeychainKit" "1.0.0-beta.2"
Acknowledgement
- SwiftyUserDefaults - API design inspiration
- KeychainAccess - API wrapper knowledge source
Author
Andriy Slyusar
License
SwiftyKeychainKit is available under the MIT license. See the LICENSE file for more info.
0 Dec 31, 2021
1.2k Dec 28, 2022
15 Nov 11, 2022
1.3k Dec 26, 2022
0 Mar 14, 2022
3.1k Dec 28, 2022
14 Jan 1, 2023
152 Dec 12, 2022
3.8k Jan 4, 2023
377 Dec 1, 2022
12 Aug 5, 2022
117 Nov 15, 2022
14 Jul 28, 2022
663 Dec 6, 2022
33 Dec 8, 2022
217 Dec 27, 2022
56 Oct 25, 2022
3.1k Dec 28, 2022
14 Jan 1, 2023
3.8k Jan 4, 2023
1.5k Jan 8, 2023
71 Oct 15, 2022
5.4k Jan 8, 2023
2.9k Dec 21, 2022
9 Sep 12, 2022