Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

Share browser session storage across crypto providers

Manav Rathi82d369012e88
diff --git a/web/apps/locker/src/services/account-keys.ts b/web/apps/locker/src/services/account-keys.ts
index 67abcd12e3..628c275d4e 100644
--- a/web/apps/locker/src/services/account-keys.ts
+++ b/web/apps/locker/src/services/account-keys.ts
@@ -1,4 +1,4 @@
-import { createSessionStorage } from "ente-accounts/services/session-storage";
+import { createSessionStorage } from "ente-base/session-storage";
import { decryptBox, encryptBox, generateKey } from "ente-locker-wasm";
export const { masterKeyFromSession } = createSessionStorage({
diff --git a/web/apps/photos/src/pages/gallery.tsx b/web/apps/photos/src/pages/gallery.tsx
index f713389992..46d1dfea08 100644
--- a/web/apps/photos/src/pages/gallery.tsx
+++ b/web/apps/photos/src/pages/gallery.tsx
@@ -82,11 +82,11 @@ import { subscribeMainWindowFocus } from "ente-base/electron";
import { isNamedError } from "ente-base/error";
import { hasPendingAlbumToJoin } from "ente-base/join-album";
import log from "ente-base/log";
+import { masterKeyFromSession } from "ente-base/session";
import {
clearSessionStorage,
haveMasterKeyInSession,
- masterKeyFromSession,
-} from "ente-base/session";
+} from "ente-base/session-storage";
import { savedAuthToken } from "ente-base/token";
import type { Location } from "ente-base/types";
import { ensureContactsReady } from "ente-contacts";
diff --git a/web/apps/photos/src/pages/plan.tsx b/web/apps/photos/src/pages/plan.tsx
index 9374a70706..472aee6db8 100644
--- a/web/apps/photos/src/pages/plan.tsx
+++ b/web/apps/photos/src/pages/plan.tsx
@@ -8,7 +8,7 @@ import {
LoadingIndicator,
TranslucentLoadingOverlay,
} from "ente-base/components/loaders";
-import { haveMasterKeyInSession } from "ente-base/session";
+import { haveMasterKeyInSession } from "ente-base/session-storage";
import { savedAuthToken } from "ente-base/token";
import { useRouter } from "next/router";
import { useEffect, useState, type JSX } from "react";
diff --git a/web/apps/space/src/services/secure-session-storage.ts b/web/apps/space/src/services/secure-session-storage.ts
index dc3c3365c2..05a619465e 100644
--- a/web/apps/space/src/services/secure-session-storage.ts
+++ b/web/apps/space/src/services/secure-session-storage.ts
@@ -1,4 +1,4 @@
-import { clearStashedKeyEncryptionKeyFromSession } from "ente-accounts/services/session-storage";
+import { clearStashedKeyEncryptionKeyFromSession } from "ente-base/session-storage";
import { z } from "zod";
const windowNamePrefix = "ente-space-secure-session:";
diff --git a/web/packages/accounts/components/utils/use-redirect.ts b/web/packages/accounts/components/utils/use-redirect.ts
index 4b41dc5336..fd60ac6be8 100644
--- a/web/packages/accounts/components/utils/use-redirect.ts
+++ b/web/packages/accounts/components/utils/use-redirect.ts
@@ -1,4 +1,4 @@
-import { haveMasterKeyInSession } from "ente-accounts/services/session-storage";
+import { haveMasterKeyInSession } from "ente-base/session-storage";
import { useRouter } from "next/router";
import { useEffect } from "react";
import { stashRedirect } from "../../services/redirect";
diff --git a/web/packages/accounts/pages/generate.tsx b/web/packages/accounts/pages/generate.tsx
index d07ee9c072..088c2d422d 100644
--- a/web/packages/accounts/pages/generate.tsx
+++ b/web/packages/accounts/pages/generate.tsx
@@ -18,7 +18,6 @@ import {
import { saveMasterKeyInSessionAndSafeStore } from "ente-accounts/services/prelogin-session";
import { getPreloginRecoveryKeyMnemonic } from "ente-accounts/services/recovery-key";
import { appHomeRoute } from "ente-accounts/services/redirect";
-import { haveMasterKeyInSession } from "ente-accounts/services/session-storage";
import {
generateSRPSetupAttributes,
getAndSaveSRPAttributes,
@@ -34,6 +33,7 @@ import { LoadingIndicator } from "ente-base/components/loaders";
import { useBaseContext } from "ente-base/context";
import { isNamedError } from "ente-base/error";
import log from "ente-base/log";
+import { haveMasterKeyInSession } from "ente-base/session-storage";
import { t } from "i18next";
import { useRouter } from "next/router";
import { useCallback, useEffect, useState, type ComponentType } from "react";
diff --git a/web/packages/accounts/pages/recover.tsx b/web/packages/accounts/pages/recover.tsx
index ad89096c5f..94c104359b 100644
--- a/web/packages/accounts/pages/recover.tsx
+++ b/web/packages/accounts/pages/recover.tsx
@@ -11,7 +11,6 @@ import { decryptBox } from "ente-accounts/services/crypto";
import { saveMasterKeyInSessionAndSafeStore } from "ente-accounts/services/prelogin-session";
import { recoveryKeyFromMnemonic } from "ente-accounts/services/recovery-key";
import { appHomeRoute, stashRedirect } from "ente-accounts/services/redirect";
-import { haveMasterKeyInSession } from "ente-accounts/services/session-storage";
import type { KeyAttributes } from "ente-accounts/services/user";
import {
decryptAndStoreTokenIfNeeded,
@@ -24,6 +23,7 @@ import {
} from "ente-base/components/SingleInputForm";
import { useBaseContext } from "ente-base/context";
import log from "ente-base/log";
+import { haveMasterKeyInSession } from "ente-base/session-storage";
import { t } from "i18next";
import { useRouter } from "next/router";
import { useCallback, useEffect, useState, type ComponentType } from "react";
diff --git a/web/packages/accounts/pages/verify.tsx b/web/packages/accounts/pages/verify.tsx
index 6cdefdc7e5..db81624b67 100644
--- a/web/packages/accounts/pages/verify.tsx
+++ b/web/packages/accounts/pages/verify.tsx
@@ -34,7 +34,6 @@ import {
stashedRedirect,
unstashRedirect,
} from "ente-accounts/services/redirect";
-import { clearSessionStorage } from "ente-accounts/services/session-storage";
import {
getAndSaveSRPAttributes,
getSRPAttributes,
@@ -54,6 +53,7 @@ import {
import { useBaseContext } from "ente-base/context";
import { isHTTPErrorWithStatus } from "ente-base/http";
import log from "ente-base/log";
+import { clearSessionStorage } from "ente-base/session-storage";
import { saveAuthToken } from "ente-base/token";
import { t } from "i18next";
import { useRouter } from "next/router";
diff --git a/web/packages/accounts/services/logout.ts b/web/packages/accounts/services/logout.ts
index 6c50f1d259..81daaf4a57 100644
--- a/web/packages/accounts/services/logout.ts
+++ b/web/packages/accounts/services/logout.ts
@@ -1,8 +1,8 @@
-import { clearSessionStorage } from "ente-accounts/services/session-storage";
import { clearBlobCaches } from "ente-base/blob-cache";
import { clearKVDB } from "ente-base/kv";
import { clearLocalStorage } from "ente-base/local-storage";
import log from "ente-base/log";
+import { clearSessionStorage } from "ente-base/session-storage";
import { clearStashedRedirect } from "./redirect";
import { remoteLogoutIfNeeded } from "./user";
diff --git a/web/packages/accounts/services/prelogin-session.ts b/web/packages/accounts/services/prelogin-session.ts
index 7678237005..6fbe3062aa 100644
--- a/web/packages/accounts/services/prelogin-session.ts
+++ b/web/packages/accounts/services/prelogin-session.ts
@@ -1,5 +1,5 @@
+import { createSessionStorage } from "ente-base/session-storage";
import { decryptBox, encryptBox, generateKey } from "ente-prelogin-wasm";
-import { createSessionStorage } from "./session-storage";
export const {
ensureMasterKeyFromSession,
diff --git a/web/packages/accounts/services/session-storage.ts b/web/packages/base/session-storage.ts
similarity index 93%
rename from web/packages/accounts/services/session-storage.ts
rename to web/packages/base/session-storage.ts
index 43838416ba..84c4fa5883 100644
--- a/web/packages/accounts/services/session-storage.ts
+++ b/web/packages/base/session-storage.ts
@@ -1,4 +1,5 @@
import { z } from "zod";
+import log from "./log";
export const clearSessionStorage = () => sessionStorage.clear();
@@ -66,8 +67,8 @@ export const createSessionStorage = ({
await saveKeyInSessionStore("encryptionKey", masterKey);
try {
await globalThis.electron?.saveMasterKeyInSafeStorage(masterKey);
- } catch {
- // Best effort, matching the current accounts package behaviour.
+ } catch (e) {
+ log.warn("Failed to save master key in safe storage", e);
}
};
@@ -78,8 +79,8 @@ export const createSessionStorage = ({
let masterKey: string | undefined;
try {
masterKey = await electron.masterKeyFromSafeStorage();
- } catch {
- masterKey = undefined;
+ } catch (e) {
+ log.warn("Failed to read master key from safe storage", e);
}
if (masterKey) await saveKeyInSessionStore("encryptionKey", masterKey);
diff --git a/web/packages/base/session.ts b/web/packages/base/session.ts
index ccb7cfa83c..f95a193f7e 100644
--- a/web/packages/base/session.ts
+++ b/web/packages/base/session.ts
@@ -1,89 +1,8 @@
-import { z } from "zod";
import { decryptBox, encryptBox, generateKey } from "./crypto";
-import log from "./log";
+import { createSessionStorage } from "./session-storage";
-export const clearSessionStorage = () => sessionStorage.clear();
-
-const SessionKeyData = z.object({
- encryptedData: z.string(),
- key: z.string(),
- nonce: z.string(),
-});
-
-type SessionKeyData = z.infer<typeof SessionKeyData>;
-
-const sessionKeyData = async (keyData: string): Promise<SessionKeyData> => {
- const key = await generateKey();
- const box = await encryptBox(keyData, key);
- return { key, ...box };
-};
-
-export const ensureMasterKeyFromSession = async () => {
- const key = await masterKeyFromSession();
- if (!key) throw new Error("Master key not found in session");
- return key;
-};
-
-export const haveMasterKeyInSession = () =>
- !!sessionStorage.getItem("encryptionKey");
-
-export const masterKeyFromSession = async () => {
- const value = sessionStorage.getItem("encryptionKey");
- if (!value) return undefined;
-
- const { encryptedData, key, nonce } = SessionKeyData.parse(
- JSON.parse(value),
- );
- return decryptBox({ encryptedData, nonce }, key);
-};
-
-// Desktop safe storage is optional; failures fall back to password entry next session.
-export const saveMasterKeyInSessionAndSafeStore = async (masterKey: string) => {
- await saveKeyInSessionStore("encryptionKey", masterKey);
- try {
- await globalThis.electron?.saveMasterKeyInSafeStorage(masterKey);
- } catch (e) {
- log.warn("Failed to save master key in safe storage", e);
- }
-};
-
-const saveKeyInSessionStore = async (keyName: string, keyData: string) => {
- sessionStorage.setItem(
- keyName,
- JSON.stringify(await sessionKeyData(keyData)),
- );
-};
-
-export const updateSessionFromElectronSafeStorageIfNeeded = async () => {
- const electron = globalThis.electron;
- if (!electron) return;
-
- if (haveMasterKeyInSession()) return;
-
- let masterKey: string | undefined;
- try {
- masterKey = await electron.masterKeyFromSafeStorage();
- } catch (e) {
- log.warn("Failed to read master key from safe storage", e);
- }
- if (masterKey) {
- await saveKeyInSessionStore("encryptionKey", masterKey);
- }
-};
-
-// Session storage carries the KEK across the 2FA app redirect.
-export const stashKeyEncryptionKeyInSessionStore = (kek: string) =>
- saveKeyInSessionStore("keyEncryptionKey", kek);
-
-export const unstashKeyEncryptionKeyFromSession = async () => {
- const value = sessionStorage.getItem("keyEncryptionKey");
- if (!value) return undefined;
-
- // Consume the stashed KEK once.
- sessionStorage.removeItem("keyEncryptionKey");
-
- const { encryptedData, key, nonce } = SessionKeyData.parse(
- JSON.parse(value),
- );
- return decryptBox({ encryptedData, nonce }, key);
-};
+export const {
+ ensureMasterKeyFromSession,
+ masterKeyFromSession,
+ updateSessionFromElectronSafeStorageIfNeeded,
+} = createSessionStorage({ decryptBox, encryptBox, generateKey });
diff --git a/web/packages/new/photos/services/app-lock.ts b/web/packages/new/photos/services/app-lock.ts
index bcff68878d..e3243c0831 100644
--- a/web/packages/new/photos/services/app-lock.ts
+++ b/web/packages/new/photos/services/app-lock.ts
@@ -6,7 +6,7 @@ import {
} from "ente-base/electron";
import { getKVN, getKVS, removeKV, setKV } from "ente-base/kv";
import log from "ente-base/log";
-import { haveMasterKeyInSession } from "ente-base/session";
+import { haveMasterKeyInSession } from "ente-base/session-storage";
import type {
NativeDeviceLockCapability,
NativeDeviceLockUnavailableReason,