mirror of
https://github.com/element-hq/element-desktop
synced 2025-04-04 05:03:57 +02:00
96 lines
3.2 KiB
TypeScript
96 lines
3.2 KiB
TypeScript
/*
|
|
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.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import { safeStorage } from "electron";
|
|
import * as keytar from "keytar-forked";
|
|
|
|
const KEYTAR_SERVICE = "element.io";
|
|
const LEGACY_KEYTAR_SERVICE = "riot.im";
|
|
|
|
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<void> {
|
|
if (global.store.get("migratedToSafeStorage")) return; // already done
|
|
|
|
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.
|
|
*
|
|
* @returns A promise for the password string.
|
|
*/
|
|
export async function getPassword(key: string): Promise<string | null> {
|
|
if (safeStorage.isEncryptionAvailable()) {
|
|
const encryptedValue = global.store.get(getStorageKey(key));
|
|
if (typeof encryptedValue === "string") {
|
|
return safeStorage.decryptString(Buffer.from(encryptedValue));
|
|
}
|
|
}
|
|
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.
|
|
*
|
|
* @returns A promise for the set password completion.
|
|
*/
|
|
export async function setPassword(key: string, password: string): Promise<void> {
|
|
if (safeStorage.isEncryptionAvailable()) {
|
|
const encryptedValue = safeStorage.encryptString(password);
|
|
global.store.set(getStorageKey(key), encryptedValue.toString());
|
|
}
|
|
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.
|
|
*
|
|
* @returns A promise for the deletion status. True on success.
|
|
*/
|
|
export async function deletePassword(key: string): Promise<boolean> {
|
|
if (safeStorage.isEncryptionAvailable()) {
|
|
global.store.delete(getStorageKey(key));
|
|
await keytar.deletePassword(LEGACY_KEYTAR_SERVICE, key);
|
|
await keytar.deletePassword(KEYTAR_SERVICE, key);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|