@corellium/corellium-cli 1.4.0 → 1.5.0

package/src/commands/instances/create.js

@@ -1,110 +1,107 @@
-const { handleError } = require('../../error')
-const {
-  getApi, waitForState,
-  waitForAgentReady
-} = require('../../utils')
-const AgentCLI = require('../../clients/Agent')
+const { handleError } = require('../../error');
+const { getApi, waitForState, waitForAgentReady } = require('../../utils');
+const AgentCLI = require('../../clients/Agent');
 
 async function builder (yargs) {
   yargs
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
-      describe: 'Console will receive verbose error output'
+      describe: 'Console will receive verbose error output',
     })
     .option('format', {
       type: 'input',
       describe: 'Output format (default is json) e.g. table',
       string: true,
-      choices: ['table', 'json', 'csv']
+      choices: ['table', 'json', 'csv'],
     })
     .positional('flavor', {
       type: 'string',
       describe: 'Flavor',
-      demandOption: true
+      demandOption: true,
     })
     .positional('os', {
       type: 'string',
       describe: 'Operating system',
-      demandOption: true
+      demandOption: true,
     })
     .positional('project', {
       type: 'string',
       describe: 'Project ID to associate with instance',
-      demandOption: true
+      demandOption: true,
     })
     .option('os-build', {
       type: 'string',
       describe: 'OS Build',
-      demandOption: false
+      demandOption: false,
     })
     .option('name', {
       type: 'string',
       describe: 'Optional name of instance',
-      demandOption: false
+      demandOption: false,
     })
     .option('wait', {
       type: 'boolean',
       describe: 'Wait for the instance to be ready',
-      demandOption: false
+      demandOption: false,
     })
     .option('dyld-aslr', {
       type: 'boolean',
       describe: 'Enable ASLR for DYLD Shared Cache. (--no-dyld-aslr to disable)',
       default: true,
-      demandOption: false
+      demandOption: false,
     })
     .option('app-aslr', {
       type: 'boolean',
       describe: 'Enable ASLR for Applications. (--no-app-aslr to disable)',
       default: true,
-      demandOption: false
-    })
+      demandOption: false,
+    });
 }
 
 async function handler (argv) {
-  const flavor = argv.flavor
-  const os = argv.os
-  const project = argv.project
-  const name = argv.name
-  const api = await getApi()
-  const bootOptions = {}
-  const additionalTags = []
-  const instanceOptions = { flavor, os, project, name }
+  const flavor = argv.flavor;
+  const os = argv.os;
+  const project = argv.project;
+  const name = argv.name;
+  const api = await getApi();
+  const bootOptions = {};
+  const additionalTags = [];
+  const instanceOptions = { flavor, os, project, name };
 
   if (argv['app-aslr'] === false) {
-    additionalTags.push('noappaslr')
+    additionalTags.push('noappaslr');
   }
 
   if (argv['dyld-aslr'] === false) {
-    additionalTags.push('nodyldaslr')
+    additionalTags.push('nodyldaslr');
   }
 
   // only define additional tags if any are present
   if (additionalTags.length > 0) {
-    bootOptions.additionalTags = additionalTags
+    bootOptions.additionalTags = additionalTags;
   }
 
   // only define bootOptions if it contains any values
   if (Object.keys(bootOptions).length > 0) {
-    instanceOptions.bootOptions = bootOptions
+    instanceOptions.bootOptions = bootOptions;
   }
 
   if (argv['os-build']) {
-    instanceOptions.osbuild = argv['os-build']
+    instanceOptions.osbuild = argv['os-build'];
   }
 
   try {
-    const instance = await api.v1CreateInstance(instanceOptions)
+    const instance = await api.v1CreateInstance(instanceOptions);
     // Wait 360 attempts for the instance to be created (30 minutes)
     if (argv.wait) {
-      await waitForState(instance.id, api.v1GetInstance.bind(api), 'on', 360)
-      const agent = new AgentCLI({ instance: instance.id })
-      await waitForAgentReady(agent, 360)
+      await waitForState(instance.id, api.v1GetInstance.bind(api), 'on', 360);
+      const agent = new AgentCLI({ instance: instance.id });
+      await waitForAgentReady(agent, 360);
     }
-    console.log(instance.id)
+    console.log(instance.id);
   } catch (err) {
-    handleError(err, 'Failed to create instance', argv.verbose)
+    handleError(err, 'Failed to create instance', argv.verbose);
   }
 }
 
@@ -112,5 +109,5 @@ module.exports = {
   builder,
   handler,
   command: 'create <flavor> <os> <project> [name] [wait]',
-  describe: 'Create instance and associate with a project'
-}
+  describe: 'Create instance and associate with a project',
+};

package/src/commands/instances/delete.js

@@ -1,43 +1,42 @@
-const { handleError } = require('../../error')
-const chalk = require('chalk')
-const { getApi, sleep } = require('../../utils')
+const { handleError } = require('../../error');
+const chalk = require('chalk');
+const { getApi, sleep } = require('../../utils');
 
 async function builder (yargs) {
-  yargs.positional('instanceId', {
-    type: 'string',
-    describe: 'Instance id',
-    demandOption: true
-  })
+  yargs
+    .positional('instanceId', {
+      type: 'string',
+      describe: 'Instance id',
+      demandOption: true,
+    })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
-      describe: 'Console will receive verbose error output'
+      describe: 'Console will receive verbose error output',
     })
     .option('wait', {
       type: 'boolean',
       describe: 'Wait for the instance delete to complete',
-      demandOption: false
-    })
+      demandOption: false,
+    });
 }
 
 async function handler (argv) {
-  const api = await getApi()
-  const instanceId = argv.instanceId
+  const api = await getApi();
+  const instanceId = argv.instanceId;
   try {
-    await api.v1DeleteInstance(instanceId)
+    await api.v1DeleteInstance(instanceId);
     if (argv.wait) {
-      let remaining
+      let remaining;
       do {
-        await sleep(1000)
-        const instances = await api.v1GetInstances()
-        remaining = instances.find((i) => i.id === instanceId)
-      } while (remaining)
+        await sleep(1000);
+        const instances = await api.v1GetInstances();
+        remaining = instances.find((i) => i.id === instanceId);
+      } while (remaining);
     }
-    console.log(
-      chalk.green(`Successfully deleted instance ${instanceId}`)
-    )
+    console.log(chalk.green(`Successfully deleted instance ${instanceId}`));
   } catch (err) {
-    handleError(err, `Failed to delete ${instanceId}`, argv.verbose)
+    handleError(err, `Failed to delete ${instanceId}`, argv.verbose);
   }
 }
 
@@ -45,5 +44,5 @@ module.exports = {
   builder,
   handler,
   command: 'delete <instanceId> [wait]',
-  describe: 'Delete instance'
-}
+  describe: 'Delete instance',
+};

package/src/commands/instances/file.js

@@ -1,40 +1,44 @@
-const AgentCLI = require('../../clients/Agent')
-const { displayTable } = require('../../table')
-const { validateNonEmpty } = require('../../utils')
-const { handleError } = require('../../error')
+const AgentCLI = require('../../clients/Agent');
+const { displayTable } = require('../../table');
+const { validateNonEmpty } = require('../../utils');
+const { handleError } = require('../../error');
 
 async function builder (yargs) {
-  yargs.option('verbose', {
-    alias: 'v',
-    type: 'boolean',
-    describe: 'Console will receive verbose error output'
-  }).option('project', {
-    type: 'input',
-    describe: 'Project ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('instance', {
-    type: 'input',
-    describe: 'Instance ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('format', {
-    type: 'input',
-    describe: 'Output format (default is json) e.g. table',
-    string: true,
-    choices: ['table', 'json', 'csv']
-  })
+  yargs
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+    })
+    .option('project', {
+      type: 'input',
+      describe: 'Project ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('instance', {
+      type: 'input',
+      describe: 'Instance ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('format', {
+      type: 'input',
+      describe: 'Output format (default is json) e.g. table',
+      string: true,
+      choices: ['table', 'json', 'csv'],
+    });
 }
 
 async function handler (argv) {
   try {
-    const agent = new AgentCLI(argv)
-    const files = await agent.listFiles()
-    await displayTable(argv.format, files, ['name', 'size'])
+    const agent = new AgentCLI(argv);
+    const files = await agent.listFiles();
+    await displayTable(argv.format, files, ['name', 'size']);
   } catch (err) {
-    handleError(err, 'List files failed', argv.verbose)
+    handleError(err, 'List files failed', argv.verbose);
   }
 }
 
@@ -42,5 +46,5 @@ module.exports = {
   builder,
   handler,
   command: 'files',
-  describe: 'List files on device instance'
-}
+  describe: 'List files on device instance',
+};

package/src/commands/instances/get.js

@@ -1,6 +1,6 @@
-const { handleError } = require('../../error')
-const { displayTable } = require('../../table')
-const { getApi } = require('../../utils')
+const { handleError } = require('../../error');
+const { displayTable } = require('../../table');
+const { getApi } = require('../../utils');
 
 async function builder (yargs) {
   yargs
@@ -8,35 +8,42 @@ async function builder (yargs) {
       alias: 'i',
       type: 'string',
       demandOption: true,
-      describe: 'virtual device id'
+      describe: 'virtual device id',
     })
     .option('format', {
       type: 'input',
       describe: 'Output format (default is json) e.g. table',
       string: true,
       choices: ['table', 'json', 'csv'],
-      default: 'json'
+      default: 'json',
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
-      describe: 'Console will receive verbose error output'
-    })
+      describe: 'Console will receive verbose error output',
+    });
 }
 
 async function handler (argv) {
-  const api = await getApi()
+  const api = await getApi();
 
   try {
-    const instance = await api.v1GetInstance(argv.instance)
+    const instance = await api.v1GetInstance(argv.instance);
     if (!instance) {
-      throw new Error(`Instance ${argv.instance} not found`)
+      throw new Error(`Instance ${argv.instance} not found`);
     }
-    await displayTable(argv.format, argv.format === 'json' ? instance : [instance], [
-      'id', 'flavor', 'type', 'state', 'os'
-    ], [{ column: 3, width: 5 }, { column: 2, width: 4 }, { column: 1, width: 6 }])
+    await displayTable(
+      argv.format,
+      argv.format === 'json' ? instance : [instance],
+      ['id', 'flavor', 'type', 'state', 'os'],
+      [
+        { column: 3, width: 5 },
+        { column: 2, width: 4 },
+        { column: 1, width: 6 },
+      ],
+    );
   } catch (err) {
-    handleError(err, 'Get instance failed', argv.verbose)
+    handleError(err, 'Get instance failed', argv.verbose);
   }
 }
 
@@ -44,5 +51,5 @@ module.exports = {
   builder,
   handler,
   command: 'get',
-  describe: 'Get instance'
-}
+  describe: 'Get instance',
+};

package/src/commands/instances/index.js

@@ -12,15 +12,15 @@ const subcommands = [
   require('./apps'),
   require('./input'),
   require('./unlock'),
-  require('./get')
-]
+  require('./get'),
+];
 
-let _yargs
+let _yargs;
 
 module.exports = {
-  builder: yargs => (_yargs = yargs) && yargs.command(subcommands).scriptName(''),
-  handler: argv => !argv[1] && _yargs.showHelp(),
+  builder: (yargs) => (_yargs = yargs) && yargs.command(subcommands).scriptName(''),
+  handler: (argv) => !argv[1] && _yargs.showHelp(),
   command: 'instance',
-  describe: 'Instance related commands'
-}
-module.exports.subcommands = subcommands
+  describe: 'Instance related commands',
+};
+module.exports.subcommands = subcommands;

package/src/commands/instances/input.js

@@ -1,8 +1,7 @@
-
-const { readFile } = require('node:fs/promises')
-const InstanceCLI = require('../../clients/Instance')
-const { handleError } = require('../../error')
-const chalk = require('chalk')
+const { readFile } = require('node:fs/promises');
+const InstanceCLI = require('../../clients/Instance');
+const { handleError } = require('../../error');
+const chalk = require('chalk');
 
 /**
  * Upload input to a device.
@@ -16,31 +15,31 @@ async function builder (yargs) {
       type: 'string',
       demandOption: true,
       describe: 'virtual device id',
-      default: process.env.INSTANCE
+      default: process.env.INSTANCE,
     })
     .positional('file', {
       type: 'string',
       demandOption: true,
-      describe: 'JSON file of device inputs'
+      describe: 'JSON file of device inputs',
       // Input specification https://app.corellium.com/api/docs#post-/v1/instances/-instanceId-/input
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'console will receive verbose error output',
-      default: false
-    })
+      default: false,
+    });
 }
 
 async function handler (argv) {
-  const { file, verbose } = argv
-  const client = new InstanceCLI(argv)
+  const { file, verbose } = argv;
+  const client = new InstanceCLI(argv);
   try {
-    const json = JSON.parse((await readFile(file)).toString())
-    await client.input(json)
-    console.log(chalk.green('Successfully uploaded inputs'))
+    const json = JSON.parse((await readFile(file)).toString());
+    await client.input(json);
+    console.log(chalk.green('Successfully uploaded inputs'));
   } catch (error) {
-    handleError(error, 'input failed', verbose)
+    handleError(error, 'input failed', verbose);
   }
 }
 
@@ -48,5 +47,5 @@ module.exports = {
   builder,
   handler,
   command: 'input <instance> <file>',
-  describe: 'Upload a series of inputs to a device.'
-}
+  describe: 'Upload a series of inputs to a device.',
+};

package/src/commands/instances/list.js

@@ -1,41 +1,51 @@
-const { handleError } = require('../../error')
-const { displayTable } = require('../../table')
-const { getApi } = require('../../utils')
+const { handleError } = require('../../error');
+const { displayTable } = require('../../table');
+const { getApi } = require('../../utils');
 
 async function builder (yargs) {
-  yargs.option('verbose', {
-    alias: 'v',
-    type: 'boolean',
-    describe: 'Console will receive verbose error output'
-  }).option('project', {
-    type: 'input',
-    describe: 'Optionally filter by project name'
-  }).option('format', {
-    type: 'input',
-    describe: 'Output format (default is json) e.g. table',
-    string: true,
-    choices: ['table', 'json', 'csv'],
-    default: 'json'
-  })
+  yargs
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+    })
+    .option('project', {
+      type: 'input',
+      describe: 'Optionally filter by project name',
+    })
+    .option('format', {
+      type: 'input',
+      describe: 'Output format (default is json) e.g. table',
+      string: true,
+      choices: ['table', 'json', 'csv'],
+      default: 'json',
+    });
 }
 
 async function handler (argv) {
-  const api = await getApi()
+  const api = await getApi();
   try {
-    let instances
+    let instances;
     if (argv.project) {
-      instances = await api.v1GetProjectInstances(argv.project, {})
+      instances = await api.v1GetProjectInstances(argv.project, {});
     } else {
-      instances = await api.v1GetInstances()
+      instances = await api.v1GetInstances();
     }
     if (!instances.length && argv.format !== 'json') {
-      console.error('Found no matching Instances')
+      console.error('Found no matching Instances');
     }
-    await displayTable(argv.format, instances, [
-      'id', 'flavor', 'type', 'state', 'os'
-    ], [{ column: 3, width: 5 }, { column: 2, width: 4 }, { column: 1, width: 6 }])
+    await displayTable(
+      argv.format,
+      instances,
+      ['id', 'flavor', 'type', 'state', 'os'],
+      [
+        { column: 3, width: 5 },
+        { column: 2, width: 4 },
+        { column: 1, width: 6 },
+      ],
+    );
   } catch (err) {
-    handleError(err, 'List failed', argv.verbose)
+    handleError(err, 'List failed', argv.verbose);
   }
 }
 
@@ -44,5 +54,5 @@ module.exports = {
   handler,
   command: 'list',
   aliases: ['ls'],
-  describe: 'List instances'
-}
+  describe: 'List instances',
+};

package/src/commands/instances/netmon/disable.js

@@ -1,39 +1,41 @@
-const log = require('../../../logging')
-const InstanceCLI = require('../../../clients/Instance')
+const log = require('../../../logging');
+const InstanceCLI = require('../../../clients/Instance');
 
 async function builder (yargs) {
   yargs
     .positional('instanceId', {
       type: 'string',
       describe: 'Instance id',
-      demandOption: true
+      demandOption: true,
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'Console will receive verbose error output',
-      demandOption: false
-    })
+      demandOption: false,
+    });
 }
 
 async function handler (argv) {
   try {
-    const instance = new InstanceCLI(argv)
-    await instance.disableMonitoring()
-    log.info('Success')
+    const instance = new InstanceCLI(argv);
+    await instance.disableMonitoring();
+    log.info('Success');
   } catch (e) {
     if (e.response) {
-      log.error(`${e.response.status} ${e.response.data.error || e.response.statusText}`)
+      log.error(`${e.response.status} ${e.response.data.error || e.response.statusText}`);
     } else {
       if (e.message) {
-        log.error(e.message)
+        log.error(e.message);
       } else {
-        log.error('Urecognized error, use --verbose for details')
+        log.error('Urecognized error, use --verbose for details');
       }
     }
 
-    if (argv.verbose) { log.error(JSON.stringify(e)) }
-    process.exit(1)
+    if (argv.verbose) {
+      log.error(JSON.stringify(e));
+    }
+    process.exit(1);
   }
 }
 
@@ -41,5 +43,5 @@ module.exports = {
   builder,
   handler,
   command: 'disable <instanceId> [--verbose]',
-  describe: 'Disable network monitoring'
-}
+  describe: 'Disable network monitoring',
+};