[Swift] KeychainManager

 

 

---

iOS 개발을 하다 보면 앱 내에서 데이터를 저장해야 하는 경우가 많다.
단순한 설정 값은 UserDefaults로 충분하지만,
엑세스 토큰이나 사용자 인증 정보처럼 민감한 데이터는 보안이 강화된 Keychain에 저장하면 좋다.

이번 글에서는 기존에 만들어둔 UserDefaultsManager와 유사한 패턴으로,
Keychain을 조금 더 손쉽게 다룰 수 있는 KeychainManager를 직접 구현해보려고 한다 :)

---

Keychain은 시스템에서 직접 암호화하여 관리하는 안전한 저장소지만,
API가 다소 복잡하고 반복적인 코드가 필요하다.
따라서 UserDefaults처럼 간단하게 '저장, 읽기, 삭제' 메서드만 호출하면 되도록 래핑하면
실무에서 훨씬 사용하기 편리할 것 같았다.

이번에 구현한 KeychainManager는 Enum 키 기반으로
타입 안정성을 확보하면서도, 불필요한 중복 코드를 최소화하도록 구성했다.

<KeyChainManager>

import Security
import Foundation

struct KeychainManager {
    enum Keys: String {
        case accessToken
        case refreshToken
        case userIdentifier
        case email
        case password
    }

    // 저장
    static func save(_ value: String, for key: Keys) -> Bool {
        guard let data = value.data(using: .utf8) else { return false }
        
        // 기존 값 제거
        delete(for: key)
        
        let query: [String: Any] = [
            kSecClass as String: kSecClassGenericPassword,
            kSecAttrAccount as String: key.rawValue,
            kSecValueData as String: data
        ]
        
        let status = SecItemAdd(query as CFDictionary, nil)
        return status == errSecSuccess
    }

    // 읽기
    static func load(for key: Keys) -> String? {
        let query: [String: Any] = [
            kSecClass as String: kSecClassGenericPassword,
            kSecAttrAccount as String: key.rawValue,
            kSecReturnData as String: true,
            kSecMatchLimit as String: kSecMatchLimitOne
        ]
        
        var item: CFTypeRef?
        let status = SecItemCopyMatching(query as CFDictionary, &item)
        
        guard status == errSecSuccess,
              let data = item as? Data,
              let value = String(data: data, encoding: .utf8) else {
            return nil
        }
        
        return value
    }

    // 삭제
    static func delete(for key: Keys) -> Bool {
        let query: [String: Any] = [
            kSecClass as String: kSecClassGenericPassword,
            kSecAttrAccount as String: key.rawValue
        ]
        
        let status = SecItemDelete(query as CFDictionary)
        return status == errSecSuccess
    }
}

 

<사용 예시>

// 저장
KeychainManager.save("my_access_token", for: .accessToken)

// 불러오기
if let token = KeychainManager.load(for: .accessToken) {
    print("토큰: \(token)")
}

// 삭제
KeychainManager.delete(for: .accessToken)

---

구현한 코드를 간략하게 설명하자면,
Keychain에 저장할 항목들을 Enum으로 정의했다.

enum Keys: String {
    case accessToken
    case refreshToken
    case userIdentifier
    case email
    case password
}

그리고 문자열 값을 저장하는 메서드를 만들었다.

static func save(_ value: String, for key: Keys) -> Bool {
    guard let data = value.data(using: .utf8) else { return false }
    
    // 기존 값 제거
    delete(for: key)
    
    let query: [String: Any] = [
        kSecClass as String: kSecClassGenericPassword,
        kSecAttrAccount as String: key.rawValue,
        kSecValueData as String: data
    ]
    
    let status = SecItemAdd(query as CFDictionary, nil)
    return status == errSecSuccess
}

내부에 String을 Data 타입으로 변환하고, 동일한 키가 이미 존재한다면 충돌을 방지하기 위해 삭제하도록 구성했다.
그리고 SecItemAdd를 사용하여 Keychain에 항목을 추가했다. (성공 여부는 Bool값으로 반환)


다음으로 읽기(조회) 메서드는

static func load(for key: Keys) -> String? {
    let query: [String: Any] = [
        kSecClass as String: kSecClassGenericPassword,
        kSecAttrAccount as String: key.rawValue,
        kSecReturnData as String: true,
        kSecMatchLimit as String: kSecMatchLimitOne
    ]
    
    var item: CFTypeRef?
    let status = SecItemCopyMatching(query as CFDictionary, &item)
    
    guard status == errSecSuccess,
          let data = item as? Data,
          let value = String(data: data, encoding: .utf8) else {
        return nil
    }
    
    return value
}

SecItemCopyMatching을 통해 key에 해당하는 데이터를 조회하고, 
찾은 값을 Data에서 String으로 변환하여 반환한다. (만약 값이 없거나 실패할 경우 nil 반환)


마지막으로 삭제 메서드는

static func delete(for key: Keys) -> Bool {
    let query: [String: Any] = [
        kSecClass as String: kSecClassGenericPassword,
        kSecAttrAccount as String: key.rawValue
    ]
    
    let status = SecItemDelete(query as CFDictionary)
    return status == errSecSuccess
}

삭제 대상(key)을 지정하면, SecItemDelete를 호출하여 해당 값을 삭제한다.
그리고 성공 실패 여부를 Bool값으로 반환한다.

 

---

위와 같이 구성하게 되면,
프로젝트 전반에서 Keychain을 활용할 때 단순하고 일관된 방식으로 사용할 수 있다.

물론 여기서는 기본적인 저장·조회·삭제 기능만 구현했지만,
필요하다면 생체인증 옵션, Keychain 공유 그룹, 접근성 설정 등을 확장하여 적용할 수도 있다.

이번에 구성한 구조는
Keychain의 복잡한 API를 감싸서 Swfit에서 간결하게 사용할 수 있도록 추상화한 구조이다.

---