From c8414fdce6ebe303eb2aa023638459747d4c702c Mon Sep 17 00:00:00 2001 From: Mikunj Date: Fri, 12 Jun 2020 13:53:54 +1000 Subject: [PATCH] Simplify sql and data files --- app/sql.js | 99 +++------------------ js/background.js | 26 +++--- js/models/conversations.js | 13 ++- js/modules/data.d.ts | 21 +---- js/modules/data.js | 32 +++---- js/modules/loki_file_server_api.js | 16 ++-- libloki/storage.js | 15 ---- libtextsecure/account_manager.js | 6 +- ts/session/index.ts | 1 + ts/session/protocols/MultiDeviceProtocol.ts | 93 ++++++++++++++++++- ts/session/types/PubKey.ts | 3 + 11 files changed, 148 insertions(+), 177 deletions(-) diff --git a/app/sql.js b/app/sql.js index 0c2589efa..d23d195d2 100644 --- a/app/sql.js +++ b/app/sql.js @@ -74,12 +74,8 @@ module.exports = { removeAllContactSignedPreKeys, createOrUpdatePairingAuthorisation, - removePairingAuthorisationForSecondaryPubKey, - getAuthorisationForSecondaryPubKey, - getGrantAuthorisationsForPrimaryPubKey, - getSecondaryDevicesFor, - getPrimaryDeviceFor, - getPairedDevicesFor, + getPairingAuthorisationsFor, + removePairingAuthorisationsFor, createOrUpdateItem, getItemById, @@ -1506,42 +1502,19 @@ async function removeAllSignedPreKeys() { const PAIRING_AUTHORISATIONS_TABLE = 'pairingAuthorisations'; -const GUARD_NODE_TABLE = 'guardNodes'; - -async function getAuthorisationForSecondaryPubKey(pubKey, options) { - const granted = options && options.granted; - let filter = ''; - if (granted) { - filter = 'AND isGranted = 1'; - } - const row = await db.get( - `SELECT json FROM ${PAIRING_AUTHORISATIONS_TABLE} WHERE secondaryDevicePubKey = $secondaryDevicePubKey ${filter};`, - { - $secondaryDevicePubKey: pubKey, - } - ); - - if (!row) { - return null; - } - - return jsonToObject(row.json); -} - -async function getGrantAuthorisationsForPrimaryPubKey(primaryDevicePubKey) { +async function getPairingAuthorisationsFor(pubKey) { const rows = await db.all( - `SELECT json FROM ${PAIRING_AUTHORISATIONS_TABLE} WHERE primaryDevicePubKey = $primaryDevicePubKey AND isGranted = 1 ORDER BY secondaryDevicePubKey ASC;`, - { - $primaryDevicePubKey: primaryDevicePubKey, - } + `SELECT json FROM ${PAIRING_AUTHORISATIONS_TABLE} WHERE primaryDevicePubKey = $pubKey OR secondaryDevicePubKey = $pubKey;`, + { $pubKey: pubKey } ); - return map(rows, row => jsonToObject(row.json)); + + return rows.map(row => jsonToObject(row.json)); } async function createOrUpdatePairingAuthorisation(data) { const { primaryDevicePubKey, secondaryDevicePubKey, grantSignature } = data; // remove any existing authorisation for this pubkey (we allow only one secondary device for now) - await removePairingAuthorisationForPrimaryPubKey(primaryDevicePubKey); + await removePairingAuthorisationsFor(primaryDevicePubKey); await db.run( `INSERT OR REPLACE INTO ${PAIRING_AUTHORISATIONS_TABLE} ( @@ -1564,30 +1537,16 @@ async function createOrUpdatePairingAuthorisation(data) { ); } -async function removePairingAuthorisationForPrimaryPubKey(pubKey) { - await db.run( - `DELETE FROM ${PAIRING_AUTHORISATIONS_TABLE} WHERE primaryDevicePubKey = $primaryDevicePubKey;`, - { - $primaryDevicePubKey: pubKey, - } - ); -} - -async function removePairingAuthorisationForSecondaryPubKey(pubKey) { +async function removePairingAuthorisationsFor(pubKey) { await db.run( - `DELETE FROM ${PAIRING_AUTHORISATIONS_TABLE} WHERE secondaryDevicePubKey = $secondaryDevicePubKey;`, + `DELETE FROM ${PAIRING_AUTHORISATIONS_TABLE} WHERE primaryDevicePubKey = $pubKey OR secondaryDevicePubKey = $pubKey;`, { - $secondaryDevicePubKey: pubKey, + $pubKey: pubKey, } ); } -async function getSecondaryDevicesFor(primaryDevicePubKey) { - const authorisations = await getGrantAuthorisationsForPrimaryPubKey( - primaryDevicePubKey - ); - return map(authorisations, row => row.secondaryDevicePubKey); -} +const GUARD_NODE_TABLE = 'guardNodes'; async function getGuardNodes() { const nodes = await db.all(`SELECT ed25519PubKey FROM ${GUARD_NODE_TABLE};`); @@ -1620,42 +1579,8 @@ async function updateGuardNodes(nodes) { await db.run('END TRANSACTION;'); } -async function getPrimaryDeviceFor(secondaryDevicePubKey) { - const row = await db.get( - `SELECT primaryDevicePubKey FROM ${PAIRING_AUTHORISATIONS_TABLE} WHERE secondaryDevicePubKey = $secondaryDevicePubKey AND isGranted = 1;`, - { - $secondaryDevicePubKey: secondaryDevicePubKey, - } - ); - - if (!row) { - return null; - } - - return row.primaryDevicePubKey; -} - // Return all the paired pubkeys for a specific pubkey (excluded), // irrespective of their Primary or Secondary status. -async function getPairedDevicesFor(pubKey) { - let results = []; - - // get primary pubkey (only works if the pubkey is a secondary pubkey) - const primaryPubKey = await getPrimaryDeviceFor(pubKey); - if (primaryPubKey) { - results.push(primaryPubKey); - } - // get secondary pubkeys (only works if the pubkey is a primary pubkey) - const secondaryPubKeys = await getSecondaryDevicesFor( - primaryPubKey || pubKey - ); - results = results.concat(secondaryPubKeys); - - // ensure the input pubkey is not in the results - results = results.filter(x => x !== pubKey); - - return results; -} const ITEMS_TABLE = 'items'; async function createOrUpdateItem(data) { diff --git a/js/background.js b/js/background.js index 7e87ac953..eb794cadc 100644 --- a/js/background.js +++ b/js/background.js @@ -9,6 +9,7 @@ textsecure, Whisper, libloki, + libsession, libsignal, StringView, BlockedNumberController, @@ -1425,8 +1426,10 @@ Whisper.events.on('devicePairingRequestRejected', async pubKey => { await libloki.storage.removeContactPreKeyBundle(pubKey); - await libloki.storage.removePairingAuthorisationForSecondaryPubKey( - pubKey + + const pubKeyObject = new libsession.Types.PubKey(pubKey); + await libsession.Protocols.MultiDeviceProtocol.removePairingAuthorisations( + pubKeyObject ); }); @@ -1435,9 +1438,9 @@ if (isSecondaryDevice) { return; } - - await libloki.storage.removePairingAuthorisationForSecondaryPubKey( - pubKey + const pubKeyObject = new libsession.Types.PubKey(pubKey); + await libsession.Protocols.MultiDeviceProtocol.removePairingAuthorisations( + pubKeyObject ); await window.lokiFileServerAPI.updateOurDeviceMapping(); // TODO: we should ensure the message was sent and retry automatically if not @@ -1752,16 +1755,13 @@ return; } - let primaryDevice = null; - const authorisation = await libloki.storage.getGrantAuthorisationForSecondaryPubKey( - sender - ); - if (authorisation) { - primaryDevice = authorisation.primaryDevicePubKey; - } + const user = libsession.Types.PubKey.from(sender); + const primaryDevice = user + ? await libsession.Protocols.MultiDeviceProtocol.getPrimaryDevice(user) + : null; const conversation = ConversationController.get( - groupId || primaryDevice || sender + groupId || (primaryDevice && primaryDevice.key) || sender ); if (conversation) { diff --git a/js/models/conversations.js b/js/models/conversations.js index 3419e15b3..032c38a8c 100644 --- a/js/models/conversations.js +++ b/js/models/conversations.js @@ -876,15 +876,12 @@ // This is already the primary conversation return this; } - const authorisation = await window.libloki.storage.getAuthorisationForSecondaryPubKey( - this.id - ); - if (authorisation) { - return ConversationController.getOrCreateAndWait( - authorisation.primaryDevicePubKey, - 'private' - ); + + const device = window.libsession.Type.PubKey.from(this.id); + if (device) { + return ConversationController.getOrCreateAndWait(device.key, 'private'); } + // Something funky has happened return this; }, diff --git a/js/modules/data.d.ts b/js/modules/data.d.ts index c70fd17e1..f95dd8a6e 100644 --- a/js/modules/data.d.ts +++ b/js/modules/data.d.ts @@ -46,7 +46,7 @@ type PairingAuthorisation = { primaryDevicePubKey: string; secondaryDevicePubKey: string; requestSignature: ArrayBuffer; - grantSignature: ArrayBuffer | null; + grantSignature?: ArrayBuffer; }; type GuardNode = { @@ -153,25 +153,10 @@ export function removeAllContactSignedPreKeys(): Promise; export function createOrUpdatePairingAuthorisation( data: PairingAuthorisation ): Promise; -export function removePairingAuthorisationForSecondaryPubKey( - pubKey: string -): Promise; -export function getGrantAuthorisationsForPrimaryPubKey( +export function getPairingAuthorisationsFor( pubKey: string ): Promise>; -export function getGrantAuthorisationForSecondaryPubKey( - pubKey: string -): Promise; -export function getAuthorisationForSecondaryPubKey( - pubKey: string -): Promise; -export function getSecondaryDevicesFor( - primaryDevicePubKey: string -): Promise>; -export function getPrimaryDeviceFor( - secondaryDevicePubKey: string -): Promise; -export function getPairedDevicesFor(pubKey: string): Promise>; +export function removePairingAuthorisationsFor(pubKey: string): Promise; // Guard Nodes export function getGuardNodes(): Promise; diff --git a/js/modules/data.js b/js/modules/data.js index cfbc3d006..33e6122c1 100644 --- a/js/modules/data.js +++ b/js/modules/data.js @@ -89,13 +89,8 @@ module.exports = { removeAllContactSignedPreKeys, createOrUpdatePairingAuthorisation, - removePairingAuthorisationForSecondaryPubKey, - getGrantAuthorisationForSecondaryPubKey, - getAuthorisationForSecondaryPubKey, - getGrantAuthorisationsForPrimaryPubKey, - getSecondaryDevicesFor, - getPrimaryDeviceFor, - getPairedDevicesFor, + getPairingAuthorisationsFor, + removePairingAuthorisationsFor, getGuardNodes, updateGuardNodes, @@ -631,21 +626,20 @@ async function createOrUpdatePairingAuthorisation(data) { }); } -async function removePairingAuthorisationForSecondaryPubKey(pubKey) { - if (!pubKey) { - return; - } - await channels.removePairingAuthorisationForSecondaryPubKey(pubKey); -} +async function getPairingAuthorisationsFor(pubKey) { + const authorisations = channels.getPairingAuthorisationsFor(pubKey); -async function getGrantAuthorisationForSecondaryPubKey(pubKey) { - return channels.getAuthorisationForSecondaryPubKey(pubKey, { - granted: true, - }); + return authorisations.map(authorisation => ({ + ...authorisation, + requestSignature: base64ToArrayBuffer(authorisation.requestSignature), + grantSignature: authorisation.grantSignature + ? base64ToArrayBuffer(authorisation.grantSignature) + : undefined, + })); } -async function getGrantAuthorisationsForPrimaryPubKey(pubKey) { - return channels.getGrantAuthorisationsForPrimaryPubKey(pubKey); +async function removePairingAuthorisationsFor(pubKey) { + await channels.removePairingAuthorisationsFor(pubKey); } function getAuthorisationForSecondaryPubKey(pubKey) { diff --git a/js/modules/loki_file_server_api.js b/js/modules/loki_file_server_api.js index 61d5b27c8..a89452911 100644 --- a/js/modules/loki_file_server_api.js +++ b/js/modules/loki_file_server_api.js @@ -1,6 +1,5 @@ /* global log, libloki, window */ /* global storage: false */ -/* global Signal: false */ /* global log: false */ const LokiAppDotNetAPI = require('./loki_app_dot_net_api'); @@ -220,16 +219,11 @@ class LokiHomeServerInstance extends LokiFileServerInstance { async updateOurDeviceMapping() { const isPrimary = !storage.get('isSecondaryDevice'); - let authorisations; - if (isPrimary) { - authorisations = await Signal.Data.getGrantAuthorisationsForPrimaryPubKey( - this.ourKey - ); - } else { - authorisations = [ - await Signal.Data.getGrantAuthorisationForSecondaryPubKey(this.ourKey), - ]; - } + const ourKey = new window.libsession.Types.PubKey(this.ourKey); + const authorisations = await window.libsession.Protocols.MultiDeviceProtocol.getPairingAuthorisations( + ourKey + ); + return this._setOurDeviceMapping(authorisations, isPrimary); } diff --git a/libloki/storage.js b/libloki/storage.js index 9f057d17e..a5fbbe7be 100644 --- a/libloki/storage.js +++ b/libloki/storage.js @@ -186,12 +186,6 @@ await window.Signal.Data.createOrUpdatePairingAuthorisation(authorisation); } - function removePairingAuthorisationForSecondaryPubKey(pubKey) { - return window.Signal.Data.removePairingAuthorisationForSecondaryPubKey( - pubKey - ); - } - // Transforms signatures from base64 to ArrayBuffer! async function getGrantAuthorisationForSecondaryPubKey(secondaryPubKey) { const conversation = ConversationController.get(secondaryPubKey); @@ -264,15 +258,6 @@ saveContactPreKeyBundle, removeContactPreKeyBundle, verifyFriendRequestAcceptPreKey, - savePairingAuthorisation, - saveAllPairingAuthorisationsFor, - removePairingAuthorisationForSecondaryPubKey, - getGrantAuthorisationForSecondaryPubKey, - getAuthorisationForSecondaryPubKey, - getPairedDevicesFor, - getAllDevicePubKeysForPrimaryPubKey, - getSecondaryDevicesFor, - getPrimaryDeviceMapping, getGuardNodes, updateGuardNodes, }; diff --git a/libtextsecure/account_manager.js b/libtextsecure/account_manager.js index e88c1581a..5385ccd5b 100644 --- a/libtextsecure/account_manager.js +++ b/libtextsecure/account_manager.js @@ -3,6 +3,7 @@ textsecure, libsignal, libloki, + libsession, lokiFileServerAPI, mnemonic, btoa, @@ -604,8 +605,9 @@ e && e.stack ? e.stack : e ); // File server upload failed or message sending failed, we should rollback changes - await libloki.storage.removePairingAuthorisationForSecondaryPubKey( - secondaryDevicePubKey + const pubKey = new libsession.Types.PubKey(secondaryDevicePubKey); + await libsession.Protocols.MultiDeviceProtocol.removePairingAuthorisations( + pubKey ); await lokiFileServerAPI.updateOurDeviceMapping(); throw e; diff --git a/ts/session/index.ts b/ts/session/index.ts index 4aeab7901..20dcfd2cb 100644 --- a/ts/session/index.ts +++ b/ts/session/index.ts @@ -1,5 +1,6 @@ import * as Messages from './messages'; import * as Protocols from './protocols'; +import * as Types from './types'; // TODO: Do we export class instances here? // E.g diff --git a/ts/session/protocols/MultiDeviceProtocol.ts b/ts/session/protocols/MultiDeviceProtocol.ts index b144c20cf..d02ba4487 100644 --- a/ts/session/protocols/MultiDeviceProtocol.ts +++ b/ts/session/protocols/MultiDeviceProtocol.ts @@ -1,6 +1,91 @@ -// TODO: Populate this with multi device specific code, e.g getting linked devices for a user etc... -// We need to deprecate the multi device code we have in js and slowly transition to this file +import _ from 'lodash'; +import { + createOrUpdatePairingAuthorisation, + getPairingAuthorisationsFor, + PairingAuthorisation, + removePairingAuthorisationsFor, +} from '../../../js/modules/data'; +import { PrimaryPubKey, PubKey, SecondaryPubKey } from '../types'; -export function implementStuffHere() { - throw new Error("Don't call me :("); +/** + * Save pairing authorisation to the database. + * @param authorisation The pairing authorisation. + */ +export async function savePairingAuthorisation( + authorisation: PairingAuthorisation +): Promise { + return createOrUpdatePairingAuthorisation(authorisation); +} + +/** + * Get pairing authorisations for a given device. + * @param device The device to get pairing authorisations for. + */ +export async function getPairingAuthorisations( + device: PubKey +): Promise> { + return getPairingAuthorisationsFor(device.key); +} + +/** + * Remove all pairing authorisations for a given device. + * @param device The device to remove authorisation for. + */ +export async function removePairingAuthorisations( + device: PubKey +): Promise { + return removePairingAuthorisationsFor(device.key); +} + +/** + * Get all devices linked to a user. + * + * @param user The user to get all the devices from. + */ +export async function getAllDevices(user: PubKey): Promise> { + const authorisations = await getPairingAuthorisations(user); + const devices = _.flatMap( + authorisations, + ({ primaryDevicePubKey, secondaryDevicePubKey }) => [ + primaryDevicePubKey, + secondaryDevicePubKey, + ] + ); + + return [...new Set(devices)].map(p => new PubKey(p)); +} + +/** + * Get the primary device linked to a user. + * + * @param user The user to get primary device for. + */ +export async function getPrimaryDevice(user: PubKey): Promise { + const authorisations = await getPairingAuthorisations(user); + if (authorisations.length === 0) { + return user; + } + + const pubKey = PrimaryPubKey.from(authorisations[0].primaryDevicePubKey); + if (!pubKey) { + throw new Error(`Primary user public key is invalid for ${user.key}.`); + } + + return pubKey; +} + +/** + * Get all the secondary devices linked to a user. + * + * @param user The user to get the devices from. + */ +export async function getSecondaryDevices( + user: PubKey +): Promise> { + const primary = await getPrimaryDevice(user); + const authorisations = await getPairingAuthorisations(primary); + + return authorisations + .map(a => a.secondaryDevicePubKey) + .map(pubKey => new SecondaryPubKey(pubKey)); } diff --git a/ts/session/types/PubKey.ts b/ts/session/types/PubKey.ts index 5653db5b5..3d0489aef 100644 --- a/ts/session/types/PubKey.ts +++ b/ts/session/types/PubKey.ts @@ -26,3 +26,6 @@ export class PubKey { return false; } } + +export class PrimaryPubKey extends PubKey {} +export class SecondaryPubKey extends PubKey {}