@corellium/corellium-cli 1.1.0 → 1.1.2

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

@@ -0,0 +1,49 @@
+const log = require('../../../logging')
+const InstanceCLI = require('../../../clients/Instance')
+
+async function builder (yargs) {
+  yargs
+    .positional('instanceId', {
+      type: 'string',
+      describe: 'Instance id',
+      demandOption: true
+    })
+    .positional('outputFile', {
+      type: 'string',
+      describe: 'Path to output',
+      demandOption: true
+    })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+      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}`)
+  } catch (e) {
+    if (e.response) {
+      log.error(`${e.response.status} ${e.response.data.error || e.response.statusText}`)
+    } else {
+      if (e.message) {
+        log.error(e.message)
+      } else {
+        log.error('Urecognized error, use --verbose for details')
+      }
+    }
+
+    if (argv.verbose) { log.error(JSON.stringify(e)) }
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'download <instanceId> <outputFile> [--verbose]',
+  describe: 'Download pcap file'
+}

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

@@ -0,0 +1,72 @@
+const log = require('../../../logging')
+const InstanceCLI = require('../../../clients/Instance')
+
+async function builder (yargs) {
+  yargs
+    .positional('instanceId', {
+      type: 'string',
+      describe: 'Instance id',
+      demandOption: true
+    })
+    .option('srcPorts', {
+      type: 'array',
+      describe: 'Source ports to filter'
+    })
+    .option('dstPorts', {
+      type: 'array',
+      describe: 'Destination ports to filter'
+    })
+    .option('ports', {
+      type: 'array',
+      describe: 'Source or destination ports to filter'
+    })
+    .option('processes', {
+      type: 'array',
+      describe: 'List of process names or pids to filter'
+    })
+    .option('portRanges', {
+      type: 'array',
+      describe: 'List of port ranges in that format \'[beginPort]-[endport]\''
+    })
+    .option('protocols', {
+      type: 'array',
+      describe: 'List of protocols'
+    })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+      demandOption: false
+    })
+}
+
+async function handler (argv) {
+  try {
+    const { srcPorts, dstPorts, ports, processes, portRanges, protocols } = argv
+
+    const instance = new InstanceCLI(argv)
+    await instance.enableMonitoring({
+      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}`)
+    } else {
+      if (e.message) {
+        log.error(e.message)
+      } else {
+        log.error('Urecognized error, use --verbose for details')
+      }
+    }
+
+    if (argv.verbose) { log.error(JSON.stringify(e)) }
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'enable <instanceId> [--verbose]',
+  describe: 'Enable network monitoring'
+}

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

@@ -0,0 +1,15 @@
+const subcommands = [
+  require('./enable'),
+  require('./disable'),
+  require('./download'),
+  require('./stream')
+]
+
+let _yargs
+
+module.exports = {
+  builder: yargs => (_yargs = yargs) && yargs.command(subcommands).scriptName(''),
+  handler: argv => !argv[1] && _yargs.showHelp(),
+  command: 'netmon',
+  describe: 'Network Monitoring related commands'
+}

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

@@ -0,0 +1,48 @@
+const log = require('../../../logging')
+const InstanceCLI = require('../../../clients/Instance')
+
+async function builder (yargs) {
+  yargs
+    .positional('instanceId', {
+      type: 'string',
+      describe: 'Instance id',
+      demandOption: true
+    })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+      demandOption: false
+    })
+}
+
+async function handler (argv) {
+  try {
+    const instance = new InstanceCLI(argv)
+    const { netdump } = await instance.info()
+    if (netdump && netdump.enabled) {
+      instance.wss(netdump.info).pipe(process.stdout)
+    } else {
+      log.error('Network monitoring is not enabled')
+    }
+  } catch (e) {
+    if (e.response) {
+      log.error(`${e.response.status} ${e.response.data.error || e.response.statusText}`)
+    } else {
+      if (e.message) {
+        log.error(e.message)
+      } else {
+        log.error('Urecognized error, use --verbose for details')
+      }
+    }
+
+    if (argv.verbose) { log.error(JSON.stringify(e)) }
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'stream <instanceId> [--verbose]',
+  describe: 'Stream monitoring events'
+}

package/src/commands/instances/restoreBackup.js

@@ -1,5 +1,5 @@
 const log = require('../../logging')
-const InstanceCLI = require('./Instance')
+const InstanceCLI = require('../../clients/Instance')
 const { readProfile } = require('../../profile')
 const { v4: uuidv4 } = require('uuid')
 const { basename } = require('path')

package/src/commands/instances/rotate.js

@@ -1,7 +1,7 @@
 const { getErrorMessage } = require('../../error')
 const asciiArt = require('ascii-art')
 
-const Client = require('../Client')
+const Client = require('../../clients/Client')
 async function builder (yargs) {
   yargs.positional('instanceId', {
     type: 'string',

package/src/commands/instances/start.js

@@ -1,6 +1,7 @@
 const { getErrorMessage } = require('../../error')
 const asciiArt = require('ascii-art')
-const { getApi, waitForState } = require('../../utils')
+const { waitForState } = require('../../utils')
+const InstanceCLI = require('../../clients/Instance')
 
 async function builder (yargs) {
   yargs.positional('instanceId', {
@@ -17,25 +18,33 @@ async function builder (yargs) {
       type: 'boolean',
       describe: 'Wait for the instance to be fully started'
     })
+    .option('paused', {
+      type: 'boolean',
+      describe: 'Start instance in a paused state'
+    })
+    .option('sockcap', {
+      type: 'boolean',
+      describe: 'Start sockcap add-on if loaded'
+    })
 }
 
 async function handler (argv) {
-  const api = await getApi()
-  const instanceId = argv.instanceId
+  const { sockcap, paused } = argv
+  const instance = new InstanceCLI(argv)
   try {
-    await api.v1StartInstance(instanceId)
+    await instance.start({ sockcap, paused })
     if (argv.wait) {
       // Wait 60 attempts for the instance to be created (5 minutes)
-      await waitForState(instanceId, api.v1GetInstance.bind(api), 'on', 60)
+      await waitForState(argv.instanceId, instance.info.bind(instance), 'on', 60)
     }
     console.log(
-      asciiArt.style(`Successfully started instance ${instanceId}`, 'green', true)
+      asciiArt.style(`Successfully started instance ${argv.instanceId}`, 'green', true)
     )
   } catch (error) {
     const errorMessage = getErrorMessage(error)
-    console.error(`Failed to start ${instanceId}: ${errorMessage}`)
+    console.error(`Failed to start ${argv.instance}: ${errorMessage}`)
 
-    if (argv.detailedErrors) {
+    if (argv.verbose) {
       console.log(error)
     }
   }
@@ -44,6 +53,6 @@ async function handler (argv) {
 module.exports = {
   builder,
   handler,
-  command: 'start <instanceId> [wait]',
+  command: 'start <instanceId> [--wait] [--verbose] [--paused] [--sockcap]',
   describe: 'Start instance'
 }

package/src/commands/instances/upgrade.js

@@ -1,5 +1,5 @@
 const log = require('../../logging')
-const InstanceCLI = require('./Instance')
+const InstanceCLI = require('../../clients/Instance')
 const { getErrorMessage } = require('../../error')
 const { waitForState, waitForIntervalMilliSec } = require('../../utils')
 

package/src/commands/signup.js

@@ -1,4 +1,4 @@
-const TrialAccount = require('../TrialAccount')
+const TrialAccount = require('../clients/TrialAccount')
 const { makePassword, validateNonEmpty } = require('../utils')
 const { getErrorMessage } = require('../error')
 const log = require('../logging')
@@ -7,7 +7,7 @@ async function builder (yargs) {
   yargs.options({
     endpoint: {
       type: 'input',
-      describe: 'Server endpoint e.g. https://app.ci-4.corellium.co',
+      describe: 'Server endpoint e.g. https://app.corellium.co',
       demandOption: true,
       string: true,
       validateNonEmpty

package/src/commands/webplayer/create.js

@@ -1,4 +1,4 @@
-const Webplayer = require('./Webplayer')
+const Webplayer = require('../../clients/Webplayer')
 const log = require('../../logging')
 const { displayTable } = require('../../table')
 const { validateNonEmpty } = require('../../utils')

package/src/commands/webplayer/destroy.js

@@ -1,4 +1,4 @@
-const Webplayer = require('./Webplayer')
+const Webplayer = require('../../clients/Webplayer')
 const log = require('../../logging')
 const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')

package/src/commands/webplayer/list.js

@@ -1,4 +1,4 @@
-const Webplayer = require('./Webplayer')
+const Webplayer = require('../../clients/Webplayer')
 const log = require('../../logging')
 const { displayTable } = require('../../table')
 const { validateNonEmpty } = require('../../utils')

package/src/commands/webplayer/login.js

@@ -1,4 +1,4 @@
-const Webplayer = require('./Webplayer')
+const Webplayer = require('../../clients/Webplayer')
 const log = require('../../logging')
 const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')

package/src/commands/Client.js

@@ -1,45 +0,0 @@
-const axios = require('axios').default
-const { readProfile } = require('../profile')
-
-/**
- * Client Base class
- */
-class Client {
-  constructor (argv) {
-    this.argv = Object.assign({}, argv)
-    this.project = argv.project || argv.projectId
-    this.instance = argv.instance || argv.instanceId
-    this._profile = readProfile()
-  }
-
-  /**
-   * Perform HTTP transaction
-   * @protected
-   * @param {string} method
-   * @param {string} path
-   * @param {object} data
-   * @returns {Promise<any>}
-   */
-  _fetch = async (method, path, data) => {
-    const headers = {
-      Authorization: `Bearer ${this._profile.token}`,
-      'User-Agent': `corellium-cli v${require('../../package.json').version}`
-    }
-    let response
-    switch (method) {
-      case 'GET':
-        response = await axios.get(`${this._profile.endpoint}/api/${path}`, { headers })
-        break
-      case 'POST':
-        response = await axios.post(`${this._profile.endpoint}/api/${path}`, data, { headers })
-        break
-      case 'DELETE':
-        response = await axios.delete(`${this._profile.endpoint}/api/${path}`, { headers })
-        break
-    }
-    if (response.status >= 400) { throw new Error(response.statusText) }
-    return response.data || {}
-  }
-}
-
-module.exports = Client

package/src/commands/instances/Instance.js

@@ -1,35 +0,0 @@
-const Client = require('../Client')
-
-/**
- * Instance class
- */
-class InstanceCLI extends Client {
-  instanceBasePath = () => `v1/instances/${this.instance}`
-
-  /**
-   * Upgrade iOS version on instance
-   * @returns {Promise<any>}
-   */
-  upgrade = async (options) => {
-    const { os, osbuild } = options
-    return await this._fetch('POST', `${this.instanceBasePath()}/upgrade`, { os, osbuild })
-  }
-
-  /**
-   * Restore backup to instance
-   * @returns {Promise<any>}
-   */
-  restoreBackup = async () => {
-    return await this._fetch('POST', `${this.instanceBasePath()}/restoreBackup`)
-  }
-
-  /**
-   * Fetch instance information
-   * @returns {Promise<any>}
-   */
-  info = async () => {
-    return await this._fetch('GET', `${this.instanceBasePath()}`, {})
-  }
-}
-
-module.exports = InstanceCLI