[iOS] Swift 에서 키체인 (Keychain) 사용하기

iOS 에는 Keychain 이라는 기능이 있는데요.
이 기능으로 간단한 값들이나 계정 정보 같은걸
저장하고 읽을 수 있습니다.

( 보통 사용자 계정을 저장할때 쓰이지만
엄청 큰 정보들을 저장해도 상관 없습니다.
예를 들면 UIImage 를 NSString 으로
변환하고 그걸 AES128 + Base64 로
인코딩 한 문자열을 저장해도 됩니다. )

문서
https://developer.apple.com/library/mac/documentation/Security/Conceptual/keychainServConcepts/iPhoneTasks/iPhoneTasks.html#//apple_ref/doc/uid/TP30000897-CH208-SW1

이 Keychain 기능을
애플의 새 언어인 Swift 에서
간단히 사용하는 방법 입니다.

먼저 프로젝트에 키체인 기능을
구현할 Swift 파일을 추가 합니다.

그다음 아래처럼 키체인 관련 코드를
간단히 작성 합니다.

import UIKit import Security // 서비스 Identifiers // 원하시는 값을 적으시면 됩니다. let serviceIdentifier = "SwiftKeychainController" // Keychain 관련 쿼리 키 값들 let kSecClassValue = NSString(format: kSecClass) let kSecAttrAccountValue = NSString(format: kSecAttrAccount) let kSecValueDataValue = NSString(format: kSecValueData) let kSecAttrGenericValue = NSString(format: kSecAttrGeneric) let kSecAttrServiceValue = NSString(format: kSecAttrService) let kSecAttrAccessValue = NSString(format: kSecAttrAccessible) let kSecMatchLimitValue = NSString(format: kSecMatchLimit) let kSecReturnDataValue = NSString(format: kSecReturnData) let kSecMatchLimitOneValue = NSString(format: kSecMatchLimitOne) let kSecAttrAccessGroupValue = NSString(format: kSecAttrAccessGroup) let kSecClassGenericPasswordValue = NSString(format: kSecClassGenericPassword) class KeychainController : NSObject { private struct internalVars { static var _serviceName: String = "" } internal class var serviceName: String { get { if internalVars._serviceName.isEmpty { internalVars._serviceName = NSBundle.mainBundle().bundleIdentifier ?? serviceIdentifier } return internalVars._serviceName } set( newServiceName ) { internalVars._serviceName = newServiceName } } // MARK: Public Methods internal class func hasValueForKey(key: String) -> Bool { var keychainData: NSData? = self.dataForKey(key) if let data = keychainData { return true } else { return false } } // MARK: Getting Values internal class func stringForKey(keyName: String) -> String? { var keychainData: NSData? = self.dataForKey(keyName) var stringValue: String? if let data = keychainData { stringValue = NSString(data: data, encoding: NSUTF8StringEncoding) as String? } return stringValue } internal class func objectForKey(keyName: String) -> NSCoding? { let dataValue: NSData? = self.dataForKey(keyName) var objectValue: NSCoding? if let data = dataValue { objectValue = NSKeyedUnarchiver.unarchiveObjectWithData(data) as NSCoding? } return objectValue } internal class func dataForKey(keyName: String) -> NSData? { var keychainQueryDictionary = self.setupKeychainQueryDictionaryForKey(keyName) // Limit search results to one keychainQueryDictionary[kSecMatchLimitValue] = kSecMatchLimitOneValue // Specify we want NSData/CFData returned keychainQueryDictionary[kSecReturnDataValue] = kCFBooleanTrue /* 원래 이렇게 쓰는건데 제대로 동작을 안해서 일단 주석 var dataTypeRef : Unmanaged<AnyObject>? let status = SecItemCopyMatching(keychainQueryDictionary, &dataTypeRef); if status == errSecSuccess { if let retrievedData = dataTypeRef?.takeRetainedValue() as? NSData { return retrievedData } return nil } else { return nil } */ return KeyChainWrapper.ItemCopyMatching( keychainQueryDictionary ); } // MARK: Setting Values internal class func setString(value: String, forKey keyName: String) -> Bool { if let data = value.dataUsingEncoding(NSUTF8StringEncoding) { return self.setData(data, forKey: keyName) } else { return false } } internal class func setObject(value: NSCoding, forKey keyName: String) -> Bool { let data = NSKeyedArchiver.archivedDataWithRootObject(value) return self.setData(data, forKey: keyName) } internal class func setData(value: NSData, forKey keyName: String) -> Bool { var keychainQueryDictionary: NSMutableDictionary = self.setupKeychainQueryDictionaryForKey(keyName) keychainQueryDictionary[kSecValueDataValue] = value SecItemDelete(keychainQueryDictionary as CFDictionaryRef) let status = SecItemAdd(keychainQueryDictionary as CFDictionaryRef, nil) if status == errSecSuccess { return true } else if status == errSecDuplicateItem { return self.updateData(value, forKey: keyName) } else { return false } } // MARK: Removing Values internal class func removeObjectForKey(keyName: String) -> Bool { let keychainQueryDictionary: NSMutableDictionary = self.setupKeychainQueryDictionaryForKey(keyName) // Delete let status: OSStatus = SecItemDelete(keychainQueryDictionary) if status == errSecSuccess { return true } else { return false } } internal class func resetAllData() { self.deleteAllKeysForSecClass(kSecClassGenericPassword) self.deleteAllKeysForSecClass(kSecClassInternetPassword) self.deleteAllKeysForSecClass(kSecClassCertificate) self.deleteAllKeysForSecClass(kSecClassKey) self.deleteAllKeysForSecClass(kSecClassIdentity) self.deleteAllKeysForSecClass(kSecValueData) } private class func deleteAllKeysForSecClass(selClass: CFTypeRef) -> Bool { var dict = NSMutableDictionary() dict.setObject(selClass, forKey: kSecClassValue) let status : OSStatus = SecItemDelete(dict) if status == errSecSuccess { return true } else { return false } } // MARK: Private Methods private class func updateData(value: NSData, forKey keyName: String) -> Bool { let keychainQueryDictionary: NSMutableDictionary = self.setupKeychainQueryDictionaryForKey(keyName) let updateDictionary = [kSecValueDataValue : value] // Update let status: OSStatus = SecItemUpdate(keychainQueryDictionary, updateDictionary) if status == errSecSuccess { return true } else { return false } } private class func setupKeychainQueryDictionaryForKey(keyName: String) -> NSMutableDictionary { var keychainQueryDictionary: NSMutableDictionary = [kSecClassValue : kSecClassGenericPassword] // Uniquely identify this keychain accessor keychainQueryDictionary[kSecAttrServiceValue] = KeychainController.serviceName // Uniquely identify the account who will be accessing the keychain var encodedIdentifier: NSData? = keyName.dataUsingEncoding(NSUTF8StringEncoding) // account key keychainQueryDictionary[kSecAttrAccountValue] = encodedIdentifier return keychainQueryDictionary } }

여기서 중요한건
제가 주석을 처 놓은 부분 인데요..

/* 원래 이렇게 쓰는건데 제대로 동작을 안해서 일단 주석 var dataTypeRef : Unmanaged<AnyObject>? let status = SecItemCopyMatching(keychainQueryDictionary, &dataTypeRef); if status == errSecSuccess { if let retrievedData = dataTypeRef?.takeRetainedValue() as? NSData { return retrievedData } return nil } else { return nil } */

원래 위 처럼 사용해야 하는건데
버전문제 인지 뭔가 잘 적용이 안되더라구요..

그래서 Objectiv-C 코드로 대체 한 부분 입니다.

대체한 부분은 아래와 같습니다.

#import "KeyChainWrapper.h" @implementation KeyChainWrapper + (NSData *)ItemCopyMatching: (NSDictionary *)dict { CFTypeRef searchResultRef = NULL; OSStatus err = SecItemCopyMatching((__bridge CFDictionaryRef)dict, &searchResultRef); NSData *result = nil; if(err == noErr) { // transfer ownership so ARC will take care of releasing underlying CF object result = (__bridge_transfer id)searchResultRef; } return result; } @end

만약 Objective-C 연동 관련
빌드에러가 발생한다면 
아래 글을 참조해 주세요.
http://lhh3520.tistory.com/160

여기까지 해주셨다면 다 끝났습니다.
사용방법은 아래와 같습니다.

import UIKit class ViewController: UIViewController { override func viewDidLoad() { super.viewDidLoad() // 원하는 서비스 ID 설정 KeychainController.serviceName = serviceIdentifier // NSString 형을 Keychain 저장할때 사용. self.saveKeyChainWithString("keyChainString", key: "testKey") if let keychainStr: NSString = self.loadKeyChainString("testKey") { NSLog("saved keychain : %@", keychainStr) } // NSObject 형을 Keychain 저장할때 사용. var testDict = NSDictionary(dictionary: [ "key1" : "value1", "key2" : "value2", "key3" : "value3" ]) self.saveKeyChainWithObject(testDict, key: "testDictKey") if let keyChainDict = self.loadKeyChainObject("testDictKey") as? NSDictionary { NSLog("%@", keyChainDict) } // Keychain 리셋할때 사용. self.resetKeyChainData() } }

이렇게 해주면 잘 실행 됩니다.

----- Tip ----

Keychain 이 어떻게 보면
NSUserDefault 와 비슷합니다.

그렇기 때문에 한번 저장하면
지우지 않는이상 계속 남아 있습니다.

하지만 NSUserDefault 는 어플을 지우면
저장했던 값들이 모두 지워지지만,
키체인은 어플을 지워도 남아있습니다.

그래서 사용하실때
주의 하셔서 사용하셔야 합니다.

소스코드 첨부합니다.

KeyChainTest.zip