@corellium/corellium-cli 1.4.0 → 1.5.0

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

@@ -1,44 +1,46 @@
-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,
     })
     .positional('outputFile', {
       type: 'string',
       describe: 'Path to output',
-      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.download('netdump.pcap', argv.outputFile)
-    log.info(`Success, pcap saved to ${argv.outputFile}`)
+    const instance = new InstanceCLI(argv);
+    await instance.download('netdump.pcap', argv.outputFile);
+    log.info(`Success, pcap saved to ${argv.outputFile}`);
   } 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);
   }
 }
 
@@ -46,5 +48,5 @@ module.exports = {
   builder,
   handler,
   command: 'download <instanceId> <outputFile> [--verbose]',
-  describe: 'Download pcap file'
-}
+  describe: 'Download pcap file',
+};

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

@@ -1,67 +1,74 @@
-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('srcPorts', {
       type: 'array',
-      describe: 'Source ports to filter'
+      describe: 'Source ports to filter',
     })
     .option('dstPorts', {
       type: 'array',
-      describe: 'Destination ports to filter'
+      describe: 'Destination ports to filter',
     })
     .option('ports', {
       type: 'array',
-      describe: 'Source or destination ports to filter'
+      describe: 'Source or destination ports to filter',
     })
     .option('processes', {
       type: 'array',
-      describe: 'List of process names or pids to filter'
+      describe: 'List of process names or pids to filter',
     })
     .option('portRanges', {
       type: 'array',
-      describe: 'List of port ranges in that format \'[beginPort]-[endport]\''
+      describe: "List of port ranges in that format '[beginPort]-[endport]'",
     })
     .option('protocols', {
       type: 'array',
-      describe: 'List of protocols'
+      describe: 'List of protocols',
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'Console will receive verbose error output',
-      demandOption: false
-    })
+      demandOption: false,
+    });
 }
 
 async function handler (argv) {
   try {
-    const { srcPorts, dstPorts, ports, processes, portRanges, protocols } = argv
+    const { srcPorts, dstPorts, ports, processes, portRanges, protocols } = argv;
 
-    const instance = new InstanceCLI(argv)
+    const instance = new InstanceCLI(argv);
     await instance.enableMonitoring({
-      srcPorts, dstPorts, ports, processes, portRanges, protocols
-    })
-    log.info('Success')
+      srcPorts,
+      dstPorts,
+      ports,
+      processes,
+      portRanges,
+      protocols,
+    });
+    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);
   }
 }
 
@@ -69,5 +76,5 @@ module.exports = {
   builder,
   handler,
   command: 'enable <instanceId> [--verbose]',
-  describe: 'Enable network monitoring'
-}
+  describe: 'Enable network monitoring',
+};

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

@@ -1,15 +1,10 @@
-const subcommands = [
-  require('./enable'),
-  require('./disable'),
-  require('./download'),
-  require('./stream')
-]
+const subcommands = [require('./enable'), require('./disable'), require('./download'), require('./stream')];
 
-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: 'netmon',
-  describe: 'Network Monitoring related commands'
-}
+  describe: 'Network Monitoring related commands',
+};

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

@@ -1,43 +1,45 @@
-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)
-    const { netdump } = await instance.info()
+    const instance = new InstanceCLI(argv);
+    const { netdump } = await instance.info();
     if (netdump && netdump.enabled) {
-      instance.wss(netdump.info).pipe(process.stdout)
+      instance.wss(netdump.info).pipe(process.stdout);
     } else {
-      log.error('Network monitoring is not enabled')
+      log.error('Network monitoring is not enabled');
     }
   } 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);
   }
 }
 
@@ -45,5 +47,5 @@ module.exports = {
   builder,
   handler,
   command: 'stream <instanceId> [--verbose]',
-  describe: 'Stream monitoring events'
-}
+  describe: 'Stream monitoring events',
+};

package/src/commands/instances/ready.js

@@ -1,35 +1,38 @@
-const AgentCLI = require('../../clients/Agent')
-const { validateNonEmpty } = require('../../utils')
-const { handleError } = require('../../error')
-const log = require('../../logging')
+const AgentCLI = require('../../clients/Agent');
+const { validateNonEmpty } = require('../../utils');
+const { handleError } = require('../../error');
+const log = require('../../logging');
 
 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
-  })
+  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,
+    });
 }
 
 async function handler (argv) {
   try {
-    const agent = new AgentCLI(argv)
-    const status = await agent.ready()
-    log.plain(JSON.stringify(status))
+    const agent = new AgentCLI(argv);
+    const status = await agent.ready();
+    log.plain(JSON.stringify(status));
   } catch (err) {
-    handleError(err, 'Query agent ready status failed', argv.verbose)
+    handleError(err, 'Query agent ready status failed', argv.verbose);
   }
 }
 
@@ -37,5 +40,5 @@ module.exports = {
   builder,
   handler,
   command: 'ready',
-  describe: 'Query agent ready status'
-}
+  describe: 'Query agent ready status',
+};

package/src/commands/instances/restoreBackup.js

@@ -1,43 +1,44 @@
-const log = require('../../logging')
-const InstanceCLI = require('../../clients/Instance')
-const { readProfile } = require('../../profile')
-const { v4: uuidv4 } = require('uuid')
-const { basename } = require('path')
-const MultiProgress = require('multi-progress')
-const { uploadWithProgress } = require('../../upload')
-const { waitForTaskState } = require('../../utils')
+const log = require('../../logging');
+const InstanceCLI = require('../../clients/Instance');
+const { readProfile } = require('../../profile');
+const { v4: uuidv4 } = require('uuid');
+const { basename } = require('path');
+const MultiProgress = require('multi-progress');
+const { uploadWithProgress } = require('../../upload');
+const { waitForTaskState } = require('../../utils');
 
 async function builder (yargs) {
   yargs
     .positional('instanceId', {
       type: 'string',
       describe: 'Instance id',
-      demandOption: true
+      demandOption: true,
     })
     .positional('zipFile', {
       type: 'string',
       describe: 'Path to backup zip file',
-      demandOption: true
+      demandOption: true,
     })
     .positional('password', {
       type: 'string',
       describe: 'Password for encrypted backup',
-      demandOption: false
+      demandOption: false,
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'Console will receive verbose error output',
-      demandOption: false
-    })
+      demandOption: false,
+    });
 }
 
 async function handler (argv) {
-  const profile = readProfile()
-  const { instanceId, zipFile, password } = argv
-  const name = basename(zipFile)
-  const image = uuidv4()
-  const url = profile.endpoint +
+  const profile = readProfile();
+  const { instanceId, zipFile, password } = argv;
+  const name = basename(zipFile);
+  const image = uuidv4();
+  const url =
+    profile.endpoint +
     '/api/v1/instances' +
     '/' +
     encodeURIComponent(instanceId) +
@@ -46,32 +47,34 @@ async function handler (argv) {
     '/' +
     encodeURIComponent(image) +
     '/' +
-    encodeURIComponent(name)
+    encodeURIComponent(name);
 
-  const multi = new MultiProgress(process.stderr)
+  const multi = new MultiProgress(process.stderr);
 
   try {
     await uploadWithProgress(url, profile.token, zipFile, multi, {
-      'x-corellium-image-encapsulated': 'false'
-    })
-    console.log(`Backup uploaded ${image}`)
+      'x-corellium-image-encapsulated': 'false',
+    });
+    console.log(`Backup uploaded ${image}`);
 
-    const instance = new InstanceCLI(argv)
-    await instance.restoreBackup(password)
+    const instance = new InstanceCLI(argv);
+    await instance.restoreBackup(password);
 
-    await waitForTaskState(instanceId, instance.info.bind(instance), 'restoring-backup')
-    console.log('Restoring in progress')
-    await waitForTaskState(instanceId, instance.info.bind(instance), 'none')
+    await waitForTaskState(instanceId, instance.info.bind(instance), 'restoring-backup');
+    console.log('Restoring in progress');
+    await waitForTaskState(instanceId, instance.info.bind(instance), 'none');
 
-    log.info(`Restored backup ${zipFile} to ${argv.instanceId}`)
+    log.info(`Restored backup ${zipFile} to ${argv.instanceId}`);
   } catch (err) {
-    const errorMessage = err.message
-    log.error(`Restore backup failed: ${errorMessage}`)
+    const errorMessage = err.message;
+    log.error(`Restore backup failed: ${errorMessage}`);
     if (err.response && err.response.data && err.response.data.error) {
-      log.error(err.response.data.error)
+      log.error(err.response.data.error);
     }
-    if (argv.verbose) { log.error(err) }
-    process.exit(1)
+    if (argv.verbose) {
+      log.error(err);
+    }
+    process.exit(1);
   }
 }
 
@@ -79,5 +82,5 @@ module.exports = {
   builder,
   handler,
   command: 'restore-backup <instanceId> <zipFile> [password] [--verbose]',
-  describe: 'Restore iOS backup to instance'
-}
+  describe: 'Restore iOS backup to instance',
+};

package/src/commands/instances/rotate.js

@@ -1,35 +1,34 @@
-const { handleError } = require('../../error')
-const chalk = require('chalk')
-const Client = require('../../clients/Client')
+const { handleError } = require('../../error');
+const chalk = require('chalk');
+const Client = require('../../clients/Client');
 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('orientation', {
       alias: 'o',
       type: 'number',
-      describe: 'Orientation type'
-    })
+      describe: 'Orientation type',
+    });
 }
 
 async function handler (argv) {
-  const client = new Client(argv)
-  const instanceId = argv.instanceId
-  const orientation = argv.orientation || 4
+  const client = new Client(argv);
+  const instanceId = argv.instanceId;
+  const orientation = argv.orientation || 4;
   try {
-    await client._fetch('POST', `v1/instances/${instanceId}/rotate`, { orientation })
-    console.log(
-      chalk.green(`Successfully rotated instance ${instanceId}`)
-    )
+    await client._fetch('POST', `v1/instances/${instanceId}/rotate`, { orientation });
+    console.log(chalk.green(`Successfully rotated instance ${instanceId}`));
   } catch (err) {
-    handleError(err, `Failed to rotate ${instanceId}`, argv.verbose)
+    handleError(err, `Failed to rotate ${instanceId}`, argv.verbose);
   }
 }
 
@@ -37,5 +36,5 @@ module.exports = {
   builder,
   handler,
   command: 'rotate <instanceId> [orientation]',
-  describe: 'Rotate instance'
-}
+  describe: 'Rotate instance',
+};

package/src/commands/instances/start.js

@@ -1,47 +1,46 @@
-const { handleError } = require('../../error')
-const chalk = require('chalk')
-const { waitForState } = require('../../utils')
-const InstanceCLI = require('../../clients/Instance')
+const { handleError } = require('../../error');
+const chalk = require('chalk');
+const { waitForState } = require('../../utils');
+const InstanceCLI = require('../../clients/Instance');
 
 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 to be fully started'
+      describe: 'Wait for the instance to be fully started',
     })
     .option('paused', {
       type: 'boolean',
-      describe: 'Start instance in a paused state'
+      describe: 'Start instance in a paused state',
     })
     .option('sockcap', {
       type: 'boolean',
-      describe: 'Start sockcap add-on if loaded'
-    })
+      describe: 'Start sockcap add-on if loaded',
+    });
 }
 
 async function handler (argv) {
-  const { sockcap, paused } = argv
-  const instance = new InstanceCLI(argv)
+  const { sockcap, paused } = argv;
+  const instance = new InstanceCLI(argv);
   try {
-    await instance.start({ sockcap, paused })
+    await instance.start({ sockcap, paused });
     if (argv.wait) {
       // Wait 60 attempts for the instance to be created (5 minutes)
-      await waitForState(argv.instanceId, instance.info.bind(instance), 'on', 60)
+      await waitForState(argv.instanceId, instance.info.bind(instance), 'on', 60);
     }
-    console.log(
-      chalk.green(`Successfully started instance ${argv.instanceId}`)
-    )
+    console.log(chalk.green(`Successfully started instance ${argv.instanceId}`));
   } catch (err) {
-    handleError(err, `Failed to start ${argv.instance}`, argv.verbose)
+    handleError(err, `Failed to start ${argv.instance}`, argv.verbose);
   }
 }
 
@@ -49,5 +48,5 @@ module.exports = {
   builder,
   handler,
   command: 'start <instanceId> [--wait] [--verbose] [--paused] [--sockcap]',
-  describe: 'Start instance'
-}
+  describe: 'Start instance',
+};

package/src/commands/instances/stop.js

@@ -1,38 +1,37 @@
-const { handleError } = require('../../error')
-const chalk = require('chalk')
-const { getApi, waitForState } = require('../../utils')
+const { handleError } = require('../../error');
+const chalk = require('chalk');
+const { getApi, waitForState } = 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 to be fully stopped'
-    })
+      describe: 'Wait for the instance to be fully stopped',
+    });
 }
 
 async function handler (argv) {
-  const api = await getApi()
-  const instanceId = argv.instanceId
+  const api = await getApi();
+  const instanceId = argv.instanceId;
   try {
-    await api.v1StopInstance(instanceId)
+    await api.v1StopInstance(instanceId);
     if (argv.wait) {
       // Wait 60 attempts for the instance to be created (5 minutes)
-      await waitForState(instanceId, api.v1GetInstance.bind(api), 'off', 60)
+      await waitForState(instanceId, api.v1GetInstance.bind(api), 'off', 60);
     }
-    console.log(
-      chalk.green(`Successfully stopped instance ${instanceId}`)
-    )
+    console.log(chalk.green(`Successfully stopped instance ${instanceId}`));
   } catch (err) {
-    handleError(err, `Failed to stop ${instanceId}`, argv.verbose)
+    handleError(err, `Failed to stop ${instanceId}`, argv.verbose);
   }
 }
 
@@ -40,5 +39,5 @@ module.exports = {
   builder,
   handler,
   command: 'stop <instanceId> [wait]',
-  describe: 'Stop instance'
-}
+  describe: 'Stop instance',
+};