CyberChef/src/core/operations/GenerateQRCode.mjs

120 lines
3.4 KiB
JavaScript
Raw Normal View History

2018-12-19 14:27:45 +01:00
/**
* @author j433866 [j433866@gmail.com]
* @copyright Crown Copyright 2018
* @license Apache-2.0
*/
import Operation from "../Operation";
import OperationError from "../errors/OperationError";
import qr from "qr-image";
import { toBase64 } from "../lib/Base64";
import Magic from "../lib/Magic";
2018-12-25 22:54:38 +01:00
import Utils from "../Utils";
2018-12-19 14:27:45 +01:00
/**
* Generate QR Code operation
*/
class GenerateQRCode extends Operation {
/**
* GenerateQRCode constructor
*/
constructor() {
super();
this.name = "Generate QR Code";
this.module = "Image";
2018-12-25 22:54:38 +01:00
this.description = "Generates a Quick Response (QR) code from the input text.<br><br>A QR code is a type of matrix barcode (or two-dimensional barcode) first designed in 1994 for the automotive industry in Japan. A barcode is a machine-readable optical label that contains information about the item to which it is attached.";
this.infoURL = "https://wikipedia.org/wiki/QR_code";
2018-12-19 14:27:45 +01:00
this.inputType = "string";
this.outputType = "byteArray";
this.presentType = "html";
this.args = [
{
"name": "Image Format",
"type": "option",
2018-12-25 22:54:38 +01:00
"value": ["PNG", "SVG", "EPS", "PDF"]
},
{
2018-12-25 22:54:38 +01:00
"name": "Module size (px)",
"type": "number",
"value": 5
},
{
2018-12-25 22:54:38 +01:00
"name": "Margin (num modules)",
"type": "number",
"value": 2
2018-12-25 22:54:38 +01:00
},
{
"name": "Error correction",
"type": "option",
"value": ["Low", "Medium", "Quartile", "High"],
"defaultIndex": 1
}
];
2018-12-19 14:27:45 +01:00
}
/**
* @param {string} input
* @param {Object[]} args
2018-12-25 22:54:38 +01:00
* @returns {byteArray}
2018-12-19 14:27:45 +01:00
*/
run(input, args) {
2018-12-25 22:54:38 +01:00
const [format, size, margin, errorCorrection] = args;
// Create new QR image from the input data, and convert it to a buffer
2018-12-25 22:54:38 +01:00
const qrImage = qr.imageSync(input, {
type: format,
size: size,
margin: margin,
"ec_level": errorCorrection.charAt(0).toUpperCase()
});
2018-12-19 14:27:45 +01:00
if (qrImage == null) {
throw new OperationError("Error generating QR code.");
}
2018-12-25 22:54:38 +01:00
switch (format) {
case "SVG":
case "EPS":
case "PDF":
return [...Buffer.from(qrImage)];
case "PNG":
// Return the QR image buffer as a byte array
return [...qrImage];
default:
throw new OperationError("Unsupported QR code format.");
}
}
/**
* Displays the QR image using HTML for web apps
2018-12-25 22:54:38 +01:00
*
* @param {byteArray} data
* @returns {html}
*/
present(data, args) {
if (!data.length) return "";
const [format] = args;
2018-12-25 22:54:38 +01:00
if (format === "PNG") {
let dataURI = "data:";
const type = Magic.magicFileType(data);
if (type && type.mime.indexOf("image") === 0){
dataURI += type.mime + ";";
} else {
2018-12-25 22:54:38 +01:00
throw new OperationError("Invalid PNG file generated by QR image");
}
dataURI += "base64," + toBase64(data);
2018-12-25 22:54:38 +01:00
return `<img src="${dataURI}">`;
2018-12-19 14:27:45 +01:00
}
2018-12-25 22:54:38 +01:00
return Utils.byteArrayToChars(data);
2018-12-19 14:27:45 +01:00
}
}
export default GenerateQRCode;