From ef4b41dac5f00a276a63f6dfd7a269dc43fcf54c Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Fri, 28 Mar 2025 13:46:20 +0000 Subject: [PATCH] Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --- src/@types/global.d.ts | 2 +- src/ipc.ts | 1 - src/language-helper.ts | 1 - src/safe-storage.ts | 61 +++++++++++++++++------------------------- src/seshat.ts | 1 - 5 files changed, 26 insertions(+), 40 deletions(-) diff --git a/src/@types/global.d.ts b/src/@types/global.d.ts index c35c220e..e628ebac 100644 --- a/src/@types/global.d.ts +++ b/src/@types/global.d.ts @@ -10,7 +10,7 @@ import { type BrowserWindow } from "electron"; import type Store from "electron-store"; import type AutoLaunch from "auto-launch"; import { type AppLocalization } from "../language-helper.js"; -import { type StoreData } from "../electron-main"; +import { type StoreData } from "../electron-main.js"; // global type extensions need to use var for whatever reason /* eslint-disable no-var */ diff --git a/src/ipc.ts b/src/ipc.ts index 8f5a12b5..5ef269fe 100644 --- a/src/ipc.ts +++ b/src/ipc.ts @@ -7,7 +7,6 @@ Please see LICENSE files in the repository root for full details. import { app, autoUpdater, desktopCapturer, ipcMain, powerSaveBlocker, TouchBar, nativeImage } from "electron"; import { relaunchApp } from "@standardnotes/electron-clear-data"; -import keytar from "keytar-forked"; import IpcMainEvent = Electron.IpcMainEvent; import { recordSSOSession } from "./protocol.js"; diff --git a/src/language-helper.ts b/src/language-helper.ts index 806d2b6f..d4d7184e 100644 --- a/src/language-helper.ts +++ b/src/language-helper.ts @@ -10,7 +10,6 @@ import { type TranslationKey as TKey } from "matrix-web-i18n"; import { dirname } from "node:path"; import { fileURLToPath } from "node:url"; -import type Store from "electron-store"; import type EN from "./i18n/strings/en_EN.json"; import { loadJsonFile } from "./utils.js"; diff --git a/src/safe-storage.ts b/src/safe-storage.ts index 48d19dec..41c3e6ab 100644 --- a/src/safe-storage.ts +++ b/src/safe-storage.ts @@ -1,5 +1,5 @@ /* -Copyright 2022 New Vector Ltd +Copyright 2022-2025 New Vector Ltd Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -15,43 +15,35 @@ limitations under the License. */ import { safeStorage } from "electron"; - -import type * as Keytar from "keytar"; +import * as keytar from "keytar-forked"; const KEYTAR_SERVICE = "element.io"; const LEGACY_KEYTAR_SERVICE = "riot.im"; -let keytar: typeof Keytar | undefined; -try { - // eslint-disable-next-line @typescript-eslint/no-var-requires - keytar = require("keytar"); -} catch (e) { - if ((e).code === "MODULE_NOT_FOUND") { - console.log("Keytar isn't installed; secure key storage is disabled."); - } else { - console.warn("Keytar unexpected error:", e); - } -} +const getStorageKey = (key: string) => `safeStorage.${key}` as const; +/** + * Migrates keytar data to safeStorage, + * deletes data from legacy keytar but keeps it in the new keytar for downgrade compatibility. + */ export async function migrate(): Promise { if (global.store.get("migratedToSafeStorage")) return; // already done - if (keytar) { - const credentials = [ - ...(await keytar.findCredentials(LEGACY_KEYTAR_SERVICE)), - ...(await keytar.findCredentials(KEYTAR_SERVICE)), - ]; - credentials.forEach((cred) => { - deletePassword(cred.account); - setPassword(cred.account, cred.password); - }); - } + const credentials = [ + ...(await keytar.findCredentials(LEGACY_KEYTAR_SERVICE)), + ...(await keytar.findCredentials(KEYTAR_SERVICE)), + ]; + credentials.forEach((cred) => { + deletePassword(cred.account); // delete from keytar & keytar legacy + setPassword(cred.account, cred.password); // write to safeStorage & keytar for downgrade compatibility + }); global.store.set("migratedToSafeStorage", true); } /** * Get the stored password for the key. + * We read from safeStorage first, then keytar & keytar legacy. * * @param key The string key name. * @@ -59,21 +51,17 @@ export async function migrate(): Promise { */ export async function getPassword(key: string): Promise { if (safeStorage.isEncryptionAvailable()) { - const encryptedValue = global.store.get(`safeStorage.${key}`); + const encryptedValue = global.store.get(getStorageKey(key)); if (typeof encryptedValue === "string") { return safeStorage.decryptString(Buffer.from(encryptedValue)); } } - if (keytar) { - return ( - (await keytar.getPassword(KEYTAR_SERVICE, key)) ?? (await keytar.getPassword(LEGACY_KEYTAR_SERVICE, key)) - ); - } - return null; + return (await keytar.getPassword(KEYTAR_SERVICE, key)) ?? (await keytar.getPassword(LEGACY_KEYTAR_SERVICE, key)); } /** * Add the password for the key to the keychain. + * We write to both safeStorage & keytar to support downgrading the application. * * @param key The string key name. * @param password The string password. @@ -83,13 +71,14 @@ export async function getPassword(key: string): Promise { export async function setPassword(key: string, password: string): Promise { if (safeStorage.isEncryptionAvailable()) { const encryptedValue = safeStorage.encryptString(password); - global.store.set(`safeStorage.${key}`, encryptedValue.toString()); + global.store.set(getStorageKey(key), encryptedValue.toString()); } - await keytar?.setPassword(KEYTAR_SERVICE, key, password); + await keytar.setPassword(KEYTAR_SERVICE, key, password); } /** * Delete the stored password for the key. + * Removes from safeStorage, keytar & keytar legacy. * * @param key The string key name. * @@ -97,9 +86,9 @@ export async function setPassword(key: string, password: string): Promise */ export async function deletePassword(key: string): Promise { if (safeStorage.isEncryptionAvailable()) { - global.store.delete(`safeStorage.${key}`); - await keytar?.deletePassword(LEGACY_KEYTAR_SERVICE, key); - await keytar?.deletePassword(KEYTAR_SERVICE, key); + global.store.delete(getStorageKey(key)); + await keytar.deletePassword(LEGACY_KEYTAR_SERVICE, key); + await keytar.deletePassword(KEYTAR_SERVICE, key); return true; } return false; diff --git a/src/seshat.ts b/src/seshat.ts index 6f5e1b95..5f4d6b35 100644 --- a/src/seshat.ts +++ b/src/seshat.ts @@ -8,7 +8,6 @@ Please see LICENSE files in the repository root for full details. import { app, ipcMain } from "electron"; import { promises as afs } from "node:fs"; import path from "node:path"; -import keytar from "keytar-forked"; import type { Seshat as SeshatType,