Move to command-line-args for argument parsing

Author: CapacitorSet

README.md

@@ -22,39 +22,39 @@ It will create a folder called `file1.js.results`; if it already exists, it will
 ## Flags
 
 <!--START_FLAGS-->
---version: Show the package version
+--version (Boolean): Show the package version
 
---debug: Die when an emulation error occurs, even in "batch mode"
+--debug (Boolean): Die when an emulation error occurs, even in "batch mode"
 
---download: Actually download the payloads
+--download (Boolean): Actually download the payloads
 
---no-file-exists: Return `false` for Scripting.FileSystemObject.FileExists(x)
+--no-file-exists (Boolean): Return `false` for Scripting.FileSystemObject.FileExists(x)
 
---no-catch-rewrite: Do not rewrite try..catch clauses to make the exception global-scoped
+--no-catch-rewrite (Boolean): Do not rewrite try..catch clauses to make the exception global-scoped
 
---no-cc_on-rewrite: Do not rewrite `/*@cc_on <...>@*/` to `<...>`
+--no-cc_on-rewrite (Boolean): Do not rewrite `/*@cc_on <...>@*/` to `<...>`
 
---no-concat-simplify: Do not simplify `'a'+'b'` to `'ab'`
+--no-concat-simplify (Boolean): Do not simplify `'a'+'b'` to `'ab'`
 
---no-echo: When the script prints data, do not print it to the console
+--no-echo (Boolean): When the script prints data, do not print it to the console
 
---no-eval-rewrite: Do not rewrite `eval` so that its argument is rewritten
+--no-eval-rewrite (Boolean): Do not rewrite `eval` so that its argument is rewritten
 
---no-rewrite: Do not rewrite the source code at all, other than for `@cc_on` support
+--no-rewrite (Boolean): Do not rewrite the source code at all, other than for `@cc_on` support
 
---no-shell-error: Do not throw a fake error when executing `WScriptShell.Run` (it throws a fake error by default to pretend that the distribution sites are down, so that the script will attempt to poll every site)
+--no-shell-error (Boolean): Do not throw a fake error when executing `WScriptShell.Run` (it throws a fake error by default to pretend that the distribution sites are down, so that the script will attempt to poll every site)
 
---no-typeof-rewrite: Do not rewrite `typeof` (e.g. `typeof ActiveXObject`, which must return 'unknown' in the JScript standard and not 'object')
+--no-typeof-rewrite (Boolean): Do not rewrite `typeof` (e.g. `typeof ActiveXObject`, which must return 'unknown' in the JScript standard and not 'object')
 
---output-dir: The location on disk to write the results files and folders to (defaults to the current directory)
+--output-dir (String): The location on disk to write the results files and folders to (defaults to the current directory)
 
---proxy=http://1.2.3.4:1234: Use the specified proxy for downloads. This is not relevant if the --download flag is not present.
+--proxy (String): Use the specified proxy for downloads. This is not relevant if the --download flag is not present.
 
---timeout: The script will timeout after this many seconds (default 10)
+--timeout (Number): The script will timeout after this many seconds (default 10)
 
---windows-xp: Emulate Windows XP (influences the value of environment variables)
+--windows-xp (Boolean): Emulate Windows XP (influences the value of environment variables)
 
---experimental-neq: [experimental] rewrite `a != b` to `false`
+--experimental-neq (Boolean): [experimental] rewrite `a != b` to `false`
 <!--END_FLAGS-->
 
 ## Analyzing the output

_controller.js

@@ -1,8 +1,18 @@
-var fs = require("fs"),
-	uuid = require("uuid"),
-	request = require("sync-request");
+const fs = require("fs");
+const uuid = require("uuid");
+const request = require("sync-request");
+const path = require("path");
 
-const argv = require('minimist')(process.argv.slice(2));
+const commandLineArgs = require('command-line-args');
+const flags = JSON.parse(fs.readFileSync(path.join(__dirname, 'flags.json'), 'utf8'))
+	.map(flag => {
+		if (flag.type === "String") flag.type = String;
+		if (flag.type === "Number") flag.type = Number;
+		if (flag.type === "Boolean") flag.type = Boolean;
+		return flag;
+	}
+);
+const argv = commandLineArgs(flags);
 
 const directory = process.argv[3];
 

_run.js

@@ -1,5 +1,4 @@
-const argv = require('minimist')(process.argv.slice(2));
-const columnify = require("columnify");
+const commandLineArgs = require('command-line-args');
 const cp = require("child_process");
 const fs = require("fs");
 const path = require("path");
@@ -14,15 +13,15 @@ Arguments:
 `;
 
 // Read and format JSON flag documentation
-let flags = JSON.parse(fs.readFileSync(path.join(__dirname, 'flags.json'), 'utf8'));
-flags = columnify(flags, {
-	showHeaders: false,
-	config: {
-		description: {
-			maxWidth: 50
-		}
+const flags = JSON.parse(fs.readFileSync(path.join(__dirname, 'flags.json'), 'utf8'))
+	.map(flag => {
+		if (flag.type === "String") flag.type = String;
+		if (flag.type === "Number") flag.type = Number;
+		if (flag.type === "Boolean") flag.type = Boolean;
+		return flag;
 	}
-});
+);
+const argv = commandLineArgs(flags);
 
 if (argv.h || argv.help || argv.length === 0) {
 	console.log(help + flags.replace(/^/mg, "    "));

analyze.js

@@ -4,9 +4,19 @@ const esprima = require("esprima");
 const fs = require("fs");
 const path = require("path");
 const {VM} = require("vm2");
-const argv = require('minimist')(process.argv)
 
-const filename = argv._[2];
+const filename = process.argv[2];
+
+const commandLineArgs = require('command-line-args');
+const flags = JSON.parse(fs.readFileSync(path.join(__dirname, 'flags.json'), 'utf8'))
+	.map(flag => {
+		if (flag.type === "String") flag.type = String;
+		if (flag.type === "Number") flag.type = Number;
+		if (flag.type === "Boolean") flag.type = Boolean;
+		return flag;
+	}
+);
+const argv = commandLineArgs(flags);
 
 console.log(`Analyzing ${filename}`);
 let code = fs.readFileSync(path.join(__dirname, "patch.js"), "utf8") + fs.readFileSync(filename, "utf8");
@@ -19,7 +29,7 @@ if (code.match("<job") || code.match("<script")) { // The sample may actually be
 
 function rewrite(code) {
 	if (code.match("@cc_on")) {
-		if (!argv["--no-cc_on-rewrite"]) {
+		if (!argv["no-cc_on-rewrite"]) {
 			code = code.replace(/\/\*@cc_on/g, "");
 			code = code.replace(/@\*\//g, "");
 		} else {
@@ -36,10 +46,8 @@ If you run into unexpected results, try uncommenting lines that look like
 		}
 	}
 
-	console.log(argv);
-	if (!argv["--no-rewrite"]) {
-		console.log("Rewriting...")
-		if (!!argv["--dumb-concat-simplify"]) {
+	if (!argv["no-rewrite"]) {
+		if (!!argv["dumb-concat-simplify"]) {
 			code = code.replace(/'[ \r\n]*\+[ \r\n]*'/gm, "");
 			code = code.replace(/"[ \r\n]*\+[ \r\n]*"/gm, "");
 		}
@@ -74,7 +82,7 @@ cc decoder.c -o decoder
 			process.exit(-1);
 			return;
 		}
-		if (!argv["--no-concat-simplify"]) {
+		if (!argv["no-concat-simplify"]) {
 			traverse(tree, function(key, val) {
 				if (!val) return;
 				if (val.type !== "BinaryExpression") return;
@@ -89,7 +97,7 @@ cc decoder.c -o decoder
 				};
 			});
 		}
-		if (!!argv["--function-rewrite"]) {
+		if (!!argv["function-rewrite"]) {
 			traverse(tree, function(key, val) {
 				if (key !== "callee") return;
 				if (val.autogenerated) return;
@@ -102,7 +110,7 @@ cc decoder.c -o decoder
 			});
 		}
 
-		if (!argv["--no-typeof-rewrite"]) {
+		if (!argv["no-typeof-rewrite"]) {
 			traverse(tree, function(key, val) {
 				if (!val) return;
 				if (val.type !== "UnaryExpression") return;
@@ -112,7 +120,7 @@ cc decoder.c -o decoder
 			});
 		}
 
-		if (!argv["--no-eval-rewrite"]) {
+		if (!argv["no-eval-rewrite"]) {
 			traverse(tree, function(key, val) {
 				if (!val) return;
 				if (val.type !== "CallExpression") return;
@@ -122,7 +130,7 @@ cc decoder.c -o decoder
 			});
 		}
 
-		if (!argv["--no-catch-rewrite"]) {
+		if (!argv["no-catch-rewrite"]) {
 			traverse(tree, function(key, val) {
 				if (!val) return;
 				if (val.type !== "TryStatement") return;
@@ -133,7 +141,7 @@ cc decoder.c -o decoder
 		}
 
 		// Replace (a !== b) with (false)
-		if (!!argv["--experimental-neq"]) {
+		if (!!argv["experimental-neq"]) {
 			traverse(tree, function(key, val) {
 				if (!val) return;
 				if (val.type !== "BinaryExpression") return;
@@ -149,7 +157,7 @@ cc decoder.c -o decoder
 		code = escodegen.generate(tree);
 
 		// The modifications may have resulted in more concatenations, eg. "a" + ("foo", "b") + "c" -> "a" + "b" + "c"
-		if (!!argv["--dumb-concat-simplify"]) {
+		if (!!argv["dumb-concat-simplify"]) {
 			code = code.replace(/'[ \r\n]*\+[ \r\n]*'/gm, "");
 			code = code.replace(/"[ \r\n]*\+[ \r\n]*"/gm, "");
 		}
@@ -222,7 +230,7 @@ const sandbox = {
 						},
 						line: 1,
 						writeline: text => {
-							if (!!argv["--no-echo"]) return;
+							if (!!argv["no-echo"]) return;
 							console.log("Script wrote:", text);
 							console.log("Add flag --no-echo to disable this.");
 						}
@@ -268,7 +276,7 @@ const sandbox = {
 				case "scriptfullname":
 					return "(ScriptFullName)";
 				case "echo":
-					if (!!argv["--no-echo"])
+					if (!!argv["no-echo"])
 						return () => {};
 					return x => {
 						console.log("Script wrote:", x);

flags.json

@@ -1,70 +1,87 @@
 [
     {
-        "flag": "--version",
+        "name": "version",
+        "type": "Boolean",
         "description": "Show the package version"
     },
     {
-        "flag": "--debug",
+        "name": "debug",
+        "type": "Boolean",
         "description": "Die when an emulation error occurs, even in \"batch mode\""
     },
     {
-        "flag": "--download",
+        "name": "download",
+        "type": "Boolean",
         "description": "Actually download the payloads"
     },
     {
-        "flag": "--no-file-exists",
+        "name": "no-file-exists",
+        "type": "Boolean",
         "description": "Return `false` for Scripting.FileSystemObject.FileExists(x)"
     },
     {
-        "flag": "--no-catch-rewrite",
+        "name": "no-catch-rewrite",
+        "type": "Boolean",
         "description": "Do not rewrite try..catch clauses to make the exception global-scoped"
     },
     {
-        "flag": "--no-cc_on-rewrite",
+        "name": "no-cc_on-rewrite",
+        "type": "Boolean",
         "description": "Do not rewrite `/*@cc_on <...>@*/` to `<...>`"
     },
     {
-        "flag": "--no-concat-simplify",
+        "name": "no-concat-simplify",
+        "type": "Boolean",
         "description": "Do not simplify `'a'+'b'` to `'ab'`"
     },
     {
-        "flag": "--no-echo",
+        "name": "no-echo",
+        "type": "Boolean",
         "description": "When the script prints data, do not print it to the console"
     },
     {
-        "flag": "--no-eval-rewrite",
+        "name": "no-eval-rewrite",
+        "type": "Boolean",
         "description": "Do not rewrite `eval` so that its argument is rewritten"
     },
     {
-        "flag": "--no-rewrite",
+        "name": "no-rewrite",
+        "type": "Boolean",
         "description": "Do not rewrite the source code at all, other than for `@cc_on` support"
     },
     {
-        "flag": "--no-shell-error",
+        "name": "no-shell-error",
+        "type": "Boolean",
         "description": "Do not throw a fake error when executing `WScriptShell.Run` (it throws a fake error by default to pretend that the distribution sites are down, so that the script will attempt to poll every site)"
     },
     {
-        "flag": "--no-typeof-rewrite",
+        "name": "no-typeof-rewrite",
+        "type": "Boolean",
         "description": "Do not rewrite `typeof` (e.g. `typeof ActiveXObject`, which must return 'unknown' in the JScript standard and not 'object')"
     },
     {
-        "flag": "--output-dir",
+        "name": "output-dir",
+        "type": "String",
         "description": "The location on disk to write the results files and folders to (defaults to the current directory)"
     },
     {
-        "flag": "--proxy=http://1.2.3.4:1234",
+        "name": "proxy",
+        "type": "String",
         "description": "Use the specified proxy for downloads. This is not relevant if the --download flag is not present."
     },
     {
-        "flag": "--timeout",
+        "name": "timeout",
+        "type": "Number",
         "description": "The script will timeout after this many seconds (default 10)"
     },
     {
-        "flag": "--windows-xp",
+        "name": "windows-xp",
+        "type": "Boolean",
         "description": "Emulate Windows XP (influences the value of environment variables)"
     },
     {
-        "flag": "--experimental-neq",
+        "name": "experimental-neq",
+        "type": "Boolean",
         "description": "[experimental] rewrite `a != b` to `false`"
     }
 ]

package.json

@@ -10,8 +10,7 @@
     "iconv-lite": "*",
     "walk": "*",
     "async": "*",
-    "minimist": "*",
-    "columnify": "*",
+    "command-line-args": "*",
     "vm2": "*"
   },
   "devDependencies": {

update-docs.js

@@ -1,6 +1,6 @@
 const fs = require("fs");
 const flags = JSON.parse(fs.readFileSync("flags.json", "utf8"));
-const text = flags.map(item => item.flag + ": " + item.description).join("\n\n");
+const text = flags.map(item => `--${item.name} (${item.type}): ${item.description}`).join("\n\n");
 const README = fs.readFileSync("README.md", "utf8");
 fs.writeFileSync(
 	"README.md",