from https://gist.github.com/kristopherjohnson/5212625
.h file
|
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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
// Based upon code from Apple's "GenericKeychain" sample application // Converted to support ARC (see https://gist.github.com/dhoerl/1170641 ) #if ! __has_feature(objc_arc) #error THIS CODE MUST BE COMPILED WITH ARC ENABLED! #endif /* File: KeychainItemWrapper.m Abstract: Objective-C wrapper for accessing a single keychain item. Version: 1.2 Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple") in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this Apple software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this Apple software. In consideration of your agreement to abide by the following terms, and subject to these terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in this original Apple software (the "Apple Software"), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software. Neither the name, trademarks, service marks or logos of Apple Inc. may be used to endorse or promote products derived from the Apple Software without specific prior written permission from Apple. Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by Apple herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the Apple Software may be incorporated. The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Copyright (C) 2010 Apple Inc. All Rights Reserved. */ #import "KDJKeychainItemWrapper.h" #import <Security/Security.h> /* These are the default constants and their respective types, available for the kSecClassGenericPassword Keychain Item class: kSecAttrAccessGroup - CFStringRef kSecAttrCreationDate - CFDateRef kSecAttrModificationDate - CFDateRef kSecAttrDescription - CFStringRef kSecAttrComment - CFStringRef kSecAttrCreator - CFNumberRef kSecAttrType - CFNumberRef kSecAttrLabel - CFStringRef kSecAttrIsInvisible - CFBooleanRef kSecAttrIsNegative - CFBooleanRef kSecAttrAccount - CFStringRef kSecAttrService - CFStringRef kSecAttrGeneric - CFDataRef See the header file Security/SecItem.h for more details. */ /* Define aliases to avoid "(__bridge id)" clutter throughout the code */ #define b_kSecAttrAccessGroup ((__bridge id) kSecAttrAccessGroup) #define b_kSecAttrAccount ((__bridge id) kSecAttrAccount) #define b_kSecAttrDescription ((__bridge id) kSecAttrDescription) #define b_kSecAttrGeneric ((__bridge id) kSecAttrGeneric) #define b_kSecAttrLabel ((__bridge id) kSecAttrLabel) #define b_kSecClass ((__bridge id) kSecClass) #define b_kSecClassGenericPassword ((__bridge id) kSecClassGenericPassword) #define b_kSecMatchLimit ((__bridge id) kSecMatchLimit) #define b_kSecMatchLimitOne ((__bridge id) kSecMatchLimitOne) #define b_kSecReturnAttributes ((__bridge id) kSecReturnAttributes) #define b_kSecReturnData ((__bridge id) kSecReturnData) #define b_kSecValueData ((__bridge id) kSecValueData) @interface KDJKeychainItemWrapper (PrivateMethods) /* The decision behind the following two methods (secItemFormatToDictionary and dictionaryToSecItemFormat) was to encapsulate the transition between what the detail view controller was expecting (NSString *) and what the Keychain API expects as a validly constructed container class. */ - (NSMutableDictionary *)secItemFormatToDictionary:(NSDictionary *)dictionaryToConvert; - (NSMutableDictionary *)dictionaryToSecItemFormat:(NSDictionary *)dictionaryToConvert; // Updates the item in the keychain, or adds it if it doesn't exist. - (void)writeToKeychain; @end @implementation KDJKeychainItemWrapper - (id)initWithIdentifier: (NSString *)identifier accessGroup:(NSString *) accessGroup; { if (self = [super init]) { // Begin Keychain search setup. The genericPasswordQuery leverages the special user // defined attribute kSecAttrGeneric to distinguish itself between other generic Keychain // items which may be included by the same application. self.genericPasswordQuery = [[NSMutableDictionary alloc] init]; _genericPasswordQuery[b_kSecClass] = b_kSecClassGenericPassword; _genericPasswordQuery[b_kSecAttrGeneric] = identifier; // The keychain access group attribute determines if this item can be shared // amongst multiple apps whose code signing entitlements contain the same keychain access group. if (accessGroup != nil) { #if TARGET_IPHONE_SIMULATOR // Ignore the access group if running on the iPhone simulator. // // Apps that are built for the simulator aren't signed, so there's no keychain access group // for the simulator to check. This means that all apps can see all keychain items when run // on the simulator. // // If a SecItem contains an access group attribute, SecItemAdd and SecItemUpdate on the // simulator will return -25243 (errSecNoAccessForItem). #else _genericPasswordQuery[b_kSecAttrAccessGroup] = accessGroup; #endif } // Use the proper search constants, return only the attributes of the first match. _genericPasswordQuery[b_kSecMatchLimit] = b_kSecMatchLimitOne; _genericPasswordQuery[b_kSecReturnAttributes] = (__bridge id)kCFBooleanTrue; NSDictionary *tempQuery = [NSDictionary dictionaryWithDictionary:_genericPasswordQuery]; CFMutableDictionaryRef outDictionary = nil; if (! SecItemCopyMatching((__bridge CFDictionaryRef)tempQuery, (CFTypeRef *)&outDictionary) == noErr) { // Stick these default values into keychain item if nothing found. [self resetKeychainItem]; // Add the generic attribute and the keychain access group. _keychainItemData[b_kSecAttrGeneric] = identifier; if (accessGroup != nil) { #if TARGET_IPHONE_SIMULATOR // Ignore the access group if running on the iPhone simulator. // // Apps that are built for the simulator aren't signed, so there's no keychain access group // for the simulator to check. This means that all apps can see all keychain items when run // on the simulator. // // If a SecItem contains an access group attribute, SecItemAdd and SecItemUpdate on the // simulator will return -25243 (errSecNoAccessForItem). #else _keychainItemData[b_kSecAttrAccessGroup] = accessGroup; #endif } } else { // load the saved data from Keychain. self.keychainItemData = [self secItemFormatToDictionary:(__bridge NSDictionary *)outDictionary]; } if (outDictionary) { CFRelease(outDictionary); } } return self; } - (void)setObject:(id)inObject forKey:(id)key { if (inObject == nil) return; id currentObject = [_keychainItemData objectForKey:key]; if (![currentObject isEqual:inObject]) { _keychainItemData[key] = inObject; [self writeToKeychain]; } } - (id)objectForKey:(id)key { return [_keychainItemData objectForKey:key]; } - (void)resetKeychainItem { OSStatus junk = noErr; if (!_keychainItemData) { self.keychainItemData = [[NSMutableDictionary alloc] init]; } else { NSMutableDictionary *tempDictionary = [self dictionaryToSecItemFormat:_keychainItemData]; junk = SecItemDelete((__bridge CFDictionaryRef)tempDictionary); NSAssert( junk == noErr || junk == errSecItemNotFound, @"Problem deleting current dictionary." ); } // Default attributes for keychain item. _keychainItemData[b_kSecAttrAccount] = @""; _keychainItemData[b_kSecAttrLabel] = @""; _keychainItemData[b_kSecAttrDescription] = @""; // Default data for keychain item. _keychainItemData[b_kSecValueData] = @""; } - (NSMutableDictionary *)dictionaryToSecItemFormat:(NSDictionary *)dictionaryToConvert { // The assumption is that this method will be called with a properly populated dictionary // containing all the right key/value pairs for a SecItem. // Create a dictionary to return populated with the attributes and data. NSMutableDictionary *returnDictionary = [NSMutableDictionary dictionaryWithDictionary:dictionaryToConvert]; // Add the Generic Password keychain item class attribute. returnDictionary[b_kSecClass] = b_kSecClassGenericPassword; // Convert the NSString to NSData to meet the requirements for the value type kSecValueData. // This is where to store sensitive data that should be encrypted. NSString *passwordString = [dictionaryToConvert objectForKey:b_kSecValueData]; returnDictionary[b_kSecValueData] = [passwordString dataUsingEncoding:NSUTF8StringEncoding]; return returnDictionary; } - (NSMutableDictionary *)secItemFormatToDictionary:(NSDictionary *)dictionaryToConvert { // The assumption is that this method will be called with a properly populated dictionary // containing all the right key/value pairs for the UI element. // Create a dictionary to return populated with the attributes and data. NSMutableDictionary *returnDictionary = [NSMutableDictionary dictionaryWithDictionary:dictionaryToConvert]; // Add the proper search key and class attribute. returnDictionary[b_kSecReturnData] = (id)kCFBooleanTrue; returnDictionary[b_kSecClass] = b_kSecClassGenericPassword; // Acquire the password data from the attributes. CFDataRef passwordData = NULL; if (SecItemCopyMatching((__bridge CFDictionaryRef)returnDictionary, (CFTypeRef *)&passwordData) == noErr) { // Remove the search, class, and identifier key/value, we don't need them anymore. [returnDictionary removeObjectForKey:b_kSecReturnData]; // Add the password to the dictionary, converting from NSData to NSString. NSString *password = [[NSString alloc] initWithBytes:[(__bridge NSData *)passwordData bytes] length:[(__bridge NSData *)passwordData length] encoding:NSUTF8StringEncoding]; returnDictionary[b_kSecValueData] = password; } else { // Don't do anything if nothing is found. NSAssert(NO, @"Serious error, no matching item found in the keychain.\n"); } if (passwordData) { CFRelease(passwordData); } return returnDictionary; } - (void)writeToKeychain { CFDictionaryRef attributes = NULL; NSMutableDictionary *updateItem = NULL; OSStatus result; if (SecItemCopyMatching((__bridge CFDictionaryRef)_genericPasswordQuery, (CFTypeRef *)&attributes) == noErr) { // First we need the attributes from the Keychain. updateItem = [NSMutableDictionary dictionaryWithDictionary:(__bridge NSDictionary *)(attributes)]; // Second we need to add the appropriate search key/values. updateItem[b_kSecClass] = [_genericPasswordQuery objectForKey:b_kSecClass]; // Lastly, we need to set up the updated attribute list being careful to remove the class. NSMutableDictionary *tempCheck = [self dictionaryToSecItemFormat:_keychainItemData]; [tempCheck removeObjectForKey:b_kSecClass]; #if TARGET_IPHONE_SIMULATOR // Remove the access group if running on the iPhone simulator. // // Apps that are built for the simulator aren't signed, so there's no keychain access group // for the simulator to check. This means that all apps can see all keychain items when run // on the simulator. // // If a SecItem contains an access group attribute, SecItemAdd and SecItemUpdate on the // simulator will return -25243 (errSecNoAccessForItem). // // The access group attribute will be included in items returned by SecItemCopyMatching, // which is why we need to remove it before updating the item. [tempCheck removeObjectForKey:b_kSecAttrAccessGroup]; #endif // An implicit assumption is that you can only update a single item at a time. result = SecItemUpdate((__bridge CFDictionaryRef)updateItem, (__bridge CFDictionaryRef)tempCheck); NSAssert( result == noErr, @"Couldn't update the Keychain Item." ); } else { // No previous item found; add the new one. result = SecItemAdd((__bridge CFDictionaryRef)[self dictionaryToSecItemFormat:_keychainItemData], NULL); NSAssert( result == noErr, @"Couldn't add the Keychain Item." ); } } @end |
.c file
|
1 |
// Based upon code from Apple's "GenericKeychain" sample application /* File: KeychainItemWrapper.h Abstract: Objective-C wrapper for accessing a single keychain item. Version: 1.2 Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple") in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this Apple software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this Apple software. In consideration of your agreement to abide by the following terms, and subject to these terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in this original Apple software (the "Apple Software"), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software. Neither the name, trademarks, service marks or logos of Apple Inc. may be used to endorse or promote products derived from the Apple Software without specific prior written permission from Apple. Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by Apple herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the Apple Software may be incorporated. The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Copyright (C) 2010 Apple Inc. All Rights Reserved. */ #import <UIKit/UIKit.h> /* The KeychainItemWrapper class is an abstraction layer for the iPhone Keychain communication. It is merely a simple wrapper to provide a distinct barrier between all the idiosyncracies involved with the Keychain CF/NS container objects. */ @interface KDJKeychainItemWrapper : NSObject @property (nonatomic, retain) NSMutableDictionary *keychainItemData; @property (nonatomic, retain) NSMutableDictionary *genericPasswordQuery; // Designated initializer. - (id)initWithIdentifier: (NSString *)identifier accessGroup:(NSString *) accessGroup; - (void)setObject:(id)inObject forKey:(id)key; - (id)objectForKey:(id)key; // Initializes and resets the default generic keychain item data. - (void)resetKeychainItem; @end |
