-
-
diff --git a/KeychainStorage/Package.swift b/KeychainStorage/Package.swift
new file mode 100644
index 0000000..95c4e86
--- /dev/null
+++ b/KeychainStorage/Package.swift
@@ -0,0 +1,27 @@
+// swift-tools-version: 6.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+ name: "KeychainStorage",
+ platforms: [
+ .macOS(.v15), .iOS(.v18), .tvOS(.v18)
+ ],
+ products: [
+ // Products define the executables and libraries a package produces, making them visible to other packages.
+ .library(
+ name: "KeychainStorage",
+ targets: ["KeychainStorage"]),
+ ],
+ targets: [
+ // Targets are the basic building blocks of a package, defining a module or a test suite.
+ // Targets can depend on other targets in this package and products from dependencies.
+ .target(
+ name: "KeychainStorage"),
+ .testTarget(
+ name: "KeychainStorageTests",
+ dependencies: ["KeychainStorage"]
+ ),
+ ]
+)
diff --git a/KeychainStorage/Sources/KeychainStorage/KeyValueStorage.swift b/KeychainStorage/Sources/KeychainStorage/KeyValueStorage.swift
new file mode 100644
index 0000000..95642a7
--- /dev/null
+++ b/KeychainStorage/Sources/KeychainStorage/KeyValueStorage.swift
@@ -0,0 +1,64 @@
+import Foundation
+
+// MARK: - Key-Value Storage
+
+/// A protocol defining a generic key-value storage interface.
+/// Conforming types can implement storage solutions such as Keychain or UserDefaults.
+public protocol KeyValueStorage {
+
+ /// Retrieves the string value associated with the specified key.
+ ///
+ /// - Parameter key: The key for which to retrieve the value.
+ /// - Returns: The string value associated with the key, or `nil` if not found.
+ /// - Throws: Throws an error if the data is invalid or if a transformation error occurs.
+ func string(forKey key: String) throws -> String?
+
+ /// Retrieves the data value associated with the specified key.
+ ///
+ /// - Parameter key: The key for which to retrieve the value.
+ /// - Returns: The data value associated with the key, or `nil` if not found.
+ /// - Throws: Throws an error if the data is invalid or if a transformation error occurs.
+ func data(forKey key: String) throws -> Data?
+
+ /// Retrieves the Boolean value associated with the specified key.
+ ///
+ /// - Parameter key: The key for which to retrieve the value.
+ /// - Returns: The Boolean value associated with the key, or `nil` if not found.
+ /// - Throws: Throws an error if the data is invalid or if a transformation error occurs.
+ func bool(forKey key: String) throws -> Bool?
+
+ /// Stores a string value at the specified key.
+ ///
+ /// - Parameters:
+ /// - value: The string value to be stored.
+ /// - key: The key under which to store the value.
+ /// - Throws: Throws an error if the data is invalid or if a transformation error occurs.
+ func set(_ value: String, key: String) throws
+
+ /// Stores a data value at the specified key.
+ ///
+ /// - Parameters:
+ /// - value: The data value to be stored.
+ /// - key: The key under which to store the value.
+ /// - Throws: Throws an error if the data is invalid or if a transformation error occurs.
+ func set(_ value: Data, key: String) throws
+
+ /// Stores a Boolean value at the specified key.
+ ///
+ /// - Parameters:
+ /// - value: The Boolean value to be stored.
+ /// - key: The key under which to store the value.
+ /// - Throws: Throws an error if the data is invalid or if a transformation error occurs.
+ func set(_ value: Bool, key: String) throws
+
+ /// Removes the value associated with the specified key.
+ ///
+ /// - Parameter key: The key for which to remove the value.
+ /// - Throws: Throws an error if the operation is unsuccessful.
+ func removeValue(forKey key: String) throws
+
+ /// Removes all values from the storage.
+ ///
+ /// - Throws: Throws an error if any value fails to be removed from the storage.
+ func removeAll() throws
+}
diff --git a/KeychainStorage/Sources/KeychainStorage/KeychainQueryFactory.swift b/KeychainStorage/Sources/KeychainStorage/KeychainQueryFactory.swift
new file mode 100644
index 0000000..28e3ec3
--- /dev/null
+++ b/KeychainStorage/Sources/KeychainStorage/KeychainQueryFactory.swift
@@ -0,0 +1,113 @@
+import Foundation
+import Security
+
+// MARK: - KeychainBasicQueryConfiguration
+
+/// A structure that defines a basic configuration for querying Keychain items.
+struct KeychainBasicQueryConfiguration {
+
+ /// The item class value, represented by `kSecClass`.
+ /// This can be one of the following:
+ /// - `kSecClassGenericPassword`: Generic password item.
+ /// - `kSecClassInternetPassword`: Internet password item.
+ /// - `kSecClassCertificate`: Certificate item.
+ /// - `kSecClassKey`: Cryptographic key item.
+ /// - `kSecClassIdentity`: Identity item.
+ let secClass: String
+
+ /// The matching limit for a Keychain query.
+ /// This can be either:
+ /// - `kSecMatchLimitAll`: Allows an unlimited number of matched items.
+ /// - `kSecMatchLimitOne`: Only matches a single item.
+ let matchLimit: String
+
+ /// Indicates whether the associated data should be returned.
+ let returnData: Bool
+
+ /// Indicates whether the attributes should be returned.
+ let returnAttributes: Bool
+
+ /// Initializes a new configuration with the specified parameters.
+ ///
+ /// - Parameters:
+ /// - secClass: The item class value. Defaults to `kSecClassGenericPassword`.
+ /// - matchLimit: The match limit for the query. Defaults to `kSecMatchLimitOne`.
+ /// - returnData: A flag indicating whether to return data. Defaults to `true`.
+ /// - returnAttributes: A flag indicating whether to return attributes. Defaults to `true`.
+ init(
+ secClass: String = kSecClassGenericPassword as String,
+ matchLimit: String = kSecMatchLimitOne as String,
+ returnData: Bool = true,
+ returnAttributes: Bool = true
+ ) {
+ self.secClass = secClass
+ self.matchLimit = matchLimit
+ self.returnData = returnData
+ self.returnAttributes = returnAttributes
+ }
+}
+
+// MARK: - KeychainBasicQueryFactory
+
+/// A typealias representing a dictionary for Keychain queries.
+typealias KeychainQuery = [String: Any]
+
+/// A factory for creating Keychain queries.
+enum KeychainBasicQueryFactory {
+
+ /// Creates a Keychain query based on the provided service, account key, value, and configuration.
+ ///
+ /// - Parameters:
+ /// - service: The Keychain item's service.
+ /// - key: The item's account name. Can be `nil`.
+ /// - value: The item's value. Can be `nil`.
+ /// - configuration: The configuration settings for the Keychain query. Defaults to a new instance of `KeychainBasicQueryConfiguration`.
+ /// - Returns: A dictionary representing the Keychain query.
+ static func makeQuery(
+ forService service: String,
+ key: String? = nil,
+ value: Data? = nil,
+ configuration: KeychainBasicQueryConfiguration = KeychainBasicQueryConfiguration()
+ ) -> KeychainQuery {
+ var queryDictionary: [String: Any] = [:]
+ queryDictionary[kSecAttrService as String] = service
+ queryDictionary[kSecClass as String] = configuration.secClass
+
+ if let key = key {
+ queryDictionary[kSecAttrAccount as String] = key
+ }
+
+ if let value = value {
+ queryDictionary[kSecValueData as String] = value
+ } else {
+ queryDictionary[kSecMatchLimit as String] = configuration.matchLimit
+ queryDictionary[kSecReturnData as String] = configuration.returnData
+ queryDictionary[kSecReturnAttributes as String] = configuration.returnAttributes
+ }
+
+ return queryDictionary
+ }
+
+ /// Creates a query for deleting Keychain items based on the provided service, account key, and configuration.
+ ///
+ /// - Parameters:
+ /// - service: The Keychain item's service.
+ /// - key: The item's account name. Can be `nil`.
+ /// - configuration: The configuration settings for the Keychain query. Defaults to a new instance of `KeychainBasicQueryConfiguration`.
+ /// - Returns: A dictionary representing the Keychain delete query.
+ static func makeDeleteQuery(
+ forService service: String,
+ key: String? = nil,
+ configuration: KeychainBasicQueryConfiguration = KeychainBasicQueryConfiguration()
+ ) -> KeychainQuery {
+ var queryDictionary: [String: Any] = [:]
+ queryDictionary[kSecAttrService as String] = service
+ queryDictionary[kSecClass as String] = configuration.secClass
+
+ if let key = key {
+ queryDictionary[kSecAttrAccount as String] = key
+ }
+
+ return queryDictionary
+ }
+}
diff --git a/KeychainStorage/KeychainStorage.swift b/KeychainStorage/Sources/KeychainStorage/KeychainStorage.swift
similarity index 56%
rename from KeychainStorage/KeychainStorage.swift
rename to KeychainStorage/Sources/KeychainStorage/KeychainStorage.swift
index faada3c..63bb0e0 100644
--- a/KeychainStorage/KeychainStorage.swift
+++ b/KeychainStorage/Sources/KeychainStorage/KeychainStorage.swift
@@ -1,20 +1,12 @@
-//
-// KeychainStorage.swift
-// KeychainStorage
-//
-// Created by Dan, Radu-Ionut (RO - Bucharest) on 25/05/2019.
-// Copyright © 2019 radude89. All rights reserved.
-//
-
import Foundation
import Security
// MARK: - KeychainStorageError
-/// Defines the keychain errors.
+/// An enumeration representing errors that can occur while accessing the Keychain.
///
-/// - unhandledError: Thrown when a keychain operation failed with a given `OSStatus`.
-/// - invalidData: Thrown when the data expected was with an invalid format.
+/// - unhandledError: Thrown when a Keychain operation fails with a specific `OSStatus`.
+/// - invalidData: Thrown when the data received is in an invalid format.
public enum KeychainStorageError: Error {
case unhandledError(OSStatus)
case invalidData
@@ -22,14 +14,14 @@ public enum KeychainStorageError: Error {
// MARK: - KeychainStorage
-/// This class is a wrapper to the Keychain, defined by a service.
-/// All Keychain items are considered generic passwords `kSecClassGenericPassword`.
+/// A class that acts as a wrapper for Keychain operations, associated with a specific service.
+/// All Keychain items are treated as generic passwords, represented by `kSecClassGenericPassword`.
public class KeychainStorage {
- /// Defines the service which all Keychain queries will use.
+ /// The service that will be used for all Keychain queries.
private let service: String
- /// Base class initializer, where the service variable is set.
+ /// Initializes a new instance of `KeychainStorage` with the specified service.
///
/// - Parameter service: The service that will be used for all Keychain queries.
public init(service: String) {
@@ -41,19 +33,18 @@ public class KeychainStorage {
extension KeychainStorage: KeyValueStorage {
- /// Sets a bool value in the Keychain.
+ /// Stores a Boolean value in the Keychain.
///
/// ### Usage Example: ###
- ///
- /// ````
+ /// ```swift
/// let storage = KeychainStorage(service: "com.foo")
/// try storage.set(true, key: "myKey")
- /// ````
+ /// ```
///
/// - Parameters:
- /// - value: The value to be set in the Keychain.
- /// - key: The key we want to put the value.
- /// - Throws: Can throw an `unhandledError` with a status.
+ /// - value: The Boolean value to be stored in the Keychain.
+ /// - key: The key under which the value will be stored.
+ /// - Throws: Throws `KeychainStorageError.unhandledError` if the operation fails.
public func set(_ value: Bool, key: String) throws {
let bytes: [UInt8] = value ? [1] : [0]
let data = Data(bytes)
@@ -61,24 +52,23 @@ extension KeychainStorage: KeyValueStorage {
try set(data, key: key)
}
- /// Sets a data value in the Keychain.
+ /// Stores a Data value in the Keychain.
///
/// ### Usage Example: ###
- ///
- /// ````
+ /// ```swift
/// let data = Data(base64Encoded: "encoded")!
/// let storage = KeychainStorage(service: "com.foo")
/// try storage.set(data, key: "myKey")
- /// ````
+ /// ```
///
/// - Parameters:
- /// - value: The value to be set in the Keychain.
- /// - key: The key we want to put the value.
- /// - Throws: Can throw an `unhandledError` with a status.
+ /// - value: The Data value to be stored in the Keychain.
+ /// - key: The key under which the value will be stored.
+ /// - Throws: Throws `KeychainStorageError.unhandledError` if the operation fails.
public func set(_ value: Data, key: String) throws {
let query = KeychainBasicQueryFactory.makeQuery(forService: service, key: key, value: value)
- // Delete anything that's already there, just in case
+ // Remove any existing item at the specified key to avoid duplication
SecItemDelete(query as CFDictionary)
let status = SecItemAdd(query as CFDictionary, nil)
@@ -88,19 +78,18 @@ extension KeychainStorage: KeyValueStorage {
}
}
- /// Sets a string value in the Keychain.
+ /// Stores a String value in the Keychain.
///
/// ### Usage Example: ###
- ///
- /// ````
+ /// ```swift
/// let storage = KeychainStorage(service: "com.foo")
/// try storage.set("Super secret value", key: "myKey")
- /// ````
+ /// ```
///
/// - Parameters:
- /// - value: The value to be set in the Keychain.
- /// - key: The key we want to put the value.
- /// - Throws: Can throw an `invalidData` storage error or an `unhandledError` with a status.
+ /// - value: The String value to be stored in the Keychain.
+ /// - key: The key under which the value will be stored.
+ /// - Throws: Throws `KeychainStorageError.invalidData` if the value cannot be converted to Data or `KeychainStorageError.unhandledError` if the operation fails.
public func set(_ value: String, key: String) throws {
guard let data = value.data(using: .utf8) else {
throw KeychainStorageError.invalidData
@@ -109,20 +98,19 @@ extension KeychainStorage: KeyValueStorage {
try set(data, key: key)
}
- /// Returns the string value of the given key.
+ /// Retrieves the String value associated with the specified key.
///
/// ### Usage Example: ###
- ///
- /// ````
+ /// ```swift
/// let storage = KeychainStorage(service: "com.foo")
/// if let myValue = try? storage.string(forKey: "myKey") {
- /// // do something with `myValue`
+ /// // Use `myValue`
/// }
- /// ````
+ /// ```
///
- /// - Parameter key: The key we want to search the value.
- /// - Returns: The value of the given key.
- /// - Throws: Can throw errors, for example if data is invalid or if there was a transformation error.
+ /// - Parameter key: The key for which to retrieve the value.
+ /// - Returns: The String value associated with the key, or `nil` if not found.
+ /// - Throws: Throws `KeychainStorageError.invalidData` if the data is invalid or cannot be converted.
public func string(forKey key: String) throws -> String? {
guard let data = try data(forKey: key) else {
return nil
@@ -135,20 +123,19 @@ extension KeychainStorage: KeyValueStorage {
return value
}
- /// Returns the data value of the given key.
+ /// Retrieves the Data value associated with the specified key.
///
/// ### Usage Example: ###
- ///
- /// ````
+ /// ```swift
/// let storage = KeychainStorage(service: "com.foo")
- /// if let myValue = try? data(forKey: "myKey") {
- /// // do something with `myValue`
+ /// if let myValue = try? storage.data(forKey: "myKey") {
+ /// // Use `myValue`
/// }
- /// ````
+ /// ```
///
- /// - Parameter key: The key we want to search the value.
- /// - Returns: The value of the given key.
- /// - Throws: Can throw an `unhandledError` with a status.
+ /// - Parameter key: The key for which to retrieve the value.
+ /// - Returns: The Data value associated with the key, or `nil` if not found.
+ /// - Throws: Throws `KeychainStorageError.unhandledError` if the operation fails.
public func data(forKey key: String) throws -> Data? {
let query = KeychainBasicQueryFactory.makeQuery(forService: service, key: key)
var result: AnyObject?
@@ -163,27 +150,26 @@ extension KeychainStorage: KeyValueStorage {
}
if let resultDictionary = result as? [String: Any],
- let data = resultDictionary[kSecValueData as String] as? Data {
+ let data = resultDictionary[kSecValueData as String] as? Data {
return data
}
return nil
}
- /// Returns the bool value of the given key.
+ /// Retrieves the Boolean value associated with the specified key.
///
/// ### Usage Example: ###
- ///
- /// ````
+ /// ```swift
/// let storage = KeychainStorage(service: "com.foo")
- /// if let myValue = try? bool(forKey: "myKey") {
- /// // do something with `myValue`
+ /// if let myValue = try? storage.bool(forKey: "myKey") {
+ /// // Use `myValue`
/// }
- /// ````
+ /// ```
///
- /// - Parameter key: The key we want to search the value.
- /// - Returns: The value of the given key.
- /// - Throws: Can throw an `unhandledError` with a status.
+ /// - Parameter key: The key for which to retrieve the value.
+ /// - Returns: The Boolean value associated with the key, or `nil` if not found.
+ /// - Throws: Throws `KeychainStorageError.unhandledError` if the operation fails.
public func bool(forKey key: String) throws -> Bool? {
guard let data = try data(forKey: key) else {
return nil
@@ -196,10 +182,10 @@ extension KeychainStorage: KeyValueStorage {
return nil
}
- /// Removes the value at a given key.
+ /// Removes the value associated with the specified key from the Keychain.
///
- /// - Parameter key: The key we want to remove the value.
- /// - Throws: Can throw errors if the operation was unsuccessful.
+ /// - Parameter key: The key for which to remove the value.
+ /// - Throws: Throws `KeychainStorageError.unhandledError` if the operation fails.
public func removeValue(forKey key: String) throws {
let query = KeychainBasicQueryFactory.makeDeleteQuery(forService: service, key: key)
@@ -210,9 +196,9 @@ extension KeychainStorage: KeyValueStorage {
}
}
- /// Removes all values from the storage.
+ /// Removes all values associated with the service from the Keychain.
///
- /// - Throws: Can throw errors if a value failed to be removed from the storage.
+ /// - Throws: Throws `KeychainStorageError.unhandledError` if the operation fails.
public func removeAll() throws {
let query = KeychainBasicQueryFactory.makeDeleteQuery(forService: service)
diff --git a/KeychainStorageTests/KeychainQueryFactoryTests.swift b/KeychainStorage/Tests/KeychainStorageTests/KeychainQueryFactoryTests.swift
similarity index 93%
rename from KeychainStorageTests/KeychainQueryFactoryTests.swift
rename to KeychainStorage/Tests/KeychainStorageTests/KeychainQueryFactoryTests.swift
index 187a08a..7a38af2 100644
--- a/KeychainStorageTests/KeychainQueryFactoryTests.swift
+++ b/KeychainStorage/Tests/KeychainStorageTests/KeychainQueryFactoryTests.swift
@@ -1,11 +1,3 @@
-//
-// KeychainQueryFactoryTests.swift
-// KeychainStorageTests
-//
-// Created by Dan, Radu-Ionut (RO - Bucharest) on 26/05/2019.
-// Copyright © 2019 radude89. All rights reserved.
-//
-
import XCTest
@testable import KeychainStorage
diff --git a/KeychainStorageTests/KeychainStorageTests.swift b/KeychainStorage/Tests/KeychainStorageTests/KeychainStorageTests.swift
similarity index 94%
rename from KeychainStorageTests/KeychainStorageTests.swift
rename to KeychainStorage/Tests/KeychainStorageTests/KeychainStorageTests.swift
index 79de3ee..abfe583 100644
--- a/KeychainStorageTests/KeychainStorageTests.swift
+++ b/KeychainStorage/Tests/KeychainStorageTests/KeychainStorageTests.swift
@@ -1,17 +1,9 @@
-//
-// KeychainStorageTests.swift
-// KeychainStorageTests
-//
-// Created by Dan, Radu-Ionut (RO - Bucharest) on 26/05/2019.
-// Copyright © 2019 radude89. All rights reserved.
-//
-
import XCTest
@testable import KeychainStorage
final class KeychainStorageTests: XCTestCase {
- var sut: KeychainStorage!
+ private var sut: KeychainStorage!
private let service = "com.test.service"
private let key = "test.key"
@@ -134,5 +126,5 @@ final class KeychainStorageTests: XCTestCase {
XCTFail("Thrown error \(error)")
}
}
-
+
}
diff --git a/KeychainStorageHost/AppDelegate.swift b/KeychainStorageHost/AppDelegate.swift
deleted file mode 100644
index f21a037..0000000
--- a/KeychainStorageHost/AppDelegate.swift
+++ /dev/null
@@ -1,43 +0,0 @@
-//
-// AppDelegate.swift
-// KeychainStorageHost
-//
-// Created by Dan, Radu-Ionut (RO - Bucharest) on 26/05/2019.
-// Copyright © 2019 radude89. All rights reserved.
-//
-
-import UIKit
-
-@UIApplicationMain
-class AppDelegate: UIResponder, UIApplicationDelegate {
-
- func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
- // Override point for customization after application launch.
- return true
- }
-
- func applicationWillResignActive(_ application: UIApplication) {
- // Sent when the application is about to move from active to inactive state. This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits the application and it begins the transition to the background state.
- // Use this method to pause ongoing tasks, disable timers, and invalidate graphics rendering callbacks. Games should use this method to pause the game.
- }
-
- func applicationDidEnterBackground(_ application: UIApplication) {
- // Use this method to release shared resources, save user data, invalidate timers, and store enough application state information to restore your application to its current state in case it is terminated later.
- // If your application supports background execution, this method is called instead of applicationWillTerminate: when the user quits.
- }
-
- func applicationWillEnterForeground(_ application: UIApplication) {
- // Called as part of the transition from the background to the active state; here you can undo many of the changes made on entering the background.
- }
-
- func applicationDidBecomeActive(_ application: UIApplication) {
- // Restart any tasks that were paused (or not yet started) while the application was inactive. If the application was previously in the background, optionally refresh the user interface.
- }
-
- func applicationWillTerminate(_ application: UIApplication) {
- // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
- }
-
-
-}
-
diff --git a/KeychainStorageHost/Info.plist b/KeychainStorageHost/Info.plist
deleted file mode 100644
index 9a1a6cb..0000000
--- a/KeychainStorageHost/Info.plist
+++ /dev/null
@@ -1,41 +0,0 @@
-
-
-
-
- CFBundleDevelopmentRegion
- $(DEVELOPMENT_LANGUAGE)
- CFBundleExecutable
- $(EXECUTABLE_NAME)
- CFBundleIdentifier
- $(PRODUCT_BUNDLE_IDENTIFIER)
- CFBundleInfoDictionaryVersion
- 6.0
- CFBundleName
- $(PRODUCT_NAME)
- CFBundlePackageType
- APPL
- CFBundleShortVersionString
- 1.0
- CFBundleVersion
- 1
- LSRequiresIPhoneOS
-
- UIRequiredDeviceCapabilities
-
- armv7
-
- UISupportedInterfaceOrientations
-
- UIInterfaceOrientationPortrait
- UIInterfaceOrientationLandscapeLeft
- UIInterfaceOrientationLandscapeRight
-
- UISupportedInterfaceOrientations~ipad
-
- UIInterfaceOrientationPortrait
- UIInterfaceOrientationPortraitUpsideDown
- UIInterfaceOrientationLandscapeLeft
- UIInterfaceOrientationLandscapeRight
-
-
-
diff --git a/KeychainStorageHostApp/AppDelegate.swift b/KeychainStorageHostApp/AppDelegate.swift
deleted file mode 100644
index 773621d..0000000
--- a/KeychainStorageHostApp/AppDelegate.swift
+++ /dev/null
@@ -1,18 +0,0 @@
-//
-// AppDelegate.swift
-// KeychainStorageHostApp
-//
-// Created by Dan, Radu-Ionut (RO - Bucharest) on 10/07/2019.
-//
-
-import UIKit
-
-@UIApplicationMain
-class AppDelegate: UIResponder, UIApplicationDelegate {
-
- func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
- // Override point for customization after application launch.
- return true
- }
-
-}
diff --git a/KeychainStorageHostApp/Info.plist b/KeychainStorageHostApp/Info.plist
deleted file mode 100644
index e1ab737..0000000
--- a/KeychainStorageHostApp/Info.plist
+++ /dev/null
@@ -1,37 +0,0 @@
-
-
-
-
- CFBundleDevelopmentRegion
- $(DEVELOPMENT_LANGUAGE)
- CFBundleExecutable
- $(EXECUTABLE_NAME)
- CFBundleIdentifier
- $(PRODUCT_BUNDLE_IDENTIFIER)
- CFBundleInfoDictionaryVersion
- 6.0
- CFBundleName
- $(PRODUCT_NAME)
- CFBundlePackageType
- APPL
- CFBundleShortVersionString
- 1.0
- CFBundleVersion
- 1
- LSRequiresIPhoneOS
-
- UIRequiredDeviceCapabilities
-
- armv7
-
- UISupportedInterfaceOrientations
-
- UISupportedInterfaceOrientations~ipad
-
- UIInterfaceOrientationPortrait
- UIInterfaceOrientationPortraitUpsideDown
- UIInterfaceOrientationLandscapeLeft
- UIInterfaceOrientationLandscapeRight
-
-
-
diff --git a/KeychainStorageTests/Info.plist b/KeychainStorageTests/Info.plist
deleted file mode 100644
index 6c40a6c..0000000
--- a/KeychainStorageTests/Info.plist
+++ /dev/null
@@ -1,22 +0,0 @@
-
-
-
-
- CFBundleDevelopmentRegion
- $(DEVELOPMENT_LANGUAGE)
- CFBundleExecutable
- $(EXECUTABLE_NAME)
- CFBundleIdentifier
- $(PRODUCT_BUNDLE_IDENTIFIER)
- CFBundleInfoDictionaryVersion
- 6.0
- CFBundleName
- $(PRODUCT_NAME)
- CFBundlePackageType
- BNDL
- CFBundleShortVersionString
- 1.0
- CFBundleVersion
- 1
-
-
diff --git a/Package.swift b/Package.swift
deleted file mode 100644
index fe3b85c..0000000
--- a/Package.swift
+++ /dev/null
@@ -1,30 +0,0 @@
-// swift-tools-version:5.0
-// The swift-tools-version declares the minimum version of Swift required to build this package.
-
-import PackageDescription
-
-let package = Package(
- name: "KeychainStorage",
- products: [
- // Products define the executables and libraries produced by a package, and make them visible to other packages.
- .library(
- name: "KeychainStorage",
- targets: ["KeychainStorage"]),
- ],
- dependencies: [
- // Dependencies declare other packages that this package depends on.
- // .package(url: /* package url */, from: "1.0.0"),
- ],
- targets: [
- // Targets are the basic building blocks of a package. A target can define a module or a test suite.
- // Targets can depend on other targets in this package, and on products in packages which this package depends on.
- .target(
- name: "KeychainStorage",
- dependencies: [],
- path: "KeychainStorage"),
- .testTarget(
- name: "KeychainStorageTests",
- dependencies: ["KeychainStorage"],
- path: "KeychainStorageTests"),
- ]
-)
diff --git a/README.md b/README.md
index 17a6817..976c314 100644
--- a/README.md
+++ b/README.md
@@ -2,85 +2,59 @@
- 
-
- 
+ 
+
-
- 
-
-
- 
-
- 
-
- 
-
+
-Keychain Storage is a simple Keychain wrapper written in Swift.
-If you ever wanted to save something in Keychain without writing too much code, you are in the right place.
+
+Keychain Storage is a simple Keychain wrapper written in Swift. If you’ve ever wanted to save something in the Keychain without writing excessive code, you’ve come to the right place!
## Requirements
-- iOS 12.0+
-- Xcode 10.2+
-- Swift 5+
+- iOS 18.0+
+- Xcode 16.0+
+- Swift 6+
## Installation
-### Cocoa Pods
-
-[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Keychain Storage into your Xcode project using CocoaPods, specify it in your `Podfile`:
-
-```ruby
-pod 'KeychainStorage', '~> 1.3.0'
-```
-
-### Carthage
-
-[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate KeychainStorage into your Xcode project using Carthage, specify it in your `Cartfile`:
-
-```ogdl
-github "radude89/KeychainStorage" "1.3.0"
-```
-
### Swift Package Manager
-The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
+The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code, integrated into the `swift` compiler.
-Once you have your Swift package set up, you can add KeychainStorage as a dependency by adding it to the `dependencies` array of your `Package.swift`.
+To add KeychainStorage as a dependency, include it in the `dependencies` array of your `Package.swift` file:
```swift
dependencies: [
- .package(url: "https://github.com/radude89/KeychainStorage.git", from: "1.0.0")
+ .package(url: "https://github.com/radude89/KeychainStorage.git", from: "2.0.0")
]
```
-### Manual
+## Manual Installation
+
+For manual installation, simply drag and drop the following files into your project from the `KeychainStorage` directory:
-Just drag and drop into your project the following projects found in `KeychainStorage`:
- `KeychainQueryFactory.swift`
- `KeychainStorage.swift`
- `KeyValueStorage.swift`
## Examples
-Make sure you try out the small app, the example project found at: `Example/KeychainStorageExample.xcworkspace`.
Build & run.
+Make sure to explore the small app included in the example project found at `Example/KeychainStorageExample.xcworkspace`. Build and run the project to see it in action.
-### Saving a value in Keychain
+### Saving a Value in the Keychain
```swift
import KeychainStorage
let storage = KeychainStorage(service: "com.test.service")
try? storage.set("secret", key: "myStringKey")
-
try? storage.set(true, key: "myBoolKey")
```
-### Retrieving a value from Keychain
+### Retrieving a Value from the Keychain
```swift
import KeychainStorage
@@ -88,15 +62,15 @@ import KeychainStorage
let storage = KeychainStorage(service: "com.test.service")
if let myStringValue = try? storage.string(forKey: "myStringKey") {
- // do something with myStringValue
+ // Do something with myStringValue
}
if let myBoolValue = try? storage.bool(forKey: "myBoolKey") {
- // do something with myBoolValue
+ // Do something with myBoolValue
}
```
-### Deleting a value from Keychain
+### Deleting a Value from the Keychain
```swift
import KeychainStorage
@@ -105,7 +79,7 @@ let storage = KeychainStorage(service: "com.test.service")
try? storage.removeValue(forKey: "myStringKey")
```
-### Deleting all values from Keychain
+### Deleting All Values from the Keychain
```swift
import KeychainStorage
@@ -113,6 +87,7 @@ import KeychainStorage
let storage = KeychainStorage(service: "com.test.service")
try? storage.removeAll()
```
+
## License
KeychainStorage is released under the MIT license. [See LICENSE](https://github.com/radude89/KeychainStorage/blob/master/LICENSE) for details.