mirror of https://github.com/gchq/CyberChef.git
101 lines
3.0 KiB
JavaScript
101 lines
3.0 KiB
JavaScript
/**
|
|
* @author n1474335 [n1474335@gmail.com]
|
|
* @copyright Crown Copyright 2018
|
|
* @license Apache-2.0
|
|
*/
|
|
|
|
import Operation from "../Operation";
|
|
import OperationError from "../errors/OperationError";
|
|
import Utils from "../Utils";
|
|
import {scanForFileTypes, extractFile} from "../lib/FileType";
|
|
import {FILE_SIGNATURES} from "../lib/FileSignatures";
|
|
|
|
/**
|
|
* Extract Files operation
|
|
*/
|
|
class ExtractFiles extends Operation {
|
|
|
|
/**
|
|
* ExtractFiles constructor
|
|
*/
|
|
constructor() {
|
|
super();
|
|
|
|
this.name = "Extract Files";
|
|
this.module = "Default";
|
|
this.description = "Performs file carving to attempt to extract files from the input.<br><br>This operation is currently capable of carving out the following formats:<ul><li>JPG</li><li>EXE</li><li>ZIP</li><li>PDF</li><li>PNG</li><li>BMP</li><li>FLV</li><li>RTF</li><li>DOCX, PPTX, XLSX</li><li>EPUB</li><li>GZIP</li><li>ZLIB</li><li>ELF, BIN, AXF, O, PRX, SO</li></ul>";
|
|
this.infoURL = "https://forensicswiki.org/wiki/File_Carving";
|
|
this.inputType = "ArrayBuffer";
|
|
this.outputType = "List<File>";
|
|
this.presentType = "html";
|
|
this.args = Object.keys(FILE_SIGNATURES).map(cat => {
|
|
return {
|
|
name: cat,
|
|
type: "boolean",
|
|
value: cat === "Miscellaneous" ? false : true
|
|
};
|
|
}).concat([
|
|
{
|
|
name: "Ignore failed extractions",
|
|
type: "boolean",
|
|
value: "true"
|
|
}
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* @param {ArrayBuffer} input
|
|
* @param {Object[]} args
|
|
* @returns {List<File>}
|
|
*/
|
|
run(input, args) {
|
|
const bytes = new Uint8Array(input),
|
|
categories = [],
|
|
ignoreFailedExtractions = args.pop(1);
|
|
|
|
args.forEach((cat, i) => {
|
|
if (cat) categories.push(Object.keys(FILE_SIGNATURES)[i]);
|
|
});
|
|
|
|
// Scan for embedded files
|
|
const detectedFiles = scanForFileTypes(bytes, categories);
|
|
|
|
// Extract each file that we support
|
|
const files = [];
|
|
const errors = [];
|
|
detectedFiles.forEach(detectedFile => {
|
|
try {
|
|
files.push(extractFile(bytes, detectedFile.fileDetails, detectedFile.offset));
|
|
} catch (err) {
|
|
if (!ignoreFailedExtractions && err.message.indexOf("No extraction algorithm available") < 0) {
|
|
errors.push(
|
|
`Error while attempting to extract ${detectedFile.fileDetails.name} ` +
|
|
`at offset ${detectedFile.offset}:\n` +
|
|
`${err.message}`
|
|
);
|
|
}
|
|
}
|
|
});
|
|
|
|
if (errors.length) {
|
|
throw new OperationError(errors.join("\n\n"));
|
|
}
|
|
|
|
return files;
|
|
}
|
|
|
|
|
|
/**
|
|
* Displays the files in HTML for web apps.
|
|
*
|
|
* @param {File[]} files
|
|
* @returns {html}
|
|
*/
|
|
async present(files) {
|
|
return await Utils.displayFilesAsHTML(files);
|
|
}
|
|
|
|
}
|
|
|
|
export default ExtractFiles;
|