Migrate to SwiftKeychain v2.1.0

Author: DominikPalo

.swift-version

@@ -1 +1 @@
-5.3
+5.5.3

OAuth2.xcodeproj/project.pbxproj

@@ -1240,8 +1240,8 @@
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/slidoapp/SwiftKeychain";
 			requirement = {
-				branch = master;
-				kind = branch;
+				kind = upToNextMinorVersion;
+				minimumVersion = 2.1.0;
 			};
 		};
 /* End XCRemoteSwiftPackageReference section */

OAuth2.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -30,7 +30,7 @@ let package = Package(
 		.library(name: "OAuth2", targets: ["OAuth2"]),
 	],
 	dependencies: [
-		.package(url: "https://github.com/slidoapp/SwiftKeychain.git", branch: "master"),
+		.package(url: "https://github.com/slidoapp/SwiftKeychain.git", .upToNextMinor(from: "2.1.0")),
 	],
 	targets: [
 		.target(name: "OAuth2",

Package.resolved

@@ -208,18 +208,26 @@ open class OAuth2Base: OAuth2Securable {
 		return authURL.description
 	}
 
-	override open func updateFromKeychainItems(_ items: [String: Any]) {
+	override open func updateFromKeychainItems(_ items: [String: any Sendable]) {
 		for message in clientConfig.updateFromStorableItems(items) {
 			logger?.debug("OAuth2", msg: message)
 		}
 		clientConfig.secretInBody = (clientConfig.endpointAuthMethod == OAuth2EndpointAuthMethod.clientSecretPost)
 	}
 
-	override open func storableCredentialItems() -> [String: Any]? {
+	override open func storableCredentialClasses() -> [AnyClass] {
+		return clientConfig.storableCredentialClasses()
+	}
+	
+	override open func storableCredentialItems() -> [String: any Sendable]? {
 		return clientConfig.storableCredentialItems()
 	}
 
-	override open func storableTokenItems() -> [String: Any]? {
+	override open func storableTokenClasses() -> [AnyClass] {
+		return clientConfig.storableTokenClasses()
+	}
+	
+	override open func storableTokenItems() -> [String: any Sendable]? {
 		return clientConfig.storableTokenItems()
 	}
 

Package.swift

@@ -204,6 +204,15 @@ open class OAuth2ClientConfig {
 		}
 	}
 
+	/**
+	Enumerates all classes used for storing credential items.
+	
+	- returns: An array containing all classes used for storing credential items
+	*/
+	func storableCredentialClasses() -> [AnyClass] {
+		return []
+	}
+	
 	/**
 	Creates a dictionary of credential items that can be stored to the keychain.
 
@@ -220,6 +229,15 @@ open class OAuth2ClientConfig {
 		return items
 	}
 
+	/**
+	Enumerates all classes used for storing token items.
+	
+	- returns: An array containing all classes used for storing token items
+	*/
+	func storableTokenClasses() -> [AnyClass] {
+		return [NSDate.self]
+	}
+	
 	/**
 	Creates a dictionary of token items that can be stored to the keychain.
 

Sources/Base/OAuth2Base.swift

@@ -37,6 +37,9 @@ struct OAuth2KeychainAccount: KeychainGenericPasswordType {
 	/// Data that ends up in the keychain.
 	var data = KeychainData()
 
+	/// Classes to store in the keychain.
+	var storedClasses: [AnyClass]
+	
 	/// Keychain access mode.
 	let accessMode: String
 
@@ -47,13 +50,15 @@ struct OAuth2KeychainAccount: KeychainGenericPasswordType {
 	- parameter oauth2:  The OAuth2 instance from which to retrieve settings
 	- parameter account: The account name to use
 	- parameter data:    Data that we want to store to the keychain
+	- parameter classes: Classes to store in the keychain
 	*/
-	init(oauth2: OAuth2Securable, account: String, data inData: [String: Any] = [:]) {
+	init(oauth2: OAuth2Securable, account: String, data inData: KeychainData = [:], classes: [AnyClass] = []) {
 		serviceName = oauth2.keychainServiceName()
 		accountName = account
 		accessMode = String(oauth2.keychainAccessMode)
 		accessGroup = oauth2.keychainAccessGroup
 		data = inData
+		storedClasses = classes
 	}
 }
 

Sources/Base/OAuth2ClientConfig.swift

@@ -113,7 +113,7 @@ open class OAuth2Securable: OAuth2Requestable {
 		logger?.debug("OAuth2", msg: "Looking for items in keychain")
 
 		do {
-			var creds = OAuth2KeychainAccount(oauth2: self, account: keychainAccountForClientCredentials)
+			var creds = OAuth2KeychainAccount(oauth2: self, account: keychainAccountForClientCredentials, classes: storableCredentialClasses())
 			let creds_data = try creds.fetchedFromKeychain()
 			updateFromKeychainItems(creds_data)
 			logger?.trace("OAuth2", msg: "Client credentials updated from keychain: \(creds_data)")
@@ -123,7 +123,7 @@ open class OAuth2Securable: OAuth2Requestable {
 		}
 
 		do {
-			var toks = OAuth2KeychainAccount(oauth2: self, account: keychainAccountForTokens)
+			var toks = OAuth2KeychainAccount(oauth2: self, account: keychainAccountForTokens, classes: storableTokenClasses())
 			let toks_data = try toks.fetchedFromKeychain()
 			updateFromKeychainItems(toks_data)
 			logger?.trace("OAuth2", msg: "Tokens updated from keychain: \(toks_data)")
@@ -134,23 +134,27 @@ open class OAuth2Securable: OAuth2Requestable {
 	}
 
 	/** Updates instance properties according to the items found in the given dictionary, which was found in the keychain. */
-	func updateFromKeychainItems(_ items: [String: Any]) {
+	func updateFromKeychainItems(_ items: [String: any Sendable]) {
+	}
+	
+	open func storableCredentialClasses() -> [AnyClass] {
+		return []
 	}
 
 	/**
 	Items that should be stored when storing client credentials.
 
 	- returns: A dictionary with `String` keys and `Any` items
 	*/
-	open func storableCredentialItems() -> [String: Any]? {
+	open func storableCredentialItems() -> [String: any Sendable]? {
 		return nil
 	}
 
 	/** Stores our client credentials in the keychain. */
 	open func storeClientToKeychain() {
 		if let items = storableCredentialItems() {
 			logger?.debug("OAuth2", msg: "Storing client credentials to keychain")
-			let keychain = OAuth2KeychainAccount(oauth2: self, account: keychainAccountForClientCredentials, data: items)
+			let keychain = OAuth2KeychainAccount(oauth2: self, account: keychainAccountForClientCredentials, data: items, classes: storableCredentialClasses())
 			do {
 				try keychain.saveInKeychain()
 				logger?.trace("OAuth2", msg: "Client credentials stored to keychain: \(items)")
@@ -161,20 +165,24 @@ open class OAuth2Securable: OAuth2Requestable {
 		}
 	}
 
+	open func storableTokenClasses() -> [AnyClass] {
+		return []
+	}
+	
 	/**
 	Items that should be stored when tokens are stored to the keychain.
 
 	- returns: A dictionary with `String` keys and `Any` items
 	*/
-	open func storableTokenItems() -> [String: Any]? {
+	open func storableTokenItems() -> [String: any Sendable]? {
 		return nil
 	}
 
 	/** Stores our current token(s) in the keychain. */
 	public func storeTokensToKeychain() {
 		if let items = storableTokenItems() {
 			logger?.debug("OAuth2", msg: "Storing tokens to keychain")
-			let keychain = OAuth2KeychainAccount(oauth2: self, account: keychainAccountForTokens, data: items)
+			let keychain = OAuth2KeychainAccount(oauth2: self, account: keychainAccountForTokens, data: items, classes: storableTokenClasses())
 			do {
 				try keychain.saveInKeychain()
 				logger?.trace("OAuth2", msg: "Tokens stored to keychain: \(items)")