A modern Swift package for convenient, type-safe Keychain operations on iOS and macOS.

SwiftKeychainKit provides a type-safe, modern Swift API for working with the Data Protection Keychain on iOS and macOS.

Apple's Security framework offers a powerful but low-level C API based on untyped dictionaries. SwiftKeychainKit wraps it with dedicated Swift methods for each item class, making it straightforward to store and retrieve sensitive data correctly.

The APIs are designed to guide you towards correct usage. Invalid attribute combinations are caught at compile time, and operation-specific parameter types help prevent common Keychain mistakes.

• ✅ Common Keychain types - Passwords, cryptographic keys, certificates, and identities
• ✅ Sensitive Data Handling - Designed to keep passwords and secrets safe in memory
• ✅ Access Control - Restrict access with biometry, device passcode, or application passwords
• ✅ Secure Enclave - Generate and use keys backed by dedicated security hardware
• ✅ iCloud Sync - Share Keychain items across devices via iCloud
• ✅ Apple CryptoKit Integration - Work with CryptoKit keys without manual conversion
• ✅ Swift 6 - Async/await and strict concurrency throughout
• ✅ Complete Documentation - DocC documentation with guides and code examples

import SwiftKeychainKit

// Store a password and keep a reference
let password = try SecretData.makeByCopyingUTF8(fromUnsafeString: "secret")
let itemReference = try await Keychain.GenericPassword.add(
    password,
    account: "user@example.com",
    service: "com.example.app"
)

// Retrieve by reference
let password = try await Keychain.GenericPassword.get(itemReference: itemReference)

// Update by reference
let newPassword = try SecretData.makeByCopyingUTF8(fromUnsafeString: "new-secret")
try await Keychain.GenericPassword.update(itemReference: itemReference, to: newPassword)

// Delete by reference
try await Keychain.GenericPassword.delete(itemReference: itemReference)

You can also retrieve and manage items by their attributes (e.g. account and service). See the documentation for details.

NIST curve keys (P-256, P-384, P-521) can be stored directly via Keychain.Keys:

import CryptoKit

let privateKey = P256.Signing.PrivateKey()
let tag = "com.example.signing-key".data(using: .utf8)!

let itemReference = try await Keychain.Keys.addPrivateKey(privateKey, applicationTag: tag)

// Retrieve by reference, or use queryOne(applicationTag:) to query by tag
let retrieved: P256.Signing.PrivateKey? = try await Keychain.Keys.get(itemReference: itemReference)

Curve25519 keys are stored as generic passwords:

let privateKey = Curve25519.KeyAgreement.PrivateKey()
try await Keychain.GenericPassword.add(
    privateKey,
    account: "com.example.curve25519-key",
    service: "com.example.app"
)

For a complete guide including key agreement and signing workflows, see the CryptoKit integration guide.

All Keychain operations can throw KeychainError. Use convenience properties for common cases:

do {
    try await Keychain.GenericPassword.add(password, account: "user", service: "app")
} catch KeychainError.duplicateItem {
    // Item already exists
}

KeychainError does not conform to LocalizedError, giving you full control over user-facing messages. See the error handling guide for patterns including localization.

Add the dependency to your Package.swift:

dependencies: [
    .package(url: "https://github.com/wiedem/swift-keychain-kit.git", from: "1.5.0")
]

Then add it to your target:

.target(
    name: "YourApp",
    dependencies: [
        .product(name: "SwiftKeychainKit", package: "swift-keychain-kit"),
    ]
)

Or add it in Xcode:

1. File → Add Package Dependencies...
2. Enter: https://github.com/wiedem/swift-keychain-kit.git

• iOS 15.0+ / macOS 12.0+
• Swift 6.2+
• Xcode 26+

The package includes unit tests and integration tests:

swift test

Integration tests require the TestHost Xcode project with Keychain entitlements. Open TestHost/TestHost.xcodeproj and run tests with ⌘U.

Full DocC documentation is available online:

SwiftKeychainKit Documentation →

Build documentation locally in Xcode:

Product → Build Documentation

Contributions are welcome! Please feel free to:

• Report bugs or request features via GitHub Issues
• Submit pull requests with improvements
• Improve documentation or add examples

• Apple Developer: Keychain Services
• Apple Developer: Protecting Keys with the Secure Enclave
• Apple Developer: CryptoKit

This project is licensed under the MIT License. See LICENSE.txt for details.

Created and maintained by Holger Wiedemann