Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.
Add capability helpers to browser extension (#2159)
Leendert de Borstadd81c8b3fef
diff --git a/apps/browser-extension/src/entrypoints/popup/App.tsx b/apps/browser-extension/src/entrypoints/popup/App.tsxindex 287fc0835..77e76a56d 100644--- a/apps/browser-extension/src/entrypoints/popup/App.tsx+++ b/apps/browser-extension/src/entrypoints/popup/App.tsx@@ -7,6 +7,7 @@ import Header from '@/entrypoints/popup/components/Layout/Header';import PasskeyLayout from '@/entrypoints/popup/components/Layout/PasskeyLayout';import LoadingSpinner from '@/entrypoints/popup/components/LoadingSpinner';import { useApp } from '@/entrypoints/popup/context/AppContext';+import { RequireCapability } from '@/entrypoints/popup/context/CapabilityContext';import { useHeaderButtons } from '@/entrypoints/popup/context/HeaderButtonsContext';import { useLoading } from '@/entrypoints/popup/context/LoadingContext';import { NavigationProvider } from '@/entrypoints/popup/context/NavigationContext';@@ -39,6 +40,7 @@ import PasswordGeneratorSettings from '@/entrypoints/popup/pages/settings/Passwoimport Settings from '@/entrypoints/popup/pages/settings/Settings';import VaultUnlockSettings from '@/entrypoints/popup/pages/settings/VaultUnlockSettings';+import { CapabilityKeys } from '@/utils/dist/core/models/webapi';import { sendMessage } from '@/utils/messaging/ExtensionMessaging';import { useMinDurationLoading } from '@/hooks/useMinDurationLoading';@@ -211,7 +213,7 @@ const App: React.FC = () => {{ path: '/settings/identity-generator', element: <IdentityGeneratorSettings />, showBackButton: true, title: t('common.settings') },{ path: '/settings/password-generator', element: <PasswordGeneratorSettings />, showBackButton: true, title: t('common.settings') },{ path: '/settings/appearance', element: <AppearanceSettings />, showBackButton: true, title: t('common.settings') },- { path: '/settings/family-sharing', element: <FamilySharingSettings />, showBackButton: true, title: t('common.settings') },+ { path: '/settings/family-sharing', element: <RequireCapability capability={CapabilityKeys.VaultSharing}><FamilySharingSettings /></RequireCapability>, showBackButton: true, title: t('common.settings') },], [t]);useEffect(() => {diff --git a/apps/browser-extension/src/entrypoints/popup/context/CapabilityContext.tsx b/apps/browser-extension/src/entrypoints/popup/context/CapabilityContext.tsxnew file mode 100644index 000000000..99cb75514--- /dev/null+++ b/apps/browser-extension/src/entrypoints/popup/context/CapabilityContext.tsx@@ -0,0 +1,78 @@+import React, { createContext, useCallback, useContext, useEffect, useMemo, useState } from 'react';+import { Navigate } from 'react-router-dom';++import { type Capabilities, CapabilityService } from '@/utils/CapabilityService';+import { type CapabilityKey, isCapabilityEnabled } from '@/utils/dist/core/models/webapi';++type CapabilityContextType = {+ isEnabled: (key: CapabilityKey) => boolean;+ isLoaded: boolean;+}++const CapabilityContext = createContext<CapabilityContextType | undefined>(undefined);++/**+ * Serves this account's capabilities to the UI.+ */+export const CapabilityProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => {+ const [capabilities, setCapabilities] = useState<Capabilities>({});+ const [isLoaded, setIsLoaded] = useState(false);++ useEffect(() => {+ CapabilityService.getAll().then((stored) => {+ setCapabilities(stored);+ setIsLoaded(true);+ });++ return CapabilityService.watch(setCapabilities);+ }, []);++ const isEnabled = useCallback((key: CapabilityKey): boolean => isCapabilityEnabled(capabilities[key]), [capabilities]);++ const value = useMemo(() => ({ isEnabled, isLoaded }), [isEnabled, isLoaded]);++ return (+ <CapabilityContext.Provider value={value}>+ {children}+ </CapabilityContext.Provider>+ );+};++/**+ * The capability check for this account.+ */+export const useCapabilities = (): CapabilityContextType['isEnabled'] => {+ return useCapabilityContext().isEnabled;+};++/**+ * Renders a page only for accounts the capability is on for.+ * @param root0 - the capability to require and the page to render.+ * @param root0.capability - the capability the page needs.+ * @param root0.children - the page.+ */+export const RequireCapability: React.FC<{ capability: CapabilityKey; children: React.ReactNode }> = ({ capability, children }) => {+ const { isEnabled, isLoaded } = useCapabilityContext();++ /*+ * Nothing is known before the stored capabilities are read, and redirecting on a guess would throw out a+ * legitimate deep link. The popup's loading state covers the moment this takes.+ */+ if (!isLoaded) {+ return null;+ }++ return isEnabled(capability) ? <>{children}</> : <Navigate to="/" replace />;+};++/**+ * The capabilities of this account.+ */+const useCapabilityContext = (): CapabilityContextType => {+ const context = useContext(CapabilityContext);+ if (context === undefined) {+ throw new Error('useCapabilities must be used within a CapabilityProvider');+ }++ return context;+};diff --git a/apps/browser-extension/src/entrypoints/popup/main.tsx b/apps/browser-extension/src/entrypoints/popup/main.tsxindex 7cac70f75..820d0aaee 100644--- a/apps/browser-extension/src/entrypoints/popup/main.tsx+++ b/apps/browser-extension/src/entrypoints/popup/main.tsx@@ -3,6 +3,7 @@ import ReactDOM from 'react-dom/client';import App from '@/entrypoints/popup/App';import { AppProvider } from '@/entrypoints/popup/context/AppContext';import { AuthProvider } from '@/entrypoints/popup/context/AuthContext';+import { CapabilityProvider } from '@/entrypoints/popup/context/CapabilityContext';import { DbProvider } from '@/entrypoints/popup/context/DbContext';import { HeaderButtonsProvider } from '@/entrypoints/popup/context/HeaderButtonsContext';import { LoadingProvider } from '@/entrypoints/popup/context/LoadingContext';@@ -24,7 +25,9 @@ const renderApp = (): void => {<LoadingProvider><HeaderButtonsProvider><ThemeProvider>- <App />+ <CapabilityProvider>+ <App />+ </CapabilityProvider></ThemeProvider></HeaderButtonsProvider></LoadingProvider>diff --git a/apps/browser-extension/src/entrypoints/popup/pages/settings/Settings.tsx b/apps/browser-extension/src/entrypoints/popup/pages/settings/Settings.tsxindex 5c332d2a6..836d186e6 100644--- a/apps/browser-extension/src/entrypoints/popup/pages/settings/Settings.tsx+++ b/apps/browser-extension/src/entrypoints/popup/pages/settings/Settings.tsx@@ -8,6 +8,7 @@ import { HeaderIconType } from '@/entrypoints/popup/components/Icons/HeaderIconsimport PageTitle from '@/entrypoints/popup/components/PageTitle';import { useApp } from '@/entrypoints/popup/context/AppContext';import { useAuth } from '@/entrypoints/popup/context/AuthContext';+import { useCapabilities } from '@/entrypoints/popup/context/CapabilityContext';import { useHeaderButtons } from '@/entrypoints/popup/context/HeaderButtonsContext';import { useLoading } from '@/entrypoints/popup/context/LoadingContext';import { useWebApi } from '@/entrypoints/popup/context/WebApiContext';@@ -16,6 +17,7 @@ import { PopoutUtility } from '@/entrypoints/popup/utils/PopoutUtility';import { AppInfo } from '@/utils/AppInfo';import { StorageKeys } from '@/utils/constants/storageKeys';+import { CapabilityKeys } from '@/utils/dist/core/models/webapi';import { sendMessage } from '@/utils/messaging/ExtensionMessaging';import { browser, storage } from "#imports";@@ -27,6 +29,7 @@ const Settings: React.FC = () => {const { t } = useTranslation();const app = useApp();const auth = useAuth();+ const hasCapability = useCapabilities();const webApi = useWebApi();const { setHeaderButtons } = useHeaderButtons();const { setIsInitialLoading } = useLoading();@@ -326,39 +329,41 @@ const Settings: React.FC = () => {<div className="bg-white dark:bg-gray-800 rounded-lg shadow-sm border border-gray-200 dark:border-gray-700"><div className="divide-y divide-gray-200 dark:divide-gray-700">{/* Family Sharing */}- <button- onClick={navigateToFamilySharingSettings}- className="w-full px-4 py-3 flex items-center justify-between hover:bg-gray-50 dark:hover:bg-gray-700 transition-colors"- >- <div className="flex items-center">+ {hasCapability(CapabilityKeys.VaultSharing) && (+ <button+ onClick={navigateToFamilySharingSettings}+ className="w-full px-4 py-3 flex items-center justify-between hover:bg-gray-50 dark:hover:bg-gray-700 transition-colors"+ >+ <div className="flex items-center">+ <svg+ className="w-5 h-5 mr-3 text-gray-600 dark:text-gray-400"+ fill="none"+ stroke="currentColor"+ strokeWidth={2}+ viewBox="0 0 24 24"+ >+ <path+ strokeLinecap="round"+ strokeLinejoin="round"+ d="M17 20h5v-2a3 3 0 00-5.356-1.857M17 20H7m10 0v-2c0-.656-.126-1.283-.356-1.857M7 20H2v-2a3 3 0 015.356-1.857M7 20v-2c0-.656.126-1.283.356-1.857m0 0a5.002 5.002 0 019.288 0M15 7a3 3 0 11-6 0 3 3 0 016 0zm6 3a2 2 0 11-4 0 2 2 0 014 0zM7 10a2 2 0 11-4 0 2 2 0 014 0z"+ />+ </svg>+ <span className="text-gray-900 dark:text-white text-left">{t('settings.familySharing')}</span>+ <span className="ml-2 px-1.5 py-0.5 text-[10px] font-semibold rounded-full bg-primary-100 dark:bg-primary-900 text-primary-700 dark:text-primary-300 uppercase tracking-wide">+ {t('sharing.family.beta')}+ </span>+ </div><svg- className="w-5 h-5 mr-3 text-gray-600 dark:text-gray-400"+ className="w-4 h-4 text-gray-400"fill="none"stroke="currentColor"strokeWidth={2}viewBox="0 0 24 24">- <path- strokeLinecap="round"- strokeLinejoin="round"- d="M17 20h5v-2a3 3 0 00-5.356-1.857M17 20H7m10 0v-2c0-.656-.126-1.283-.356-1.857M7 20H2v-2a3 3 0 015.356-1.857M7 20v-2c0-.656.126-1.283.356-1.857m0 0a5.002 5.002 0 019.288 0M15 7a3 3 0 11-6 0 3 3 0 016 0zm6 3a2 2 0 11-4 0 2 2 0 014 0zM7 10a2 2 0 11-4 0 2 2 0 014 0z"- />+ <path strokeLinecap="round" strokeLinejoin="round" d="M9 5l7 7-7 7" /></svg>- <span className="text-gray-900 dark:text-white text-left">{t('settings.familySharing')}</span>- <span className="ml-2 px-1.5 py-0.5 text-[10px] font-semibold rounded-full bg-primary-100 dark:bg-primary-900 text-primary-700 dark:text-primary-300 uppercase tracking-wide">- {t('sharing.family.beta')}- </span>- </div>- <svg- className="w-4 h-4 text-gray-400"- fill="none"- stroke="currentColor"- strokeWidth={2}- viewBox="0 0 24 24"- >- <path strokeLinecap="round" strokeLinejoin="round" d="M9 5l7 7-7 7" />- </svg>- </button>+ </button>+ )}{/* Autofill Settings */}<buttondiff --git a/apps/browser-extension/src/utils/CapabilityService.ts b/apps/browser-extension/src/utils/CapabilityService.tsnew file mode 100644index 000000000..7bd512427--- /dev/null+++ b/apps/browser-extension/src/utils/CapabilityService.ts@@ -0,0 +1,51 @@+import { StorageKeys } from '@/utils/constants/storageKeys';+import { type StatusResponseV2 } from '@/utils/dist/core/models/webapi';++import { storage } from '#imports';++/** The resolved capabilities, keyed by capability key. */+export type Capabilities = Record<string, string>;++/**+ * Reads and stores the capabilities the server resolved for this account.+ */+export class CapabilityService {+ /**+ * Persist the capabilities that came with a status response.+ * @param status - the status response to take the capabilities from.+ */+ public static async store(status: StatusResponseV2): Promise<void> {+ const resolved = status.capabilities ?? {};++ // Only write when the status response actually changed.+ if (canonical(await this.getAll()) === canonical(resolved)) {+ return;+ }++ await storage.setItem(StorageKeys.CAPABILITIES, resolved);+ }++ /**+ * The capabilities from the last status call.+ */+ public static async getAll(): Promise<Capabilities> {+ return await storage.getItem<Capabilities>(StorageKeys.CAPABILITIES) ?? {};+ }++ /**+ * Watch for capabilities changing.+ * @param callback - called with the new set whenever it changes.+ * @returns Unwatch function.+ */+ public static watch(callback: (capabilities: Capabilities) => void): () => void {+ return storage.watch<Capabilities>(StorageKeys.CAPABILITIES, (capabilities) => callback(capabilities ?? {}));+ }+}++/**+ * Check if two capability sets are equal.+ * @param capabilities - the capabilities to serialise.+ */+function canonical(capabilities: Capabilities): string {+ return JSON.stringify(Object.entries(capabilities).sort(([a], [b]) => a.localeCompare(b)));+}diff --git a/apps/browser-extension/src/utils/WebApiService.ts b/apps/browser-extension/src/utils/WebApiService.tsindex af4b48553..d611e5f58 100644--- a/apps/browser-extension/src/utils/WebApiService.ts+++ b/apps/browser-extension/src/utils/WebApiService.ts@@ -4,6 +4,7 @@ import type { StatusResponseV2 } from '@/utils/dist/core/models/webapi';import { logoutEventEmitter } from '@/events/LogoutEventEmitter';import { AppInfo } from "./AppInfo";+import { CapabilityService } from './CapabilityService';import { ApiAuthError } from './types/errors/ApiAuthError';import { ApiRequestError } from './types/errors/ApiRequestError';import { ClientUpgradeRequiredError } from './types/errors/ClientUpgradeRequiredError';@@ -324,6 +325,10 @@ export class WebApiService {if (status.serverVersion && status.serverVersion !== '0.0.0') {await storage.setItem(StorageKeys.SERVER_VERSION, status.serverVersion);}++ // Persist the capabilities that are enabled for this account.+ await CapabilityService.store(status);+return status;} catch (error) {/**@@ -343,7 +348,8 @@ export class WebApiService {serverVersion: '0.0.0',manifestRevisions: [],personalManifestId: null,- srpSalt: ''+ srpSalt: '',+ capabilities: await CapabilityService.getAll()};}}diff --git a/apps/browser-extension/src/utils/constants/storageKeys.ts b/apps/browser-extension/src/utils/constants/storageKeys.tsindex 00d7aa493..aae8de326 100644--- a/apps/browser-extension/src/utils/constants/storageKeys.ts+++ b/apps/browser-extension/src/utils/constants/storageKeys.ts@@ -26,6 +26,8 @@ export const StorageKeys = {CLIENT_URL: 'local:clientUrl',/** Version reported by the server on the last status call. */SERVER_VERSION: 'local:serverVersion',+ /** The capabilities that are enabled for this account passed from the server. */+ CAPABILITIES: 'local:capabilities',/** -- Vault data (local cache) --@@ -197,11 +199,12 @@ export const dirtyScopeStorageKey = (scope: VaultMutationScope): `local:${string*/export const bucketRevisionKey = (manifestId: string, category: string): string => `${manifestId}:${category}`;-/** Keys that hold auth tokens and ephemeral error state. Cleared on any logout. */+/** Keys that hold auth tokens, ephemeral error state and account-scoped server state. Cleared on any logout. */export const AUTH_STORAGE_KEYS: readonly StorageKey[] = [StorageKeys.ACCESS_TOKEN,StorageKeys.REFRESH_TOKEN,StorageKeys.LAST_SYNC_ERROR,+ StorageKeys.CAPABILITIES,];/** Keys that must not survive a vault lock: the encryption key plus anything derived from decrypted data. */