git.squeep.com Git - squeep-mystery-box/blob - lib/mystery-box.js

   1 'use strict';
   2
   3 const crypto = require('crypto');
   4 const zlib = require('zlib');
   5 const { promisify } = require('util');
   6 const { base64ToBase64URL, base64URLToBase64 } = require('@squeep/base64url');
   7 const common = require('./common');
   8 const allVersions = require('./version-parameters');
   9 const { performance } = require('perf_hooks');
  10
  11 const _fileScope = common.fileScope(__filename);
  12
  13 const brotliCompressAsync = promisify(zlib.brotliCompress);
  14 const brotliDecompressAsync = promisify(zlib.brotliDecompress);
  15 const deflateRawAsync = promisify(zlib.deflateRaw);
  16 const inflateRawAsync = promisify(zlib.inflateRaw);
  17 const scryptAsync = promisify(crypto.scrypt);
  18
  19 /**
  20  * Only you will know what's inside your...
  21  *    \  |            |               | __ )
  22  *   |\/ | |   |  __| __|  _ \  __|   | __ \   _ \ \  /
  23  *   |   | |   |\__ \ |    __/ |  |   | |   | (   |`  <
  24  *  _|  _|\__, |____/\__|\___|_| \__, |____/ \___/ _/\_\
  25  *        ____/                  ____/
  26  *
  27  * Our very own way of converting a buffer or serializable object
  28  * to and from an opaque and web-safe representation, which we can
  29  * let anyone see without disclosing the contents, nor allowing it
  30  * to be modified without detection.
  31  *
  32  * The result is a Base64URL-encoded byte-array consisting of:
  33  * - version, indicating format and encryption algorithm
  34  * - flags, indicating state of the contents
  35  * - iv/nonce, randomness for the algorithm
  36  * - salt, applied to a secret to derive a key
  37  * - tag, additional room for encryption to validate the previous fields
  38  * - payload, encrypted version of possibly compressed and serialized object
  39  *
  40  */
  41
  42
  43 const availableFlags = {
  44   Brotli: (1<<0), // Slightly better compression, but slow
  45   Flate: (1<<1), // Slightly worse compression, but much faster especially with larger payloads.  Prefer this.
  46   FutureCompression: (1<<0)|(1<<1), // Something else, like zstd maybe.
  47
  48   Unused2: (1<<2),
  49   Unused3: (1<<3),
  50   Unused4: (1<<4),
  51   Unused5: (1<<5),
  52   Unused6: (1<<6),
  53
  54   BufferPayload: (1<<7), // Payload is a buffer, not an object
  55 };
  56 const compressionFlagsMask = (availableFlags.Flate | availableFlags.Brotli);
  57 const compressionFlagsShift = 0;
  58 const payloadFlagsMask = (availableFlags.BufferPayload);
  59 const payloadFlagsShift = 7;
  60
  61
  62 class MysteryBox {
  63   /**
  64    * @param {Console} logger
  65    * @param {Object} options
  66    * @param {String|String[]} options.encryptionSecret - if an array, will always encrypt with first secret, will attempt to decrypt with all; useful for rolling secrets
  67    * @param {Number=} options.defaultFlags
  68    */
  69   constructor(logger, options = {}) {
  70     this.logger = logger;
  71     this.options = options;
  72
  73     this.secrets = common.ensureArray(options.encryptionSecret);
  74     if (!this.secrets.length) {
  75       throw new Error('missing encryption secret');
  76     }
  77
  78     // Filter any unavailable algorithms
  79     const availableCiphers = crypto.getCiphers();
  80     this.versionParameters = Object.entries(allVersions).reduce((acc, [v, p]) => {
  81       if (availableCiphers.includes(p.algorithm)) {
  82         acc[v] = p; // eslint-disable-line security/detect-object-injection
  83       }
  84       return acc;
  85     }, {});
  86
  87     // Default to highest
  88     this.bestVersion = Number(Object.keys(this.versionParameters).sort().pop());
  89     if (Number.isNaN(this.bestVersion)) {
  90       throw new Error('no supported versions available');
  91     }
  92
  93     this.Flags = availableFlags;
  94     this.defaultFlags = 'defaultFlags' in options ? options.defaultFlags : availableFlags.Flate;
  95     if (this.defaultFlags < 0 || this.defaultFlags > 255) {
  96       throw new RangeError('Invalid default flag value');
  97     }
  98   }
  99
 100
 101   /**
 102    * Parse the bits out of the flags.
 103    */
 104   static _decodeFlags(flags) {
 105     return {
 106       compression: (flags & compressionFlagsMask) >> compressionFlagsShift,
 107       payloadIsBuffer: Boolean((flags & payloadFlagsMask) >> payloadFlagsShift),
 108     };
 109   }
 110
 111
 112   /**
 113    * Put contents into a mysterious box.
 114    * @param {Object|Buffer} contents
 115    * @returns {String}
 116    */
 117   async pack(contents, version = this.bestVersion, flags = this.defaultFlags) {
 118     const _scope = _fileScope('pack');
 119     const timingsMs = {
 120       start: performance.now(),
 121       preCompress: 0,
 122       postCompress: 0,
 123       preEncrypt: 0,
 124       postEncrypt: 0,
 125       end: 0,
 126     };
 127
 128     if (!(version in this.versionParameters)) {
 129       throw new RangeError(`MysteryBox format version ${version} not supported`);
 130     }
 131     // eslint-disable-next-line security/detect-object-injection
 132     const v = this.versionParameters[version];
 133
 134     const { compression } = MysteryBox._decodeFlags(flags);
 135
 136     if (Buffer.isBuffer(contents)) {
 137       flags |= this.Flags.BufferPayload;
 138     } else {
 139       contents = JSON.stringify(contents);
 140     }
 141
 142     const versionBuffer = Buffer.alloc(v.versionBytes);
 143     versionBuffer.writeUInt8(v.version, 0);
 144
 145     const [iv, salt] = await Promise.all([
 146       v.ivBytes,
 147       v.saltBytes,
 148     ].map((b) => common.randomBytesAsync(b)));
 149
 150     timingsMs.preCompress = performance.now();
 151     let compressedContents;
 152     switch (compression) {
 153       case 0: // No compression requested
 154         compressedContents = contents;
 155         break;
 156       case this.Flags.Brotli:
 157         compressedContents = await brotliCompressAsync(contents);
 158         break;
 159       case this.Flags.Flate:
 160         compressedContents = await deflateRawAsync(contents);
 161         break;
 162     }
 163     timingsMs.postCompress = timingsMs.preCrypt = performance.now();
 164
 165     let payload;
 166     if (compressedContents.length >= contents.length) {
 167       flags = flags & ~compressionFlagsMask;
 168       payload = contents;
 169     } else {
 170       payload = compressedContents;
 171     }
 172     const flagsBuffer = Buffer.alloc(v.flagsBytes);
 173     flagsBuffer.writeUInt8(flags, 0);
 174
 175     // Authenticate all this data
 176     const aadBuffer = Buffer.concat([versionBuffer, flagsBuffer, iv, salt]);
 177
 178     // Always encrypt with first secret
 179     const secret = this.secrets[0];
 180     const key = await scryptAsync(secret, salt, v.keyBytes);
 181     const cipher = crypto.createCipheriv(v.algorithm, key, iv, v.algOptions);
 182     cipher.setAAD(aadBuffer);
 183     const encrypted = cipher.update(payload);
 184     const final = cipher.final();
 185     const tag = cipher.getAuthTag();
 186
 187     const merged = Buffer.concat([versionBuffer, flagsBuffer, iv, salt, tag, encrypted, final]).toString('base64');
 188     const result = base64ToBase64URL(merged);
 189     timingsMs.end = timingsMs.postCrypt = performance.now();
 190
 191     this.logger.debug(_scope, 'statistics', { version, flags: this._prettyFlags(flags), serialized: contents.length, compressed: payload.length, encoded: result.length, ...MysteryBox._timingsLog(timingsMs) });
 192
 193     return result;
 194   }
 195
 196
 197   /**
 198    * Take contents out of a mysterious box.
 199    * @param {String} box - Base64URL encoded payload
 200    * @returns {Object}
 201    */
 202   async unpack(box) {
 203     const _scope = _fileScope('unpack');
 204     const timingsMs = {
 205       start: performance.now(),
 206       preCompress: 0,
 207       postCompress: 0,
 208       preCrypt: 0,
 209       postCrypt: 0,
 210       end: 0,
 211     };
 212
 213     if (!box) {
 214       throw new RangeError('nothing to unpack');
 215     }
 216
 217     const raw = Buffer.from(base64URLToBase64(box), 'base64');
 218     let offset = 0;
 219
 220     const version = raw.subarray(offset, 1).readUInt8(0);
 221     if (!(version in this.versionParameters)) {
 222       throw new RangeError('unsupported version');
 223     }
 224     // eslint-disable-next-line security/detect-object-injection
 225     const v = this.versionParameters[version];
 226     offset += v.versionBytes;
 227
 228     const minBytes = v.versionBytes + v.flagsBytes + v.ivBytes + v.saltBytes + v.tagBytes;
 229     if (raw.length < minBytes) {
 230       throw new RangeError('not enough to unpack');
 231     }
 232
 233     const flags = raw.subarray(offset, offset + v.flagsBytes).readUInt8(0);
 234     offset += v.flagsBytes;
 235
 236     const { compression, payloadIsBuffer } = MysteryBox._decodeFlags(flags);
 237
 238     const iv = raw.subarray(offset, offset + v.ivBytes);
 239     offset += v.ivBytes;
 240
 241     const salt = raw.subarray(offset, offset + v.saltBytes);
 242     offset += v.saltBytes;
 243
 244     const aad = raw.subarray(0, offset); // Everything up to here
 245
 246     const tag = raw.subarray(offset, offset + v.tagBytes);
 247     offset += v.tagBytes;
 248
 249     const encrypted = raw.subarray(offset);
 250
 251     timingsMs.preCrypt = performance.now();
 252
 253     let decrypted;
 254     let err;
 255     let success = false;
 256     for await (const secret of this.secrets) {
 257       const key = await scryptAsync(secret, salt, v.keyBytes);
 258       const decipher = crypto.createDecipheriv(v.algorithm, key, iv, v.algOptions);
 259       decipher.setAAD(aad);
 260       decipher.setAuthTag(tag);
 261
 262       try {
 263         decrypted = Buffer.concat([decipher.update(encrypted), decipher.final()]);
 264         success = true;
 265         break;
 266       } catch (e) {
 267         err = e;
 268         continue;
 269       }
 270     }
 271     if (!success) {
 272       throw err;
 273     }
 274
 275     let payload;
 276     timingsMs.preCompress = timingsMs.postCrypt = performance.now();
 277     switch (compression) {
 278       case 0: // No compression
 279         payload = decrypted;
 280         break;
 281       case this.Flags.Brotli:
 282         payload = await brotliDecompressAsync(decrypted);
 283         break;
 284       case this.Flags.Flate:
 285         payload = await inflateRawAsync(decrypted);
 286         break;
 287     }
 288     timingsMs.end = timingsMs.postCompress = performance.now();
 289
 290     if (!payloadIsBuffer) {
 291       payload = JSON.parse(payload.toString('utf8'));
 292     }
 293
 294     this.logger.debug(_scope, 'statistics', { version, flags: this._prettyFlags(flags), ...MysteryBox._timingsLog(timingsMs) });
 295
 296     return payload;
 297   }
 298
 299
 300   /**
 301    * Pretty-print flag values
 302    * @param {Number} flags
 303    * @returns {String}
 304    */
 305   _prettyFlags(flags) {
 306     const flagNames = Object.entries(this.Flags).reduce((acc, cur) => {
 307       const [flagName, flagValue] = cur;
 308       if ((flags & flagValue) === flagValue) {
 309         acc.push(flagName);
 310       }
 311       return acc;
 312     }, []);
 313     return `0x${flags.toString(16).padStart(2, '0')} [${flagNames.join(',')}]`;
 314   }
 315
 316
 317   /**
 318    * Everyone loves numbers.
 319    * @param {Object} timingsMs
 320    * @returns
 321    */
 322   static _timingsLog({ start, preCompress, postCompress, preCrypt, postCrypt, end }) {
 323     return {
 324       totalMs: end - start,
 325       compressMs: postCompress - preCompress,
 326       cryptMs: postCrypt - preCrypt,
 327     };
 328   }
 329
 330 }
 331
 332 // Expose for stubbing in tests
 333 MysteryBox._test = { crypto };
 334
 335 module.exports = MysteryBox;