cyberchef/src/core/lib/QRCode.mjs

The Cyber Swiss Army Knife for encryption, encoding, compression and data analysis.

/**
 * QR code resources
 *
 * @author j433866 [j433866@gmail.com]
 * @copyright Crown Copyright 2019
 * @license Apache-2.0
 */

import OperationError from "../errors/OperationError.mjs";
import jsQR from "jsqr";
import qr from "qr-image";
import Utils from "../Utils.mjs";
import { Jimp, JimpMime } from "jimp";

/**
 * Parses a QR code image from an image
 *
 * @param {ArrayBuffer} input
 * @param {boolean} normalise
 * @returns {string}
 */
export async function parseQrCode(input, normalise) {
    let image;
    try {
        image = await Jimp.read(input);
    } catch (err) {
        throw new OperationError(`Error opening image. (${err})`);
    }

    try {
        if (normalise) {
            image.greyscale();
            image.normalize();
        }
    } catch (err) {
        throw new OperationError(`Error normalising image. (${err})`);
    }

    // Remove transparency which jsQR cannot handle
    image.scan((x, y, idx) => {
        // If pixel is fully transparent, make it opaque white
        if (image.bitmap.data[idx + 3] === 0x00) {
            image.bitmap.data[idx + 0] = 0xff;
            image.bitmap.data[idx + 1] = 0xff;
            image.bitmap.data[idx + 2] = 0xff;
        }
        // Otherwise, make it fully opaque at its existing colour
        image.bitmap.data[idx + 3] = 0xff;
    });
    image = await Jimp.read(await image.getBuffer(JimpMime.jpeg));

    const qrData = jsQR(
        new Uint8ClampedArray(image.bitmap.data),
        image.width,
        image.height,
    );
    if (qrData) {
        return qrData.data;
    } else {
        throw new OperationError("Could not read a QR code from the image.");
    }
}

/**
 * Generates a QR code from the input string
 *
 * @param {string} input
 * @param {string} format
 * @param {number} moduleSize
 * @param {number} margin
 * @param {string} errorCorrection
 * @returns {ArrayBuffer}
 */
export function generateQrCode(
    input,
    format,
    moduleSize,
    margin,
    errorCorrection,
) {
    const formats = ["SVG", "EPS", "PDF", "PNG"];
    if (!formats.includes(format.toUpperCase())) {
        throw new OperationError("Unsupported QR code format.");
    }

    let qrImage;
    try {
        qrImage = qr.imageSync(input, {
            type: format,
            size: moduleSize,
            margin: margin,
            // eslint-disable-next-line camelcase
            ec_level: errorCorrection.charAt(0).toUpperCase(),
        });
    } catch (err) {
        throw new OperationError(`Error generating QR code. (${err})`);
    }

    if (!qrImage) {
        throw new OperationError("Error generating QR code.");
    }

    switch (format) {
        case "SVG":
        case "EPS":
        case "PDF":
            return Utils.strToArrayBuffer(qrImage);
        case "PNG":
            return qrImage.buffer.slice(qrImage.byteOffset, qrImage.byteLength + qrImage.byteOffset);
        default:
            throw new OperationError("Unsupported QR code format.");
    }
}