Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable generic secrets in keytar via ipc #1286

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/ipc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import { randomArray } from "./utils";
import { Settings } from "./settings";
import { keytar } from "./keytar";
import { getDisplayMediaCallback, setDisplayMediaCallback } from "./displayMediaCallback";
import { getSecretStore } from "./secrets";

ipcMain.on("setBadgeCount", function (_ev: IpcMainEvent, count: number): void {
if (process.platform !== "win32") {
Expand Down Expand Up @@ -147,6 +148,26 @@ ipcMain.on("ipcCall", async function (_ev: IpcMainEvent, payload) {
recordSSOSession(args[0]);
break;

case "getSecret":
try {
ret = await getSecretStore().getSecret(args[0]);
} catch (e) {
ret = null;
}
break;
case "saveSecret":
try {
ret = await getSecretStore().saveSecret(args[0], args[1]);
} catch (e) {
ret = null;
}
break;
case "destroySecret":
try {
ret = await getSecretStore().destroySecret(args[0]);
} catch (e) {}
break;

case "getPickleKey":
try {
ret = await keytar?.getPassword("element.io", `${args[0]}|${args[1]}`);
Expand Down
66 changes: 66 additions & 0 deletions src/secrets.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
Copyright 2023 New Vector Ltd
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be your copyright


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 { type SafeStorage, safeStorage } from "electron";

/**
* Save secrets on a local machine until logout.
*/
interface SecretStore {
saveSecret(name: string, value: string): Promise<string | null>;
getSecret(name: string): Promise<string | null>;
destroySecret(name: string): Promise<void>;
}

class SafeStorageSecretStore implements SecretStore {
public constructor(public readonly safeStorage: SafeStorage) { }

public async saveSecret(name: string, value: string): Promise<string | null> {
global.store.set(this.storeKey(name), this.safeStorage.encryptString(value).toString("base64"));
return await this.getSecret(this.storeKey(name));
}
public async getSecret(name: string): Promise<string | null> {
return this.safeStorage.decryptString(Buffer.from(global.store.get(this.storeKey(name)) as string, "base64"));
}
public async destroySecret(name: string): Promise<void> {
global.store.delete(this.storeKey(name) as any);
}

private storeKey(name: string): string {
return `safeStorage.${name}`;
}
}

class NullSecretStore implements SecretStore {
public async saveSecret(): Promise<string | null> { return null; }
public async getSecret(): Promise<string | null> { return null; }
public async destroySecret(): Promise<void> { }
}

function createSecretStore(): SecretStore {
if (safeStorage.isEncryptionAvailable() && safeStorage.getSelectedStorageBackend() !== "basic_text") {
return new SafeStorageSecretStore(safeStorage);
}
return new NullSecretStore();
}

let secretStore: SecretStore | null = null;
export function getSecretStore(): SecretStore {
if (!secretStore) {
secretStore = createSecretStore();
}
return secretStore;
}