@protontech/openpgp 4.10.6 → 5.4.0

package/src/packet/all_packets.js

@@ -1,116 +0,0 @@
-/**
- * @fileoverview Exports all OpenPGP packet types
- * @requires enums
- * @module packet/all_packets
- */
-
-import enums from '../enums.js';
-import * as packets from './all_packets.js'; // re-import module to parse packets from tag
-
-export {
-  /** @see module:packet.Compressed */
-  default as Compressed
-} from './compressed.js';
-export {
-  /** @see module:packet.SymEncryptedIntegrityProtected */
-  default as SymEncryptedIntegrityProtected
-} from './sym_encrypted_integrity_protected.js';
-export {
-  /** @see module:packet.SymEncryptedAEADProtected */
-  default as SymEncryptedAEADProtected
-} from './sym_encrypted_aead_protected.js';
-export {
-  /** @see module:packet.PublicKeyEncryptedSessionKey */
-  default as PublicKeyEncryptedSessionKey
-} from './public_key_encrypted_session_key.js';
-export {
-  /** @see module:packet.SymEncryptedSessionKey */
-  default as SymEncryptedSessionKey
-} from './sym_encrypted_session_key.js';
-export {
-  /** @see module:packet.Literal */
-  default as Literal
-} from './literal.js';
-export {
-  /** @see module:packet.PublicKey */
-  default as PublicKey
-} from './public_key.js';
-export {
-  /** @see module:packet.SymmetricallyEncrypted */
-  default as SymmetricallyEncrypted
-} from './symmetrically_encrypted.js';
-export {
-  /** @see module:packet.Marker */
-  default as Marker
-} from './marker.js';
-export {
-  /** @see module:packet.PublicSubkey */
-  default as PublicSubkey
-} from './public_subkey.js';
-export {
-  /** @see module:packet.UserAttribute */
-  default as UserAttribute
-} from './user_attribute.js';
-export {
-  /** @see module:packet.OnePassSignature */
-  default as OnePassSignature
-} from './one_pass_signature.js';
-export {
-  /** @see module:packet.SecretKey */
-  default as SecretKey
-} from './secret_key.js';
-export {
-  /** @see module:packet.Userid */
-  default as Userid
-} from './userid.js';
-export {
-  /** @see module:packet.SecretSubkey */
-  default as SecretSubkey
-} from './secret_subkey.js';
-export {
-  /** @see module:packet.Signature */
-  default as Signature
-} from './signature.js';
-export {
-  /** @see module:packet.Trust */
-  default as Trust
-} from './trust.js';
-
-/**
- * Allocate a new packet
- * @function newPacketFromTag
- * @memberof module:packet
- * @param {String} tag property name from {@link module:enums.packet}
- * @returns {Object} new packet object with type based on tag
- */
-export function newPacketFromTag(tag) {
-  return new packets[packetClassFromTagName(tag)]();
-}
-
-/**
- * Allocate a new packet from structured packet clone
- * @see {@link https://w3c.github.io/html/infrastructure.html#safe-passing-of-structured-data}
- * @function fromStructuredClone
- * @memberof module:packet
- * @param {Object} packetClone packet clone
- * @returns {Object} new packet object with data from packet clone
- */
-export function fromStructuredClone(packetClone) {
-  const tagName = enums.read(enums.packet, packetClone.tag);
-  const packet = newPacketFromTag(tagName);
-  Object.assign(packet, packetClone);
-  if (packet.postCloneTypeFix) {
-    packet.postCloneTypeFix();
-  }
-  return packet;
-}
-
-/**
- * Convert tag name to class name
- * @param {String} tag property name from {@link module:enums.packet}
- * @returns {String}
- * @private
- */
-function packetClassFromTagName(tag) {
-  return tag.substr(0, 1).toUpperCase() + tag.substr(1);
-}

package/src/packet/clone.js

@@ -1,189 +0,0 @@
-// OpenPGP.js - An OpenPGP implementation in javascript
-// Copyright (C) 2015 Tankred Hase
-//
-// 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
-
-/**
- * @fileoverview This module implements packet list cloning required to
- * pass certain object types between the web worker and main thread using
- * the structured cloning algorithm.
- * @module packet/clone
- */
-
-import stream from 'web-stream-tools';
-import { Key } from '../key';
-import { Message } from '../message';
-import { CleartextMessage } from '../cleartext';
-import { Signature } from '../signature';
-import List from './packetlist';
-import type_keyid from '../type/keyid';
-import util from '../util';
-
-
-//////////////////////////////
-//                          //
-//   List --> Clone   //
-//                          //
-//////////////////////////////
-
-
-/**
- * Create a packetlist from the correspoding object types.
- * @param  {Object} options   the object passed to and from the web worker
- * @returns {Object}           a mutated version of the options optject
- */
-export function clonePackets(options) {
-  if (options.publicKeys) {
-    options.publicKeys = options.publicKeys.map(key => key.toPacketlist());
-  }
-  if (options.privateKeys) {
-    options.privateKeys = options.privateKeys.map(key => key.toPacketlist());
-  }
-  if (options.publicKey) {
-    options.publicKey = options.publicKey.toPacketlist();
-  }
-  if (options.privateKey) {
-    options.privateKey = options.privateKey.toPacketlist();
-  }
-  if (options.key) {
-    options.key = options.key.toPacketlist();
-  }
-  if (options.message) {
-    //could be either a Message or CleartextMessage object
-    if (options.message instanceof Message) {
-      options.message = { packets: options.message.packets, fromStream: options.message.fromStream };
-    } else if (options.message instanceof CleartextMessage) {
-      options.message = { text: options.message.text, signature: options.message.signature.packets };
-    }
-  }
-  if (options.signature && (options.signature instanceof Signature)) {
-    options.signature = options.signature.packets;
-  }
-  if (options.signatures) {
-    options.signatures.forEach(verificationObjectToClone);
-  }
-  return options;
-}
-
-function verificationObjectToClone(verObject) {
-  const verified = verObject.verified;
-  verObject.verified = stream.fromAsync(() => verified);
-  if (verObject.signature instanceof Promise) {
-    const signature = verObject.signature;
-    verObject.signature = stream.fromAsync(async () => {
-      const packets = (await signature).packets;
-      try {
-        await verified;
-      } catch (e) {}
-      if (packets && packets[0]) {
-        delete packets[0].signature;
-        delete packets[0].hashed;
-      }
-      return packets;
-    });
-  } else {
-    verObject.signature = verObject.signature.packets;
-  }
-  if (verObject.error) {
-    verObject.error = verObject.error.message;
-  }
-  return verObject;
-}
-
-//////////////////////////////
-//                          //
-//   Clone --> List   //
-//                          //
-//////////////////////////////
-
-
-/**
- * Creates an object with the correct prototype from a corresponding packetlist.
- * @param  {Object} options   the object passed to and from the web worker
- * @param  {String} method    the public api function name to be delegated to the worker
- * @returns {Object}           a mutated version of the options optject
- */
-export function parseClonedPackets(options) {
-  if (options.publicKeys) {
-    options.publicKeys = options.publicKeys.map(packetlistCloneToKey);
-  }
-  if (options.privateKeys) {
-    options.privateKeys = options.privateKeys.map(packetlistCloneToKey);
-  }
-  if (options.publicKey) {
-    options.publicKey = packetlistCloneToKey(options.publicKey);
-  }
-  if (options.privateKey) {
-    options.privateKey = packetlistCloneToKey(options.privateKey);
-  }
-  if (options.key) {
-    options.key = packetlistCloneToKey(options.key);
-  }
-  if (options.message && options.message.signature) {
-    options.message = packetlistCloneToCleartextMessage(options.message);
-  } else if (options.message) {
-    options.message = packetlistCloneToMessage(options.message);
-  }
-  if (options.signatures) {
-    options.signatures = options.signatures.map(packetlistCloneToSignatures);
-  }
-  if (options.signature) {
-    options.signature = packetlistCloneToSignature(options.signature);
-  }
-  return options;
-}
-
-function packetlistCloneToKey(clone) {
-  const packetlist = List.fromStructuredClone(clone);
-  return new Key(packetlist);
-}
-
-function packetlistCloneToMessage(clone) {
-  const packetlist = List.fromStructuredClone(clone.packets);
-  const message = new Message(packetlist);
-  message.fromStream = clone.fromStream;
-  return message;
-}
-
-function packetlistCloneToCleartextMessage(clone) {
-  const packetlist = List.fromStructuredClone(clone.signature);
-  return new CleartextMessage(clone.text, new Signature(packetlist));
-}
-
-//verification objects
-function packetlistCloneToSignatures(clone) {
-  clone.keyid = type_keyid.fromClone(clone.keyid);
-  if (util.isStream(clone.signature)) {
-    clone.signature = stream.readToEnd(clone.signature, ([signature]) => new Signature(List.fromStructuredClone(signature)));
-    clone.signature.catch(() => {});
-  } else {
-    clone.signature = new Signature(List.fromStructuredClone(clone.signature));
-  }
-  clone.verified = stream.readToEnd(clone.verified, ([verified]) => verified);
-  clone.verified.catch(() => {});
-  if (clone.error) {
-    clone.error = new Error(clone.error);
-  }
-  return clone;
-}
-
-function packetlistCloneToSignature(clone) {
-  if (util.isString(clone) || util.isStream(clone)) {
-    //signature is armored
-    return clone;
-  }
-  const packetlist = List.fromStructuredClone(clone);
-  return new Signature(packetlist);
-}

package/src/packet/compressed.js

@@ -1,194 +0,0 @@
-// 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
-
-/**
- * @requires web-stream-tools
- * @requires pako
- * @requires config
- * @requires enums
- * @requires util
- * @requires compression/bzip2
- */
-
-import pako from 'pako';
-import Bunzip from 'seek-bzip';
-import stream from 'web-stream-tools';
-import config from '../config';
-import enums from '../enums';
-import util from '../util';
-
-/**
- * Implementation of the Compressed Data Packet (Tag 8)
- *
- * {@link https://tools.ietf.org/html/rfc4880#section-5.6|RFC4880 5.6}:
- * The Compressed Data packet contains compressed data.  Typically,
- * this packet is found as the contents of an encrypted packet, or following
- * a Signature or One-Pass Signature packet, and contains a literal data packet.
- * @memberof module:packet
- * @constructor
- */
-function Compressed() {
-  /**
-   * Packet type
-   * @type {module:enums.packet}
-   */
-  this.tag = enums.packet.compressed;
-  /**
-   * List of packets
-   * @type {module:packet.List}
-   */
-  this.packets = null;
-  /**
-   * Compression algorithm
-   * @type {compression}
-   */
-  this.algorithm = 'zip';
-
-  /**
-   * Compressed packet data
-   * @type {Uint8Array | ReadableStream<Uint8Array>}
-   */
-  this.compressed = null;
-}
-
-/**
- * Parsing function for the packet.
- * @param {Uint8Array | ReadableStream<Uint8Array>} bytes Payload of a tag 8 packet
- */
-Compressed.prototype.read = async function (bytes, streaming) {
-  await stream.parse(bytes, async reader => {
-
-    // One octet that gives the algorithm used to compress the packet.
-    this.algorithm = enums.read(enums.compression, await reader.readByte());
-
-    // Compressed data, which makes up the remainder of the packet.
-    this.compressed = reader.remainder();
-
-    await this.decompress(streaming);
-  });
-};
-
-
-/**
- * Return the compressed packet.
- * @returns {Uint8Array | ReadableStream<Uint8Array>} binary compressed packet
- */
-Compressed.prototype.write = function () {
-  if (this.compressed === null) {
-    this.compress();
-  }
-
-  return util.concat([new Uint8Array([enums.write(enums.compression, this.algorithm)]), this.compressed]);
-};
-
-
-/**
- * Decompression method for decompressing the compressed data
- * read by read_packet
- */
-Compressed.prototype.decompress = async function (streaming) {
-
-  if (!decompress_fns[this.algorithm]) {
-    throw new Error(this.algorithm + ' decompression not supported');
-  }
-
-  await this.packets.read(decompress_fns[this.algorithm](this.compressed), streaming);
-};
-
-/**
- * Compress the packet data (member decompressedData)
- */
-Compressed.prototype.compress = function () {
-
-  if (!compress_fns[this.algorithm]) {
-    throw new Error(this.algorithm + ' compression not supported');
-  }
-
-  this.compressed = compress_fns[this.algorithm](this.packets.write());
-};
-
-export default Compressed;
-
-//////////////////////////
-//                      //
-//   Helper functions   //
-//                      //
-//////////////////////////
-
-
-const nodeZlib = util.getNodeZlib();
-
-function uncompressed(data) {
-  return data;
-}
-
-function node_zlib(func, options = {}) {
-  return function (data) {
-    return stream.nodeToWeb(stream.webToNode(data).pipe(func(options)));
-  };
-}
-
-function pako_zlib(constructor, options = {}) {
-  return function(data) {
-    const obj = new constructor(options);
-    return stream.transform(data, value => {
-      if (value.length) {
-        obj.push(value, pako.Z_SYNC_FLUSH);
-        return obj.result;
-      }
-    }, () => {
-      if (constructor === pako.Deflate) {
-        obj.push([], pako.Z_FINISH);
-        return obj.result;
-      }
-    });
-  };
-}
-
-function bzip2(func) {
-  return function(data) {
-    return stream.fromAsync(async () => func(await stream.readToEnd(data)));
-  };
-}
-
-let compress_fns;
-let decompress_fns;
-if (nodeZlib) { // Use Node native zlib for DEFLATE compression/decompression
-  compress_fns = {
-    zip: node_zlib(nodeZlib.createDeflateRaw, { level: config.deflate_level }),
-    zlib: node_zlib(nodeZlib.createDeflate, { level: config.deflate_level })
-  };
-
-  decompress_fns = {
-    uncompressed: uncompressed,
-    zip: node_zlib(nodeZlib.createInflateRaw),
-    zlib: node_zlib(nodeZlib.createInflate),
-    bzip2: bzip2(Bunzip.decode)
-  };
-} else { // Use JS fallbacks
-  compress_fns = {
-    zip: pako_zlib(pako.Deflate, { raw: true, level: config.deflate_level }),
-    zlib: pako_zlib(pako.Deflate, { level: config.deflate_level })
-  };
-
-  decompress_fns = {
-    uncompressed: uncompressed,
-    zip: pako_zlib(pako.Inflate, { raw: true }),
-    zlib: pako_zlib(pako.Inflate),
-    bzip2: bzip2(Bunzip.decode)
-  };
-}

package/src/packet/index.js

@@ -1,20 +0,0 @@
-/**
- * @fileoverview OpenPGP packet types
- * @see module:packet/all_packets
- * @see module:packet/clone
- * @see module:packet.List
- * @module packet
- */
-
-import * as packets from './all_packets';
-import * as clone from './clone';
-import List from './packetlist';
-
-const mod = {
-  List,
-  clone
-};
-
-Object.assign(mod, packets);
-
-export default mod;

package/src/packet/literal.js

@@ -1,168 +0,0 @@
-// 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
-
-/**
- * @requires web-stream-tools
- * @requires enums
- * @requires util
- */
-
-import stream from 'web-stream-tools';
-import enums from '../enums';
-import util from '../util';
-
-/**
- * Implementation of the Literal Data Packet (Tag 11)
- *
- * {@link https://tools.ietf.org/html/rfc4880#section-5.9|RFC4880 5.9}:
- * A Literal Data packet contains the body of a message; data that is not to be
- * further interpreted.
- * @param {Date} date the creation date of the literal package
- * @memberof module:packet
- * @constructor
- */
-function Literal(date = new Date()) {
-  this.tag = enums.packet.literal;
-  this.format = 'utf8'; // default format for literal data packets
-  this.date = util.normalizeDate(date);
-  this.text = null; // textual data representation
-  this.data = null; // literal data representation
-  this.filename = 'msg.txt';
-}
-
-/**
- * Set the packet data to a javascript native string, end of line
- * will be normalized to \r\n and by default text is converted to UTF8
- * @param {String | ReadableStream<String>} text Any native javascript string
- * @param {utf8|binary|text|mime} format (optional) The format of the string of bytes
- */
-Literal.prototype.setText = function(text, format = 'utf8') {
-  this.format = format;
-  this.text = text;
-  this.data = null;
-};
-
-/**
- * Returns literal data packets as native JavaScript string
- * with normalized end of line to \n
- * @param {Boolean} clone (optional) Whether to return a clone so that getBytes/getText can be called again
- * @returns {String | ReadableStream<String>} literal data as text
- */
-Literal.prototype.getText = function(clone = false) {
-  if (this.text === null || util.isStream(this.text)) { // Assume that this.text has been read
-    this.text = util.decode_utf8(util.nativeEOL(this.getBytes(clone)));
-  }
-  return this.text;
-};
-
-/**
- * Set the packet data to value represented by the provided string of bytes.
- * @param {Uint8Array | ReadableStream<Uint8Array>} bytes The string of bytes
- * @param {utf8|binary|text|mime} format The format of the string of bytes
- */
-Literal.prototype.setBytes = function(bytes, format) {
-  this.format = format;
-  this.data = bytes;
-  this.text = null;
-};
-
-
-/**
- * Get the byte sequence representing the literal packet data
- * @param {Boolean} clone (optional) Whether to return a clone so that getBytes/getText can be called again
- * @returns {Uint8Array | ReadableStream<Uint8Array>} A sequence of bytes
- */
-Literal.prototype.getBytes = function(clone = false) {
-  if (this.data === null) {
-    // encode UTF8 and normalize EOL to \r\n
-    this.data = util.canonicalizeEOL(util.encode_utf8(this.text));
-  }
-  if (clone) {
-    return stream.passiveClone(this.data);
-  }
-  return this.data;
-};
-
-
-/**
- * Sets the filename of the literal packet data
- * @param {String} filename Any native javascript string
- */
-Literal.prototype.setFilename = function(filename) {
-  this.filename = filename;
-};
-
-
-/**
- * Get the filename of the literal packet data
- * @returns {String} filename
- */
-Literal.prototype.getFilename = function() {
-  return this.filename;
-};
-
-
-/**
- * Parsing function for a literal data packet (tag 11).
- *
- * @param {Uint8Array | ReadableStream<Uint8Array>} input Payload of a tag 11 packet
- * @returns {module:packet.Literal} object representation
- */
-Literal.prototype.read = async function(bytes) {
-  await stream.parse(bytes, async reader => {
-    // - A one-octet field that describes how the data is formatted.
-    const format = enums.read(enums.literal, await reader.readByte());
-
-    const filename_len = await reader.readByte();
-    this.filename = util.decode_utf8(await reader.readBytes(filename_len));
-
-    this.date = util.readDate(await reader.readBytes(4));
-
-    const data = reader.remainder();
-
-    this.setBytes(data, format);
-  });
-};
-
-/**
- * Creates a Uint8Array representation of the packet, excluding the data
- *
- * @returns {Uint8Array} Uint8Array representation of the packet
- */
-Literal.prototype.writeHeader = function() {
-  const filename = util.encode_utf8(this.filename);
-  const filename_length = new Uint8Array([filename.length]);
-
-  const format = new Uint8Array([enums.write(enums.literal, this.format)]);
-  const date = util.writeDate(this.date);
-
-  return util.concatUint8Array([format, filename_length, filename, date]);
-};
-
-/**
- * Creates a Uint8Array representation of the packet
- *
- * @returns {Uint8Array | ReadableStream<Uint8Array>} Uint8Array representation of the packet
- */
-Literal.prototype.write = function() {
-  const header = this.writeHeader();
-  const data = this.getBytes();
-
-  return util.concat([header, data]);
-};
-
-export default Literal;