Merge pull request #1079 from WalletConnect/feature/clienid-from-defa…

…ults [Core] ClientID public and private part
WalletConnect · Oct 9, 2023 · c17686e · c17686e
2 parents 9bab50d + 4fd6d9b
commit c17686e
Show file tree

Hide file tree

Showing 18 changed files with 174 additions and 39 deletions.
diff --git a/Example/ExampleApp.xcodeproj/IntegrationTests.xctestplan b/Example/ExampleApp.xcodeproj/IntegrationTests.xctestplan
@@ -53,6 +53,7 @@
         "AuthTests\/testEIP1271RespondSuccess()",
         "ChatTests",
         "ENSResolverTests",
+        "HistoryTests",
         "SyncDerivationServiceTests",
         "SyncTests"
       ],

diff --git a/Example/IntegrationTests/Chat/ChatTests.swift b/Example/IntegrationTests/Chat/ChatTests.swift
@@ -74,7 +74,9 @@ final class ChatTests: XCTestCase {
         let historyClient = HistoryClientFactory.create(
             historyUrl: "https://history.walletconnect.com",
             relayUrl: "wss://relay.walletconnect.com",
-            keychain: keychain
+            keyValueStorage: keyValueStorage,
+            keychain: keychain,
+            logger: logger
         )
 
         let clientId = try! networkingInteractor.getClientId()

diff --git a/Example/IntegrationTests/History/HistoryTests.swift b/Example/IntegrationTests/History/HistoryTests.swift
@@ -18,9 +18,11 @@ final class HistoryTests: XCTestCase {
     override func setUp() {
         let keychain1 = KeychainStorageMock()
         let keychain2 = KeychainStorageMock()
+        let logger1 = ConsoleLoggerMock()
+        let defaults1 = RuntimeKeyValueStorage()
         relayClient1 = makeRelayClient(prefix: "🐄", keychain: keychain1)
         relayClient2 = makeRelayClient(prefix: "🐫", keychain: keychain2)
-        historyClient = makeHistoryClient(keychain: keychain1)
+        historyClient = makeHistoryClient(defaults: defaults1, keychain: keychain1, logger: logger1)
     }
 
     private func makeRelayClient(prefix: String, keychain: KeychainStorageProtocol) -> RelayClient {
@@ -33,8 +35,8 @@ final class HistoryTests: XCTestCase {
             logger: ConsoleLogger(prefix: prefix + " [Relay]", loggingLevel: .debug))
     }
 
-    private func makeHistoryClient(keychain: KeychainStorageProtocol) -> HistoryNetworkService {
-        let clientIdStorage = ClientIdStorage(keychain: keychain)
+    private func makeHistoryClient(defaults: KeyValueStorage, keychain: KeychainStorageProtocol, logger: ConsoleLogging) -> HistoryNetworkService {
+        let clientIdStorage = ClientIdStorage(defaults: defaults, keychain: keychain, logger: logger)
         return HistoryNetworkService(clientIdStorage: clientIdStorage)
     }
 

diff --git a/Example/IntegrationTests/Pairing/PairingTests.swift b/Example/IntegrationTests/Pairing/PairingTests.swift
@@ -78,11 +78,14 @@ final class PairingTests: XCTestCase {
         let prefix = "🐶 Wallet: "
         let (pairingClient, networkingInteractor, keychain, keyValueStorage) = makeClientDependencies(prefix: prefix)
         let notifyLogger = ConsoleLogger(prefix: prefix + " [Notify]", loggingLevel: .debug)
+        let defaults = RuntimeKeyValueStorage()
         walletPairingClient = pairingClient
         let historyClient = HistoryClientFactory.create(
             historyUrl: "https://history.walletconnect.com",
             relayUrl: "wss://relay.walletconnect.com",
-            keychain: keychain
+            keyValueStorage: defaults,
+            keychain: keychain,
+            logger: notifyLogger
         )
         appAuthClient = AuthClientFactory.create(
             metadata: AppMetadata(name: name, description: "", url: "", icons: [""]),

diff --git a/Example/IntegrationTests/Push/NotifyTests.swift b/Example/IntegrationTests/Push/NotifyTests.swift
@@ -70,6 +70,7 @@ final class NotifyTests: XCTestCase {
         let notifyLogger = ConsoleLogger(prefix: prefix + " [Notify]", loggingLevel: .debug)
         let pushClient = PushClientFactory.create(projectId: "",
                                                   pushHost: "echo.walletconnect.com",
+                                                  keyValueStorage: keyValueStorage,
                                                   keychainStorage: keychain,
                                                   environment: .sandbox)
         let keyserverURL = URL(string: "https://keys.walletconnect.com")!

diff --git a/Example/RelayIntegrationTests/RelayClientEndToEndTests.swift b/Example/RelayIntegrationTests/RelayClientEndToEndTests.swift
@@ -31,7 +31,9 @@ final class RelayClientEndToEndTests: XCTestCase {
     private var publishers = Set<AnyCancellable>()
 
     func makeRelayClient(prefix: String) -> RelayClient {
-        let clientIdStorage = ClientIdStorage(keychain: KeychainStorageMock())
+        let keyValueStorage = RuntimeKeyValueStorage()
+        let logger = ConsoleLogger(prefix: prefix, loggingLevel: .debug)
+        let clientIdStorage = ClientIdStorage(defaults: keyValueStorage, keychain: KeychainStorageMock(), logger: logger)
         let socketAuthenticator = ClientIdAuthenticator(
             clientIdStorage: clientIdStorage,
             url: InputConfig.relayUrl
@@ -43,15 +45,13 @@ final class RelayClientEndToEndTests: XCTestCase {
         )
         let socket = WebSocket(url: urlFactory.create(fallback: false))
         let webSocketFactory = WebSocketFactoryMock(webSocket: socket)
-        let logger = ConsoleLogger(prefix: prefix, loggingLevel: .debug)
         let dispatcher = Dispatcher(
             socketFactory: webSocketFactory,
             relayUrlFactory: urlFactory,
             socketConnectionType: .manual,
             logger: logger
         )
         let keychain = KeychainStorageMock()
-        let keyValueStorage = RuntimeKeyValueStorage()
         let relayClient = RelayClientFactory.create(
             relayHost: InputConfig.relayHost,
             projectId: InputConfig.projectId,

diff --git a/Sources/WalletConnectHistory/HistoryClientFactory.swift b/Sources/WalletConnectHistory/HistoryClientFactory.swift
@@ -4,15 +4,19 @@ class HistoryClientFactory {
 
     static func create() -> HistoryClient {
         let keychain = KeychainStorage(serviceIdentifier: "com.walletconnect.sdk")
+        let keyValueStorage = UserDefaults.standard
+        let logger = ConsoleLogger()
         return HistoryClientFactory.create(
             historyUrl: "https://history.walletconnect.com",
             relayUrl: "wss://relay.walletconnect.com",
-            keychain: keychain
+            keyValueStorage: keyValueStorage,
+            keychain: keychain,
+            logger: logger
         )
     }
 
-    static func create(historyUrl: String, relayUrl: String, keychain: KeychainStorageProtocol) -> HistoryClient {
-        let clientIdStorage = ClientIdStorage(keychain: keychain)
+    static func create(historyUrl: String, relayUrl: String, keyValueStorage: KeyValueStorage, keychain: KeychainStorageProtocol, logger: ConsoleLogging) -> HistoryClient {
+        let clientIdStorage = ClientIdStorage(defaults: keyValueStorage, keychain: keychain, logger: logger)
         let kms = KeyManagementService(keychain: keychain)
         let serializer = Serializer(kms: kms, logger: ConsoleLogger(prefix: "🔐", loggingLevel: .off))
         let historyNetworkService = HistoryNetworkService(clientIdStorage: clientIdStorage)

diff --git a/Sources/WalletConnectJWT/JSONEncoder+JWT.swift b/Sources/WalletConnectJWT/JSONEncoder+JWT.swift
@@ -0,0 +1,11 @@
+import Foundation
+
+extension JSONEncoder {
+
+    public static var jwt: JSONEncoder {
+        let jsonEncoder = JSONEncoder()
+        jsonEncoder.outputFormatting = .withoutEscapingSlashes
+        jsonEncoder.dateEncodingStrategy = .secondsSince1970
+        return jsonEncoder
+    }
+}
diff --git a/Sources/WalletConnectJWT/JWT.swift b/Sources/WalletConnectJWT/JWT.swift
@@ -7,12 +7,12 @@ struct JWT<JWTClaims: JWTEncodable>: Codable, Equatable {
     let signature: String
     let string: String
 
-    init(claims: JWTClaims, signer: JWTSigning) throws {
+    init(claims: JWTClaims, signer: JWTSigning, jsonEncoder: JSONEncoder = .jwt) throws {
         self.header = JWTHeader(alg: signer.alg)
         self.claims = claims
 
-        let headerString = try header.encode()
-        let claimsString = try claims.encode()
+        let headerString = try header.encode(jsonEncoder: jsonEncoder)
+        let claimsString = try claims.encode(jsonEncoder: jsonEncoder)
         let signature = try signer.sign(header: headerString, claims: claimsString)
 
         self.signature = signature

diff --git a/Sources/WalletConnectJWT/JWTEncodable.swift b/Sources/WalletConnectJWT/JWTEncodable.swift
@@ -1,17 +1,14 @@
 import Foundation
 
 public protocol JWTEncodable: Codable, Equatable {
-    func encode() throws -> String
+    func encode(jsonEncoder: JSONEncoder) throws -> String
 
     static func decode(from string: String) throws -> Self
 }
 
 extension JWTEncodable {
 
-    public func encode() throws -> String {
-        let jsonEncoder = JSONEncoder()
-        jsonEncoder.outputFormatting = .withoutEscapingSlashes
-        jsonEncoder.dateEncodingStrategy = .secondsSince1970
+    public func encode(jsonEncoder: JSONEncoder) throws -> String {
         let data = try jsonEncoder.encode(self)
         return JWTEncoder.base64urlEncodedString(data: data)
     }

diff --git a/Sources/WalletConnectPush/PushClientFactory.swift b/Sources/WalletConnectPush/PushClientFactory.swift
@@ -6,17 +6,20 @@ public struct PushClientFactory {
                               environment: APNSEnvironment) -> PushClient {
 
         let keychainStorage = KeychainStorage(serviceIdentifier: "com.walletconnect.sdk")
+        let keyValueStorage = UserDefaults.standard
 
         return PushClientFactory.create(
             projectId: projectId,
             pushHost: pushHost,
+            keyValueStorage: keyValueStorage,
             keychainStorage: keychainStorage,
             environment: environment)
     }
 
     public static func create(
         projectId: String,
         pushHost: String,
+        keyValueStorage: KeyValueStorage,
         keychainStorage: KeychainStorageProtocol,
         environment: APNSEnvironment
     ) -> PushClient {
@@ -28,7 +31,7 @@ public struct PushClientFactory {
         let logger = ConsoleLogger(prefix: "👂🏻", loggingLevel: .off)
         let httpClient = HTTPNetworkClient(host: pushHost, session: session)
 
-        let clientIdStorage = ClientIdStorage(keychain: keychainStorage)
+        let clientIdStorage = ClientIdStorage(defaults: keyValueStorage, keychain: keychainStorage, logger: logger)
 
         let pushAuthenticator = PushAuthenticator(clientIdStorage: clientIdStorage, pushHost: pushHost)
 

diff --git a/Sources/WalletConnectRelay/ClientAuth/ClientIdStorage.swift b/Sources/WalletConnectRelay/ClientAuth/ClientIdStorage.swift
@@ -6,26 +6,89 @@ public protocol ClientIdStoring {
 }
 
 public struct ClientIdStorage: ClientIdStoring {
-    private let key = "com.walletconnect.iridium.client_id"
+    private let oldStorageKey = "com.walletconnect.iridium.client_id"
+    private let publicStorageKey = "com.walletconnect.iridium.client_id.public"
+
+    private let defaults: KeyValueStorage
     private let keychain: KeychainStorageProtocol
+    private let logger: ConsoleLogging
 
-    public init(keychain: KeychainStorageProtocol) {
+    public init(defaults: KeyValueStorage, keychain: KeychainStorageProtocol, logger: ConsoleLogging) {
+        self.defaults = defaults
         self.keychain = keychain
+        self.logger = logger
+
+        migrateIfNeeded()
     }
 
     public func getOrCreateKeyPair() throws -> SigningPrivateKey {
         do {
-            return try keychain.read(key: key)
+            let publicPart = try getPublicPart()
+            return try getPrivatePart(for: publicPart)
         } catch {
             let privateKey = SigningPrivateKey()
-            try keychain.add(privateKey, forKey: key)
+            try setPrivatePart(privateKey)
+            setPublicPart(privateKey.publicKey)
             return privateKey
         }
     }
 
     public func getClientId() throws -> String {
-        let privateKey: SigningPrivateKey = try keychain.read(key: key)
-        let pubKey = privateKey.publicKey.rawRepresentation
-        return DIDKey(rawData: pubKey).did(variant: .ED25519)
+        let pubKey = try getPublicPart()
+        let _ = try getPrivatePart(for: pubKey)
+        return DIDKey(rawData: pubKey.rawRepresentation).did(variant: .ED25519)
+    }
+}
+
+private extension ClientIdStorage {
+
+    enum Errors: Error {
+        case publicPartNotFound
+        case privatePartNotFound
+    }
+
+    func migrateIfNeeded() {
+        guard let privateKey: SigningPrivateKey = try? keychain.read(key: oldStorageKey) else {
+            return
+        }
+
+        do {
+            try setPrivatePart(privateKey)
+            setPublicPart(privateKey.publicKey)
+            try keychain.delete(key: oldStorageKey)
+            logger.debug("ClientID migrated")
+        } catch {
+            logger.debug("ClientID migration failed with: \(error.localizedDescription)")
+        }
+    }
+
+    func getPublicPart() throws -> SigningPublicKey {
+        guard let data = defaults.data(forKey: publicStorageKey) else {
+            throw Errors.publicPartNotFound
+        }
+        return try SigningPublicKey(rawRepresentation: data)
+    }
+
+    func setPublicPart(_ newValue: SigningPublicKey) {
+        defaults.set(newValue.rawRepresentation, forKey: publicStorageKey)
+    }
+
+    func getPrivatePart(for publicPart: SigningPublicKey) throws -> SigningPrivateKey {
+        do {
+            return try keychain.read(key: publicPart.storageId)
+        } catch {
+            throw Errors.privatePartNotFound
+        }
+    }
+
+    func setPrivatePart(_ newValue: SigningPrivateKey) throws {
+        try keychain.add(newValue, forKey: newValue.publicKey.storageId)
+    }
+}
+
+private extension SigningPublicKey {
+
+    var storageId: String {
+        return rawRepresentation.sha256().toHexString()
     }
 }
diff --git a/Sources/WalletConnectRelay/RelayClientFactory.swift b/Sources/WalletConnectRelay/RelayClientFactory.swift
@@ -39,7 +39,7 @@ public struct RelayClientFactory {
         logger: ConsoleLogging
     ) -> RelayClient {
 
-        let clientIdStorage = ClientIdStorage(keychain: keychainStorage)
+        let clientIdStorage = ClientIdStorage(defaults: keyValueStorage, keychain: keychainStorage, logger: logger)
 
         let socketAuthenticator = ClientIdAuthenticator(
             clientIdStorage: clientIdStorage,

diff --git a/Tests/CommonsTests/AnyCodableTests.swift b/Tests/CommonsTests/AnyCodableTests.swift
@@ -28,7 +28,7 @@ private struct SampleStruct: Codable, Equatable {
         SampleStruct(
             bool: true,
             int: 1337,
-            double: 13.37,
+            double: 13,
             string: "verystringwow",
             object: SubObject(
                 string: "0xdeadbeef"
@@ -40,7 +40,7 @@ private struct SampleStruct: Codable, Equatable {
 {
     "bool": true,
     "int": 1337,
-    "double": 13.37,
+    "double": 13,
     "string": "verystringwow",
     "object": {
         "string": "0xdeadbeef"
@@ -52,7 +52,7 @@ private struct SampleStruct: Codable, Equatable {
 {
     "bool": ****,
     "int": 1337,
-    "double": 13.37,
+    "double": 13,
     "string": "verystringwow",
 }
 """.data(using: .utf8)!