@protontech/openpgp 6.1.1-patch.1 → 6.1.1-patch.2

package/dist/openpgp.mjs

@@ -1,4 +1,4 @@
-/*! OpenPGP.js v6.1.1-patch.1 - 2025-05-14 - this is LGPL licensed code, see LICENSE/our website https://openpgpjs.org/ for more information. */
+/*! OpenPGP.js v6.1.1-patch.2 - 2025-05-14 - 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 : {};
 
 function _mergeNamespaces(n, m) {
@@ -1717,7 +1717,7 @@ var config = {
    * @memberof module:config
    * @property {String} versionString A version string to be included in armored messages
    */
-  versionString: 'OpenPGP.js 6.1.1-patch.1',
+  versionString: 'OpenPGP.js 6.1.1-patch.2',
   /**
    * @memberof module:config
    * @property {String} commentString A comment string to be included in armored messages

package/openpgp.d.ts

@@ -13,7 +13,7 @@ import type { WebStream as GenericWebStream, NodeWebStream as GenericNodeWebStre
 import enums from './src/enums';
 import config, { type Config, type PartialConfig } from './src/config';
 
-export { enums, config, PartialConfig };
+export { enums, config, Config, PartialConfig };
 
 /* ############## STREAM #################### */
 type Data = Uint8Array | string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@protontech/openpgp",
   "description": "OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.",
-  "version": "6.1.1-patch.1",
+  "version": "6.1.1-patch.2",
   "license": "LGPL-3.0+",
   "homepage": "https://openpgpjs.org/",
   "engines": {
@@ -39,7 +39,8 @@
   "files": [
     "dist/",
     "lightweight/",
-    "openpgp.d.ts"
+    "openpgp.d.ts",
+    "**/*.d.ts"
   ],
   "scripts": {
     "build": "rollup --config",

package/src/config/config.d.ts

@@ -0,0 +1,68 @@
+// GPG4Browsers - An OpenPGP implementation in javascript
+// Copyright (C) 2011 Recurity Labs GmbH
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 3.0 of the License, or (at your option) any later version.
+//
+// This library 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
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+/**
+ * Global configuration values.
+ */
+
+import enums from '../enums';
+
+export interface Config {
+  preferredHashAlgorithm: enums.hash;
+  preferredSymmetricAlgorithm: enums.symmetric;
+  preferredCompressionAlgorithm: enums.compression;
+  showVersion: boolean;
+  showComment: boolean;
+  aeadProtect: boolean;
+  ignoreSEIPDv2FeatureFlag: boolean;
+  parseAEADEncryptedV4KeysAsLegacy: boolean;
+  allowUnauthenticatedMessages: boolean;
+  allowUnauthenticatedStream: boolean;
+  allowForwardedMessages: boolean;
+  minRSABits: number;
+  passwordCollisionCheck: boolean;
+  ignoreUnsupportedPackets: boolean;
+  ignoreMalformedPackets: boolean;
+  enforceGrammar: boolean;
+  pluggableGrammarErrorReporter: ((errorMessage: string) => any) | null;
+  additionalAllowedPackets: Array<{ new(): any }>;
+  versionString: string;
+  commentString: string;
+  allowInsecureDecryptionWithSigningKeys: boolean;
+  allowInsecureVerificationWithReformattedKeys: boolean;
+  allowMissingKeyFlags: boolean;
+  constantTimePKCS1Decryption: boolean;
+  constantTimePKCS1DecryptionSupportedSymmetricAlgorithms: Set<enums.symmetric>;
+  v6Keys: boolean;
+  enableParsingV5Entities: boolean;
+  preferredAEADAlgorithm: enums.aead;
+  aeadChunkSizeByte: number;
+  s2kType: enums.s2k.iterated | enums.s2k.argon2;
+  s2kIterationCountByte: number;
+  s2kArgon2Params: { passes: number, parallelism: number; memoryExponent: number; };
+  maxUserIDLength: number;
+  knownNotations: string[];
+  nonDeterministicSignaturesViaNotation: boolean;
+  useEllipticFallback: boolean;
+  rejectHashAlgorithms: Set<enums.hash>;
+  rejectMessageHashAlgorithms: Set<enums.hash>;
+  rejectPublicKeyAlgorithms: Set<enums.publicKey>;
+  rejectCurves: Set<enums.curve>;
+}
+
+declare const config: Config;
+export default config;

package/src/config/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The config module cannot be written in TS directly for now,
+ * since our JSDoc compiler does not support TS.
+ */
+import config, { type Config } from './config';
+
+
+// PartialConfig has the same properties as Config, but declared as optional.
+// This interface is relevant for top-level functions, which accept a subset of configuration options
+interface PartialConfig extends Partial<Config> {}
+
+export { Config, PartialConfig };
+export default config;

package/src/enums.d.ts

@@ -0,0 +1,195 @@
+declare namespace enums {
+  export function read(type: typeof armor, e: armor): armorNames;
+  export function read(type: typeof compression, e: compression): compressionNames;
+  export function read(type: typeof hash, e: hash): hashNames;
+  export function read(type: typeof packet, e: packet): packetNames;
+  export function read(type: typeof publicKey, e: publicKey): publicKeyNames;
+  export function read(type: typeof symmetric, e: symmetric): symmetricNames;
+  export function read(type: typeof keyStatus, e: keyStatus): keyStatusNames;
+  export function read(type: typeof keyFlags, e: keyFlags): keyFlagsNames;
+
+  export type armorNames = 'multipartSection' | 'multipartLast' | 'signed' | 'message' | 'publicKey' | 'privateKey';
+  export enum armor {
+    multipartSection = 0,
+    multipartLast = 1,
+    signed = 2,
+    message = 3,
+    publicKey = 4,
+    privateKey = 5,
+    signature = 6
+  }
+
+  export enum reasonForRevocation {
+    noReason = 0, // No reason specified (key revocations or cert revocations)
+    keySuperseded = 1, // Key is superseded (key revocations)
+    keyCompromised = 2, // Key material has been compromised (key revocations)
+    keyRetired = 3, // Key is retired and no longer used (key revocations)
+    userIDInvalid = 32 // User ID information is no longer valid (cert revocations)
+  }
+
+  export type compressionNames = 'uncompressed' | 'zip' | 'zlib' | 'bzip2';
+  export enum compression {
+    uncompressed = 0,
+    zip = 1,
+    zlib = 2,
+    bzip2 = 3
+  }
+
+  export type hashNames = 'md5' | 'sha1' | 'ripemd' | 'sha256' | 'sha384' | 'sha512' | 'sha224' | 'sha3_256' | 'sha3_512';
+  export enum hash {
+    md5 = 1,
+    sha1 = 2,
+    ripemd = 3,
+    sha256 = 8,
+    sha384 = 9,
+    sha512 = 10,
+    sha224 = 11,
+    sha3_256 = 12,
+    sha3_512 = 14
+  }
+
+  export type packetNames = 'publicKeyEncryptedSessionKey' | 'signature' | 'symEncryptedSessionKey' | 'onePassSignature' | 'secretKey' | 'publicKey' |
+  'secretSubkey' | 'compressed' | 'symmetricallyEncrypted' | 'marker' | 'literal' | 'trust' | 'userID' | 'publicSubkey' | 'userAttribute' |
+  'symEncryptedIntegrityProtected' | 'modificationDetectionCode' | 'AEADEncryptedDataPacket' | 'padding';
+  export enum packet {
+    publicKeyEncryptedSessionKey = 1,
+    signature = 2,
+    symEncryptedSessionKey = 3,
+    onePassSignature = 4,
+    secretKey = 5,
+    publicKey = 6,
+    secretSubkey = 7,
+    compressedData = 8,
+    symmetricallyEncryptedData = 9,
+    marker = 10,
+    literalData = 11,
+    trust = 12,
+    userID = 13,
+    publicSubkey = 14,
+    userAttribute = 17,
+    symEncryptedIntegrityProtectedData = 18,
+    modificationDetectionCode = 19,
+    aeadEncryptedData = 20,
+    padding = 21
+  }
+
+  export type publicKeyNames = 'rsaEncryptSign' | 'rsaEncrypt' | 'rsaSign' | 'elgamal' | 'dsa' | 'ecdh' | 'ecdsa' | 'eddsaLegacy' | 'aedh' | 'aedsa' | 'ed25519' | 'x25519' | 'ed448' | 'x448' | 'pqc_mlkem_x25519' | 'pqc_mldsa_ed25519';
+  export enum publicKey {
+    rsaEncryptSign = 1,
+    rsaEncrypt = 2,
+    rsaSign = 3,
+    elgamal = 16,
+    dsa = 17,
+    ecdh = 18,
+    ecdsa = 19,
+    eddsaLegacy = 22,
+    aedh = 23,
+    aedsa = 24,
+    x25519 = 25,
+    x448 = 26,
+    ed25519 = 27,
+    ed448 = 28,
+    pqc_mlkem_x25519 = 105,
+    pqc_mldsa_ed25519 = 107
+  }
+
+  export enum curve {
+    /** @deprecated use `nistP256` instead */
+    p256 = 'nistP256',
+    nistP256 = 'nistP256',
+    /** @deprecated use `nistP384` instead */
+    p384 = 'nistP384',
+    nistP384 = 'nistP384',
+    /** @deprecated use `nistP521` instead */
+    p521 = 'nistP521',
+    nistP521 = 'nistP521',
+    /** @deprecated use `ed25519Legacy` instead */
+    ed25519 = 'ed25519Legacy',
+    ed25519Legacy = 'ed25519Legacy',
+    /** @deprecated use `curve25519Legacy` instead */
+    curve25519 = 'curve25519Legacy',
+    curve25519Legacy = 'curve25519Legacy',
+    secp256k1 = 'secp256k1',
+    brainpoolP256r1 = 'brainpoolP256r1',
+    brainpoolP384r1 = 'brainpoolP384r1',
+    brainpoolP512r1 = 'brainpoolP512r1'
+  }
+
+  export type symmetricNames = 'idea' | 'tripledes' | 'cast5' | 'blowfish' | 'aes128' | 'aes192' | 'aes256' | 'twofish';
+  export enum symmetric {
+    idea = 1,
+    tripledes = 2,
+    cast5 = 3,
+    blowfish = 4,
+    aes128 = 7,
+    aes192 = 8,
+    aes256 = 9,
+    twofish = 10
+  }
+
+  export type keyStatusNames = 'invalid' | 'expired' | 'revoked' | 'valid' | 'noSelfCert';
+  export enum keyStatus {
+    invalid = 0,
+    expired = 1,
+    revoked = 2,
+    valid = 3,
+    noSelfCert = 4
+  }
+
+  export type keyFlagsNames = 'certifyKeys' | 'signData' | 'encryptCommunication' | 'encryptStorage' | 'splitPrivateKey' | 'authentication' | 'sharedPrivateKey';
+  export enum keyFlags {
+    certifyKeys = 1,
+    signData = 2,
+    encryptCommunication = 4,
+    encryptStorage = 8,
+    splitPrivateKey = 16,
+    authentication = 32,
+    forwardedCommunication = 64,
+    sharedPrivateKey = 128
+  }
+
+  export enum signature {
+    binary = 0,
+    text = 1,
+    standalone = 2,
+    certGeneric = 16,
+    certPersona = 17,
+    certCasual = 18,
+    certPositive = 19,
+    certRevocation = 48,
+    subkeyBinding = 24,
+    keyBinding = 25,
+    key = 31,
+    keyRevocation = 32,
+    subkeyRevocation = 40,
+    timestamp = 64,
+    thirdParty = 80
+  }
+
+  export type aeadNames = 'eax' | 'ocb' | 'gcm';
+  export enum aead {
+    eax = 1,
+    ocb = 2,
+    gcm = 3,
+    /** @deprecated use `gcm` instead */
+    experimentalGCM = 100 // Private algorithm
+  }
+
+  export type literalFormatNames = 'utf8' | 'binary' | 'text' | 'mime';
+  export enum literal {
+    binary = 98,
+    text = 116,
+    utf8 = 117,
+    mime = 109
+  }
+
+  export enum s2k {
+    simple = 0,
+    salted = 1,
+    iterated = 3,
+    argon2 = 4,
+    gnu = 101
+  }
+}
+
+export default enums;