Question 1

How do I save a custom Swift struct to the keychain with Locksmith?

Accepted Answer

Conform your struct to protocols like CreateableSecureStorable and GenericPasswordSecureStorable, then implement required properties such as account and data. For example, define a TwitterAccount struct with username and password, and call createInSecureStore() to save it.

Question 2

Locksmith vs KeychainSwift: which should I use?

Accepted Answer

Locksmith is better for complex, type-safe integrations with Swift protocols, while KeychainSwift offers a simpler, closure-based API for basic operations. Choose Locksmith if you need to extend existing types or access detailed metadata without casting.

Question 3

Can Locksmith store certificates or cryptographic keys?

Accepted Answer

Not directly out of the box. The README mentions it's possible but not fully implemented, focusing instead on passwords. For certificates or keys, you might need to use Apple's Security framework directly or look for alternative libraries.

Question 4

How to handle errors when using Locksmith?

Accepted Answer

Use try-catch blocks for methods that throw LocksmithError, such as createInSecureStore(). Errors are Swift-native types like .Duplicate for existing items or .NotFound for missing data, making debugging easier than raw OSStatus codes.

Question 5

Is Locksmith compatible with SwiftUI projects?

Accepted Answer

Yes, as a Swift package, it can be integrated into SwiftUI apps via CocoaPods or Carthage. However, it's platform-agnostic within Apple ecosystems, so ensure keychain entitlements are set up in Xcode for proper functionality.

Question 6

How do I update an existing keychain item with Locksmith?

Accepted Answer

Use the updateData method for simple cases or conform your type to CreateableSecureStorable and call createInSecureStore(), which overwrites existing data. For protocol-based updates, ensure your type supports the necessary CRUD protocols.

Locksmith

What is Locksmith?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions