-
Notifications
You must be signed in to change notification settings - Fork 345
/
KeychainSwiftDistrib.swift
303 lines (198 loc) · 9.67 KB
/
KeychainSwiftDistrib.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
//
// Keychain helper for iOS/Swift.
//
// https://github.com/exchangegroup/keychain-swift
//
// This file was automatically generated by combining multiple Swift source files.
//
// ----------------------------
//
// KeychainSwift.swift
//
// ----------------------------
import UIKit
import Security
/**
A collection of helper functions for saving text and data in the keychain.
*/
public class KeychainSwift {
static var lastQueryParameters: [String: NSObject]? // Used by unit tests
/**
Stores the text value in the keychain item under the given key.
:param: key Key under which the text value is stored in the keychain.
:param: value Text string to be written to the keychain.
:param: withAccess Value that indicates when your app needs access to the text in the keychain item. By default the .AccessibleWhenUnlocked option is used that permits the data to be accessed only while the device is unlocked by the user.
*/
public class func set(value: String, forKey key: String,
withAccess access: KeychainSwiftAccessOptions? = nil) -> Bool {
if let value = value.dataUsingEncoding(NSUTF8StringEncoding) {
return set(value, forKey: key, withAccess: access)
}
return false
}
/**
Stores the data in the keychain item under the given key.
:param: key Key under which the data is stored in the keychain.
:param: value Data to be written to the keychain.
:param: withAccess Value that indicates when your app needs access to the text in the keychain item. By default the .AccessibleWhenUnlocked option is used that permits the data to be accessed only while the device is unlocked by the user.
:returns: True if the text was successfully written to the keychain.
*/
public class func set(value: NSData, forKey key: String,
withAccess access: KeychainSwiftAccessOptions? = nil) -> Bool {
let accessible = access?.value ?? KeychainSwiftAccessOptions.defaultOption.value
let query = [
KeychainSwiftConstants.klass : KeychainSwiftConstants.classGenericPassword,
KeychainSwiftConstants.attrAccount : key,
KeychainSwiftConstants.valueData : value,
KeychainSwiftConstants.accessible : accessible
]
lastQueryParameters = query
SecItemDelete(query as CFDictionaryRef)
let status: OSStatus = SecItemAdd(query as CFDictionaryRef, nil)
return status == noErr
}
/**
Retrieves the text value from the keychain that corresponds to the given key.
:param: key The key that is used to read the keychain item.
:returns: The text value from the keychain. Returns nil if unable to read the item.
*/
public class func get(key: String) -> String? {
if let data = getData(key),
let currentString = NSString(data: data, encoding: NSUTF8StringEncoding) as? String {
return currentString
}
return nil
}
/**
Retrieves the data from the keychain that corresponds to the given key.
:param: key The key that is used to read the keychain item.
:returns: The text value from the keychain. Returns nil if unable to read the item.
*/
public class func getData(key: String) -> NSData? {
let query = [
KeychainSwiftConstants.klass : kSecClassGenericPassword,
KeychainSwiftConstants.attrAccount : key,
KeychainSwiftConstants.returnData : kCFBooleanTrue,
KeychainSwiftConstants.matchLimit : kSecMatchLimitOne ]
var result: AnyObject?
let status = withUnsafeMutablePointer(&result) {
SecItemCopyMatching(query, UnsafeMutablePointer($0))
}
if status == noErr { return result as? NSData }
return nil
}
/**
Deletes the single keychain item specified by the key.
:param: key The key that is used to delete the keychain item.
:returns: True if the item was successfully deleted.
*/
public class func delete(key: String) -> Bool {
let query = [
KeychainSwiftConstants.klass : kSecClassGenericPassword,
KeychainSwiftConstants.attrAccount : key ]
let status: OSStatus = SecItemDelete(query as CFDictionaryRef)
return status == noErr
}
/**
Deletes all keychain items used by the app.
:returns: True if the keychain items were successfully deleted.
*/
public class func clear() -> Bool {
let query = [ kSecClass as String : kSecClassGenericPassword ]
let status: OSStatus = SecItemDelete(query as CFDictionaryRef)
return status == noErr
}
}
// ----------------------------
//
// KeychainSwiftAccessOptions.swift
//
// ----------------------------
import Security
/**
These options are used to determine when a keychain item should be readable. The default value is AccessibleWhenUnlocked.
*/
public enum KeychainSwiftAccessOptions {
/**
The data in the keychain item can be accessed only while the device is unlocked by the user.
This is recommended for items that need to be accessible only while the application is in the foreground. Items with this attribute migrate to a new device when using encrypted backups.
This is the default value for keychain items added without explicitly setting an accessibility constant.
*/
case AccessibleWhenUnlocked
/**
The data in the keychain item can be accessed only while the device is unlocked by the user.
This is recommended for items that need to be accessible only while the application is in the foreground. Items with this attribute do not migrate to a new device. Thus, after restoring from a backup of a different device, these items will not be present.
*/
case AccessibleWhenUnlockedThisDeviceOnly
/**
The data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user.
After the first unlock, the data remains accessible until the next restart. This is recommended for items that need to be accessed by background applications. Items with this attribute migrate to a new device when using encrypted backups.
*/
case AccessibleAfterFirstUnlock
/**
The data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user.
After the first unlock, the data remains accessible until the next restart. This is recommended for items that need to be accessed by background applications. Items with this attribute do not migrate to a new device. Thus, after restoring from a backup of a different device, these items will not be present.
*/
case AccessibleAfterFirstUnlockThisDeviceOnly
/**
The data in the keychain item can always be accessed regardless of whether the device is locked.
This is not recommended for application use. Items with this attribute migrate to a new device when using encrypted backups.
*/
case AccessibleAlways
/**
The data in the keychain can only be accessed when the device is unlocked. Only available if a passcode is set on the device.
This is recommended for items that only need to be accessible while the application is in the foreground. Items with this attribute never migrate to a new device. After a backup is restored to a new device, these items are missing. No items can be stored in this class on devices without a passcode. Disabling the device passcode causes all items in this class to be deleted.
*/
case AccessibleWhenPasscodeSetThisDeviceOnly
/**
The data in the keychain item can always be accessed regardless of whether the device is locked.
This is not recommended for application use. Items with this attribute do not migrate to a new device. Thus, after restoring from a backup of a different device, these items will not be present.
*/
case AccessibleAlwaysThisDeviceOnly
static var defaultOption: KeychainSwiftAccessOptions {
return .AccessibleWhenUnlocked
}
var value: String {
switch self {
case .AccessibleWhenUnlocked:
return toString(kSecAttrAccessibleWhenUnlocked)
case .AccessibleWhenUnlockedThisDeviceOnly:
return toString(kSecAttrAccessibleWhenUnlockedThisDeviceOnly)
case .AccessibleAfterFirstUnlock:
return toString(kSecAttrAccessibleAfterFirstUnlock)
case .AccessibleAfterFirstUnlockThisDeviceOnly:
return toString(kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly)
case .AccessibleAlways:
return toString(kSecAttrAccessibleAlways)
case .AccessibleWhenPasscodeSetThisDeviceOnly:
return toString(kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly)
case .AccessibleAlwaysThisDeviceOnly:
return toString(kSecAttrAccessibleAlwaysThisDeviceOnly)
}
}
func toString(value: CFStringRef) -> String {
return KeychainSwiftConstants.toString(value)
}
}
// ----------------------------
//
// TegKeychainConstants.swift
//
// ----------------------------
import Foundation
import Security
public struct KeychainSwiftConstants {
public static var klass: String { return toString(kSecClass) }
public static var classGenericPassword: String { return toString(kSecClassGenericPassword) }
public static var attrAccount: String { return toString(kSecAttrAccount) }
public static var valueData: String { return toString(kSecValueData) }
public static var returnData: String { return toString(kSecReturnData) }
public static var matchLimit: String { return toString(kSecMatchLimit) }
/**
A value that indicates when your app needs access to the data in a keychain item. The default value is AccessibleWhenUnlocked. For a list of possible values, see KeychainSwiftAccessOptions.
*/
public static var accessible: String { return toString(kSecAttrAccessible) }
static func toString(value: CFStringRef) -> String {
return (value as? String) ?? ""
}
}