Mirror
/
CyberChef
mirror of https://github.com/gchq/CyberChef.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tidied up QR code operations

This commit is contained in:
n1474335 2018-12-25 21:54:38 +00:00
parent 4ee0800990
commit 9734b78aeb
5 changed files with 683 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -2,6 +2,9 @@
All major and minor version changes will be documented in this file. Details of patch-level version changes can be found in [commit messages](https://github.com/gchq/CyberChef/commits/master). All major and minor version changes will be documented in this file. Details of patch-level version changes can be found in [commit messages](https://github.com/gchq/CyberChef/commits/master).
### [8.17.0] - 2018-12-25
- 'Generate QR Code' and 'Parse QR Code' operations added [@j433866] | [#448]
### [8.16.0] - 2018-12-19 ### [8.16.0] - 2018-12-19
- 'Play Media' operation added [@anthony-arnold] | [#446] - 'Play Media' operation added [@anthony-arnold] | [#446]
@ -79,6 +82,7 @@ All major and minor version changes will be documented in this file. Details of
[8.17.0]: https://github.com/gchq/CyberChef/releases/tag/v8.17.0
[8.16.0]: https://github.com/gchq/CyberChef/releases/tag/v8.16.0 [8.16.0]: https://github.com/gchq/CyberChef/releases/tag/v8.16.0
[8.15.0]: https://github.com/gchq/CyberChef/releases/tag/v8.15.0 [8.15.0]: https://github.com/gchq/CyberChef/releases/tag/v8.15.0
[8.14.0]: https://github.com/gchq/CyberChef/releases/tag/v8.14.0 [8.14.0]: https://github.com/gchq/CyberChef/releases/tag/v8.14.0
@ -103,6 +107,7 @@ All major and minor version changes will be documented in this file. Details of
[@n1474335]: https://github.com/n1474335 [@n1474335]: https://github.com/n1474335
[@d98762625]: https://github.com/d98762625 [@d98762625]: https://github.com/d98762625
[@j433866]: https://github.com/j433866
[@GCHQ77703]: https://github.com/GCHQ77703 [@GCHQ77703]: https://github.com/GCHQ77703
[@artemisbot]: https://github.com/artemisbot [@artemisbot]: https://github.com/artemisbot
[@picapi]: https://github.com/picapi [@picapi]: https://github.com/picapi
@ -144,3 +149,4 @@ All major and minor version changes will be documented in this file. Details of
[#441]: https://github.com/gchq/CyberChef/pull/441 [#441]: https://github.com/gchq/CyberChef/pull/441
[#443]: https://github.com/gchq/CyberChef/pull/443 [#443]: https://github.com/gchq/CyberChef/pull/443
[#446]: https://github.com/gchq/CyberChef/pull/446 [#446]: https://github.com/gchq/CyberChef/pull/446
[#448]: https://github.com/gchq/CyberChef/pull/448

704
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

63
src/core/operations/GenerateQRCode.mjs
View File

@ -9,6 +9,7 @@ import OperationError from "../errors/OperationError";
import qr from "qr-image"; import qr from "qr-image";
import { toBase64 } from "../lib/Base64"; import { toBase64 } from "../lib/Base64";
import Magic from "../lib/Magic"; import Magic from "../lib/Magic";
import Utils from "../Utils";
/** /**
* Generate QR Code operation * Generate QR Code operation
@ -23,7 +24,7 @@ class GenerateQRCode extends Operation {
this.name = "Generate QR Code"; this.name = "Generate QR Code";
this.module = "Image"; this.module = "Image";
this.description = "Generates a QR code from text."; 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"; this.infoURL = "https://wikipedia.org/wiki/QR_code";
this.inputType = "string"; this.inputType = "string";
this.outputType = "byteArray"; this.outputType = "byteArray";
@ -32,17 +33,23 @@ class GenerateQRCode extends Operation {
{ {
"name": "Image Format", "name": "Image Format",
"type": "option", "type": "option",
"value": ["PNG", "SVG"] "value": ["PNG", "SVG", "EPS", "PDF"]
}, },
{ {
"name": "Size of QR module", "name": "Module size (px)",
"type": "number", "type": "number",
"value": 5 "value": 5
}, },
{ {
"name": "Margin", "name": "Margin (num modules)",
"type": "number", "type": "number",
"value": 2 "value": 2
},
{
"name": "Error correction",
"type": "option",
"value": ["Low", "Medium", "Quartile", "High"],
"defaultIndex": 1
} }
]; ];
} }
@ -50,28 +57,39 @@ class GenerateQRCode extends Operation {
/** /**
* @param {string} input * @param {string} input
* @param {Object[]} args * @param {Object[]} args
* @returns {File} * @returns {byteArray}
*/ */
run(input, args) { run(input, args) {
const [format, size, margin, errorCorrection] = args;
// Create new QR image from the input data, and convert it to a buffer // Create new QR image from the input data, and convert it to a buffer
const [format, size, margin] = args; const qrImage = qr.imageSync(input, {
const qrImage = qr.imageSync(input, { type: format, size: size, margin: margin }); type: format,
size: size,
margin: margin,
"ec_level": errorCorrection.charAt(0).toUpperCase()
});
if (qrImage == null) { if (qrImage == null) {
throw new OperationError("Error generating QR code."); throw new OperationError("Error generating QR code.");
} }
if (format === "SVG") {
return [...Buffer.from(qrImage)]; switch (format) {
} else if (format === "PNG") { case "SVG":
// Return the QR image buffer as a byte array case "EPS":
return [...qrImage]; case "PDF":
} else { return [...Buffer.from(qrImage)];
throw new OperationError("Error generating QR code."); 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 * Displays the QR image using HTML for web apps
* *
* @param {byteArray} data * @param {byteArray} data
* @returns {html} * @returns {html}
*/ */
@ -79,24 +97,21 @@ class GenerateQRCode extends Operation {
if (!data.length) return ""; if (!data.length) return "";
const [format] = args; const [format] = args;
if (format === "SVG") {
let outputData = ""; if (format === "PNG") {
for (let i = 0; i < data.length; i++){
outputData += String.fromCharCode(parseInt(data[i]));
}
return outputData;
} else {
let dataURI = "data:"; let dataURI = "data:";
const type = Magic.magicFileType(data); const type = Magic.magicFileType(data);
if (type && type.mime.indexOf("image") === 0){ if (type && type.mime.indexOf("image") === 0){
dataURI += type.mime + ";"; dataURI += type.mime + ";";
} else { } else {
throw new OperationError("Invalid file type"); throw new OperationError("Invalid PNG file generated by QR image");
} }
dataURI += "base64," + toBase64(data); dataURI += "base64," + toBase64(data);
return "<img src='" + dataURI + "'>"; return `<img src="${dataURI}">`;
} }
return Utils.byteArrayToChars(data);
} }
} }

38
src/core/operations/ParseQRCode.mjs
View File

@ -23,7 +23,7 @@ class ParseQRCode extends Operation {
this.name = "Parse QR Code"; this.name = "Parse QR Code";
this.module = "Image"; this.module = "Image";
this.description = "Reads an image file and attempts to detect and read a QR code from the image.<br><br><u>Normalise Image</u><br>Attempt to normalise the image before parsing it, to try and improve detection of a QR code."; this.description = "Reads an image file and attempts to detect and read a Quick Response (QR) code from the image.<br><br><u>Normalise Image</u><br>Attempts to normalise the image before parsing it to improve detection of a QR code.";
this.infoURL = "https://wikipedia.org/wiki/QR_code"; this.infoURL = "https://wikipedia.org/wiki/QR_code";
this.inputType = "byteArray"; this.inputType = "byteArray";
this.outputType = "string"; this.outputType = "string";
@ -31,7 +31,7 @@ class ParseQRCode extends Operation {
{ {
"name": "Normalise image", "name": "Normalise image",
"type": "boolean", "type": "boolean",
"value": true "value": false
} }
]; ];
} }
@ -44,17 +44,19 @@ class ParseQRCode extends Operation {
async run(input, args) { async run(input, args) {
const type = Magic.magicFileType(input); const type = Magic.magicFileType(input);
const [normalise] = args; const [normalise] = args;
// Make sure that the input is an image // Make sure that the input is an image
if (type && type.mime.indexOf("image") === 0){ if (type && type.mime.indexOf("image") === 0) {
let normalisedImage = null; let image = input;
if (normalise){
if (normalise) {
// Process the image to be easier to read by jsqr // Process the image to be easier to read by jsqr
// Disables the alpha channel // Disables the alpha channel
// Sets the image default background to white // Sets the image default background to white
// Normalises the image colours // Normalises the image colours
// Makes the image greyscale // Makes the image greyscale
// Converts image to a JPEG // Converts image to a JPEG
normalisedImage = await new Promise((resolve, reject) => { image = await new Promise((resolve, reject) => {
jimp.read(Buffer.from(input)) jimp.read(Buffer.from(input))
.then(image => { .then(image => {
image image
@ -63,38 +65,38 @@ class ParseQRCode extends Operation {
.normalize() .normalize()
.greyscale() .greyscale()
.getBuffer(jimp.MIME_JPEG, (error, result) => { .getBuffer(jimp.MIME_JPEG, (error, result) => {
resolve([...result]); resolve(result);
}); });
}) })
.catch(err => { .catch(err => {
reject(new OperationError("Error reading the image file.")); reject(new OperationError("Error reading the image file."));
}); });
}); });
} else {
normalisedImage = input;
} }
if (normalisedImage instanceof OperationError){
return normalisedImage; if (image instanceof OperationError) {
throw image;
} }
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
jimp.read(Buffer.from(normalisedImage)) jimp.read(Buffer.from(image))
.then(image => { .then(image => {
if (image.bitmap != null){ if (image.bitmap != null) {
const qrData = jsqr(image.bitmap.data, image.getWidth(), image.getHeight()); const qrData = jsqr(image.bitmap.data, image.getWidth(), image.getHeight());
if (qrData != null){ if (qrData != null) {
resolve(qrData.data); resolve(qrData.data);
} else { } else {
reject(new OperationError("Couldn't read a QR code from the image.")); reject(new OperationError("Couldn't read a QR code from the image."));
} }
} else { } else {
reject(new OperationError("Error reading the normalised image file.")); reject(new OperationError("Error reading the image file."));
} }
}) })
.catch(err => { .catch(err => {
reject(new OperationError("Error reading the normalised image file.")); reject(new OperationError("Error reading the image file."));
}); });
}); });
} else { } else {
throw new OperationError("Invalid file type."); throw new OperationError("Invalid file type.");
} }

12
test/tests/operations/ParseQRCode.mjs
View File

@ -1,6 +1,6 @@
/** /**
* Parse QR Code tests * Parse QR Code tests
* *
* @author j433866 [j433866@gmail.com] * @author j433866 [j433866@gmail.com]
* @copyright Crown Copyright 2018 * @copyright Crown Copyright 2018
* @license Apache-2.0 * @license Apache-2.0
@ -15,7 +15,7 @@ TestRegister.addTests([
recipeConfig: [ recipeConfig: [
{ {
"op": "From Hex", "op": "From Hex",
"args": ["Space"] "args": ["None"]
}, },
{ {
"op": "Parse QR Code", "op": "Parse QR Code",
@ -34,7 +34,7 @@ TestRegister.addTests([
}, },
{ {
"op": "Parse QR Code", "op": "Parse QR Code",
"args": [true] "args": [false]
}, },
], ],
}, },
@ -45,7 +45,7 @@ TestRegister.addTests([
recipeConfig: [ recipeConfig: [
{ {
"op": "From Hex", "op": "From Hex",
"args": ["Space"] "args": ["None"]
}, },
{ {
"op": "Parse QR Code", "op": "Parse QR Code",
@ -60,7 +60,7 @@ TestRegister.addTests([
recipeConfig: [ recipeConfig: [
{ {
"op": "From Hex", "op": "From Hex",
"args": ["Space"] "args": ["None"]
}, },
{ {
"op": "Parse QR Code", "op": "Parse QR Code",