#2676 Upgrade openpgp to 6.2

Core/package.json

@@ -5,7 +5,7 @@
   "dependencies": {
     "@openpgp/web-stream-tools": "^0.1.3",
     "encoding-japanese": "^2.2.0",
-    "openpgp": "^6.1.1",
+    "openpgp": "^6.2.0",
     "sanitize-html": "^2.8.0",
     "zxcvbn": "4.4.2"
   },

Core/source/core/openpgpjs-custom.ts

@@ -0,0 +1,30 @@
+/* ©️ 2016 - present FlowCrypt a.s. Limitations apply. Contact human@flowcrypt.com */
+
+import {
+  PublicKeyPacket,
+  PublicSubkeyPacket,
+  SecretKeyPacket,
+  SecretSubkeyPacket,
+  UserIDPacket,
+  UserAttributePacket,
+  SignaturePacket,
+  KeyID,
+  Signature,
+} from 'openpgp';
+
+export type OpenPGPDataType = string | Uint8Array;
+
+export type AllowedKeyPackets =
+  | PublicKeyPacket
+  | PublicSubkeyPacket
+  | SecretKeyPacket
+  | SecretSubkeyPacket
+  | UserIDPacket
+  | UserAttributePacket
+  | SignaturePacket;
+
+export interface VerificationResult {
+  keyID: KeyID;
+  verified: Promise<true>; // throws on invalid signature
+  signature: Promise<Signature>;
+}

Core/source/core/pgp-armor.ts

@@ -5,11 +5,12 @@
 import { Buf } from './buf';
 import { ReplaceableMsgBlockType } from './msg-block';
 import { Str } from './common';
-import { CleartextMessage, Data, Message, readCleartextMessage, readMessage } from 'openpgp';
+import { CleartextMessage, Message, readCleartextMessage, readMessage } from 'openpgp';
+import { OpenPGPDataType } from './openpgpjs-custom';
 
 export type PreparedForDecrypt =
   | { isArmored: boolean; isCleartext: true; message: CleartextMessage }
-  | { isArmored: boolean; isCleartext: false; message: Message<Data> };
+  | { isArmored: boolean; isCleartext: false; message: Message<OpenPGPDataType> };
 
 type CryptoArmorHeaderDefinitions = {
   readonly [type in ReplaceableMsgBlockType | 'null' | 'signature']: CryptoArmorHeaderDefinition;

Core/source/core/pgp-key.ts

@@ -8,7 +8,6 @@ import { Store } from '../platform/store';
 import { mnemonic } from './mnemonic';
 import { getKeyExpirationTimeForCapabilities, strToHex } from '../platform/util';
 import {
-  AllowedKeyPackets,
   AnyKeyPacket,
   encryptKey,
   enums,
@@ -30,6 +29,7 @@ import {
 import { isFullyDecrypted, isFullyEncrypted } from './pgp';
 import { requireStreamReadToEnd } from '../platform/require';
 import { Str } from './common';
+import { AllowedKeyPackets } from './openpgpjs-custom';
 
 export interface PrvKeyInfo {
   private: string;

Core/source/core/pgp-msg.ts

@@ -15,7 +15,6 @@ import {
   CleartextMessage,
   createCleartextMessage,
   createMessage,
-  Data,
   encrypt,
   enums,
   Key,
@@ -24,10 +23,10 @@ import {
   PrivateKey,
   readKeys,
   sign,
-  VerificationResult,
 } from 'openpgp';
 import { isFullyDecrypted, isFullyEncrypted, isPacketDecrypted } from './pgp';
 import { MaybeStream, requireStreamReadToEnd } from '../platform/require';
+import { OpenPGPDataType, VerificationResult } from './openpgpjs-custom';
 
 export namespace PgpMsgMethod {
   export namespace Arg {
@@ -52,7 +51,7 @@ export namespace PgpMsgMethod {
   export type VerifyDetached = (arg: Arg.VerifyDetached) => Promise<VerifyRes>;
   export type Decrypt = (arg: Arg.Decrypt) => Promise<DecryptSuccess | DecryptError>;
   export type Type = (arg: Arg.Type) => Promise<PgpMsgTypeResult>;
-  export type Encrypt = (arg: Arg.Encrypt) => Promise<Data>;
+  export type Encrypt = (arg: Arg.Encrypt) => Promise<OpenPGPDataType>;
 }
 
 type SortedKeysForDecrypt = {
@@ -74,13 +73,13 @@ export type DecryptError = {
   longids: DecryptError$longids;
   content?: Buf;
   isEncrypted?: boolean;
-  message?: Message<Data> | CleartextMessage;
+  message?: Message<OpenPGPDataType> | CleartextMessage;
 };
 type PreparedForDecrypt =
   | { isArmored: boolean; isCleartext: true; message: CleartextMessage }
-  | { isArmored: boolean; isCleartext: false; message: Message<Data> };
+  | { isArmored: boolean; isCleartext: false; message: Message<OpenPGPDataType> };
 
-type OpenpgpMsgOrCleartext = Message<Data> | CleartextMessage;
+type OpenpgpMsgOrCleartext = Message<OpenPGPDataType> | CleartextMessage;
 
 export type VerifyRes = {
   signer?: string;
@@ -265,7 +264,7 @@ export class PgpMsg {
       };
     }
     try {
-      const packets = (prepared.message as Message<Data>).packets;
+      const packets = (prepared.message as Message<OpenPGPDataType>).packets;
       const isSymEncrypted = packets.filterByTag(enums.packet.symEncryptedSessionKey).length > 0;
       const isPubEncrypted = packets.filterByTag(enums.packet.publicKeyEncryptedSessionKey).length > 0;
       if (isSymEncrypted && !isPubEncrypted && !msgPwd) {
@@ -279,7 +278,7 @@ export class PgpMsg {
       const passwords = msgPwd ? [msgPwd] : undefined;
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       const privateKeys = keys.prvForDecryptDecrypted.map(ki => ki.decrypted!);
-      const decrypted = await (prepared.message as Message<Data>).decrypt(privateKeys, passwords);
+      const decrypted = await (prepared.message as Message<OpenPGPDataType>).decrypt(privateKeys, passwords);
       // we can only figure out who signed the msg once it's decrypted
       await PgpMsg.cryptoMsgGetSignedBy(decrypted, keys);
       await PgpMsg.populateKeysForVerification(keys, verificationPubkeys);
@@ -292,7 +291,8 @@ export class PgpMsg {
       const signature = verifyResults ? await PgpMsg.verify(verifyResults, []) : undefined;
       if (
         !prepared.isCleartext &&
-        (prepared.message as Message<Data>).packets.filterByTag(enums.packet.symmetricallyEncryptedData).length
+        (prepared.message as Message<OpenPGPDataType>).packets.filterByTag(enums.packet.symmetricallyEncryptedData)
+          .length
       ) {
         const noMdc =
           'Security threat!\n\nMessage is missing integrity checks (MDC). ' +
@@ -429,7 +429,7 @@ export class PgpMsg {
       prvForDecryptDecrypted: [],
       prvForDecryptWithoutPassphrases: [],
     };
-    const encryptedForKeyids = msg instanceof Message ? (msg as Message<Data>).getEncryptionKeyIDs() : [];
+    const encryptedForKeyids = msg instanceof Message ? (msg as Message<OpenPGPDataType>).getEncryptionKeyIDs() : [];
     keys.encryptedFor = await PgpKey.longids(encryptedForKeyids);
     await PgpMsg.cryptoMsgGetSignedBy(msg, keys);
     await PgpMsg.populateKeysForVerification(keys, verificationPubkeys);