@corellium/corellium-cli 1.2.6 → 1.2.8

package/coverage/cobertura-coverage.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" ?>
 <!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
-<coverage lines-valid="0" lines-covered="0" line-rate="NaN" branches-valid="0" branches-covered="0" branch-rate="NaN" timestamp="1715705808060" complexity="0" version="0.1">
+<coverage lines-valid="0" lines-covered="0" line-rate="NaN" branches-valid="0" branches-covered="0" branch-rate="NaN" timestamp="1715897730108" complexity="0" version="0.1">
   <sources>
     <source>/builds/middleware/corellium-cli</source>
   </sources>

package/coverage/lcov-report/index.html

@@ -86,7 +86,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2024-05-14T16:56:48.070Z
+                at 2024-05-16T22:15:30.115Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@corellium/corellium-cli",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "Corellium CLI Tool",
   "scripts": {
     "corellium": "node index.js",
@@ -27,7 +27,7 @@
   ],
   "dependencies": {
     "@corellium/client-api": "^0.1.0",
-    "@corellium/corellium-api": "^1.7.3",
+    "@corellium/corellium-api": "^1.7.7",
     "axios": "^0.27.2",
     "chalk": "^4.1.2",
     "cli-progress": "^3.12.0",

package/src/clients/Agent.js

@@ -6,8 +6,15 @@ const { progressBar } = require('../progress')
 const { getCorelliumApi } = require('../corellium-api')
 
 /**
- * @typedef {object} AppsResult
- * @property {Array<{object}>} apps
+ * @typedef {object} App
+ * @property {Array<any>} tags
+ * @property {boolean} running
+ * @property {string} [icon]
+ * @property {number} diskUsage
+ * @property {number} date
+ * @property {string} applicationType
+ * @property {string} name
+ * @property {string} bundleID
  */
 
 /**
@@ -30,14 +37,19 @@ class AgentCLI extends Client {
 
   /**
    * List apps on device
-   * @returns {Promise<Array<{apps: Array<{object}>}>>}
+   * @returns {Promise<Array<App>>}
    */
-  listApps = async (options) => {
+  listApps = async (options = { loadIcons: false }) => {
     const { loadIcons } = options
     const response = (await this._fetch('GET', `${this.agentBasePath()}/app/apps?loadIcons=${loadIcons ? 1 : 0}`, {}))
     return response ? response.apps : []
   }
 
+  /**
+   * Install an app on device
+   * @param {string} app - path to app
+   * @returns {Promise<void>}
+   */
   installApp = async (app) => {
     // get app info
     const filePath = resolve(app)
@@ -47,6 +59,7 @@ class AgentCLI extends Client {
     const corellium = await getCorelliumApi()
     const instance = await corellium.getInstance(this.instance)
     const agent = await instance.agent()
+    await agent.ready()
 
     // configure upload bar for user
     const uploadBar = progressBar()
@@ -64,6 +77,23 @@ class AgentCLI extends Client {
     // cleanup
     await agent.disconnect()
   };
+
+  /**
+   * Open an application on a device
+   * @param {string} bundleId - Application Bundle ID
+   * @returns {Promise<void>}
+   */
+  openApp = async (bundleId) => {
+    // get agent
+    const corellium = await getCorelliumApi()
+    const instance = await corellium.getInstance(this.instance)
+    const agent = await instance.agent()
+    await agent.ready()
+    await agent.openApp(bundleId)
+
+    // cleanup
+    await agent.disconnect()
+  }
 }
 
 module.exports = AgentCLI

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

@@ -3,35 +3,42 @@ const { displayTable } = require('../../../table')
 const { validateNonEmpty } = require('../../../utils')
 const { handleError } = require('../../../error')
 const InstallCommand = require('./install')
+const OpenCommand = require('./open')
 
 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('load-icons', {
-    type: 'input',
-    describe: 'Toggle loading of icons',
-    demandOption: false,
-    boolean: true
-  }).option('format', {
-    type: 'input',
-    describe: 'Output format (default is json) e.g. table',
-    string: true,
-    choices: ['table', 'json', 'csv']
-  }).command(InstallCommand)
+  })
+    .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('load-icons', {
+      type: 'input',
+      describe: 'Toggle loading of icons',
+      demandOption: false,
+      boolean: true
+    })
+    .option('format', {
+      type: 'input',
+      describe: 'Output format (default is json) e.g. table',
+      string: true,
+      choices: ['table', 'json', 'csv']
+    })
+    .command(InstallCommand)
+    .command(OpenCommand)
 }
 
 async function handler (argv) {

package/src/commands/instances/apps/open.js

@@ -0,0 +1,37 @@
+const AgentCLI = require('../../../clients/Agent')
+const { validateNonEmpty } = require('../../../utils')
+const { handleError } = require('../../../error')
+const log = require('../../../logging')
+
+async function builder (yargs) {
+  yargs.option('bundle', {
+    alias: 'b',
+    type: 'string',
+    demandOption: true,
+    describe: 'application bundle id',
+    validateNonEmpty
+  })
+}
+
+async function handler (argv) {
+  try {
+    const { bundle: bundleId } = argv
+    const agent = new AgentCLI(argv)
+    log.info('Opening app...')
+    const apps = await agent.listApps()
+    if (!apps.filter(app => app.bundleID === bundleId).length) {
+      throw new Error('App not installed.')
+    }
+    await agent.openApp(bundleId)
+    log.info('App opened.')
+  } catch (err) {
+    handleError(err, 'Open app failed', argv.verbose)
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'open',
+  describe: 'Open app on device instance'
+}

package/src/commands/mast/api-base-path.js

@@ -0,0 +1,21 @@
+const { MAST_API_BASE_PATH, MAST_API_BASE_PATH_LEGACY } = require('./constants')
+
+/**
+ * Temporarily support backwards compatibility with mast/matrix routes.
+ * Until all environments are listening on /matrix at the conclusion of release 6.4.0, we need to handle
+ * the possibility that some environments will listen to MAST on /mast or /matrix
+ *
+ * This temporary code can be removed in release 6.5.0 - CORE-7670
+ */
+async function getMastApiBasePath (client, instance) {
+  try {
+    await client._fetch('GET', `${MAST_API_BASE_PATH}/${instance}/instances/${instance}/assessments`)
+    return MAST_API_BASE_PATH
+  } catch (_) {
+    // no-op, we want to fall back to legacy route.
+  }
+
+  return MAST_API_BASE_PATH_LEGACY
+}
+
+module.exports = { getMastApiBasePath }

package/src/commands/mast/constants.js

@@ -1,3 +1,4 @@
 module.exports = {
-  MAST_API_BASE_PATH: 'v1/services/matrix'
+  MAST_API_BASE_PATH: 'v1/services/matrix',
+  MAST_API_BASE_PATH_LEGACY: 'v1/services/mast' // CORE-7670
 }

package/src/commands/mast/create-assessment.js

@@ -1,6 +1,6 @@
 const Client = require('../../clients/Client')
 const { handleError } = require('../../error')
-const { MAST_API_BASE_PATH } = require('./constants')
+const { getMastApiBasePath } = require('./api-base-path')
 
 /**
  * Create an assessment via corellium-mast API.
@@ -42,7 +42,8 @@ async function handler (argv) {
   const client = new Client(argv)
   try {
     const body = { instanceId: instance, bundleId: bundle, wordlistId: wordlist }
-    const res = await client._fetch('POST', `${MAST_API_BASE_PATH}/${instance}/assessments`, body)
+    const API_BASE_PATH = await getMastApiBasePath(client, instance)
+    const res = await client._fetch('POST', `${API_BASE_PATH}/${instance}/assessments`, body)
     console.log(JSON.stringify(res))
   } catch (error) {
     handleError(error, 'create-assessment failed', verbose)

package/src/commands/mast/delete-assessment.js

@@ -1,7 +1,7 @@
 const Client = require('../../clients/Client')
 const { handleError } = require('../../error')
-const { MAST_API_BASE_PATH } = require('./constants')
 const log = require('../../logging')
+const { getMastApiBasePath } = require('./api-base-path')
 
 /**
  * Delete an assessment via corellium-mast API.
@@ -35,7 +35,8 @@ async function handler (argv) {
   const { assessment, instance, verbose } = argv
   const client = new Client(argv)
   try {
-    await client._fetch('DELETE', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}`)
+    const API_BASE_PATH = await getMastApiBasePath(client, instance)
+    await client._fetch('DELETE', `${API_BASE_PATH}/${instance}/assessments/${assessment}`)
     log.info('Assessment deleted.')
   } catch (error) {
     handleError(error, 'delete-assessment failed', verbose)

package/src/commands/mast/download-report.js

@@ -1,6 +1,6 @@
 const Client = require('../../clients/Client')
 const { handleError } = require('../../error')
-const { MAST_API_BASE_PATH } = require('./constants')
+const { getMastApiBasePath } = require('./api-base-path')
 
 /**
  * Download assessment report via corellium-mast API.
@@ -43,7 +43,8 @@ async function handler (argv) {
   const { assessment, instance, format, verbose } = argv
   const client = new Client(argv)
   try {
-    const res = await client._fetch('GET', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}/download?format=${format}`)
+    const API_BASE_PATH = await getMastApiBasePath(client, instance)
+    const res = await client._fetch('GET', `${API_BASE_PATH}/${instance}/assessments/${assessment}/download?format=${format}`)
     console.log(res)
   } catch (error) {
     handleError(error, 'download-report failed', verbose)

package/src/commands/mast/get-assessment.js

@@ -1,6 +1,6 @@
 const Client = require('../../clients/Client')
 const { handleError } = require('../../error')
-const { MAST_API_BASE_PATH } = require('./constants')
+const { getMastApiBasePath } = require('./api-base-path')
 
 /**
  * Get an assessment via corellium-mast API.
@@ -36,7 +36,8 @@ async function handler (argv) {
   const { assessment, instance, verbose } = argv
   const client = new Client(argv)
   try {
-    const res = await client._fetch('GET', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}`)
+    const API_BASE_PATH = await getMastApiBasePath(client, instance)
+    const res = await client._fetch('GET', `${API_BASE_PATH}/${instance}/assessments/${assessment}`)
     console.log(JSON.stringify(res))
   } catch (error) {
     handleError(error, 'get-assessment failed', verbose)

package/src/commands/mast/get-assessments.js

@@ -1,6 +1,6 @@
 const Client = require('../../clients/Client')
 const { handleError } = require('../../error')
-const { MAST_API_BASE_PATH } = require('./constants')
+const { getMastApiBasePath } = require('./api-base-path')
 
 /**
  * Get assessments for an instance via corellium-mast API.
@@ -29,7 +29,8 @@ async function handler (argv) {
   const { instance, verbose } = argv
   const client = new Client(argv)
   try {
-    const res = await client._fetch('GET', `${MAST_API_BASE_PATH}/${instance}/instances/${instance}/assessments`)
+    const API_BASE_PATH = await getMastApiBasePath(client, instance)
+    const res = await client._fetch('GET', `${API_BASE_PATH}/${instance}/instances/${instance}/assessments`)
     console.log(JSON.stringify(res))
   } catch (error) {
     handleError(error, 'get-assessments failed', verbose)

package/src/commands/mast/start-monitor.js

@@ -1,7 +1,7 @@
 const Client = require('../../clients/Client')
 const { handleError } = require('../../error')
-const { MAST_API_BASE_PATH } = require('./constants')
 const log = require('../../logging')
+const { getMastApiBasePath } = require('./api-base-path')
 
 /**
  * The start-monitor command starts device monitoring via the start-monitor API on corellium-mast
@@ -37,7 +37,8 @@ async function handler (argv) {
   const { assessment, instance, verbose } = argv
   const client = new Client(argv)
   try {
-    await client._fetch('POST', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}/start`)
+    const API_BASE_PATH = await getMastApiBasePath(client, instance)
+    await client._fetch('POST', `${API_BASE_PATH}/${instance}/assessments/${assessment}/start`)
     log.info('Monitoring started.')
   } catch (error) {
     handleError(error, 'start-monitor failed', verbose)

package/src/commands/mast/stop-monitor.js

@@ -1,7 +1,7 @@
 const Client = require('../../clients/Client')
 const { handleError } = require('../../error')
-const { MAST_API_BASE_PATH } = require('./constants')
 const log = require('../../logging')
+const { getMastApiBasePath } = require('./api-base-path')
 
 /**
  * The stop-monitor command stops device monitoring via the stop-monitor API on corellium-mast.
@@ -37,7 +37,8 @@ async function handler (argv) {
   const { assessment, instance, verbose } = argv
   const client = new Client(argv)
   try {
-    await client._fetch('POST', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}/stop`)
+    const API_BASE_PATH = await getMastApiBasePath(client, instance)
+    await client._fetch('POST', `${API_BASE_PATH}/${instance}/assessments/${assessment}/stop`)
     log.info('Monitoring stopped.')
   } catch (error) {
     handleError(error, 'stop-monitor failed', verbose)

package/src/commands/mast/test.js

@@ -1,6 +1,6 @@
 const Client = require('../../clients/Client')
 const { handleError } = require('../../error')
-const { MAST_API_BASE_PATH } = require('./constants')
+const { getMastApiBasePath } = require('./api-base-path')
 
 /**
  * The test command executes device testing via the test API on corellium-mast.
@@ -47,7 +47,8 @@ async function handler (argv) {
   const { grep, invert, assessment, instance, verbose } = argv
   const client = new Client(argv)
   try {
-    const res = await client._fetch('POST', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}/test`, { grep, invert })
+    const API_BASE_PATH = await getMastApiBasePath(client, instance)
+    const res = await client._fetch('POST', `${API_BASE_PATH}/${instance}/assessments/${assessment}/test`, { grep, invert })
     console.log(JSON.stringify(res))
   } catch (error) {
     handleError(error, 'test failed', verbose)