mirrors/CyberChef
1
0
Fork 0
mirror of https://github.com/gchq/CyberChef.git synced 2025-05-10 00:05:11 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Address feedback so far in MR #1043

Browse source 
* Remove TCP server feature; this area is better served by the
  CyberChef-server project
* Increase required version of commander to one which provides
  `requiredOption()`
* Print the error message that is captured when failing to parse the
  command line

Also use `fs.readFileSync()` to read the recipe file.
This commit is contained in:
David Perry 2020-05-29 11:16:12 -04:00
parent 6805f90e05
commit 50a66c1910
2 changed files with 32 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

123
cli.js
View file

@ -49,26 +49,9 @@ const slurp = (fname) => { // {{{1
return slurpStream(istream);
}; // }}}1
/**
* Get a valid port number from the command line
*
* Used by commander
*
* @param {String} value
* @param {String} dummyPrevious
*/
const getPort = (value, dummyPrevious) => { // {{{1
const ret = parseInt(value, 10);
if (ret < 1 || ret > 65535) {
throw new Error("invalid port number");
}
return ret;
};
// }}}1
/* * * * * MAIN * * * * */ // {{{1
const chef = require("cyberchef");
const chef = require("./src/node/cjs.js");
const program = require("commander");
program
@ -78,24 +61,30 @@ program
.usage("[options] [file [file ...]]")
.requiredOption("-r, --recipe-file <file>",
"recipe JSON file")
.option("-l, --listen [port]",
"listen on TCP port for data (random if not given)", getPort, false)
.option("-o, --output <file-or-dir>",
"where to write result (file input only; default:stdout)");
try {
program.exitOverride().parse(process.argv);
} catch (e) {
console.error(e.message);
if (e.code !== "commander.helpDisplayed") {
console.error("Run with \"--help\" for usage");
}
process.exit(1);
}
// If we get no inputs and we aren't running a server,
// make stdin our single input
let recipe;
try {
recipe = JSON.parse(fs.readFileSync(program.recipeFile));
} catch (err) {
console.error(err.message);
process.exit(3);
}
// If we get no inputs, make stdin our single input
let inputs = program.args;
if (inputs.length === 0 && !program.listen) {
if (inputs.length === 0) {
inputs = ["-"];
}
@ -103,16 +92,16 @@ if (inputs.length === 0 && !program.listen) {
let ostream;
let path;
let outputIsDir = false;
if (program.output === undefined && !program.listen) {
if (program.output === undefined) {
ostream = process.stdout;
} else if (inputs.length > 0) {
} else {
// See if our output is a directory
let st;
try {
st = fs.statSync(program.output);
outputIsDir = st.isDirectory();
} catch (err) {
// We"re fine if the output doesn"t exist yet
// We"re fine if the output doesn't exist yet
if (err.code !== "ENOENT") throw err;
}
if (!outputIsDir) {
@ -121,71 +110,21 @@ if (program.output === undefined && !program.listen) {
}
if (outputIsDir) path = require("path");
let recipe;
slurp(program.recipeFile).then((data) => {
recipe = JSON.parse(data);
})
.catch((err) => {
console.error(`Error parsing recipe: ${err.message}`);
process.exit(2);
})
.then(() => {
// First, deal with any files we want to read
for (const i of inputs) {
slurp(i).then((data) => {
const output = chef.bake(data, recipe);
if (outputIsDir) {
let outFileName = path.basename(i);
if (outFileName === "-") outFileName = "from-stdin";
ostream = fs.createWriteStream(
path.join(program.output, outFileName));
}
ostream.write(output.presentAs("string", true));
if (outputIsDir) ostream.end();
},
(err) => {
console.error(err.message);
process.exitCode = 2;
})
.catch((err) => {
console.error(err.message);
process.exitCode = 2;
});
}
// Next, listen for TCP requests.
// This is intentionally hardcoded to localhost to discourage
// the use of this script as a production system.
if (program.listen) {
const net = require("net");
const server = net.createServer((socket) => {
slurpStream(socket).then((data) => {
const output = chef.bake(data, recipe);
socket.write(output.presentAs("string", true));
socket.end();
})
.catch((err) => {
console.error(err);
});
});
// If no port given by user, let the OS choose one
if (program.listen === true) program.listen = 0;
server.listen(program.listen, "127.0.0.1")
.on("listening", () => {
console.log("Now listening on " +
server.address().address +
":" + server.address().port);
});
// Exit gracefully
process.on("SIGINT", () => {
console.log("Exiting");
server.close();
});
// Deal with any files we want to read
for (const i of inputs) {
slurp(i).then((data) => {
const output = chef.bake(data, recipe);
if (outputIsDir) {
let outFileName = path.basename(i);
if (outFileName === "-") outFileName = "from-stdin";
ostream = fs.createWriteStream(
path.join(program.output, outFileName));
}
ostream.write(output.presentAs("string", true));
if (outputIsDir) ostream.end();
})
.catch((err) => {
console.error(err);
process.exit(3);
});
.catch((err) => {
console.error(err.message);
process.exitCode = 2;
});
}

2
package.json
View file

@ -101,7 +101,7 @@
"bson": "^4.0.3",
"chi-squared": "^1.1.0",
"codepage": "^1.14.0",
"commander": "^2.14.1",
"commander": "^5.1.0",
"core-js": "^3.6.4",
"crypto-api": "^0.8.5",
"crypto-js": "^4.0.0",