[iOS] 키체인 유틸

String 타입의 값 키체인에 저장할 때 사용하려고 구현해놓은 키체인 유틸 클래스입니다. 싱글톤으로 구현되어 있습니다. store 시 이미 존재하던 값이면 자동으로 업데이트가 되도록 구현했습니다. 발생하는 각종 오류에 대한 설명은 주석으로 달았습니다. 

import Foundation
import Security

enum KeyChainType: String {
    case tokenKey = "Token_Key"
    // ...
}

enum KeyChainError: Error {
    case invalidBundleID
    case invalidData
    case recognizedKeyChainError(OSStatus, CFString?)
    case unrecognizedKeyChainError
    case dataCannotConvertString
    case dataNotFound
}

class KeyChainUtil {
    private let bundleID = Bundle.main.bundleIdentifier

    // singleton
    static let shared = KeyChainUtil()

    private init() { }

    // MARK: Create = Store
    /**
     키체인에 데이터 저장하는 함수. 기존에 존재하던 데이터여도 이 함수로 저장해주면 됨.
     
     발생할 수 있는 에러
     1. invalidBundleID -> 유효하지 않은 bundle id의 경우
     2. invalidData -> 저장 데이터의 저장 형식 변환이 불가능한 경우
     3. recognizedKeyChainError -> 발생 가능
     
     - Parameters:
     - key: enum KeyChainType에 존재하는 저장할 값의 타입
     - data: 저장할 값
     */
    func storeStringTypeInKeyChain(
        type key: KeyChainType,
        data: String
    ) throws {

        guard let service = self.bundleID else {
            throw KeyChainError.invalidBundleID
        }

        guard let validData = data.data(using: .utf8, allowLossyConversion: false) else {
            throw KeyChainError.invalidData
        }

        let query: [CFString: Any] = [
            kSecClass: kSecClassGenericPassword,
            kSecAttrService: service,
            kSecAttrAccount: key.rawValue,
            kSecValueData: validData
        ]

        let status: OSStatus = SecItemAdd(query as CFDictionary, nil)

        if status == errSecSuccess {
            print("key chain stored well")
        } else {
            if status == errSecDuplicateItem {
                do {
                    try updateStringTypeInKeyChain(type: key, data: data)
                } catch KeyChainError.recognizedKeyChainError(let status, let err) {
                    throw KeyChainError.recognizedKeyChainError(status, err)
                }
            }
            let err = SecCopyErrorMessageString(status, nil)
            throw KeyChainError.recognizedKeyChainError(status, err)
        }

    }

    // MARK: Update
    /**
     키체인에 데이터 업데이트하는 함수. 외부에서 접근 불가능. Store 시 자동으로 불림
     
     발생할 수 있는 에러
     1. invalidBundleID -> 발생하지 않음 (store에서 한 번 검증)
     2. invalidData -> 발생하지 않음 (store에서 한 번 검증)
     3. recognizedKeyChainError -> 발생 가능
     */
    fileprivate func updateStringTypeInKeyChain(
        type key: KeyChainType,
        data: String
    ) throws {

        guard let service = self.bundleID else {
            throw KeyChainError.invalidBundleID
        }

        guard let validData = data.data(using: .utf8, allowLossyConversion: false) else {
            throw KeyChainError.invalidData
        }

        let query: [CFString: Any] = [
            kSecClass: kSecClassGenericPassword,
            kSecAttrService: service
        ]

        let attributes: [CFString: Any] = [
            kSecAttrAccount: key.rawValue,
            kSecValueData: validData
        ]

        let status = SecItemUpdate(query as CFDictionary, attributes as CFDictionary)

        if status == errSecSuccess {
            print("key chain updated well")
        } else {
            let err = SecCopyErrorMessageString(status, nil)
            throw KeyChainError.recognizedKeyChainError(status, err)
        }

    }

    // MARK: Read
    /**
     키체인에서 데이터 값 불러오는 함수
     
     발생할 수 있는 에러
     1. invalidBundleID -> 유효하지 않은 bundle id의 경우
     2. dataCannotConvertString -> 저장 데이터의 String 변환이 불가능한 경우
     3. dataNotFound -> key 값으로 접근한 데이터가 존재하지 않는 경우
     4. recognizedKeyChainError -> 발생 가능
     
     - Parameter key: enum KeyChainType에 존재하는 저장한 값의 타입
     - Returns: KeyChain에 저장된 값
     */
    func getStringTypeFromKeyChain(type key: KeyChainType) throws -> String {

        guard let service = self.bundleID else {
            throw KeyChainError.invalidBundleID
        }

        let query: [CFString: Any] = [
            kSecClass: kSecClassGenericPassword,
            kSecAttrService: service,
            kSecAttrAccount: key.rawValue,
            kSecReturnData: true,
            kSecReturnAttributes: true,
            kSecMatchLimit: kSecMatchLimitOne
        ]

        var dataTypeRef: CFTypeRef?

        let status: OSStatus = SecItemCopyMatching(query as CFDictionary, &dataTypeRef)

        if status == errSecSuccess {
            guard let item = dataTypeRef as? [String: Any] else {
                throw KeyChainError.dataCannotConvertString
            }

            guard let deviceData = item[kSecValueData as String] as? Data else {
                throw KeyChainError.dataCannotConvertString
            }

            guard let result = String(data: deviceData, encoding: .utf8) else {
                throw KeyChainError.dataCannotConvertString
            }

            return result
        } else if status == errSecItemNotFound || status == -25300 {
            throw KeyChainError.dataNotFound
        } else {
            let err = SecCopyErrorMessageString(status, nil)
            throw KeyChainError.recognizedKeyChainError(status, err)
        }

    }
}

fileprivate extension KeyChainUtil {

}