#5667 Added message decryption on Thunderbird

extension/js/common/browser/browser-msg.ts

@@ -8,7 +8,7 @@
 import { AuthRes } from '../api/authentication/google/google-oauth.js';
 import { AjaxErr } from '../api/shared/api-error.js';
 import { Buf } from '../core/buf.js';
-import { Dict, Str, Url, UrlParams } from '../core/common.js';
+import { Dict, Str, UrlParams } from '../core/common.js';
 import { NotificationGroupType } from '../notifications.js';
 import { Catch } from '../platform/catch.js';
 import { PassphraseDialogType } from '../xss-safe-factory.js';
@@ -18,8 +18,6 @@ import { RenderMessage } from '../render-message.js';
 import { SymEncryptedMessage, SymmetricMessageEncryption } from '../symmetric-message-encryption.js';
 import { Ajax as ApiAjax, ResFmt } from '../api/shared/api.js';
 import { Ui } from './ui.js';
-import { GlobalStore } from '../platform/store/global-store.js';
-import { BgUtils } from '../../service_worker/bgutils.js';
 
 export type GoogleAuthWindowResult$result = 'Success' | 'Denied' | 'Error' | 'Closed';
 export type ScreenDimensions = { width: number; height: number; availLeft: number; availTop: number };
@@ -453,40 +451,6 @@ export class BrowserMsg {
     });
   }
 
-  public static thunderbirdSecureComposeHandler() {
-    const handleClickEvent = async (tabId: number, acctEmail: string, thunderbirdMsgId: number, composeMethod?: messenger.compose._ComposeDetailsType) => {
-      const accountEmails = await GlobalStore.acctEmailsGet();
-      const useFullScreenSecureCompose = (await messenger.windows.getCurrent()).type === 'messageCompose';
-      composeMethod = composeMethod === 'reply' || composeMethod === 'forward' ? composeMethod : undefined;
-      if (accountEmails.length !== 0) {
-        await BgUtils.openExtensionTab(
-          Url.create('/chrome/settings/inbox/inbox.htm', { acctEmail, useFullScreenSecureCompose, thunderbirdMsgId, composeMethod })
-        );
-        await messenger.tabs.remove(tabId);
-      } else {
-        await BgUtils.openExtensionTab(Url.create('/chrome/settings/initial.htm', {}));
-      }
-    };
-    messenger.composeAction.onClicked.addListener(async tab => {
-      const messageDetails = await messenger.compose.getComposeDetails(Number(tab.id));
-      const composeMethod = messageDetails.type;
-      const msgId = Number(messageDetails.relatedMessageId);
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      const acctEmail = Str.parseEmail(messageDetails.from as string).email!;
-      await handleClickEvent(Number(tab.id), acctEmail, msgId, composeMethod);
-    });
-    messenger.messageDisplayAction.onClicked.addListener(async tab => {
-      const tabId = Number(tab.id);
-      const messageDetails = await messenger.messageDisplay.getDisplayedMessage(tabId);
-      if (messageDetails) {
-        const msgId = messageDetails.id;
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const acctEmail = (await messenger.accounts.get(messageDetails.folder!.accountId)).name;
-        await handleClickEvent(tabId, acctEmail, msgId);
-      }
-    });
-  }
-
   public static alarmListen() {
     const alarmListener = (alarm: { name: string }) => {
       const alarmName = alarm.name;

extension/js/common/browser/env.ts

@@ -57,7 +57,7 @@ export class Env {
 
   // eslint-disable-next-line @typescript-eslint/require-await
   public static async webmails(): Promise<WebMailName[]> {
-    return ['gmail']; // async because storage may be involved in the future
+    return ['gmail', 'thunderbird']; // async because storage may be involved in the future
   }
 
   public static getBaseUrl() {

extension/js/common/inject.ts

@@ -57,9 +57,11 @@ export class Injector {
   }
 
   public meta = () => {
-    this.S.cached('body')
-      .addClass(`cryptup_${this.webmailName} cryptup_${this.webmailName}_${this.webmailVariant} ${Catch.browser().name}`)
-      .append(this.factory.metaStylesheet('webmail') + this.factory.metaNotificationContainer()); // xss-safe-factory
+    if (!Catch.isThunderbirdMail()) {
+      this.S.cached('body')
+        .addClass(`cryptup_${this.webmailName} cryptup_${this.webmailName}_${this.webmailVariant} ${Catch.browser().name}`)
+        .append(this.factory.metaStylesheet('webmail') + this.factory.metaNotificationContainer()); // xss-safe-factory
+    }
   };
 
   public openComposeWin = (draftId?: string, openInFullScreen?: boolean, thunderbirdMsgId?: number, replyOption?: string, replyMsgId?: string): boolean => {

extension/js/content_scripts/webmail/generic/setup-webmail-content-script.ts

@@ -74,7 +74,13 @@ export const contentScriptSetupIfVacant = async (webmailSpecific: WebmailSpecifi
     let acctEmailInterval = 1000;
     const webmails = await Env.webmails();
     while (true) {
-      const acctEmail = webmailSpecific.getUserAccountEmail();
+      // todo - find a way to obtain current user account from Thundermail
+      let acctEmail: string | undefined;
+      if (Catch.isThunderbirdMail()) {
+        acctEmail = (await messenger.runtime.sendMessage('thunderbird_get_current_user')) as string; // todo - add to BrowserMsg
+      } else {
+        acctEmail = webmailSpecific.getUserAccountEmail();
+      }
       if (typeof acctEmail !== 'undefined') {
         win.account_email_global = acctEmail;
         if (webmails.includes(webmailSpecific.name)) {
@@ -433,12 +439,16 @@ export const contentScriptSetupIfVacant = async (webmailSpecific: WebmailSpecifi
       }
       const acctEmail = await waitForAcctEmail();
       const { tabId, notifications, factory, inject } = await initInternalVars(acctEmail);
-      await showNotificationsAndWaitTilAcctSetUp(acctEmail, notifications);
+
       Catch.setHandledTimeout(() => updateClientConfiguration(acctEmail), 0);
       const ppEvent: { entered?: boolean } = {};
       const relayManager = new RelayManager();
-      browserMsgListen(acctEmail, tabId, inject, factory, notifications, relayManager, ppEvent);
+      if (webmailSpecific.name === 'gmail') {
+        await showNotificationsAndWaitTilAcctSetUp(acctEmail, notifications);
+        browserMsgListen(acctEmail, tabId, inject, factory, notifications, relayManager, ppEvent);
+      }
       const clientConfiguration = await ClientConfiguration.newInstance(acctEmail);
+      // todo - investigate startPullingKeysFromEkm in Thunderbird
       await startPullingKeysFromEkm(
         acctEmail,
         clientConfiguration,
@@ -515,6 +525,9 @@ export const contentScriptSetupIfVacant = async (webmailSpecific: WebmailSpecifi
     document.dispatchEvent(new CustomEvent(win.destruction_event));
     document.addEventListener(win.destruction_event, win.destroy);
 
+    if (Catch.isThunderbirdMail()) {
+      await entrypoint();
+    }
     if (win.vacant()) {
       await entrypoint();
     } else if (Catch.isFirefox()) {

extension/js/content_scripts/webmail/thunderbird/thunderbird-element-replacer.ts

@@ -2,12 +2,28 @@
 
 'use strict';
 
+import { Catch } from '../../../common/platform/catch';
 import { IntervalFunction, WebmailElementReplacer } from '../generic/webmail-element-replacer';
 
 export class ThunderbirdElementReplacer extends WebmailElementReplacer {
-  public getIntervalFunctions: () => IntervalFunction[];
+  // public getIntervalFunctions: () => IntervalFunction[];
   public setReplyBoxEditable: () => Promise<void>;
   public reinsertReplyBox: (replyMsgId: string) => void;
   public scrollToReplyBox: (replyMsgId: string) => void;
   public scrollToCursorInReplyBox: (replyMsgId: string, cursorOffsetTop: number) => void;
+
+  public getIntervalFunctions = (): IntervalFunction[] => {
+    return [{ interval: 1000, handler: () => this.replaceThunderbirdMsgPane() }];
+  };
+
+  private replaceThunderbirdMsgPane = () => {
+    if (Catch.isThunderbirdMail()) {
+      console.log('todo');
+      // const fullMsg = (await messenger.runtime.sendMessage('decrypt')) as messenger.messages.MessagePart;
+      //   if (fullMsg?.headers && 'openpgp' in fullMsg.headers) {
+      //     // note : embeddedMsg for pgp_block injection -> replaceArmoredBlocks
+      //     // do secure compose badge injection eg. signed or encrypted, (secure email status rendering) etc
+      //     // render decrypted message right into the messageDisplay
+    }
+  };
 }

extension/js/content_scripts/webmail/thunderbird/thunderbird-webmail-startup.ts

@@ -3,19 +3,18 @@ import { ClientConfiguration } from '../../../common/client-configuration';
 import { Injector } from '../../../common/inject';
 import { Notifications } from '../../../common/notifications';
 import { contentScriptSetupIfVacant } from '../generic/setup-webmail-content-script';
-import { GmailElementReplacer } from '../gmail/gmail-element-replacer';
 import { ThunderbirdElementReplacer } from './thunderbird-element-replacer';
 
 export class ThunderbirdWebmailStartup {
-  private replacer: GmailElementReplacer;
+  private replacer: ThunderbirdElementReplacer;
 
   public asyncConstructor = async () => {
     await contentScriptSetupIfVacant({
       name: 'thunderbird',
       variant: undefined,
       getUserAccountEmail: () => undefined, // todo, but can start with undefined
       getUserFullName: () => undefined, // todo, but can start with undefined
-      getReplacer: () => new ThunderbirdElementReplacer(), // todo - add this class empty, methods do nothing
+      getReplacer: () => this.replacer, // todo - add this class empty, methods do nothing
       start: this.start,
     });
   };
@@ -29,6 +28,7 @@ export class ThunderbirdWebmailStartup {
     // relayManager: RelayManager // todo in another issue
   ) => {
     // injector.btns(); // todo in another issue - add compose button
+    this.replacer = new ThunderbirdElementReplacer();
     this.replacer.runIntervalFunctionsPeriodically();
     await notifications.showInitial(acctEmail);
     notifications.show(

extension/js/service_worker/background.ts

@@ -68,8 +68,22 @@ console.info('background.js service worker starting');
   await BgHandlers.updateUninstallUrl({});
   injectFcIntoWebmail();
 
-  // Thunderbird event handlers
   if (Catch.isThunderbirdMail()) {
-    BrowserMsg.thunderbirdSecureComposeHandler();
+    BgHandlers.thunderbirdSecureComposeHandler();
+    await BgHandlers.thunderbirdContentScriptRegistration();
+    // todo - add background listener here with name "thunderbird_msg_decrypt"
+    // todo - move this to BrowserMsg
+    messenger.runtime.onMessage.addListener(async (message, sender) => {
+      if (message === 'thunderbird_get_current_user') {
+        if (sender.tab?.id) {
+          const messageDetails = await messenger.messageDisplay.getDisplayedMessage(sender.tab?.id);
+          if (messageDetails) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return (await messenger.accounts.get(messageDetails.folder!.accountId)).name;
+          }
+        }
+      }
+      return;
+    });
   }
 })().catch(Catch.reportErr);

extension/js/service_worker/bg-handlers.ts

@@ -10,6 +10,7 @@ import { ContactStore } from '../common/platform/store/contact-store.js';
 import { Api } from '../common/api/shared/api.js';
 import { ExpirationCache } from '../common/core/expiration-cache.js';
 import { GoogleOAuth } from '../common/api/authentication/google/google-oauth.js';
+import { Url, Str } from '../common/core/common.js';
 
 export class BgHandlers {
   public static openSettingsPageHandler: Bm.AsyncResponselessHandler = async ({ page, path, pageUrlParams, addNewAcct, acctEmail }: Bm.Settings) => {
@@ -106,4 +107,45 @@ export class BgHandlers {
         }
       });
     });
+
+  public static thunderbirdSecureComposeHandler = () => {
+    const handleClickEvent = async (tabId: number, acctEmail: string, thunderbirdMsgId: number, composeMethod?: messenger.compose._ComposeDetailsType) => {
+      const accountEmails = await GlobalStore.acctEmailsGet();
+      const useFullScreenSecureCompose = (await messenger.windows.getCurrent()).type === 'messageCompose';
+      composeMethod = composeMethod === 'reply' || composeMethod === 'forward' ? composeMethod : undefined;
+      if (accountEmails.length !== 0) {
+        await BgUtils.openExtensionTab(
+          Url.create('/chrome/settings/inbox/inbox.htm', { acctEmail, useFullScreenSecureCompose, thunderbirdMsgId, composeMethod })
+        );
+        await messenger.tabs.remove(tabId);
+      } else {
+        await BgUtils.openExtensionTab(Url.create('/chrome/settings/initial.htm', {}));
+      }
+    };
+    messenger.composeAction.onClicked.addListener(async tab => {
+      const messageDetails = await messenger.compose.getComposeDetails(Number(tab.id));
+      const composeMethod = messageDetails.type;
+      const msgId = Number(messageDetails.relatedMessageId);
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const acctEmail = Str.parseEmail(messageDetails.from as string).email!;
+      await handleClickEvent(Number(tab.id), acctEmail, msgId, composeMethod);
+    });
+    messenger.messageDisplayAction.onClicked.addListener(async tab => {
+      const tabId = Number(tab.id);
+      const messageDetails = await messenger.messageDisplay.getDisplayedMessage(tabId);
+      if (messageDetails) {
+        const msgId = messageDetails.id;
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const acctEmail = (await messenger.accounts.get(messageDetails.folder!.accountId)).name;
+        await handleClickEvent(tabId, acctEmail, msgId);
+      }
+    });
+  };
+
+  public static thunderbirdContentScriptRegistration = async () => {
+    await messenger.messageDisplayScripts.register({
+      js: [{ file: './js/content_scripts/thunderbird-content-script.js' }],
+      css: [{ file: './css/cryptup.css' }],
+    });
+  };
 }

tooling/build-types-and-manifests.ts

@@ -62,7 +62,7 @@ addManifest(
     (manifest.browser_action as messenger._manifest.ActionManifest).default_title = 'FlowCrypt';
     manifest.name = 'FlowCrypt Encryption for Thunderbird';
     manifest.description = 'Simple end-to-end encryption to secure email and attachments on Thunderbird';
-    manifest.permissions = [...(manifestV3.permissions ?? []), 'compose', 'messagesRead', 'accountsRead'];
+    manifest.permissions = [...(manifestV3.permissions ?? []), 'compose', 'messagesRead', 'messagesUpdate', 'messagesModify', 'accountsRead'];
     manifest.compose_action = {
       default_title: 'Secure Compose', // eslint-disable-line @typescript-eslint/naming-convention
       default_icon: '/img/logo/flowcrypt-logo-64-64.png', // eslint-disable-line @typescript-eslint/naming-convention

tooling/bundle-content-scripts.ts

@@ -56,3 +56,27 @@ buildContentScript(
   ),
   'webmail_bundle.js'
 );
+
+// thunderbird
+buildContentScript(
+  ([] as string[]).concat(
+    getFilesInDir(`${sourceDir}/js/common/platform`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/platform/store`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/core`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/core/crypto/`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/core/crypto/smime`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api/shared`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api/key-server`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api/account-servers`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api/authentication/generic`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api/authentication/google`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api/authentication`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api/email-provider`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api/email-provider/gmail`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/api`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common/browser`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/common`, /\.js$/, false),
+    getFilesInDir(`${sourceDir}/js/content_scripts/webmail`, /\.js$/)
+  ),
+  'thunderbird-content-script.js'
+);