Merge pull request #429 from Brice-W/exp-timer-group-creation

Include Closed Group Expiration Timer Setting When Adding Members
pull/440/head
Niels Andriesse 3 years ago committed by GitHub
commit e6d15d7273
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -14,7 +14,7 @@ public final class ClosedGroupControlMessage : ControlMessage {
// MARK: Kind
public enum Kind : CustomStringConvertible {
case new(publicKey: Data, name: String, encryptionKeyPair: ECKeyPair, members: [Data], admins: [Data])
case new(publicKey: Data, name: String, encryptionKeyPair: ECKeyPair, members: [Data], admins: [Data], expireTimer: UInt32)
/// An encryption key pair encrypted for each member individually.
///
/// - Note: `publicKey` is only set when an encryption key pair is sent in a one-to-one context (i.e. not in a group).
@ -89,9 +89,9 @@ public final class ClosedGroupControlMessage : ControlMessage {
public override var isValid: Bool {
guard super.isValid, let kind = kind else { return false }
switch kind {
case .new(let publicKey, let name, let encryptionKeyPair, let members, let admins):
case .new(let publicKey, let name, let encryptionKeyPair, let members, let admins, let expireTimer):
return !publicKey.isEmpty && !name.isEmpty && !encryptionKeyPair.publicKey.isEmpty
&& !encryptionKeyPair.privateKey.isEmpty && !members.isEmpty && !admins.isEmpty
&& !encryptionKeyPair.privateKey.isEmpty && !members.isEmpty && !admins.isEmpty && expireTimer >= 0
case .encryptionKeyPair: return true
case .nameChange(let name): return !name.isEmpty
case .membersAdded(let members): return !members.isEmpty
@ -112,7 +112,8 @@ public final class ClosedGroupControlMessage : ControlMessage {
let encryptionKeyPair = coder.decodeObject(forKey: "encryptionKeyPair") as? ECKeyPair,
let members = coder.decodeObject(forKey: "members") as? [Data],
let admins = coder.decodeObject(forKey: "admins") as? [Data] else { return nil }
self.kind = .new(publicKey: publicKey, name: name, encryptionKeyPair: encryptionKeyPair, members: members, admins: admins)
let expireTimer = coder.decodeObject(forKey: "expireTimer") as! UInt32
self.kind = .new(publicKey: publicKey, name: name, encryptionKeyPair: encryptionKeyPair, members: members, admins: admins, expireTimer: expireTimer)
case "encryptionKeyPair":
let publicKey = coder.decodeObject(forKey: "publicKey") as? Data
guard let wrappers = coder.decodeObject(forKey: "wrappers") as? [KeyPairWrapper] else { return nil }
@ -138,13 +139,14 @@ public final class ClosedGroupControlMessage : ControlMessage {
super.encode(with: coder)
guard let kind = kind else { return }
switch kind {
case .new(let publicKey, let name, let encryptionKeyPair, let members, let admins):
case .new(let publicKey, let name, let encryptionKeyPair, let members, let admins, let expireTimer):
coder.encode("new", forKey: "kind")
coder.encode(publicKey, forKey: "publicKey")
coder.encode(name, forKey: "name")
coder.encode(encryptionKeyPair, forKey: "encryptionKeyPair")
coder.encode(members, forKey: "members")
coder.encode(admins, forKey: "admins")
coder.encode(expireTimer, forKey: "expireTimer")
case .encryptionKeyPair(let publicKey, let wrappers):
coder.encode("encryptionKeyPair", forKey: "kind")
coder.encode(publicKey, forKey: "publicKey")
@ -174,9 +176,10 @@ public final class ClosedGroupControlMessage : ControlMessage {
guard let publicKey = closedGroupControlMessageProto.publicKey, let name = closedGroupControlMessageProto.name,
let encryptionKeyPairAsProto = closedGroupControlMessageProto.encryptionKeyPair else { return nil }
do {
let expireTimer = closedGroupControlMessageProto.expireTimer
let encryptionKeyPair = try ECKeyPair(publicKeyData: encryptionKeyPairAsProto.publicKey.removing05PrefixIfNeeded(), privateKeyData: encryptionKeyPairAsProto.privateKey)
kind = .new(publicKey: publicKey, name: name, encryptionKeyPair: encryptionKeyPair,
members: closedGroupControlMessageProto.members, admins: closedGroupControlMessageProto.admins)
members: closedGroupControlMessageProto.members, admins: closedGroupControlMessageProto.admins, expireTimer: expireTimer)
} catch {
SNLog("Couldn't parse key pair.")
return nil
@ -208,7 +211,7 @@ public final class ClosedGroupControlMessage : ControlMessage {
do {
let closedGroupControlMessage: SNProtoDataMessageClosedGroupControlMessage.SNProtoDataMessageClosedGroupControlMessageBuilder
switch kind {
case .new(let publicKey, let name, let encryptionKeyPair, let members, let admins):
case .new(let publicKey, let name, let encryptionKeyPair, let members, let admins, let expireTimer):
closedGroupControlMessage = SNProtoDataMessageClosedGroupControlMessage.builder(type: .new)
closedGroupControlMessage.setPublicKey(publicKey)
closedGroupControlMessage.setName(name)
@ -221,6 +224,7 @@ public final class ClosedGroupControlMessage : ControlMessage {
}
closedGroupControlMessage.setMembers(members)
closedGroupControlMessage.setAdmins(admins)
closedGroupControlMessage.setExpireTimer(expireTimer)
case .encryptionKeyPair(let publicKey, let wrappers):
closedGroupControlMessage = SNProtoDataMessageClosedGroupControlMessage.builder(type: .encryptionKeyPair)
if let publicKey = publicKey {

@ -1579,6 +1579,9 @@ extension SNProtoDataMessageClosedGroupControlMessageKeyPairWrapper.SNProtoDataM
builder.setMembers(members)
builder.setAdmins(admins)
builder.setWrappers(wrappers)
if hasExpireTimer {
builder.setExpireTimer(expireTimer)
}
return builder
}
@ -1640,6 +1643,10 @@ extension SNProtoDataMessageClosedGroupControlMessageKeyPairWrapper.SNProtoDataM
proto.wrappers = wrappedItems.map { $0.proto }
}
@objc public func setExpireTimer(_ valueParam: UInt32) {
proto.expireTimer = valueParam
}
@objc public func build() throws -> SNProtoDataMessageClosedGroupControlMessage {
return try SNProtoDataMessageClosedGroupControlMessage.parseProto(proto)
}
@ -1685,6 +1692,13 @@ extension SNProtoDataMessageClosedGroupControlMessageKeyPairWrapper.SNProtoDataM
return proto.admins
}
@objc public var expireTimer: UInt32 {
return proto.expireTimer
}
@objc public var hasExpireTimer: Bool {
return proto.hasExpireTimer
}
private init(proto: SessionProtos_DataMessage.ClosedGroupControlMessage,
type: SNProtoDataMessageClosedGroupControlMessageType,
encryptionKeyPair: SNProtoKeyPair?,

File diff suppressed because it is too large Load Diff

@ -54,7 +54,7 @@ struct WebSocketProtos_WebSocketRequestMessage {
mutating func clearPath() {self._path = nil}
var body: Data {
get {return _body ?? Data()}
get {return _body ?? SwiftProtobuf.Internal.emptyData}
set {_body = newValue}
}
/// Returns true if `body` has been explicitly set.
@ -121,7 +121,7 @@ struct WebSocketProtos_WebSocketResponseMessage {
var headers: [String] = []
var body: Data {
get {return _body ?? Data()}
get {return _body ?? SwiftProtobuf.Internal.emptyData}
set {_body = newValue}
}
/// Returns true if `body` has been explicitly set.
@ -234,15 +234,12 @@ extension WebSocketProtos_WebSocketRequestMessage: SwiftProtobuf.Message, SwiftP
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
while let fieldNumber = try decoder.nextFieldNumber() {
// The use of inline closures is to circumvent an issue where the compiler
// allocates stack space for every case branch when no optimizations are
// enabled. https://github.com/apple/swift-protobuf/issues/1034
switch fieldNumber {
case 1: try { try decoder.decodeSingularStringField(value: &self._verb) }()
case 2: try { try decoder.decodeSingularStringField(value: &self._path) }()
case 3: try { try decoder.decodeSingularBytesField(value: &self._body) }()
case 4: try { try decoder.decodeSingularUInt64Field(value: &self._requestID) }()
case 5: try { try decoder.decodeRepeatedStringField(value: &self.headers) }()
case 1: try decoder.decodeSingularStringField(value: &self._verb)
case 2: try decoder.decodeSingularStringField(value: &self._path)
case 3: try decoder.decodeSingularBytesField(value: &self._body)
case 4: try decoder.decodeSingularUInt64Field(value: &self._requestID)
case 5: try decoder.decodeRepeatedStringField(value: &self.headers)
default: break
}
}
@ -290,15 +287,12 @@ extension WebSocketProtos_WebSocketResponseMessage: SwiftProtobuf.Message, Swift
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
while let fieldNumber = try decoder.nextFieldNumber() {
// The use of inline closures is to circumvent an issue where the compiler
// allocates stack space for every case branch when no optimizations are
// enabled. https://github.com/apple/swift-protobuf/issues/1034
switch fieldNumber {
case 1: try { try decoder.decodeSingularUInt64Field(value: &self._requestID) }()
case 2: try { try decoder.decodeSingularUInt32Field(value: &self._status) }()
case 3: try { try decoder.decodeSingularStringField(value: &self._message) }()
case 4: try { try decoder.decodeSingularBytesField(value: &self._body) }()
case 5: try { try decoder.decodeRepeatedStringField(value: &self.headers) }()
case 1: try decoder.decodeSingularUInt64Field(value: &self._requestID)
case 2: try decoder.decodeSingularUInt32Field(value: &self._status)
case 3: try decoder.decodeSingularStringField(value: &self._message)
case 4: try decoder.decodeSingularBytesField(value: &self._body)
case 5: try decoder.decodeRepeatedStringField(value: &self.headers)
default: break
}
}
@ -344,13 +338,10 @@ extension WebSocketProtos_WebSocketMessage: SwiftProtobuf.Message, SwiftProtobuf
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
while let fieldNumber = try decoder.nextFieldNumber() {
// The use of inline closures is to circumvent an issue where the compiler
// allocates stack space for every case branch when no optimizations are
// enabled. https://github.com/apple/swift-protobuf/issues/1034
switch fieldNumber {
case 1: try { try decoder.decodeSingularEnumField(value: &self._type) }()
case 2: try { try decoder.decodeSingularMessageField(value: &self._request) }()
case 3: try { try decoder.decodeSingularMessageField(value: &self._response) }()
case 1: try decoder.decodeSingularEnumField(value: &self._type)
case 2: try decoder.decodeSingularMessageField(value: &self._request)
case 3: try decoder.decodeSingularMessageField(value: &self._response)
default: break
}
}

@ -111,7 +111,7 @@ message DataMessage {
message ClosedGroupControlMessage {
enum Type {
NEW = 1; // publicKey, name, encryptionKeyPair, members, admins
NEW = 1; // publicKey, name, encryptionKeyPair, members, admins, expireTimer
ENCRYPTION_KEY_PAIR = 3; // publicKey, wrappers
NAME_CHANGE = 4; // name
MEMBERS_ADDED = 5; // members
@ -135,6 +135,7 @@ message DataMessage {
repeated bytes members = 5;
repeated bytes admins = 6;
repeated KeyPairWrapper wrappers = 7;
optional uint32 expireTimer = 8;
}
optional string body = 1;

@ -208,7 +208,7 @@ extension MessageReceiver {
for closedGroup in message.closedGroups {
guard !allClosedGroupPublicKeys.contains(closedGroup.publicKey) else { continue }
handleNewClosedGroup(groupPublicKey: closedGroup.publicKey, name: closedGroup.name, encryptionKeyPair: closedGroup.encryptionKeyPair,
members: [String](closedGroup.members), admins: [String](closedGroup.admins), messageSentTimestamp: message.sentTimestamp!, using: transaction)
members: [String](closedGroup.members), admins: [String](closedGroup.admins), expireTimer: 0, messageSentTimestamp: message.sentTimestamp!, using: transaction)
}
// Open groups
for openGroupURL in message.openGroups {
@ -368,15 +368,15 @@ extension MessageReceiver {
}
private static func handleNewClosedGroup(_ message: ClosedGroupControlMessage, using transaction: Any) {
guard case let .new(publicKeyAsData, name, encryptionKeyPair, membersAsData, adminsAsData) = message.kind else { return }
guard case let .new(publicKeyAsData, name, encryptionKeyPair, membersAsData, adminsAsData, expireTimer) = message.kind else { return }
let groupPublicKey = publicKeyAsData.toHexString()
let members = membersAsData.map { $0.toHexString() }
let admins = adminsAsData.map { $0.toHexString() }
handleNewClosedGroup(groupPublicKey: groupPublicKey, name: name, encryptionKeyPair: encryptionKeyPair,
members: members, admins: admins, messageSentTimestamp: message.sentTimestamp!, using: transaction)
members: members, admins: admins, expireTimer: expireTimer, messageSentTimestamp: message.sentTimestamp!, using: transaction)
}
private static func handleNewClosedGroup(groupPublicKey: String, name: String, encryptionKeyPair: ECKeyPair, members: [String], admins: [String], messageSentTimestamp: UInt64, using transaction: Any) {
private static func handleNewClosedGroup(groupPublicKey: String, name: String, encryptionKeyPair: ECKeyPair, members: [String], admins: [String], expireTimer: UInt32, messageSentTimestamp: UInt64, using transaction: Any) {
let transaction = transaction as! YapDatabaseReadWriteTransaction
// Create the group
let groupID = LKGroupUtilities.getEncodedClosedGroupIDAsData(groupPublicKey)
@ -397,6 +397,13 @@ extension MessageReceiver {
let infoMessage = TSInfoMessage(timestamp: messageSentTimestamp, in: thread, messageType: .groupCreated)
infoMessage.save(with: transaction)
}
var configuration: OWSDisappearingMessagesConfiguration
if (expireTimer > 0) {
configuration = OWSDisappearingMessagesConfiguration(threadId: thread.uniqueId!, enabled: true, durationSeconds: expireTimer)
} else {
configuration = OWSDisappearingMessagesConfiguration(threadId: thread.uniqueId!, enabled: false, durationSeconds: 24 * 60 * 60)
}
configuration.save(with: transaction)
// Add the group to the user's set of public keys to poll for
Storage.shared.addClosedGroupPublicKey(groupPublicKey, using: transaction)
// Store the key pair

@ -27,7 +27,7 @@ extension MessageSender {
let thread = TSContactThread.getOrCreateThread(withContactSessionID: member, transaction: transaction)
thread.save(with: transaction)
let closedGroupControlMessageKind = ClosedGroupControlMessage.Kind.new(publicKey: Data(hex: groupPublicKey), name: name,
encryptionKeyPair: encryptionKeyPair, members: membersAsData, admins: adminsAsData)
encryptionKeyPair: encryptionKeyPair, members: membersAsData, admins: adminsAsData, expireTimer: 0)
let closedGroupControlMessage = ClosedGroupControlMessage(kind: closedGroupControlMessageKind)
// Sending this non-durably is okay because we show a loader to the user. If they close the app while the
// loader is still showing, it's within expectation that the group creation might be incomplete.
@ -163,6 +163,8 @@ extension MessageSender {
let members = [String](Set(group.groupMemberIds).union(newMembers))
let membersAsData = members.map { Data(hex: $0) }
let adminsAsData = group.groupAdminIds.map { Data(hex: $0) }
// Get expiration timer value for the group
let expireTimer = thread.disappearingMessagesDuration(with: transaction)
guard let encryptionKeyPair = Storage.shared.getLatestClosedGroupEncryptionKeyPair(for: groupPublicKey) else {
SNLog("Couldn't find encryption key pair for closed group: \(groupPublicKey).")
return Promise(error: Error.noKeyPair)
@ -175,7 +177,7 @@ extension MessageSender {
let thread = TSContactThread.getOrCreateThread(withContactSessionID: member, transaction: transaction)
thread.save(with: transaction)
let closedGroupControlMessageKind = ClosedGroupControlMessage.Kind.new(publicKey: Data(hex: groupPublicKey), name: group.groupName!,
encryptionKeyPair: encryptionKeyPair, members: membersAsData, admins: adminsAsData)
encryptionKeyPair: encryptionKeyPair, members: membersAsData, admins: adminsAsData, expireTimer: expireTimer)
let closedGroupControlMessage = ClosedGroupControlMessage(kind: closedGroupControlMessageKind)
MessageSender.send(closedGroupControlMessage, in: thread, using: transaction)
}

@ -61,7 +61,7 @@ public final class NotificationServiceExtension : UNNotificationServiceExtension
// TODO: We could consider actually handling the update here. Not sure if there's enough time though, seeing as though
// in some cases we need to send messages (e.g. our sender key) to a number of other users.
switch closedGroupControlMessage.kind {
case .new(_, let name, _, _, _): snippet = "\(senderDisplayName) added you to \(name)"
case .new(_, let name, _, _, _, _): snippet = "\(senderDisplayName) added you to \(name)"
default: return self.completeSilenty()
}
default: return self.completeSilenty()

Loading…
Cancel
Save