From 73c35ff80e0a1d9a6323cbdd49df5a7fe4f83cbc Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Thu, 28 May 2020 00:05:45 -0400 Subject: [PATCH 1/3] set the client's pickle key if the platform can store one --- src/BasePlatform.js | 31 +++++++++++++++++++++++++++++++ src/Lifecycle.js | 15 ++++++++++++--- src/MatrixClientPeg.js | 1 + 3 files changed, 44 insertions(+), 3 deletions(-) diff --git a/src/BasePlatform.js b/src/BasePlatform.js index 8a950dc2e3..f4fa43cb10 100644 --- a/src/BasePlatform.js +++ b/src/BasePlatform.js @@ -190,4 +190,35 @@ export default class BasePlatform { onKeyDown(ev: KeyboardEvent): boolean { return false; // no shortcuts implemented } + + /** + * Get a previously stored pickle key. The pickle key is used for + * encrypting libolm objects. + * @param {string} userId the user ID for the user that the pickle key is for. + * @param {string} userId the device ID that the pickle key is for. + * @returns {string|null} the previously stored pickle key, or null if no + * pickle key has been stored. + */ + async getPickleKey(userId: string, deviceId: string): string | null { + return null; + } + + /** + * Create and store a pickle key for encrypting libolm objects. + * @param {string} userId the user ID for the user that the pickle key is for. + * @param {string} userId the device ID that the pickle key is for. + * @returns {string|null} the pickle key, or null if the platform does not + * support storing pickle keys. + */ + async createPickleKey(userId: string, deviceId: string): string | null { + return null; + } + + /** + * Delete a previously stored pickle key from storage. + * @param {string} userId the user ID for the user that the pickle key is for. + * @param {string} userId the device ID that the pickle key is for. + */ + async destroyPickleKey(userId: string, deviceId: string) { + } } diff --git a/src/Lifecycle.js b/src/Lifecycle.js index 1baa6c8e0c..598624293b 100644 --- a/src/Lifecycle.js +++ b/src/Lifecycle.js @@ -298,6 +298,8 @@ async function _restoreFromLocalStorage(opts) { return false; } + const pickleKey = await PlatformPeg.get().getPickleKey(userId, deviceId); + console.log(`Restoring session for ${userId}`); await _doSetLoggedIn({ userId: userId, @@ -306,6 +308,7 @@ async function _restoreFromLocalStorage(opts) { homeserverUrl: hsUrl, identityServerUrl: isUrl, guest: isGuest, + pickleKey: pickleKey, }, false); return true; } else { @@ -348,9 +351,13 @@ async function _handleLoadSessionFailure(e) { * * @returns {Promise} promise which resolves to the new MatrixClient once it has been started */ -export function setLoggedIn(credentials) { +export async function setLoggedIn(credentials) { stopMatrixClient(); - return _doSetLoggedIn(credentials, true); + const pickleKey = credentials.userId && credentials.deviceId + ? await PlatformPeg.get().createPickleKey(credentials.userId, credentials.deviceId) + : null; + + return _doSetLoggedIn(Object.assign({}, credentials, {pickleKey}), true); } /** @@ -516,7 +523,9 @@ export function logout() { } _isLoggingOut = true; - MatrixClientPeg.get().logout().then(onLoggedOut, + const client = MatrixClientPeg.get(); + PlatformPeg.get().destroyPickleKey(client.getUserId(), client.getDeviceId()); + client.logout().then(onLoggedOut, (err) => { // Just throwing an error here is going to be very unhelpful // if you're trying to log out because your server's down and diff --git a/src/MatrixClientPeg.js b/src/MatrixClientPeg.js index 21f05b9759..af43705227 100644 --- a/src/MatrixClientPeg.js +++ b/src/MatrixClientPeg.js @@ -218,6 +218,7 @@ class _MatrixClientPeg { accessToken: creds.accessToken, userId: creds.userId, deviceId: creds.deviceId, + pickleKey: creds.pickleKey, timelineSupport: true, forceTURN: !SettingsStore.getValue('webRtcAllowPeerToPeer', false), fallbackICEServerAllowed: !!SettingsStore.getValue('fallbackICEServerAllowed'), From 0859827910a250d9d72bf16523376a13a2375323 Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Thu, 28 May 2020 11:56:48 -0400 Subject: [PATCH 2/3] fix types --- src/BasePlatform.ts | 6 +++--- src/MatrixClientPeg.ts | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/BasePlatform.ts b/src/BasePlatform.ts index 14682728d0..ed04c67803 100644 --- a/src/BasePlatform.ts +++ b/src/BasePlatform.ts @@ -189,7 +189,7 @@ export default abstract class BasePlatform { * @returns {string|null} the previously stored pickle key, or null if no * pickle key has been stored. */ - async getPickleKey(userId: string, deviceId: string): string | null { + async getPickleKey(userId: string, deviceId: string): Promise { return null; } @@ -200,7 +200,7 @@ export default abstract class BasePlatform { * @returns {string|null} the pickle key, or null if the platform does not * support storing pickle keys. */ - async createPickleKey(userId: string, deviceId: string): string | null { + async createPickleKey(userId: string, deviceId: string): Promise { return null; } @@ -209,6 +209,6 @@ export default abstract class BasePlatform { * @param {string} userId the user ID for the user that the pickle key is for. * @param {string} userId the device ID that the pickle key is for. */ - async destroyPickleKey(userId: string, deviceId: string) { + async destroyPickleKey(userId: string, deviceId: string): Promise { } } diff --git a/src/MatrixClientPeg.ts b/src/MatrixClientPeg.ts index ddeff39216..e875a053b5 100644 --- a/src/MatrixClientPeg.ts +++ b/src/MatrixClientPeg.ts @@ -41,6 +41,7 @@ export interface IMatrixClientCreds { deviceId: string, accessToken: string, guest: boolean, + pickleKey: string, } // TODO: Move this to the js-sdk From dc4a2191c1b76b83ae4bb75f80d2de6a1c65557b Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Thu, 28 May 2020 12:04:32 -0400 Subject: [PATCH 3/3] really fix types --- src/MatrixClientPeg.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/MatrixClientPeg.ts b/src/MatrixClientPeg.ts index e875a053b5..c6ee6c546f 100644 --- a/src/MatrixClientPeg.ts +++ b/src/MatrixClientPeg.ts @@ -41,7 +41,7 @@ export interface IMatrixClientCreds { deviceId: string, accessToken: string, guest: boolean, - pickleKey: string, + pickleKey?: string, } // TODO: Move this to the js-sdk