// 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 type/s2k * @requires config * @requires crypto * @requires enums * @requires util */ import type_s2k from '../type/s2k'; import defaultConfig from '../config'; import crypto from '../crypto'; import enums from '../enums'; import util from '../util'; /** * Symmetric-Key Encrypted Session Key Packets (Tag 3) * * {@link https://tools.ietf.org/html/rfc4880#section-5.3|RFC4880 5.3}: * The Symmetric-Key Encrypted Session Key packet holds the * symmetric-key encryption of a session key used to encrypt a message. * Zero or more Public-Key Encrypted Session Key packets and/or * Symmetric-Key Encrypted Session Key packets may precede a * Symmetrically Encrypted Data packet that holds an encrypted message. * The message is encrypted with a session key, and the session key is * itself encrypted and stored in the Encrypted Session Key packet or * the Symmetric-Key Encrypted Session Key packet. * @memberof module:packet */ class SymEncryptedSessionKeyPacket { /** * @param {Object} config (optional) full configuration, defaults to openpgp.config */ constructor(config = defaultConfig) { this.tag = enums.packet.symEncryptedSessionKey; this.version = config.aeadProtect ? 5 : 4; this.sessionKey = null; this.sessionKeyEncryptionAlgorithm = null; this.sessionKeyAlgorithm = 'aes256'; this.aeadAlgorithm = enums.read(enums.aead, config.aeadMode); this.encrypted = null; this.s2k = null; this.iv = null; } /** * Parsing function for a symmetric encrypted session key packet (tag 3). * * @param {Uint8Array} bytes Payload of a tag 3 packet */ read(bytes) { let offset = 0; // A one-octet version number. The only currently defined version is 4. this.version = bytes[offset++]; // A one-octet number describing the symmetric algorithm used. const algo = enums.read(enums.symmetric, bytes[offset++]); if (this.version === 5) { // A one-octet AEAD algorithm. this.aeadAlgorithm = enums.read(enums.aead, bytes[offset++]); } // A string-to-key (S2K) specifier, length as defined above. this.s2k = new type_s2k(); offset += this.s2k.read(bytes.subarray(offset, bytes.length)); if (this.version === 5) { const mode = crypto[this.aeadAlgorithm]; // A starting initialization vector of size specified by the AEAD // algorithm. this.iv = bytes.subarray(offset, offset += mode.ivLength); } // The encrypted session key itself, which is decrypted with the // string-to-key object. This is optional in version 4. if (this.version === 5 || offset < bytes.length) { this.encrypted = bytes.subarray(offset, bytes.length); this.sessionKeyEncryptionAlgorithm = algo; } else { this.sessionKeyAlgorithm = algo; } } /** * Create a binary representation of a tag 3 packet * * @returns {Uint8Array} The Uint8Array representation */ write() { const algo = this.encrypted === null ? this.sessionKeyAlgorithm : this.sessionKeyEncryptionAlgorithm; let bytes; if (this.version === 5) { bytes = util.concatUint8Array([new Uint8Array([this.version, enums.write(enums.symmetric, algo), enums.write(enums.aead, this.aeadAlgorithm)]), this.s2k.write(), this.iv, this.encrypted]); } else { bytes = util.concatUint8Array([new Uint8Array([this.version, enums.write(enums.symmetric, algo)]), this.s2k.write()]); if (this.encrypted !== null) { bytes = util.concatUint8Array([bytes, this.encrypted]); } } return bytes; } /** * Decrypts the session key * @param {String} passphrase The passphrase in string form * @throws {Error} if decryption was not successful * @async */ async decrypt(passphrase) { const algo = this.sessionKeyEncryptionAlgorithm !== null ? this.sessionKeyEncryptionAlgorithm : this.sessionKeyAlgorithm; const length = crypto.cipher[algo].keySize; const key = await this.s2k.produce_key(passphrase, length); if (this.version === 5) { const mode = crypto[this.aeadAlgorithm]; const adata = new Uint8Array([0xC0 | this.tag, this.version, enums.write(enums.symmetric, this.sessionKeyEncryptionAlgorithm), enums.write(enums.aead, this.aeadAlgorithm)]); const modeInstance = await mode(algo, key); this.sessionKey = await modeInstance.decrypt(this.encrypted, this.iv, adata); } else if (this.encrypted !== null) { const decrypted = await crypto.cfb.decrypt(algo, key, this.encrypted, new Uint8Array(crypto.cipher[algo].blockSize)); this.sessionKeyAlgorithm = enums.read(enums.symmetric, decrypted[0]); this.sessionKey = decrypted.subarray(1, decrypted.length); } else { this.sessionKey = key; } } /** * Encrypts the session key * @param {String} passphrase The passphrase in string form * @param {Object} config (optional) full configuration, defaults to openpgp.config * @throws {Error} if encryption was not successful * @async */ async encrypt(passphrase, config = defaultConfig) { const algo = this.sessionKeyEncryptionAlgorithm !== null ? this.sessionKeyEncryptionAlgorithm : this.sessionKeyAlgorithm; this.sessionKeyEncryptionAlgorithm = algo; this.s2k = new type_s2k(config); this.s2k.salt = await crypto.random.getRandomBytes(8); const length = crypto.cipher[algo].keySize; const key = await this.s2k.produce_key(passphrase, length); if (this.sessionKey === null) { this.sessionKey = await crypto.generateSessionKey(this.sessionKeyAlgorithm); } if (this.version === 5) { const mode = crypto[this.aeadAlgorithm]; this.iv = await crypto.random.getRandomBytes(mode.ivLength); // generate new random IV const adata = new Uint8Array([0xC0 | this.tag, this.version, enums.write(enums.symmetric, this.sessionKeyEncryptionAlgorithm), enums.write(enums.aead, this.aeadAlgorithm)]); const modeInstance = await mode(algo, key); this.encrypted = await modeInstance.encrypt(this.sessionKey, this.iv, adata); } else { const algo_enum = new Uint8Array([enums.write(enums.symmetric, this.sessionKeyAlgorithm)]); const private_key = util.concatUint8Array([algo_enum, this.sessionKey]); this.encrypted = await crypto.cfb.encrypt(algo, key, private_key, new Uint8Array(crypto.cipher[algo].blockSize), config); } } } export default SymEncryptedSessionKeyPacket;