Skip to main content
Module

x/openpgp/src/signature.js

OpenPGP implementation for JavaScript
Go to Latest
File
// 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
import { armor, unarmor } from './encoding/armor';import { PacketList, SignaturePacket } from './packet';import enums from './enums';import util from './util';import defaultConfig from './config';
// A Signature can contain the following packetsconst allowedPackets = /*#__PURE__*/ util.constructAllowedPackets([SignaturePacket]);
/** * Class that represents an OpenPGP signature. */export class Signature { /** * @param {PacketList} packetlist - The signature packets */ constructor(packetlist) { this.packets = packetlist || new PacketList(); }
/** * Returns binary encoded signature * @returns {ReadableStream<Uint8Array>} Binary signature. */ write() { return this.packets.write(); }
/** * Returns ASCII armored text of signature * @param {Object} [config] - Full configuration, defaults to openpgp.config * @returns {ReadableStream<String>} ASCII armor. */ armor(config = defaultConfig) { return armor(enums.armor.signature, this.write(), undefined, undefined, undefined, config); }
/** * Returns an array of KeyIDs of all of the issuers who created this signature * @returns {Array<KeyID>} The Key IDs of the signing keys */ getSigningKeyIDs() { return this.packets.map(packet => packet.issuerKeyID); }}
/** * reads an (optionally armored) OpenPGP signature and returns a signature object * @param {Object} options * @param {String} [options.armoredSignature] - Armored signature to be parsed * @param {Uint8Array} [options.binarySignature] - Binary signature to be parsed * @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config} * @returns {Promise<Signature>} New signature object. * @async * @static */export async function readSignature({ armoredSignature, binarySignature, config, ...rest }) { config = { ...defaultConfig, ...config }; let input = armoredSignature || binarySignature; if (!input) { throw new Error('readSignature: must pass options object containing `armoredSignature` or `binarySignature`'); } if (armoredSignature && !util.isString(armoredSignature)) { throw new Error('readSignature: options.armoredSignature must be a string'); } if (binarySignature && !util.isUint8Array(binarySignature)) { throw new Error('readSignature: options.binarySignature must be a Uint8Array'); } const unknownOptions = Object.keys(rest); if (unknownOptions.length > 0) throw new Error(`Unknown option: ${unknownOptions.join(', ')}`);
if (armoredSignature) { const { type, data } = await unarmor(input, config); if (type !== enums.armor.signature) { throw new Error('Armored text not of type signature'); } input = data; } const packetlist = await PacketList.fromBinary(input, allowedPackets, config); return new Signature(packetlist);}