From 86afe43c87b5d8381b00bbcb84f6567db2237b3c Mon Sep 17 00:00:00 2001 From: Ryan ZHAO Date: Fri, 4 Sep 2020 17:21:04 +1000 Subject: [PATCH 1/2] enable PN for SSK --- .../Closed Groups/ClosedGroupsProtocol.swift | 8 +++- .../LokiPushNotificationManager.swift | 38 +++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/SignalServiceKit/src/Loki/Protocol/Closed Groups/ClosedGroupsProtocol.swift b/SignalServiceKit/src/Loki/Protocol/Closed Groups/ClosedGroupsProtocol.swift index 2fb9aa316..9705c7da0 100644 --- a/SignalServiceKit/src/Loki/Protocol/Closed Groups/ClosedGroupsProtocol.swift +++ b/SignalServiceKit/src/Loki/Protocol/Closed Groups/ClosedGroupsProtocol.swift @@ -12,7 +12,7 @@ import PromiseKit /// See [the documentation](https://github.com/loki-project/session-protocol-docs/wiki/Medium-Size-Groups) for more information. @objc(LKClosedGroupsProtocol) public final class ClosedGroupsProtocol : NSObject { - public static let isSharedSenderKeysEnabled = false + public static let isSharedSenderKeysEnabled = true public static let groupSizeLimit = 10 // MARK: - Sending @@ -65,6 +65,8 @@ public final class ClosedGroupsProtocol : NSObject { } // Add the group to the user's set of public keys to poll for Storage.setClosedGroupPrivateKey(groupKeyPair.privateKey.toHexString(), for: groupPublicKey, using: transaction) + // Notify PN server + promises.append(LokiPushNotificationManager.operateClosedGroup(to: groupPublicKey, hexEncodedPublicKey: userPublicKey, operation: .subscribe)) // Notify the user let infoMessage = TSInfoMessage(timestamp: NSDate.ows_millisecondTimeStamp(), in: thread, messageType: .typeGroupUpdate) infoMessage.save(with: transaction) @@ -172,6 +174,8 @@ public final class ClosedGroupsProtocol : NSObject { // Remove the group from the user's set of public keys to poll for if isUserLeaving { Storage.removeClosedGroupPrivateKey(for: groupPublicKey, using: transaction) + // Notify PN server + LokiPushNotificationManager.operateClosedGroup(to: groupPublicKey, hexEncodedPublicKey: userPublicKey, operation: .unsubscribe) } } } @@ -265,6 +269,8 @@ public final class ClosedGroupsProtocol : NSObject { SSKEnvironment.shared.profileManager.addThread(toProfileWhitelist: thread) // Add the group to the user's set of public keys to poll for Storage.setClosedGroupPrivateKey(groupPrivateKey.toHexString(), for: groupPublicKey, using: transaction) + // Notify PN server + LokiPushNotificationManager.operateClosedGroup(to: groupPublicKey, hexEncodedPublicKey: getUserHexEncodedPublicKey(), operation: .subscribe) // Notify the user let infoMessage = TSInfoMessage(timestamp: NSDate.ows_millisecondTimeStamp(), in: thread, messageType: .typeGroupUpdate) infoMessage.save(with: transaction) diff --git a/SignalServiceKit/src/Loki/Push Notifications/LokiPushNotificationManager.swift b/SignalServiceKit/src/Loki/Push Notifications/LokiPushNotificationManager.swift index aed2ffee1..5f878730e 100644 --- a/SignalServiceKit/src/Loki/Push Notifications/LokiPushNotificationManager.swift +++ b/SignalServiceKit/src/Loki/Push Notifications/LokiPushNotificationManager.swift @@ -10,6 +10,10 @@ public final class LokiPushNotificationManager : NSObject { private static let server = "https://live.apns.getsession.org/" #endif private static let tokenExpirationInterval: TimeInterval = 12 * 60 * 60 + public enum ClosedGroupOpertion: String { + case subscribe = "subscribe_closed_group" + case unsubscribe = "unsubscribe_closed_group" + } // MARK: Initialization private override init() { } @@ -47,6 +51,11 @@ public final class LokiPushNotificationManager : NSObject { promise.catch2 { error in print("[Loki] Couldn't register device token.") } + //Unsubscribe all closed groups + let closedGroups = Storage.getUserClosedGroupPublicKeys() + for closedGroup in closedGroups { + operateClosedGroup(to: closedGroup, hexEncodedPublicKey: getUserHexEncodedPublicKey(), operation: .unsubscribe) + } return promise } @@ -88,6 +97,11 @@ public final class LokiPushNotificationManager : NSObject { promise.catch2 { error in print("[Loki] Couldn't register device token.") } + //Subscribe all closed groups + let closedGroups = Storage.getUserClosedGroupPublicKeys() + for closedGroup in closedGroups { + operateClosedGroup(to: closedGroup, hexEncodedPublicKey: hexEncodedPublicKey, operation: .subscribe) + } return promise } @@ -100,6 +114,7 @@ public final class LokiPushNotificationManager : NSObject { @objc(acknowledgeDeliveryForMessageWithHash:expiration:hexEncodedPublicKey:) static func acknowledgeDelivery(forMessageWithHash hash: String, expiration: UInt64, hexEncodedPublicKey: String) { + guard UserDefaults.standard[.isUsingFullAPNs] else { return } let parameters: JSON = [ "lastHash" : hash, "pubKey" : hexEncodedPublicKey, "expiration" : expiration] let url = URL(string: server + "acknowledge_message_delivery")! let request = TSRequest(url: url, method: "POST", parameters: parameters) @@ -115,4 +130,27 @@ public final class LokiPushNotificationManager : NSObject { print("[Loki] Couldn't acknowledge delivery for message with hash: \(hash) due to error: \(error).") }) } + + static func operateClosedGroup(to closedGroupPublicKey: String, hexEncodedPublicKey: String, operation: ClosedGroupOpertion) -> Promise { + let userDefaults = UserDefaults.standard + let isUsingFullAPNs = userDefaults[.isUsingFullAPNs] + guard isUsingFullAPNs else { return Promise { $0.fulfill(()) } } + let parameters = [ "closedGroupPublicKey" : closedGroupPublicKey, "pubKey" : hexEncodedPublicKey] + let url = URL(string: server + operation.rawValue)! + let request = TSRequest(url: url, method: "POST", parameters: parameters) + request.allHTTPHeaderFields = [ "Content-Type" : "application/json" ] + let promise = TSNetworkManager.shared().makePromise(request: request).map2 { _, response in + guard let json = response as? JSON else { + return print("[Loki] Couldn't register device token.") + } + guard json["code"] as? Int != 0 else { + return print("[Loki] Couldn't register device token due to error: \(json["message"] as? String ?? "nil").") + } + return + } + promise.catch2 { error in + print("[Loki] Couldn't register device token.") + } + return promise + } } From f11f289f9dfb23328404411c9a9aeeaa02886f35 Mon Sep 17 00:00:00 2001 From: nielsandriesse Date: Tue, 15 Sep 2020 10:37:58 +1000 Subject: [PATCH 2/2] Add missing unsubscribe case --- .../Closed Groups/ClosedGroupsProtocol.swift | 16 +++---- .../LokiPushNotificationManager.swift | 42 +++++++++---------- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/SignalServiceKit/src/Loki/Protocol/Closed Groups/ClosedGroupsProtocol.swift b/SignalServiceKit/src/Loki/Protocol/Closed Groups/ClosedGroupsProtocol.swift index 9705c7da0..7c826844a 100644 --- a/SignalServiceKit/src/Loki/Protocol/Closed Groups/ClosedGroupsProtocol.swift +++ b/SignalServiceKit/src/Loki/Protocol/Closed Groups/ClosedGroupsProtocol.swift @@ -12,7 +12,7 @@ import PromiseKit /// See [the documentation](https://github.com/loki-project/session-protocol-docs/wiki/Medium-Size-Groups) for more information. @objc(LKClosedGroupsProtocol) public final class ClosedGroupsProtocol : NSObject { - public static let isSharedSenderKeysEnabled = true + public static let isSharedSenderKeysEnabled = false public static let groupSizeLimit = 10 // MARK: - Sending @@ -65,8 +65,8 @@ public final class ClosedGroupsProtocol : NSObject { } // Add the group to the user's set of public keys to poll for Storage.setClosedGroupPrivateKey(groupKeyPair.privateKey.toHexString(), for: groupPublicKey, using: transaction) - // Notify PN server - promises.append(LokiPushNotificationManager.operateClosedGroup(to: groupPublicKey, hexEncodedPublicKey: userPublicKey, operation: .subscribe)) + // Notify the PN server + promises.append(LokiPushNotificationManager.performOperation(.subscribe, for: groupPublicKey, publicKey: userPublicKey)) // Notify the user let infoMessage = TSInfoMessage(timestamp: NSDate.ows_millisecondTimeStamp(), in: thread, messageType: .typeGroupUpdate) infoMessage.save(with: transaction) @@ -174,8 +174,8 @@ public final class ClosedGroupsProtocol : NSObject { // Remove the group from the user's set of public keys to poll for if isUserLeaving { Storage.removeClosedGroupPrivateKey(for: groupPublicKey, using: transaction) - // Notify PN server - LokiPushNotificationManager.operateClosedGroup(to: groupPublicKey, hexEncodedPublicKey: userPublicKey, operation: .unsubscribe) + // Notify the PN server + LokiPushNotificationManager.performOperation(.unsubscribe, for: groupPublicKey, publicKey: userPublicKey) } } } @@ -269,8 +269,8 @@ public final class ClosedGroupsProtocol : NSObject { SSKEnvironment.shared.profileManager.addThread(toProfileWhitelist: thread) // Add the group to the user's set of public keys to poll for Storage.setClosedGroupPrivateKey(groupPrivateKey.toHexString(), for: groupPublicKey, using: transaction) - // Notify PN server - LokiPushNotificationManager.operateClosedGroup(to: groupPublicKey, hexEncodedPublicKey: getUserHexEncodedPublicKey(), operation: .subscribe) + // Notify the PN server + LokiPushNotificationManager.performOperation(.subscribe, for: groupPublicKey, publicKey: getUserHexEncodedPublicKey()) // Notify the user let infoMessage = TSInfoMessage(timestamp: NSDate.ows_millisecondTimeStamp(), in: thread, messageType: .typeGroupUpdate) infoMessage.save(with: transaction) @@ -320,6 +320,8 @@ public final class ClosedGroupsProtocol : NSObject { Storage.removeAllClosedGroupRatchets(for: groupPublicKey, using: transaction) if wasUserRemoved { Storage.removeClosedGroupPrivateKey(for: groupPublicKey, using: transaction) + // Notify the PN server + LokiPushNotificationManager.performOperation(.unsubscribe, for: groupPublicKey, publicKey: userPublicKey) } else { establishSessionsIfNeeded(with: members, using: transaction) // This internally takes care of multi device let userRatchet = SharedSenderKeysImplementation.shared.generateRatchet(for: groupPublicKey, senderPublicKey: userPublicKey, using: transaction) diff --git a/SignalServiceKit/src/Loki/Push Notifications/LokiPushNotificationManager.swift b/SignalServiceKit/src/Loki/Push Notifications/LokiPushNotificationManager.swift index 5f878730e..d060eee2b 100644 --- a/SignalServiceKit/src/Loki/Push Notifications/LokiPushNotificationManager.swift +++ b/SignalServiceKit/src/Loki/Push Notifications/LokiPushNotificationManager.swift @@ -10,7 +10,8 @@ public final class LokiPushNotificationManager : NSObject { private static let server = "https://live.apns.getsession.org/" #endif private static let tokenExpirationInterval: TimeInterval = 12 * 60 * 60 - public enum ClosedGroupOpertion: String { + + public enum ClosedGroupOperation: String { case subscribe = "subscribe_closed_group" case unsubscribe = "unsubscribe_closed_group" } @@ -51,10 +52,9 @@ public final class LokiPushNotificationManager : NSObject { promise.catch2 { error in print("[Loki] Couldn't register device token.") } - //Unsubscribe all closed groups - let closedGroups = Storage.getUserClosedGroupPublicKeys() - for closedGroup in closedGroups { - operateClosedGroup(to: closedGroup, hexEncodedPublicKey: getUserHexEncodedPublicKey(), operation: .unsubscribe) + // Unsubscribe from all closed groups + Storage.getUserClosedGroupPublicKeys().forEach { closedGroup in + performOperation(.unsubscribe, for: closedGroup, publicKey: getUserHexEncodedPublicKey()) } return promise } @@ -68,7 +68,7 @@ public final class LokiPushNotificationManager : NSObject { /// Registers the user for normal push notifications. Requires the user's device /// token and their Session ID. - static func register(with token: Data, hexEncodedPublicKey: String, isForcedUpdate: Bool) -> Promise { + static func register(with token: Data, publicKey: String, isForcedUpdate: Bool) -> Promise { let hexEncodedToken = token.toHexString() let userDefaults = UserDefaults.standard let oldToken = userDefaults[.deviceToken] @@ -78,7 +78,7 @@ public final class LokiPushNotificationManager : NSObject { print("[Loki] Device token hasn't changed or expired; no need to re-upload.") return Promise { $0.fulfill(()) } } - let parameters = [ "token" : hexEncodedToken, "pubKey" : hexEncodedPublicKey] + let parameters = [ "token" : hexEncodedToken, "pubKey" : publicKey] let url = URL(string: server + "register")! let request = TSRequest(url: url, method: "POST", parameters: parameters) request.allHTTPHeaderFields = [ "Content-Type" : "application/json" ] @@ -97,10 +97,9 @@ public final class LokiPushNotificationManager : NSObject { promise.catch2 { error in print("[Loki] Couldn't register device token.") } - //Subscribe all closed groups - let closedGroups = Storage.getUserClosedGroupPublicKeys() - for closedGroup in closedGroups { - operateClosedGroup(to: closedGroup, hexEncodedPublicKey: hexEncodedPublicKey, operation: .subscribe) + // Subscribe to all closed groups + Storage.getUserClosedGroupPublicKeys().forEach { closedGroup in + performOperation(.subscribe, for: closedGroup, publicKey: publicKey) } return promise } @@ -108,14 +107,14 @@ public final class LokiPushNotificationManager : NSObject { /// Registers the user for normal push notifications. Requires the user's device /// token and their Session ID. @objc(registerWithToken:hexEncodedPublicKey:isForcedUpdate:) - static func objc_register(with token: Data, hexEncodedPublicKey: String, isForcedUpdate: Bool) -> AnyPromise { - return AnyPromise.from(register(with: token, hexEncodedPublicKey: hexEncodedPublicKey, isForcedUpdate: isForcedUpdate)) + static func objc_register(with token: Data, publicKey: String, isForcedUpdate: Bool) -> AnyPromise { + return AnyPromise.from(register(with: token, publicKey: publicKey, isForcedUpdate: isForcedUpdate)) } @objc(acknowledgeDeliveryForMessageWithHash:expiration:hexEncodedPublicKey:) - static func acknowledgeDelivery(forMessageWithHash hash: String, expiration: UInt64, hexEncodedPublicKey: String) { + static func acknowledgeDelivery(forMessageWithHash hash: String, expiration: UInt64, publicKey: String) { guard UserDefaults.standard[.isUsingFullAPNs] else { return } - let parameters: JSON = [ "lastHash" : hash, "pubKey" : hexEncodedPublicKey, "expiration" : expiration] + let parameters: JSON = [ "lastHash" : hash, "pubKey" : publicKey, "expiration" : expiration] let url = URL(string: server + "acknowledge_message_delivery")! let request = TSRequest(url: url, method: "POST", parameters: parameters) request.allHTTPHeaderFields = [ "Content-Type" : "application/json" ] @@ -131,25 +130,24 @@ public final class LokiPushNotificationManager : NSObject { }) } - static func operateClosedGroup(to closedGroupPublicKey: String, hexEncodedPublicKey: String, operation: ClosedGroupOpertion) -> Promise { - let userDefaults = UserDefaults.standard - let isUsingFullAPNs = userDefaults[.isUsingFullAPNs] + static func performOperation(_ operation: ClosedGroupOperation, for closedGroupPublicKey: String, publicKey: String) -> Promise { + let isUsingFullAPNs = UserDefaults.standard[.isUsingFullAPNs] guard isUsingFullAPNs else { return Promise { $0.fulfill(()) } } - let parameters = [ "closedGroupPublicKey" : closedGroupPublicKey, "pubKey" : hexEncodedPublicKey] + let parameters = [ "closedGroupPublicKey" : closedGroupPublicKey, "pubKey" : publicKey] let url = URL(string: server + operation.rawValue)! let request = TSRequest(url: url, method: "POST", parameters: parameters) request.allHTTPHeaderFields = [ "Content-Type" : "application/json" ] let promise = TSNetworkManager.shared().makePromise(request: request).map2 { _, response in guard let json = response as? JSON else { - return print("[Loki] Couldn't register device token.") + return print("[Loki] Couldn't subscribe to PNs for closed group with ID: \(closedGroupPublicKey).") } guard json["code"] as? Int != 0 else { - return print("[Loki] Couldn't register device token due to error: \(json["message"] as? String ?? "nil").") + return print("[Loki] Couldn't subscribe to PNs for closed group with ID: \(closedGroupPublicKey) due to error: \(json["message"] as? String ?? "nil").") } return } promise.catch2 { error in - print("[Loki] Couldn't register device token.") + print("[Loki] Couldn't subscribe to PNs for closed group with ID: \(closedGroupPublicKey).") } return promise }