mirror of https://github.com/oxen-io/session-ios
WIP
Niels Andriesse
4 years ago
parent
bbd3ecd54a
commit
aec182f36c
@ -1,225 +0,0 @@
|
|||||||
import PromiseKit
|
|
||||||
|
|
||||||
// A few notes about making changes in this file:
|
|
||||||
//
|
|
||||||
// • Don't use a database transaction if you can avoid it.
|
|
||||||
// • If you do need to use a database transaction, use a read transaction if possible.
|
|
||||||
// • For write transactions, consider making it the caller's responsibility to manage the database transaction (this helps avoid unnecessary transactions).
|
|
||||||
// • Think carefully about adding a function; there might already be one for what you need.
|
|
||||||
// • Document the expected cases in which a function will be used
|
|
||||||
// • Express those cases in tests.
|
|
||||||
|
|
||||||
@objc(LKSessionManagementProtocol)
|
|
||||||
public final class SessionManagementProtocol : NSObject {
|
|
||||||
|
|
||||||
internal static var storage: OWSPrimaryStorage { OWSPrimaryStorage.shared() }
|
|
||||||
|
|
||||||
// MARK: - General
|
|
||||||
|
|
||||||
@objc(createPreKeys)
|
|
||||||
public static func createPreKeys() {
|
|
||||||
// We don't generate new pre keys here like Signal does.
|
|
||||||
// This is because we need the records to be linked to a contact since we don't have a central server.
|
|
||||||
// It's done automatically when we generate a pre key bundle to send to a contact (generatePreKeyBundleForContact:).
|
|
||||||
// You can use getOrCreatePreKeyForContact: to generate one if needed.
|
|
||||||
let signedPreKeyRecord = storage.generateRandomSignedRecord()
|
|
||||||
signedPreKeyRecord.markAsAcceptedByService()
|
|
||||||
storage.storeSignedPreKey(signedPreKeyRecord.id, signedPreKeyRecord: signedPreKeyRecord)
|
|
||||||
storage.setCurrentSignedPrekeyId(signedPreKeyRecord.id)
|
|
||||||
SNLog("Pre keys created successfully.")
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(refreshSignedPreKey)
|
|
||||||
public static func refreshSignedPreKey() {
|
|
||||||
// We don't generate new pre keys here like Signal does.
|
|
||||||
// This is because we need the records to be linked to a contact since we don't have a central server.
|
|
||||||
// It's done automatically when we generate a pre key bundle to send to a contact (generatePreKeyBundleForContact:).
|
|
||||||
// You can use getOrCreatePreKeyForContact: to generate one if needed.
|
|
||||||
guard storage.currentSignedPrekeyId() == nil else { return }
|
|
||||||
let signedPreKeyRecord = storage.generateRandomSignedRecord()
|
|
||||||
signedPreKeyRecord.markAsAcceptedByService()
|
|
||||||
storage.storeSignedPreKey(signedPreKeyRecord.id, signedPreKeyRecord: signedPreKeyRecord)
|
|
||||||
storage.setCurrentSignedPrekeyId(signedPreKeyRecord.id)
|
|
||||||
TSPreKeyManager.clearPreKeyUpdateFailureCount()
|
|
||||||
TSPreKeyManager.clearSignedPreKeyRecords()
|
|
||||||
SNLog("Signed pre key refreshed successfully.")
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(rotateSignedPreKey)
|
|
||||||
public static func rotateSignedPreKey() {
|
|
||||||
// This is identical to what Signal does, except that it doesn't upload the signed pre key
|
|
||||||
// to a server.
|
|
||||||
let signedPreKeyRecord = storage.generateRandomSignedRecord()
|
|
||||||
signedPreKeyRecord.markAsAcceptedByService()
|
|
||||||
storage.storeSignedPreKey(signedPreKeyRecord.id, signedPreKeyRecord: signedPreKeyRecord)
|
|
||||||
storage.setCurrentSignedPrekeyId(signedPreKeyRecord.id)
|
|
||||||
TSPreKeyManager.clearPreKeyUpdateFailureCount()
|
|
||||||
TSPreKeyManager.clearSignedPreKeyRecords()
|
|
||||||
SNLog("Signed pre key rotated successfully.")
|
|
||||||
}
|
|
||||||
|
|
||||||
// MARK: - Sending
|
|
||||||
|
|
||||||
@objc(isSessionRequiredForMessage:recipientID:transaction:)
|
|
||||||
public static func isSessionRequired(for message: TSOutgoingMessage, recipientID: String, transaction: YapDatabaseReadWriteTransaction) -> Bool {
|
|
||||||
return false
|
|
||||||
// if SharedSenderKeysImplementation.shared.isClosedGroup(recipientID) {
|
|
||||||
// return false
|
|
||||||
// } else {
|
|
||||||
// return !shouldUseFallbackEncryption(for: message, recipientID: recipientID, transaction: transaction)
|
|
||||||
// }
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(shouldUseFallbackEncryptionForMessage:recipientID:transaction:)
|
|
||||||
public static func shouldUseFallbackEncryption(for message: TSOutgoingMessage, recipientID: String, transaction: YapDatabaseReadWriteTransaction) -> Bool {
|
|
||||||
return true
|
|
||||||
// if SharedSenderKeysImplementation.shared.isClosedGroup(recipientID) { return false }
|
|
||||||
// else if message is SessionRequestMessage { return true }
|
|
||||||
// else if message is EndSessionMessage { return true }
|
|
||||||
// else if let message = message as? DeviceLinkMessage, message.kind == .request { return true }
|
|
||||||
// else if message is OWSOutgoingNullMessage { return false }
|
|
||||||
// return !storage.containsSession(recipientID, deviceId: Int32(OWSDevicePrimaryDeviceId), protocolContext: transaction)
|
|
||||||
}
|
|
||||||
|
|
||||||
private static func hasSentSessionRequestExpired(for publicKey: String) -> Bool {
|
|
||||||
return false
|
|
||||||
// let timestamp = Storage.getSessionRequestSentTimestamp(for: publicKey)
|
|
||||||
// let expiration = timestamp + TTLUtilities.getTTL(for: .sessionRequest)
|
|
||||||
// return NSDate.ows_millisecondTimeStamp() > expiration
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(sendSessionRequestIfNeededToPublicKey:transaction:)
|
|
||||||
public static func sendSessionRequestIfNeeded(to publicKey: String, using transaction: YapDatabaseReadWriteTransaction) {
|
|
||||||
// It's never necessary to establish a session with self
|
|
||||||
guard publicKey != getUserHexEncodedPublicKey() else { return }
|
|
||||||
// Check that we don't already have a session
|
|
||||||
let hasSession = storage.containsSession(publicKey, deviceId: Int32(1), protocolContext: transaction)
|
|
||||||
guard !hasSession else { return }
|
|
||||||
// Check that we didn't already send a session request
|
|
||||||
let hasSentSessionRequest = (Storage.shared.getSessionRequestSentTimestamp(for: publicKey) > 0)
|
|
||||||
let hasSentSessionRequestExpired = SessionManagementProtocol.hasSentSessionRequestExpired(for: publicKey)
|
|
||||||
if hasSentSessionRequestExpired {
|
|
||||||
Storage.shared.setSessionRequestSentTimestamp(for: publicKey, to: 0, using: transaction)
|
|
||||||
}
|
|
||||||
guard !hasSentSessionRequest || hasSentSessionRequestExpired else { return }
|
|
||||||
// Create the thread if needed
|
|
||||||
let thread = TSContactThread.getOrCreateThread(withContactId: publicKey, transaction: transaction)
|
|
||||||
thread.save(with: transaction)
|
|
||||||
// Send the session request
|
|
||||||
SNLog("Sending session request to: \(publicKey).")
|
|
||||||
Storage.shared.setSessionRequestSentTimestamp(for: publicKey, to: NSDate.ows_millisecondTimeStamp(), using: transaction)
|
|
||||||
let sessionRequest = SessionRequest()
|
|
||||||
sessionRequest.preKeyBundle = storage.generatePreKeyBundle(forContact: publicKey)
|
|
||||||
MessageSender.send(sessionRequest, in: thread, using: transaction)
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(sendNullMessageToPublicKey:transaction:)
|
|
||||||
public static func sendNullMessage(to publicKey: String, in transaction: YapDatabaseReadWriteTransaction) {
|
|
||||||
let thread = TSContactThread.getOrCreateThread(withContactId: publicKey, transaction: transaction)
|
|
||||||
thread.save(with: transaction)
|
|
||||||
let nullMessage = NullMessage()
|
|
||||||
MessageSender.send(nullMessage, in: thread, using: transaction)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// - Note: Deprecated.
|
|
||||||
///
|
|
||||||
/// Only relevant for closed groups that don't use shared sender keys.
|
|
||||||
@objc(shouldIgnoreMissingPreKeyBundleExceptionForMessage:to:)
|
|
||||||
public static func shouldIgnoreMissingPreKeyBundleException(for message: TSOutgoingMessage, to hexEncodedPublicKey: String) -> Bool {
|
|
||||||
// When a closed group is created, members try to establish sessions with eachother in the background through
|
|
||||||
// session requests. Until ALL users those session requests were sent to have come online, stored the pre key
|
|
||||||
// bundles contained in the session requests and replied with background messages to finalize the session
|
|
||||||
// creation, a given user won't be able to successfully send a message to all members of a group. This check
|
|
||||||
// is so that until we can do better on this front the user at least won't see this as an error in the UI.
|
|
||||||
guard let groupThread = message.thread as? TSGroupThread else { return false }
|
|
||||||
return groupThread.groupModel.groupType == .closedGroup && !groupThread.usesSharedSenderKeys
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(startSessionResetInThread:transaction:)
|
|
||||||
public static func startSessionReset(in thread: TSThread, using transaction: YapDatabaseReadWriteTransaction) {
|
|
||||||
// // Check preconditions
|
|
||||||
// guard let thread = thread as? TSContactThread else {
|
|
||||||
// return SNLog("Can't restore session for non contact thread.")
|
|
||||||
// }
|
|
||||||
// // Send end session messages to the devices requiring session restoration
|
|
||||||
// let devices = thread.sessionRestoreDevices // TODO: Rename this to something that reads better
|
|
||||||
// for device in devices {
|
|
||||||
// guard ECKeyPair.isValidHexEncodedPublicKey(candidate: device) else { continue }
|
|
||||||
// let thread = TSContactThread.getOrCreateThread(withContactId: device, transaction: transaction)
|
|
||||||
// thread.save(with: transaction)
|
|
||||||
// /*
|
|
||||||
// let endSessionMessage = EndSessionMessage(timestamp: NSDate.ows_millisecondTimeStamp(), in: thread)
|
|
||||||
// let messageSenderJobQueue = SSKEnvironment.shared.messageSenderJobQueue
|
|
||||||
// messageSenderJobQueue.add(message: endSessionMessage, transaction: transaction)
|
|
||||||
// */
|
|
||||||
// }
|
|
||||||
// thread.removeAllSessionRestoreDevices(with: transaction)
|
|
||||||
// // Notify the user
|
|
||||||
// let infoMessage = TSInfoMessage(timestamp: NSDate.ows_millisecondTimeStamp(), in: thread, messageType: .typeLokiSessionResetInProgress)
|
|
||||||
// infoMessage.save(with: transaction)
|
|
||||||
// // Update the session reset status
|
|
||||||
// thread.sessionResetStatus = .initiated
|
|
||||||
// thread.save(with: transaction)
|
|
||||||
}
|
|
||||||
|
|
||||||
// MARK: - Receiving
|
|
||||||
|
|
||||||
@objc(handleDecryptionError:forPublicKey:transaction:)
|
|
||||||
public static func handleDecryptionError(_ errorMessage: TSErrorMessage, for publicKey: String, using transaction: YapDatabaseReadWriteTransaction) {
|
|
||||||
// let type = errorMessage.errorType
|
|
||||||
// let masterPublicKey = storage.getMasterHexEncodedPublicKey(for: publicKey, in: transaction) ?? publicKey
|
|
||||||
// let thread = TSContactThread.getOrCreateThread(withContactId: masterPublicKey, transaction: transaction)
|
|
||||||
// let restorationTimeInMs = UInt64(storage.getRestorationTime() * 1000)
|
|
||||||
// // Show the session reset prompt upon certain errors
|
|
||||||
// switch type {
|
|
||||||
// case .noSession, .invalidMessage, .invalidKeyException:
|
|
||||||
// if restorationTimeInMs > errorMessage.timestamp {
|
|
||||||
// // Automatically rebuild session after restoration
|
|
||||||
// sendSessionRequestIfNeeded(to: publicKey, using: transaction)
|
|
||||||
// } else {
|
|
||||||
// // Store the source device's public key in case it was a secondary device
|
|
||||||
// thread.addSessionRestoreDevice(publicKey, transaction: transaction)
|
|
||||||
// }
|
|
||||||
// default: break
|
|
||||||
// }
|
|
||||||
}
|
|
||||||
|
|
||||||
private static func shouldProcessSessionRequest(from publicKey: String, at timestamp: UInt64) -> Bool {
|
|
||||||
let sentTimestamp = Storage.shared.getSessionRequestSentTimestamp(for: publicKey)
|
|
||||||
let processedTimestamp = Storage.shared.getSessionRequestProcessedTimestamp(for: publicKey)
|
|
||||||
let restorationTimestamp = UInt64(storage.getRestorationTime() * 1000)
|
|
||||||
return timestamp > sentTimestamp && timestamp > processedTimestamp && timestamp > restorationTimestamp
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(handlePreKeyBundleMessageIfNeeded:wrappedIn:transaction:)
|
|
||||||
public static func handlePreKeyBundleMessageIfNeeded(_ protoContent: SNProtoContent, wrappedIn envelope: SNProtoEnvelope, using transaction: YapDatabaseReadWriteTransaction) {
|
|
||||||
// let publicKey = envelope.source! // Set during UD decryption
|
|
||||||
// guard let preKeyBundleMessage = protoContent.prekeyBundleMessage else { return }
|
|
||||||
// SNLog("Received a pre key bundle message from: \(publicKey).")
|
|
||||||
// guard let preKeyBundle = preKeyBundleMessage.getPreKeyBundle(with: transaction) else {
|
|
||||||
// return SNLog("Couldn't parse pre key bundle received from: \(publicKey).")
|
|
||||||
// }
|
|
||||||
// if !shouldProcessSessionRequest(from: publicKey, at: envelope.timestamp) {
|
|
||||||
// return SNLog("Ignoring session request from: \(publicKey).")
|
|
||||||
// }
|
|
||||||
// storage.setPreKeyBundle(preKeyBundle, forContact: publicKey, transaction: transaction)
|
|
||||||
// Storage.setSessionRequestProcessedTimestamp(for: publicKey, to: NSDate.ows_millisecondTimeStamp(), using: transaction)
|
|
||||||
// sendNullMessage(to: publicKey, in: transaction)
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(handleEndSessionMessageReceivedInThread:using:)
|
|
||||||
public static func handleEndSessionMessageReceived(in thread: TSContactThread, using transaction: YapDatabaseReadWriteTransaction) {
|
|
||||||
// let publicKey = thread.contactIdentifier()
|
|
||||||
// SNLog("End session message received from: \(publicKey).")
|
|
||||||
// // Notify the user
|
|
||||||
// let infoMessage = TSInfoMessage(timestamp: NSDate.ows_millisecondTimeStamp(), in: thread, messageType: .typeLokiSessionResetInProgress)
|
|
||||||
// infoMessage.save(with: transaction)
|
|
||||||
// // Archive all sessions
|
|
||||||
// storage.archiveAllSessions(forContact: publicKey, protocolContext: transaction)
|
|
||||||
// // Update the session reset status
|
|
||||||
// thread.sessionResetStatus = .requestReceived
|
|
||||||
// thread.save(with: transaction)
|
|
||||||
// // Send a null message
|
|
||||||
// sendNullMessage(to: publicKey, in: transaction)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,119 +0,0 @@
|
|||||||
import PromiseKit
|
|
||||||
|
|
||||||
// A few notes about making changes in this file:
|
|
||||||
//
|
|
||||||
// • Don't use a database transaction if you can avoid it.
|
|
||||||
// • If you do need to use a database transaction, use a read transaction if possible.
|
|
||||||
// • For write transactions, consider making it the caller's responsibility to manage the database transaction (this helps avoid unnecessary transactions).
|
|
||||||
// • Think carefully about adding a function; there might already be one for what you need.
|
|
||||||
// • Document the expected cases in which a function will be used
|
|
||||||
// • Express those cases in tests.
|
|
||||||
|
|
||||||
/// See [Receipts, Transcripts & Typing Indicators](https://github.com/loki-project/session-protocol-docs/wiki/Receipts,-Transcripts-&-Typing-Indicators) for more information.
|
|
||||||
@objc(LKSessionMetaProtocol)
|
|
||||||
public final class SessionMetaProtocol : NSObject {
|
|
||||||
|
|
||||||
internal static var storage: OWSPrimaryStorage { OWSPrimaryStorage.shared() }
|
|
||||||
|
|
||||||
// MARK: - Sending
|
|
||||||
|
|
||||||
// MARK: Message Destination(s)
|
|
||||||
@objc public static func getDestinationsForOutgoingSyncMessage() -> NSMutableSet {
|
|
||||||
return NSMutableSet(set: [ getUserHexEncodedPublicKey() ]) // return NSMutableSet(set: MultiDeviceProtocol.getUserLinkedDevices())
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(getDestinationsForOutgoingGroupMessage:inThread:)
|
|
||||||
public static func getDestinations(for outgoingGroupMessage: TSOutgoingMessage, in thread: TSThread) -> NSMutableSet {
|
|
||||||
guard let thread = thread as? TSGroupThread else { preconditionFailure("Can't get destinations for group message in non-group thread.") }
|
|
||||||
var result: Set<String> = []
|
|
||||||
if thread.isOpenGroup {
|
|
||||||
if let openGroup = Storage.shared.getOpenGroup(for: thread.uniqueId!) {
|
|
||||||
result = [ openGroup.server ] // Aim the message at the open group server
|
|
||||||
} else {
|
|
||||||
// Should never occur
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if let groupThread = thread as? TSGroupThread, groupThread.usesSharedSenderKeys {
|
|
||||||
let groupPublicKey = LKGroupUtilities.getDecodedGroupID(groupThread.groupModel.groupId)
|
|
||||||
result = [ groupPublicKey ]
|
|
||||||
} else {
|
|
||||||
result = Set(outgoingGroupMessage.sendingRecipientIds())
|
|
||||||
.intersection(thread.groupModel.groupMemberIds)
|
|
||||||
.subtracting([ getUserHexEncodedPublicKey() ]) // .subtracting(MultiDeviceProtocol.getUserLinkedDevices())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return NSMutableSet(set: result)
|
|
||||||
}
|
|
||||||
|
|
||||||
// MARK: Note to Self
|
|
||||||
@objc(isThreadNoteToSelf:)
|
|
||||||
public static func isThreadNoteToSelf(_ thread: TSThread) -> Bool {
|
|
||||||
guard let thread = thread as? TSContactThread else { return false }
|
|
||||||
return thread.contactIdentifier() == getUserHexEncodedPublicKey()
|
|
||||||
/*
|
|
||||||
var isNoteToSelf = false
|
|
||||||
storage.dbReadConnection.read { transaction in
|
|
||||||
isNoteToSelf = LokiDatabaseUtilities.isUserLinkedDevice(thread.contactIdentifier(), transaction: transaction)
|
|
||||||
}
|
|
||||||
return isNoteToSelf
|
|
||||||
*/
|
|
||||||
}
|
|
||||||
|
|
||||||
// MARK: Transcripts
|
|
||||||
@objc(shouldSendTranscriptForMessage:inThread:)
|
|
||||||
public static func shouldSendTranscript(for message: TSOutgoingMessage, in thread: TSThread) -> Bool {
|
|
||||||
guard message.shouldSyncTranscript() else { return false }
|
|
||||||
let isOpenGroupMessage = (thread as? TSGroupThread)?.isOpenGroup == true
|
|
||||||
let wouldSignalRequireTranscript = (AreRecipientUpdatesEnabled() || !message.hasSyncedTranscript)
|
|
||||||
guard wouldSignalRequireTranscript && !isOpenGroupMessage else { return false }
|
|
||||||
return false
|
|
||||||
/*
|
|
||||||
var usesMultiDevice = false
|
|
||||||
storage.dbReadConnection.read { transaction in
|
|
||||||
usesMultiDevice = !storage.getDeviceLinks(for: getUserHexEncodedPublicKey(), in: transaction).isEmpty
|
|
||||||
|| UserDefaults.standard[.masterHexEncodedPublicKey] != nil
|
|
||||||
}
|
|
||||||
return usesMultiDevice
|
|
||||||
*/
|
|
||||||
}
|
|
||||||
|
|
||||||
// MARK: Typing Indicators
|
|
||||||
/// Invoked only if typing indicators are enabled in the settings. Provides an opportunity
|
|
||||||
/// to avoid sending them if certain conditions are met.
|
|
||||||
@objc(shouldSendTypingIndicatorInThread:)
|
|
||||||
public static func shouldSendTypingIndicator(in thread: TSThread) -> Bool {
|
|
||||||
return !thread.isGroupThread() && thread.numberOfInteractions() > 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// MARK: Receipts
|
|
||||||
@objc(shouldSendReceiptInThread:)
|
|
||||||
public static func shouldSendReceipt(in thread: TSThread) -> Bool {
|
|
||||||
return !thread.isGroupThread()
|
|
||||||
}
|
|
||||||
|
|
||||||
// MARK: - Receiving
|
|
||||||
|
|
||||||
@objc(isErrorMessageFromBeforeRestoration:)
|
|
||||||
public static func isErrorMessageFromBeforeRestoration(_ errorMessage: TSErrorMessage) -> Bool {
|
|
||||||
let restorationTimeInMs = UInt64(storage.getRestorationTime() * 1000)
|
|
||||||
return errorMessage.timestamp < restorationTimeInMs
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(updateDisplayNameIfNeededForPublicKey:using:transaction:)
|
|
||||||
public static func updateDisplayNameIfNeeded(for publicKey: String, using dataMessage: SNProtoDataMessage, in transaction: YapDatabaseReadWriteTransaction) {
|
|
||||||
guard let profile = dataMessage.profile, let displayName = profile.displayName, !displayName.isEmpty else { return }
|
|
||||||
let profileManager = SSKEnvironment.shared.profileManager
|
|
||||||
profileManager.updateProfileForContact(withID: publicKey, displayName: displayName, with: transaction)
|
|
||||||
}
|
|
||||||
|
|
||||||
@objc(updateProfileKeyIfNeededForPublicKey:using:)
|
|
||||||
public static func updateProfileKeyIfNeeded(for publicKey: String, using dataMessage: SNProtoDataMessage) {
|
|
||||||
guard dataMessage.hasProfileKey, let profileKey = dataMessage.profileKey else { return }
|
|
||||||
guard profileKey.count == kAES256_KeyByteLength else {
|
|
||||||
return SNLog("Unexpected profile key size: \(profileKey.count).")
|
|
||||||
}
|
|
||||||
let profilePictureURL = dataMessage.profile?.profilePicture
|
|
||||||
let profileManager = SSKEnvironment.shared.profileManager
|
|
||||||
profileManager.setProfileKeyData(profileKey, forRecipientId: publicKey, avatarURL: profilePictureURL)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Loading…
Reference in New Issue