feat(desktop): keep the login tokens only in the OS keychain (#105 step 2)
CI / Build & Quality Checks (push) Skipped
CI / Secret scan (gitleaks) (push) Skipped
CI / Playwright smoke (e2e) (push) Skipped
CI / Build & Quality Checks (pull_request) Successful in 3m50s
CI / Trigger Desktop Build (pull_request) Skipped
CI / Docker image build & smoke test (pull_request) Skipped
CI / Secret scan (gitleaks) (pull_request) Successful in 12s
CI / Playwright smoke (e2e) (pull_request) Successful in 20m30s
CI / Build & Quality Checks (push) Skipped
CI / Secret scan (gitleaks) (push) Skipped
CI / Playwright smoke (e2e) (push) Skipped
CI / Build & Quality Checks (pull_request) Successful in 3m50s
CI / Trigger Desktop Build (pull_request) Skipped
CI / Docker image build & smoke test (pull_request) Skipped
CI / Secret scan (gitleaks) (pull_request) Successful in 12s
CI / Playwright smoke (e2e) (pull_request) Successful in 20m30s
On the desktop app with a working keychain (Windows Credential Manager), the tokens leave localStorage: it keeps a token-less shell blob (tokensIn: keychain) and the full session lives in memory, read from the keychain at boot before anything reads the session, so getFallbackSession stays synchronous. Web, Linux and older desktop builds are unchanged. - A new session (login, token refresh) is written to localStorage in full first; the mirror verifies the keychain copy and only then strips the tokens, so one durable store always holds the newest tokens. - Existing installs migrate on first boot the same way; a failing keychain write keeps the tokens in localStorage. - If a shell is there but the keychain entry is missing or unreadable, the app shows Retry / Sign in again instead of logging out, and the mirror is not started (it would clear the entry). Fixes #105 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017PCb59uY3UKqDqt7B6hzd5
This commit is contained in:
1 parent
4120ccdbcc
commit
5f3c5d370a
6 files changed
+571
-75
No files matched your search
+85
-67
@@ -18,75 +18,18 @@ import './app/i18n';
|
||||
import { pushSessionToSW } from './sw-session';
|
||||
import { getFallbackSession } from './app/state/sessions';
|
||||
import { startKeychainMirror } from './app/state/keychainMirror';
|
||||
import { bootKeychainSession, KeychainBootResult } from './app/state/keychainSession';
|
||||
import { KeychainUnavailable } from './app/pages/KeychainUnavailable';
|
||||
import { tauriInvoke } from './app/hooks/useTauri';
|
||||
import { cleanupSearchCacheIfSignedOut } from './client/initMatrix';
|
||||
|
||||
document.body.classList.add(configClass, varsClass);
|
||||
|
||||
// [Gitea #105] Desktop: keep a copy of the login tokens in the OS keychain
|
||||
// (step 1: mirror only; the session is still read from localStorage).
|
||||
startKeychainMirror(tauriInvoke());
|
||||
|
||||
// Register Service Worker
|
||||
// Service workers only register on http(s) pages. The desktop app loads from
|
||||
// `tauri://localhost` in debug builds (and on any platform where the localhost
|
||||
// plugin isn't used), where register() rejects: that surfaced in Sentry as an
|
||||
// unhandled "must be called with a script URL whose protocol is either HTTP or
|
||||
// HTTPS". Skip it there; the app works without a SW, only authenticated media
|
||||
// falls back to the client's own fetch.
|
||||
const swProtocolOk = window.location.protocol === 'https:' || window.location.protocol === 'http:';
|
||||
if ('serviceWorker' in navigator && swProtocolOk) {
|
||||
const swUrl =
|
||||
import.meta.env.MODE === 'production'
|
||||
? `${trimTrailingSlash(import.meta.env.BASE_URL)}/sw.js`
|
||||
: `/dev-sw.js?dev-sw`;
|
||||
|
||||
const sendSessionToSW = () => {
|
||||
const session = getFallbackSession();
|
||||
pushSessionToSW(session?.baseUrl, session?.accessToken, session?.userId);
|
||||
};
|
||||
|
||||
// The dev worker is an ES module (it imports workbox), so it must be
|
||||
// registered as one — otherwise "script evaluation failed" and the dev
|
||||
// client has no SW: authenticated media 401s and notification clicks
|
||||
// never route. Production sw.js is a classic bundled script.
|
||||
navigator.serviceWorker
|
||||
.register(swUrl, import.meta.env.MODE === 'production' ? undefined : { type: 'module' })
|
||||
.then(sendSessionToSW)
|
||||
.catch((err) => {
|
||||
// e.g. a private window with SWs disabled; the app still works.
|
||||
console.warn('Service worker registration failed', err);
|
||||
});
|
||||
navigator.serviceWorker.ready.then(sendSessionToSW);
|
||||
|
||||
navigator.serviceWorker.addEventListener('message', (ev) => {
|
||||
const { type } = ev.data ?? {};
|
||||
|
||||
if (type === 'requestSession') {
|
||||
sendSessionToSW();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Request persistent storage so the browser can't evict the IndexedDB
|
||||
// rust-crypto store under storage pressure. Eviction (while the localStorage
|
||||
// session/device-id survives) resurrects the device with a blank crypto store,
|
||||
// which then re-uploads OTKs the server already holds → the "one time key
|
||||
// already exists" upload storm and E2EE breakage. Only ask for sessions worth
|
||||
// protecting (skip anonymous/landing visitors to avoid a needless Firefox
|
||||
// prompt); check persisted() first so we don't re-prompt. Best-effort.
|
||||
// [Gitea #45] If a logout's search-index wipe lost the multi-tab race (another
|
||||
// tab still held the DB), finish it now that no session exists.
|
||||
if (!getFallbackSession()) {
|
||||
cleanupSearchCacheIfSignedOut().catch(() => undefined);
|
||||
}
|
||||
|
||||
if (navigator.storage?.persist && getFallbackSession()) {
|
||||
navigator.storage
|
||||
.persisted()
|
||||
.then((already) => (already ? undefined : navigator.storage.persist()))
|
||||
.catch(() => undefined);
|
||||
}
|
||||
// [Gitea #105] Desktop: the login tokens live in the OS keychain. Read them
|
||||
// into memory BEFORE anything reads the session (step 2), then keep the
|
||||
// keychain in line with every login / refresh / logout. If the keychain should
|
||||
// hold them but can't be read, show Retry instead of the app, and don't start
|
||||
// the mirror: it would clear the entry it couldn't read.
|
||||
|
||||
// Reload once if a lazy-loaded chunk is missing (stale deployment)
|
||||
window.addEventListener('vite:preloadError', () => {
|
||||
@@ -121,7 +64,72 @@ window.addEventListener('load', () => sessionStorage.removeItem('chunk-reload-at
|
||||
};
|
||||
}
|
||||
|
||||
const mountApp = () => {
|
||||
// Everything that reads the session runs once the keychain step decided it.
|
||||
const startSessionDependent = () => {
|
||||
// Register Service Worker
|
||||
// Service workers only register on http(s) pages. The desktop app loads from
|
||||
// `tauri://localhost` in debug builds (and on any platform where the localhost
|
||||
// plugin isn't used), where register() rejects: that surfaced in Sentry as an
|
||||
// unhandled "must be called with a script URL whose protocol is either HTTP or
|
||||
// HTTPS". Skip it there; the app works without a SW, only authenticated media
|
||||
// falls back to the client's own fetch.
|
||||
const swProtocolOk =
|
||||
window.location.protocol === 'https:' || window.location.protocol === 'http:';
|
||||
if ('serviceWorker' in navigator && swProtocolOk) {
|
||||
const swUrl =
|
||||
import.meta.env.MODE === 'production'
|
||||
? `${trimTrailingSlash(import.meta.env.BASE_URL)}/sw.js`
|
||||
: `/dev-sw.js?dev-sw`;
|
||||
|
||||
const sendSessionToSW = () => {
|
||||
const session = getFallbackSession();
|
||||
pushSessionToSW(session?.baseUrl, session?.accessToken, session?.userId);
|
||||
};
|
||||
|
||||
// The dev worker is an ES module (it imports workbox), so it must be
|
||||
// registered as one — otherwise "script evaluation failed" and the dev
|
||||
// client has no SW: authenticated media 401s and notification clicks
|
||||
// never route. Production sw.js is a classic bundled script.
|
||||
navigator.serviceWorker
|
||||
.register(swUrl, import.meta.env.MODE === 'production' ? undefined : { type: 'module' })
|
||||
.then(sendSessionToSW)
|
||||
.catch((err) => {
|
||||
// e.g. a private window with SWs disabled; the app still works.
|
||||
console.warn('Service worker registration failed', err);
|
||||
});
|
||||
navigator.serviceWorker.ready.then(sendSessionToSW);
|
||||
|
||||
navigator.serviceWorker.addEventListener('message', (ev) => {
|
||||
const { type } = ev.data ?? {};
|
||||
|
||||
if (type === 'requestSession') {
|
||||
sendSessionToSW();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Request persistent storage so the browser can't evict the IndexedDB
|
||||
// rust-crypto store under storage pressure. Eviction (while the localStorage
|
||||
// session/device-id survives) resurrects the device with a blank crypto store,
|
||||
// which then re-uploads OTKs the server already holds → the "one time key
|
||||
// already exists" upload storm and E2EE breakage. Only ask for sessions worth
|
||||
// protecting (skip anonymous/landing visitors to avoid a needless Firefox
|
||||
// prompt); check persisted() first so we don't re-prompt. Best-effort.
|
||||
// [Gitea #45] If a logout's search-index wipe lost the multi-tab race (another
|
||||
// tab still held the DB), finish it now that no session exists.
|
||||
if (!getFallbackSession()) {
|
||||
cleanupSearchCacheIfSignedOut().catch(() => undefined);
|
||||
}
|
||||
|
||||
if (navigator.storage?.persist && getFallbackSession()) {
|
||||
navigator.storage
|
||||
.persisted()
|
||||
.then((already) => (already ? undefined : navigator.storage.persist()))
|
||||
.catch(() => undefined);
|
||||
}
|
||||
};
|
||||
|
||||
const mountApp = (keychainBoot: KeychainBootResult, keychainBlocked: boolean) => {
|
||||
const rootContainer = document.getElementById('root');
|
||||
|
||||
if (rootContainer === null) {
|
||||
@@ -130,7 +138,17 @@ const mountApp = () => {
|
||||
}
|
||||
|
||||
const root = createRoot(rootContainer);
|
||||
root.render(<App />);
|
||||
root.render(
|
||||
keychainBlocked ? <KeychainUnavailable boot={keychainBoot} invoke={tauriInvoke()} /> : <App />,
|
||||
);
|
||||
};
|
||||
|
||||
mountApp();
|
||||
bootKeychainSession(tauriInvoke())
|
||||
// Whatever happens, the app mounts: an unexpected failure means "no keychain".
|
||||
.catch((): KeychainBootResult => ({ mode: 'off' }))
|
||||
.then((keychainBoot) => {
|
||||
const keychainBlocked = keychainBoot.mode === 'missing' || keychainBoot.mode === 'error';
|
||||
if (!keychainBlocked) startKeychainMirror(tauriInvoke());
|
||||
startSessionDependent();
|
||||
mountApp(keychainBoot, keychainBlocked);
|
||||
});
|
||||
Reference in new issue
Block a user