import PromiseKit // TODO: Test path snodes as well /// See the "Onion Requests" section of [The Session Whitepaper](https://arxiv.org/pdf/2002.04609.pdf) for more information. internal enum OnionRequestAPI { private static let urlSession = URLSession(configuration: .ephemeral, delegate: urlSessionDelegate, delegateQueue: nil) private static let urlSessionDelegate = URLSessionDelegateImplementation() internal static var guardSnodes: Set = [] internal static var paths: Set = [] /// - Note: Exposed for testing purposes. internal static let workQueue = DispatchQueue(label: "OnionRequestAPI.workQueue", qos: .userInitiated) // MARK: Settings private static let guardSnodeCount: UInt = 3 private static let pathCount: UInt = 3 /// The number of snodes (including the guard snode) in a path. private static let pathSize: UInt = 3 private static let timeout: TimeInterval = 20 // MARK: URL Session Delegate Implementation private final class URLSessionDelegateImplementation : NSObject, URLSessionDelegate { func urlSession(_ session: URLSession, didReceive challenge: URLAuthenticationChallenge, completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) { // Snode to snode communication uses self-signed certificates but clients can safely ignore this completionHandler(.useCredential, URLCredential(trust: challenge.protectionSpace.serverTrust!)) } } // MARK: Error internal enum Error : LocalizedError { case generic case insufficientSnodes case invalidJSON case randomDataGenerationFailed case snodePublicKeySetMissing var errorDescription: String? { switch self { case .generic: return "An error occurred." case .insufficientSnodes: return "Couldn't find enough snodes to build a path." case .invalidJSON: return "Invalid JSON." case .randomDataGenerationFailed: return "Couldn't generate random data." case .snodePublicKeySetMissing: return "Missing snode public key set." } } } // MARK: Path internal typealias Path = [LokiAPITarget] // MARK: Private API /// Tests the given snode. The returned promise errors out if the snode is faulty; the promise is fulfilled otherwise. private static func testSnode(_ snode: LokiAPITarget) -> Promise { let (promise, seal) = Promise.pending() let queue = DispatchQueue(label: UUID().uuidString, qos: .userInitiated) // No need to block the work queue for this queue.async { print("[Loki] [Onion Request API] Testing snode: \(snode).") let hexEncodedPublicKey = getUserHexEncodedPublicKey() let parameters: JSON = [ "pubKey" : hexEncodedPublicKey ] let timeout: TimeInterval = 6 // Use a shorter timeout for testing // TODO: Move LokiAPI away from using TSNetworkManager so that we can be smarter about threading LokiAPI.invoke(.getSwarm, on: snode, associatedWith: hexEncodedPublicKey, parameters: parameters, timeout: timeout).done(on: queue) { _ in seal.fulfill(()) }.catch { error in seal.reject(error) } } return promise } /// Finds `guardSnodeCount` guard snodes to use for path building. The returned promise errors out with `Error.insufficientSnodes` /// if not enough (reliable) snodes are available. private static func getGuardSnodes() -> Promise> { if !guardSnodes.isEmpty { return Promise> { $0.fulfill(guardSnodes) } } else { print("[Loki] [Onion Request API] Populating guard snode cache.") return LokiAPI.getRandomSnode().then(on: workQueue) { _ -> Promise> in // Just used to populate the snode pool let snodePool = LokiAPI.randomSnodePool guard !snodePool.isEmpty else { throw Error.insufficientSnodes } var result: Set = [] // Sync on DispatchQueue.global() func getGuardSnode() -> Promise { // randomElement() uses the system's default random generator, which is cryptographically secure guard let candidate = snodePool.randomElement() else { return Promise { $0.reject(Error.insufficientSnodes) } } // Loop until a reliable guard snode is found return testSnode(candidate).map(on: workQueue) { candidate }.recover(on: workQueue) { _ in getGuardSnode() } } func getAndStoreGuardSnode() -> Promise { return getGuardSnode().then(on: workQueue) { guardSnode -> Promise in if !result.contains(guardSnode) { result.insert(guardSnode) return Promise { $0.fulfill(guardSnode) } } else { return getAndStoreGuardSnode() } } } let promises = (0.. Promise> { print("[Loki] [Onion Request API] Building onion request paths.") return LokiAPI.getRandomSnode().then(on: workQueue) { _ -> Promise> in // Just used to populate the snode pool let snodePool = LokiAPI.randomSnodePool return getGuardSnodes().map(on: workQueue) { guardSnodes in var unusedSnodes = snodePool.subtracting(guardSnodes) let minSnodeCount = guardSnodeCount * pathSize - guardSnodeCount guard unusedSnodes.count >= minSnodeCount else { throw Error.insufficientSnodes } let result: Set = Set(guardSnodes.map { guardSnode in // Force unwrapping is safe because of the minSnodeCount check above // randomElement() uses the system's default random generator, which is cryptographically secure let result = [ guardSnode ] + (0..<(pathSize - 1)).map { _ in unusedSnodes.randomElement()! } print("[Loki] [Onion Request API] Built new onion request path: \(result.prettifiedDescription).") return result }) return result } } } /// Returns a `Path` to be used for building an onion request. Builds new paths as needed. private static func getPath() -> Promise { // TODO: Handle potential race condition on paths // randomElement() uses the system's default random generator, which is cryptographically secure if paths.count >= pathCount { return Promise { $0.fulfill(paths.randomElement()!) } } else { return buildPaths().map(on: workQueue) { paths in let path = paths.randomElement()! OnionRequestAPI.paths = paths return path } } } /// Builds an onion around `payload` and returns the result. private static func buildOnion(around payload: Data, targetedAt snode: LokiAPITarget) -> Promise<(guardSnode: LokiAPITarget, onion: Data)> { var guardSnode: LokiAPITarget! return getPath().then(on: workQueue) { path -> Promise in guardSnode = path.first! return encrypt(payload, forTargetSnode: snode).then(on: workQueue) { r -> Promise in var path = path var encryptionResult = r var rhs = snode func addLayer() -> Promise { if path.isEmpty { return Promise { $0.fulfill(encryptionResult) } } else { let lhs = path.removeLast() return OnionRequestAPI.encryptHop(from: lhs, to: rhs, using: encryptionResult).then(on: workQueue) { r -> Promise in encryptionResult = r rhs = lhs return addLayer() } } } return addLayer() } }.map(on: workQueue) { (guardSnode: guardSnode, onion: $0.ciphertext) } } // MARK: Internal API /// Sends an onion request to `snode`. Builds new paths as needed. internal static func invoke(_ method: LokiAPITarget.Method, on snode: LokiAPITarget, parameters: JSON) -> Promise { let parameters: JSON = [ "method" : method.rawValue, "params" : parameters ] let payload: Data do { payload = try JSONSerialization.data(withJSONObject: parameters, options: []) } catch (let error) { return Promise { $0.reject(error) } } return buildOnion(around: payload, targetedAt: snode).then(on: workQueue) { intermediate -> Promise in let guardSnode = intermediate.guardSnode let onion = intermediate.onion let url = URL(string: "\(guardSnode.address):\(guardSnode.port)/onion_req")! var request = URLRequest(url: url) request.httpMethod = "POST" request.httpBody = onion request.timeoutInterval = timeout let (promise, seal) = Promise.pending() print("[Loki] [Onion Request API] Sending onion request.") let task = urlSession.dataTask(with: request) { response, result, error in if let error = error { seal.reject(error) } else if let result = result { seal.fulfill(result) } else { seal.reject(Error.generic) } } task.resume() return promise } } }