/* This file is part of TALER (C) 2016 GNUnet e.V. TALER is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. TALER is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with TALER; see the file COPYING. If not, see */ /** * Messaging for the WebExtensions wallet. Should contain * parts that are specific for WebExtensions, but as little business * logic as possible. */ /** * Imports. */ import { classifyTalerUri, CoreApiResponse, CoreApiResponseSuccess, NotificationType, TalerErrorCode, TalerUriType, WalletDiagnostics, } from "@gnu-taler/taler-util"; import { DbAccess, deleteTalerDatabase, makeErrorDetail, OpenedPromise, openPromise, openTalerDatabase, Wallet, WalletStoresV1, } from "@gnu-taler/taler-wallet-core"; import { BrowserCryptoWorkerFactory } from "./browserCryptoWorkerFactory"; import { BrowserHttpLib } from "./browserHttpLib"; import { getPermissionsApi, isFirefox } from "./compat"; import { getReadRequestPermissions } from "./permissions"; import { SynchronousCryptoWorkerFactory } from "./serviceWorkerCryptoWorkerFactory.js"; import { ServiceWorkerHttpLib } from "./serviceWorkerHttpLib"; /** * Currently active wallet instance. Might be unloaded and * re-instantiated when the database is reset. * * FIXME: Maybe move the wallet resetting into the Wallet class? */ let currentWallet: Wallet | undefined; let currentDatabase: DbAccess | undefined; /** * Last version of an outdated DB, if applicable. */ let outdatedDbVersion: number | undefined; const walletInit: OpenedPromise = openPromise(); const notificationPorts: chrome.runtime.Port[] = []; async function getDiagnostics(): Promise { const manifestData = chrome.runtime.getManifest(); const errors: string[] = []; let firefoxIdbProblem = false; let dbOutdated = false; try { await walletInit.promise; } catch (e) { errors.push("Error during wallet initialization: " + e); if ( currentDatabase === undefined && outdatedDbVersion === undefined && isFirefox() ) { firefoxIdbProblem = true; } } if (!currentWallet) { errors.push("Could not create wallet backend."); } if (!currentDatabase) { errors.push("Could not open database"); } if (outdatedDbVersion !== undefined) { errors.push(`Outdated DB version: ${outdatedDbVersion}`); dbOutdated = true; } const diagnostics: WalletDiagnostics = { walletManifestDisplayVersion: manifestData.version_name || "(undefined)", walletManifestVersion: manifestData.version, errors, firefoxIdbProblem, dbOutdated, }; return diagnostics; } async function dispatch( req: any, sender: any, sendResponse: any, ): Promise { let r: CoreApiResponse; const wrapResponse = (result: unknown): CoreApiResponseSuccess => { return { type: "response", id: req.id, operation: req.operation, result, }; }; switch (req.operation) { case "wxGetDiagnostics": { r = wrapResponse(await getDiagnostics()); break; } case "reset-db": { await deleteTalerDatabase(indexedDB as any); r = wrapResponse(await reinitWallet()); break; } case "wxGetExtendedPermissions": { const res = await new Promise((resolve, reject) => { getPermissionsApi().contains( getReadRequestPermissions(), (result: boolean) => { resolve(result); }, ); }); r = wrapResponse({ newValue: res }); break; } case "wxSetExtendedPermissions": { const newVal = req.payload.value; console.log("new extended permissions value", newVal); if (newVal) { setupHeaderListener(); r = wrapResponse({ newValue: true }); } else { await new Promise((resolve, reject) => { getPermissionsApi().remove(getReadRequestPermissions(), (rem) => { console.log("permissions removed:", rem); resolve(); }); }); r = wrapResponse({ newVal: false }); } break; } default: { const w = currentWallet; if (!w) { r = { type: "error", id: req.id, operation: req.operation, error: makeErrorDetail( TalerErrorCode.WALLET_CORE_NOT_AVAILABLE, {}, "wallet core not available", ), }; break; } r = await w.handleCoreApiRequest(req.operation, req.id, req.payload); break; } } try { sendResponse(r); } catch (e) { // might fail if tab disconnected } } function getTab(tabId: number): Promise { return new Promise((resolve, reject) => { chrome.tabs.get(tabId, (tab: chrome.tabs.Tab) => resolve(tab)); }); } function setBadgeText(options: chrome.action.BadgeTextDetails): void { // not supported by all browsers ... if (chrome && chrome.action && chrome.action.setBadgeText) { chrome.action.setBadgeText(options); } else { console.warn("can't set badge text, not supported", options); } } function waitMs(timeoutMs: number): Promise { return new Promise((resolve, reject) => { const bgPage = chrome.extension.getBackgroundPage(); if (!bgPage) { reject("fatal: no background page"); return; } bgPage.setTimeout(() => resolve(), timeoutMs); }); } function makeSyncWalletRedirect( url: string, tabId: number, oldUrl: string, params?: { [name: string]: string | undefined }, ): Record { const innerUrl = new URL(chrome.runtime.getURL(url)); if (params) { const hParams = Object.keys(params) .map((k) => `${k}=${params[k]}`) .join("&"); innerUrl.hash = innerUrl.hash + "?" + hParams; } // Some platforms don't support the sync redirect (yet), so fall back to // async redirect after a timeout. const doit = async (): Promise => { await waitMs(150); const tab = await getTab(tabId); if (tab.url === oldUrl) { console.log("redirecting to", innerUrl.href); chrome.tabs.update(tabId, { url: innerUrl.href, loadReplace: true, } as any); } }; doit(); return { redirectUrl: innerUrl.href }; } export type MessageFromBackend = { type: NotificationType; }; async function reinitWallet(): Promise { if (currentWallet) { currentWallet.stop(); currentWallet = undefined; } currentDatabase = undefined; setBadgeText({ text: "" }); try { currentDatabase = await openTalerDatabase(indexedDB as any, reinitWallet); } catch (e) { console.error("could not open database", e); walletInit.reject(e); return; } let httpLib; let cryptoWorker; if (chrome.runtime.getManifest().manifest_version === 3) { httpLib = new ServiceWorkerHttpLib(); cryptoWorker = new SynchronousCryptoWorkerFactory(); } else { httpLib = new BrowserHttpLib(); cryptoWorker = new BrowserCryptoWorkerFactory(); } console.log("setting wallet"); const wallet = await Wallet.create(currentDatabase, httpLib, cryptoWorker); try { await wallet.handleCoreApiRequest("initWallet", "native-init", {}); } catch (e) { console.error("could not initialize wallet", e); walletInit.reject(e); return; } wallet.addNotificationListener((x) => { for (const notif of notificationPorts) { const message: MessageFromBackend = { type: x.type }; try { notif.postMessage(message); } catch (e) { console.error(e); } } }); wallet.runTaskLoop().catch((e) => { console.log("error during wallet task loop", e); }); // Useful for debugging in the background page. if (typeof window !== "undefined") { (window as any).talerWallet = wallet; } currentWallet = wallet; walletInit.resolve(); } try { // This needs to be outside of main, as Firefox won't fire the event if // the listener isn't created synchronously on loading the backend. chrome.runtime.onInstalled.addListener((details) => { console.log("onInstalled with reason", details.reason); if (details.reason === "install") { const url = chrome.runtime.getURL("/static/wallet.html#/welcome"); chrome.tabs.create({ active: true, url }); } }); } catch (e) { console.error(e); } function headerListener( details: chrome.webRequest.WebResponseHeadersDetails, ): chrome.webRequest.BlockingResponse | undefined { if (chrome.runtime.lastError) { console.error(chrome.runtime.lastError); return; } const wallet = currentWallet; if (!wallet) { console.warn("wallet not available while handling header"); return; } if ( details.statusCode === 402 || details.statusCode === 202 || details.statusCode === 200 ) { for (const header of details.responseHeaders || []) { if (header.name.toLowerCase() === "taler") { const talerUri = header.value || ""; const uriType = classifyTalerUri(talerUri); switch (uriType) { case TalerUriType.TalerWithdraw: return makeSyncWalletRedirect( "/static/wallet.html#/cta/withdraw", details.tabId, details.url, { talerWithdrawUri: talerUri, }, ); case TalerUriType.TalerPay: return makeSyncWalletRedirect( "/static/wallet.html#/cta/pay", details.tabId, details.url, { talerPayUri: talerUri, }, ); case TalerUriType.TalerTip: return makeSyncWalletRedirect( "/static/wallet.html#/cta/tip", details.tabId, details.url, { talerTipUri: talerUri, }, ); case TalerUriType.TalerRefund: return makeSyncWalletRedirect( "/static/wallet.html#/cta/refund", details.tabId, details.url, { talerRefundUri: talerUri, }, ); case TalerUriType.TalerNotifyReserve: Promise.resolve().then(() => { const w = currentWallet; if (!w) { return; } // FIXME: Is this still useful? // handleNotifyReserve(w); }); break; default: console.warn( "Response with HTTP 402 has Taler header, but header value is not a taler:// URI.", ); break; } } } } return; } function setupHeaderListener(): void { // if (chrome.runtime.getManifest().manifest_version === 3) { // console.error("cannot block request on manfest v3") // return // } console.log("setting up header listener"); // Handlers for catching HTTP requests getPermissionsApi().contains( getReadRequestPermissions(), (result: boolean) => { if ( "webRequest" in chrome && "onHeadersReceived" in chrome.webRequest && chrome.webRequest.onHeadersReceived.hasListener(headerListener) ) { chrome.webRequest.onHeadersReceived.removeListener(headerListener); } if (result) { console.log("actually adding listener"); chrome.webRequest.onHeadersReceived.addListener( headerListener, { urls: [""] }, ["responseHeaders"], ); } if ("webRequest" in chrome) { chrome.webRequest.handlerBehaviorChanged(() => { if (chrome.runtime.lastError) { console.error(chrome.runtime.lastError); } }); } }, ); } /** * Main function to run for the WebExtension backend. * * Sets up all event handlers and other machinery. */ export async function wxMain(): Promise { // Explicitly unload the extension page as soon as an update is available, // so the update gets installed as soon as possible. chrome.runtime.onUpdateAvailable.addListener((details) => { console.log("update available:", details); chrome.runtime.reload(); }); const afterWalletIsInitialized = reinitWallet(); // Handlers for messages coming directly from the content // script on the page chrome.runtime.onMessage.addListener((req, sender, sendResponse) => { afterWalletIsInitialized.then(() => { dispatch(req, sender, sendResponse); }); return true; }); chrome.runtime.onConnect.addListener((port) => { notificationPorts.push(port); port.onDisconnect.addListener((discoPort) => { const idx = notificationPorts.indexOf(discoPort); if (idx >= 0) { notificationPorts.splice(idx, 1); } }); }); try { if (chrome.runtime.getManifest().manifest_version === 2) { setupHeaderListener(); } } catch (e) { console.log(e); } // On platforms that support it, also listen to external // modification of permissions. getPermissionsApi().addPermissionsListener((perm) => { if (chrome.runtime.lastError) { console.error(chrome.runtime.lastError); return; } setupHeaderListener(); }); }