@protontech/openpgp 5.7.0 → 5.8.0-0

package/dist/lightweight/openpgp.mjs

@@ -1,4 +1,4 @@
-/*! OpenPGP.js v5.7.0 - 2023-03-06 - this is LGPL licensed code, see LICENSE/our website https://openpgpjs.org/ for more information. */
+/*! OpenPGP.js v5.8.0-0 - 2023-03-17 - this is LGPL licensed code, see LICENSE/our website https://openpgpjs.org/ for more information. */
 const globalThis = typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 const doneWritingPromise = Symbol('doneWritingPromise');
@@ -2303,6 +2303,7 @@ var enums = {
     simple: 0,
     salted: 1,
     iterated: 3,
+    argon2: 4,
     gnu: 101
   },
 
@@ -2767,12 +2768,41 @@ var config = {
    */
   v5Keys: false,
   /**
-   * {@link https://tools.ietf.org/html/rfc4880#section-3.7.1.3|RFC4880 3.7.1.3}:
-   * Iteration Count Byte for S2K (String to Key)
+   * S2K (String to Key) type, used for key derivation in the context of secret key encryption
+   * and password-encrypted data. Weaker s2k options are not allowed.
+   * Note: Argon2 is the strongest option but not all OpenPGP implementations are compatible with it
+   * (pending standardisation).
+   * @memberof module:config
+   * @property {enums.s2k.argon2|enums.s2k.iterated} s2kType {@link module:enums.s2k}
+   */
+  s2kType: enums.s2k.iterated,
+  /**
+   * {@link https://tools.ietf.org/html/rfc4880#section-3.7.1.3| RFC4880 3.7.1.3}:
+   * Iteration Count Byte for Iterated and Salted S2K (String to Key).
+   * Only relevant if `config.s2kType` is set to `enums.s2k.iterated`.
+   * Note: this is the exponent value, not the final number of iterations (refer to specs for more details).
    * @memberof module:config
    * @property {Integer} s2kIterationCountByte
    */
   s2kIterationCountByte: 224,
+  /**
+   * {@link https://tools.ietf.org/html/draft-ietf-openpgp-crypto-refresh-07.html#section-3.7.1.4| draft-crypto-refresh 3.7.1.4}:
+   * Argon2 parameters for S2K (String to Key).
+   * Only relevant if `config.s2kType` is set to `enums.s2k.argon2`.
+   * Default settings correspond to the second recommendation from RFC9106 ("uniformly safe option"),
+   * to ensure compatibility with memory-constrained environments.
+   * For more details on the choice of parameters, see https://tools.ietf.org/html/rfc9106#section-4.
+   * @memberof module:config
+   * @property {Object} params
+   * @property {Integer} params.passes - number of iterations t
+   * @property {Integer} params.parallelism - degree of parallelism p
+   * @property {Integer} params.memoryExponent - one-octet exponent indicating the memory size, which will be: 2**memoryExponent kibibytes.
+   */
+  s2kArgon2Params: {
+    passes: 3,
+    parallelism: 4, // lanes
+    memoryExponent: 16 // 64 MiB of RAM
+  },
   /**
    * Allow decryption of messages without integrity protection.
    * This is an **insecure** setting:
@@ -2882,7 +2912,7 @@ var config = {
    * @memberof module:config
    * @property {String} versionString A version string to be included in armored messages
    */
-  versionString: 'OpenPGP.js 5.7.0',
+  versionString: 'OpenPGP.js 5.8.0-0',
   /**
    * @memberof module:config
    * @property {String} commentString A comment string to be included in armored messages
@@ -15863,6 +15893,339 @@ const mod = {
 
 Object.assign(mod, crypto$1);
 
+const ARGON2_TYPE = 0x02; // id
+const ARGON2_VERSION = 0x13;
+const ARGON2_SALT_SIZE = 16;
+
+class Argon2OutOfMemoryError extends Error {
+  constructor(...params) {
+    super(...params);
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, Argon2OutOfMemoryError);
+    }
+
+    this.name = 'Argon2OutOfMemoryError';
+  }
+}
+
+// cache argon wasm module
+let loadArgonWasmModule;
+let argon2Promise;
+// reload wasm module above this treshold, to deallocated used memory
+const ARGON2_WASM_MEMORY_THRESHOLD_RELOAD = 2 << 19;
+
+class Argon2S2K {
+  /**
+  * @param {Object} [config] - Full configuration, defaults to openpgp.config
+  */
+  constructor(config$1 = config) {
+    const { passes, parallelism, memoryExponent } = config$1.s2kArgon2Params;
+
+    this.type = 'argon2';
+    /**  @type {Uint8Array} 16 bytes of salt */
+    this.salt = null;
+    /** @type {Integer} number of passes */
+    this.t = passes;
+    /** @type {Integer} degree of parallelism (lanes) */
+    this.p = parallelism;
+    /** @type {Integer} exponent indicating memory size */
+    this.encodedM = memoryExponent;
+  }
+
+  generateSalt() {
+    this.salt = mod.random.getRandomBytes(ARGON2_SALT_SIZE);
+  }
+
+  /**
+  * Parsing function for argon2 string-to-key specifier.
+  * @param {Uint8Array} bytes - Payload of argon2 string-to-key specifier
+  * @returns {Integer} Actual length of the object.
+  */
+  read(bytes) {
+    let i = 0;
+
+    this.salt = bytes.subarray(i, i + 16);
+    i += 16;
+
+    this.t = bytes[i++];
+    this.p = bytes[i++];
+    this.encodedM = bytes[i++]; // memory size exponent, one-octect
+
+    return i;
+  }
+
+  /**
+  * Serializes s2k information
+  * @returns {Uint8Array} Binary representation of s2k.
+  */
+  write() {
+    const arr = [
+      new Uint8Array([enums.write(enums.s2k, this.type)]),
+      this.salt,
+      new Uint8Array([this.t, this.p, this.encodedM])
+    ];
+
+    return util.concatUint8Array(arr);
+  }
+
+  /**
+  * Produces a key using the specified passphrase and the defined
+  * hashAlgorithm
+  * @param {String} passphrase - Passphrase containing user input
+  * @returns {Promise<Uint8Array>} Produced key with a length corresponding to `keySize`
+  * @throws {Argon2OutOfMemoryError|Errors}
+  * @async
+  */
+  async produceKey(passphrase, keySize) {
+    const decodedM = 2 << (this.encodedM - 1);
+
+    try {
+      if (!argon2Promise) { // first load
+        loadArgonWasmModule = loadArgonWasmModule || (await import('./argon2id.mjs')).default;
+        argon2Promise = loadArgonWasmModule();
+      }
+      // important to keep local ref to argon2 in case the module is reloaded by another instance
+      const argon2 = await argon2Promise;
+
+      const passwordBytes = util.encodeUTF8(passphrase);
+      const hash = argon2({
+        version: ARGON2_VERSION,
+        type: ARGON2_TYPE,
+        password: passwordBytes,
+        salt: this.salt,
+        tagLength: keySize,
+        memorySize: decodedM,
+        parallelism: this.p,
+        passes: this.t
+      });
+
+      // a lot of memory was used, reload to deallocate
+      if (decodedM > ARGON2_WASM_MEMORY_THRESHOLD_RELOAD) {
+        // it will be awaited if needed at the next `produceKey` invocation
+        argon2Promise = loadArgonWasmModule();
+      }
+      return hash;
+    } catch (e) {
+      if (e.message && (
+        e.message.includes('Unable to grow instance memory') || // Chrome
+        e.message.includes('failed to grow memory') || // Firefox
+        e.message.includes('WebAssembly.Memory.grow') || // Safari
+        e.message.includes('Out of memory') // Safari iOS
+      )) {
+        throw new Argon2OutOfMemoryError('Could not allocate required memory for Argon2');
+      } else {
+        throw e;
+      }
+    }
+  }
+}
+
+// GPG4Browsers - An OpenPGP implementation in javascript
+
+class GenericS2K {
+  /**
+   * @param {Object} [config] - Full configuration, defaults to openpgp.config
+   */
+  constructor(s2kType, config$1 = config) {
+    /**
+     * Hash function identifier, or 0 for gnu-dummy keys
+     * @type {module:enums.hash | 0}
+     */
+    this.algorithm = enums.hash.sha256;
+    /**
+     * enums.s2k identifier or 'gnu-dummy'
+     * @type {String}
+     */
+    this.type = enums.read(enums.s2k, s2kType);
+    /** @type {Integer} */
+    this.c = config$1.s2kIterationCountByte;
+    /** Eight bytes of salt in a binary string.
+     * @type {Uint8Array}
+     */
+    this.salt = null;
+  }
+
+  generateSalt() {
+    switch (this.type) {
+      case 'salted':
+      case 'iterated':
+        this.salt = mod.random.getRandomBytes(8);
+    }
+  }
+
+  getCount() {
+    // Exponent bias, defined in RFC4880
+    const expbias = 6;
+
+    return (16 + (this.c & 15)) << ((this.c >> 4) + expbias);
+  }
+
+  /**
+   * Parsing function for a string-to-key specifier ({@link https://tools.ietf.org/html/rfc4880#section-3.7|RFC 4880 3.7}).
+   * @param {Uint8Array} bytes - Payload of string-to-key specifier
+   * @returns {Integer} Actual length of the object.
+   */
+  read(bytes) {
+    let i = 0;
+    this.algorithm = bytes[i++];
+
+    switch (this.type) {
+      case 'simple':
+        break;
+
+      case 'salted':
+        this.salt = bytes.subarray(i, i + 8);
+        i += 8;
+        break;
+
+      case 'iterated':
+        this.salt = bytes.subarray(i, i + 8);
+        i += 8;
+
+        // Octet 10: count, a one-octet, coded value
+        this.c = bytes[i++];
+        break;
+      case 'gnu':
+        if (util.uint8ArrayToString(bytes.subarray(i, i + 3)) === 'GNU') {
+          i += 3; // GNU
+          const gnuExtType = 1000 + bytes[i++];
+          if (gnuExtType === 1001) {
+            this.type = 'gnu-dummy';
+            // GnuPG extension mode 1001 -- don't write secret key at all
+          } else {
+            throw new Error('Unknown s2k gnu protection mode.');
+          }
+        } else {
+          throw new Error('Unknown s2k type.');
+        }
+        break;
+
+      default:
+        throw new Error('Unknown s2k type.');
+    }
+
+    return i;
+  }
+
+  /**
+   * Serializes s2k information
+   * @returns {Uint8Array} Binary representation of s2k.
+   */
+  write() {
+    if (this.type === 'gnu-dummy') {
+      return new Uint8Array([101, 0, ...util.stringToUint8Array('GNU'), 1]);
+    }
+    const arr = [new Uint8Array([enums.write(enums.s2k, this.type), this.algorithm])];
+
+    switch (this.type) {
+      case 'simple':
+        break;
+      case 'salted':
+        arr.push(this.salt);
+        break;
+      case 'iterated':
+        arr.push(this.salt);
+        arr.push(new Uint8Array([this.c]));
+        break;
+      case 'gnu':
+        throw new Error('GNU s2k type not supported.');
+      default:
+        throw new Error('Unknown s2k type.');
+    }
+
+    return util.concatUint8Array(arr);
+  }
+
+  /**
+   * Produces a key using the specified passphrase and the defined
+   * hashAlgorithm
+   * @param {String} passphrase - Passphrase containing user input
+   * @returns {Promise<Uint8Array>} Produced key with a length corresponding to.
+   * hashAlgorithm hash length
+   * @async
+   */
+  async produceKey(passphrase, numBytes) {
+    passphrase = util.encodeUTF8(passphrase);
+
+    const arr = [];
+    let rlength = 0;
+
+    let prefixlen = 0;
+    while (rlength < numBytes) {
+      let toHash;
+      switch (this.type) {
+        case 'simple':
+          toHash = util.concatUint8Array([new Uint8Array(prefixlen), passphrase]);
+          break;
+        case 'salted':
+          toHash = util.concatUint8Array([new Uint8Array(prefixlen), this.salt, passphrase]);
+          break;
+        case 'iterated': {
+          const data = util.concatUint8Array([this.salt, passphrase]);
+          let datalen = data.length;
+          const count = Math.max(this.getCount(), datalen);
+          toHash = new Uint8Array(prefixlen + count);
+          toHash.set(data, prefixlen);
+          for (let pos = prefixlen + datalen; pos < count; pos += datalen, datalen *= 2) {
+            toHash.copyWithin(pos, prefixlen, pos);
+          }
+          break;
+        }
+        case 'gnu':
+          throw new Error('GNU s2k type not supported.');
+        default:
+          throw new Error('Unknown s2k type.');
+      }
+      const result = await mod.hash.digest(this.algorithm, toHash);
+      arr.push(result);
+      rlength += result.length;
+      prefixlen++;
+    }
+
+    return util.concatUint8Array(arr).subarray(0, numBytes);
+  }
+}
+
+const allowedS2KTypesForEncryption = new Set([enums.s2k.argon2, enums.s2k.iterated]);
+
+/**
+ * Instantiate a new S2K instance of the given type
+ * @param {module:enums.s2k} type
+ * @oaram {Object} [config]
+ * @returns {Object} New s2k object
+ * @throws {Error} for unknown or unsupported types
+ */
+function newS2KFromType(type, config$1 = config) {
+  switch (type) {
+    case enums.s2k.argon2:
+      return new Argon2S2K(config$1);
+    case enums.s2k.iterated:
+    case enums.s2k.gnu:
+    case enums.s2k.salted:
+    case enums.s2k.simple:
+      return new GenericS2K(type, config$1);
+    default:
+      throw new Error(`Unsupported S2K type ${type}`);
+  }
+}
+
+/**
+ * Instantiate a new S2K instance based on the config settings
+ * @oaram {Object} config
+ * @returns {Object} New s2k object
+ * @throws {Error} for unknown or unsupported types
+ */
+function newS2KFromConfig(config) {
+  const { s2kType } = config;
+
+  if (!allowedS2KTypesForEncryption.has(s2kType)) {
+    throw new Error('The provided `config.s2kType` value is not allowed');
+  }
+
+  return newS2KFromType(s2kType, config);
+}
+
 var TYPED_OK = typeof Uint8Array !== "undefined" &&
   typeof Uint16Array !== "undefined" &&
   typeof Int32Array !== "undefined";
@@ -24684,166 +25047,6 @@ class PublicKeyEncryptedSessionKeyPacket {
 
 // GPG4Browsers - An OpenPGP implementation in javascript
 
-class S2K {
-  /**
-   * @param {Object} [config] - Full configuration, defaults to openpgp.config
-   */
-  constructor(config$1 = config) {
-    /**
-     * Hash function identifier, or 0 for gnu-dummy keys
-     * @type {module:enums.hash | 0}
-     */
-    this.algorithm = enums.hash.sha256;
-    /**
-     * enums.s2k identifier or 'gnu-dummy'
-     * @type {String}
-     */
-    this.type = 'iterated';
-    /** @type {Integer} */
-    this.c = config$1.s2kIterationCountByte;
-    /** Eight bytes of salt in a binary string.
-     * @type {Uint8Array}
-     */
-    this.salt = null;
-  }
-
-  getCount() {
-    // Exponent bias, defined in RFC4880
-    const expbias = 6;
-
-    return (16 + (this.c & 15)) << ((this.c >> 4) + expbias);
-  }
-
-  /**
-   * Parsing function for a string-to-key specifier ({@link https://tools.ietf.org/html/rfc4880#section-3.7|RFC 4880 3.7}).
-   * @param {Uint8Array} bytes - Payload of string-to-key specifier
-   * @returns {Integer} Actual length of the object.
-   */
-  read(bytes) {
-    let i = 0;
-    this.type = enums.read(enums.s2k, bytes[i++]);
-    this.algorithm = bytes[i++];
-
-    switch (this.type) {
-      case 'simple':
-        break;
-
-      case 'salted':
-        this.salt = bytes.subarray(i, i + 8);
-        i += 8;
-        break;
-
-      case 'iterated':
-        this.salt = bytes.subarray(i, i + 8);
-        i += 8;
-
-        // Octet 10: count, a one-octet, coded value
-        this.c = bytes[i++];
-        break;
-
-      case 'gnu':
-        if (util.uint8ArrayToString(bytes.subarray(i, i + 3)) === 'GNU') {
-          i += 3; // GNU
-          const gnuExtType = 1000 + bytes[i++];
-          if (gnuExtType === 1001) {
-            this.type = 'gnu-dummy';
-            // GnuPG extension mode 1001 -- don't write secret key at all
-          } else {
-            throw new Error('Unknown s2k gnu protection mode.');
-          }
-        } else {
-          throw new Error('Unknown s2k type.');
-        }
-        break;
-
-      default:
-        throw new Error('Unknown s2k type.');
-    }
-
-    return i;
-  }
-
-  /**
-   * Serializes s2k information
-   * @returns {Uint8Array} Binary representation of s2k.
-   */
-  write() {
-    if (this.type === 'gnu-dummy') {
-      return new Uint8Array([101, 0, ...util.stringToUint8Array('GNU'), 1]);
-    }
-    const arr = [new Uint8Array([enums.write(enums.s2k, this.type), this.algorithm])];
-
-    switch (this.type) {
-      case 'simple':
-        break;
-      case 'salted':
-        arr.push(this.salt);
-        break;
-      case 'iterated':
-        arr.push(this.salt);
-        arr.push(new Uint8Array([this.c]));
-        break;
-      case 'gnu':
-        throw new Error('GNU s2k type not supported.');
-      default:
-        throw new Error('Unknown s2k type.');
-    }
-
-    return util.concatUint8Array(arr);
-  }
-
-  /**
-   * Produces a key using the specified passphrase and the defined
-   * hashAlgorithm
-   * @param {String} passphrase - Passphrase containing user input
-   * @returns {Promise<Uint8Array>} Produced key with a length corresponding to.
-   * hashAlgorithm hash length
-   * @async
-   */
-  async produceKey(passphrase, numBytes) {
-    passphrase = util.encodeUTF8(passphrase);
-
-    const arr = [];
-    let rlength = 0;
-
-    let prefixlen = 0;
-    while (rlength < numBytes) {
-      let toHash;
-      switch (this.type) {
-        case 'simple':
-          toHash = util.concatUint8Array([new Uint8Array(prefixlen), passphrase]);
-          break;
-        case 'salted':
-          toHash = util.concatUint8Array([new Uint8Array(prefixlen), this.salt, passphrase]);
-          break;
-        case 'iterated': {
-          const data = util.concatUint8Array([this.salt, passphrase]);
-          let datalen = data.length;
-          const count = Math.max(this.getCount(), datalen);
-          toHash = new Uint8Array(prefixlen + count);
-          toHash.set(data, prefixlen);
-          for (let pos = prefixlen + datalen; pos < count; pos += datalen, datalen *= 2) {
-            toHash.copyWithin(pos, prefixlen, pos);
-          }
-          break;
-        }
-        case 'gnu':
-          throw new Error('GNU s2k type not supported.');
-        default:
-          throw new Error('Unknown s2k type.');
-      }
-      const result = await mod.hash.digest(this.algorithm, toHash);
-      arr.push(result);
-      rlength += result.length;
-      prefixlen++;
-    }
-
-    return util.concatUint8Array(arr).subarray(0, numBytes);
-  }
-}
-
-// GPG4Browsers - An OpenPGP implementation in javascript
-
 /**
  * Symmetric-Key Encrypted Session Key Packets (Tag 3)
  *
@@ -24911,7 +25114,8 @@ class SymEncryptedSessionKeyPacket {
     }
 
     // A string-to-key (S2K) specifier, length as defined above.
-    this.s2k = new S2K();
+    const s2kType = bytes[offset++];
+    this.s2k = newS2KFromType(s2kType);
     offset += this.s2k.read(bytes.subarray(offset, bytes.length));
 
     if (this.version === 5) {
@@ -25000,8 +25204,8 @@ class SymEncryptedSessionKeyPacket {
 
     this.sessionKeyEncryptionAlgorithm = algo;
 
-    this.s2k = new S2K(config$1);
-    this.s2k.salt = mod.random.getRandomBytes(8);
+    this.s2k = newS2KFromConfig(config$1);
+    this.s2k.generateSalt();
 
     const { blockSize, keySize } = mod.getCipher(algo);
     const encryptionKey = await this.s2k.produceKey(passphrase, keySize);
@@ -25627,7 +25831,8 @@ class SecretKeyPacket extends PublicKeyPacket {
       // - [Optional] If string-to-key usage octet was 255, 254, or 253, a
       //   string-to-key specifier.  The length of the string-to-key
       //   specifier is implied by its type, as described above.
-      this.s2k = new S2K();
+      const s2kType = bytes[i++];
+      this.s2k = newS2KFromType(s2kType);
       i += this.s2k.read(bytes.subarray(i, bytes.length));
 
       if (this.s2k.type === 'gnu-dummy') {
@@ -25765,7 +25970,7 @@ class SecretKeyPacket extends PublicKeyPacket {
     }
     this.isEncrypted = null;
     this.keyMaterial = null;
-    this.s2k = new S2K(config$1);
+    this.s2k = newS2KFromType(enums.s2k.gnu, config$1);
     this.s2k.algorithm = 0;
     this.s2k.c = 0;
     this.s2k.type = 'gnu-dummy';
@@ -25796,8 +26001,8 @@ class SecretKeyPacket extends PublicKeyPacket {
       throw new Error('A non-empty passphrase is required for key encryption.');
     }
 
-    this.s2k = new S2K(config$1);
-    this.s2k.salt = mod.random.getRandomBytes(8);
+    this.s2k = newS2KFromConfig(config$1);
+    this.s2k.generateSalt();
     const cleartext = mod.serializeParams(this.algorithm, this.privateParams);
     this.symmetric = enums.symmetric.aes256;
     const key = await produceEncryptionKey(this.s2k, passphrase, this.symmetric);
@@ -29675,6 +29880,9 @@ class Message {
             decryptedSessionKeyPackets.push(skeskPacket);
           } catch (err) {
             util.printDebugError(err);
+            if (err instanceof Argon2OutOfMemoryError) {
+              exception = err;
+            }
           }
         }));
       }));