@corellium/corellium-cli 1.4.0 → 1.5.1

package/src/commands/instances/unlock.js

@@ -1,9 +1,9 @@
 // this is for iOS only
 
-const chalk = require('chalk')
-const AgentCLI = require('../../clients/Agent')
-const { handleError } = require('../../error')
-const { getApi } = require('../../utils')
+const chalk = require('chalk');
+const AgentCLI = require('../../clients/Agent');
+const { handleError } = require('../../error');
+const { getApi } = require('../../utils');
 
 async function builder (yargs) {
   yargs
@@ -11,35 +11,33 @@ async function builder (yargs) {
       alias: 'i',
       type: 'string',
       demandOption: true,
-      describe: 'virtual device id'
+      describe: 'virtual device id',
     })
     .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 {
     // verify instance type
-    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`);
     }
     if (instance.type !== 'ios') {
-      throw new Error(`Instance ${argv.instance} is not an iOS device`)
+      throw new Error(`Instance ${argv.instance} is not an iOS device`);
     }
 
-    const agent = new AgentCLI(argv)
-    await agent.unlock()
-    console.log(
-      chalk.green(`Successfully unlocked ${argv.instance}`)
-    )
+    const agent = new AgentCLI(argv);
+    await agent.unlock();
+    console.log(chalk.green(`Successfully unlocked ${argv.instance}`));
   } catch (err) {
-    handleError(err, 'Unlock failed', argv.verbose)
+    handleError(err, 'Unlock failed', argv.verbose);
   }
 }
 
@@ -47,5 +45,5 @@ module.exports = {
   builder,
   handler,
   command: 'unlock',
-  describe: 'Unlock iOS device'
-}
+  describe: 'Unlock iOS device',
+};

package/src/commands/instances/upgrade.js

@@ -1,88 +1,92 @@
-const log = require('../../logging')
-const InstanceCLI = require('../../clients/Instance')
-const { handleError } = require('../../error')
-const { waitForState, waitForIntervalMilliSec } = require('../../utils')
+const log = require('../../logging');
+const InstanceCLI = require('../../clients/Instance');
+const { handleError } = require('../../error');
+const { waitForState, waitForIntervalMilliSec } = require('../../utils');
 
-const waitForMinutes = 15
+const waitForMinutes = 15;
 
 async function builder (yargs) {
   yargs
     .positional('instanceId', {
       type: 'string',
       describe: 'Instance id',
-      demandOption: true
+      demandOption: true,
     })
     .positional('os', {
       type: 'string',
-      describe: 'Operating system semantic version (example: \'16.1\' or \'16.1.4\'',
-      demandOption: true
+      describe: "Operating system semantic version (example: '16.1' or '16.1.4'",
+      demandOption: true,
     })
     .option('osbuild', {
       type: 'string',
-      describe: 'Use a specific build (example: \'16H20\')',
-      demandOption: false
+      describe: "Use a specific build (example: '16H20')",
+      demandOption: false,
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'Console will receive verbose error output',
-      demandOption: false
+      demandOption: false,
     })
     .option('format', {
       type: 'input',
       describe: 'Output format (default is json) e.g. table',
       string: true,
       choices: ['table', 'json', 'csv'],
-      demandOption: false
+      demandOption: false,
     })
     .option('wait', {
       type: 'boolean',
       describe: 'Wait for the instance to be ready',
-      demandOption: false
-    })
+      demandOption: false,
+    });
 }
 
 async function handler (argv) {
   try {
-    const { os, osbuild } = argv
-    const instance = new InstanceCLI(argv)
-    await instance.upgrade({ os, osbuild })
+    const { os, osbuild } = argv;
+    const instance = new InstanceCLI(argv);
+    await instance.upgrade({ os, osbuild });
     if (argv.wait) {
       const reporter = argv.verbose
         ? (info) => {
             if (argv.verbose) {
-              let restoreStatus = ''
+              let restoreStatus = '';
               if (info.restoreStatus && info.restoreStatus.stage) {
-                restoreStatus = ` -> ${info.restoreStatus.stage}` + (info.restoreStatus.progress ? `(${parseInt(info.restoreStatus.progress)}%)` : '')
+                restoreStatus =
+                  ` -> ${info.restoreStatus.stage}` +
+                  (info.restoreStatus.progress ? `(${parseInt(info.restoreStatus.progress)}%)` : '');
               }
-              const report = ` - ${info.state}${restoreStatus}`
+              const report = ` - ${info.state}${restoreStatus}`;
               if (lastReport !== report) {
-                log.info(report)
+                log.info(report);
               }
-              lastReport = report
+              lastReport = report;
             }
           }
-        : () => { /* nop */ }
-      let lastReport = ''
+        : () => {
+            /* nop */
+          };
+      let lastReport = '';
       // First wait up to 10 seconds for the update to begin
-      let attempts = 10000 / waitForIntervalMilliSec
-      await waitForState(argv.instance, instance.info.bind(instance), 'updating', attempts)
+      let attempts = 10000 / waitForIntervalMilliSec;
+      await waitForState(argv.instance, instance.info.bind(instance), 'updating', attempts);
       // Then wait up to "waitForMinutes" for the instance to upgrade its OS version or error out
       // Using on-prem cluster ci-1, the upgrade from iOS 16.0 to 16.1 has been taking about 8-1/2 minutes
       // 180 * 5 seconds = 15 minutes
-      log.info(`Waiting up to ${waitForMinutes} minutes for upgrade to complete...`)
-      attempts = (waitForMinutes * 60 * 1000) / waitForIntervalMilliSec
-      await waitForState(argv.instance, instance.info.bind(instance), 'on', attempts, reporter)
+      log.info(`Waiting up to ${waitForMinutes} minutes for upgrade to complete...`);
+      attempts = (waitForMinutes * 60 * 1000) / waitForIntervalMilliSec;
+      await waitForState(argv.instance, instance.info.bind(instance), 'on', attempts, reporter);
     }
-    log.info(`Successfully upgraded instance ${argv.instanceId} to ${os}`)
+    log.info(`Successfully upgraded instance ${argv.instanceId} to ${os}`);
   } catch (err) {
-    handleError(err, 'Upgrade iOS version failed', argv.verbose)
+    handleError(err, 'Upgrade iOS version failed', argv.verbose);
   }
 }
 
 module.exports = {
   builder,
   handler,
-  command: 'upgrade <instanceId> <os> [--osbuild <buildid>] [--wait] [--format <\'json\' | \'csv\'>] [--verbose]',
-  describe: 'Upgrade iOS version for instance'
-}
+  command: "upgrade <instanceId> <os> [--osbuild <buildid>] [--wait] [--format <'json' | 'csv'>] [--verbose]",
+  describe: 'Upgrade iOS version for instance',
+};

package/src/commands/login.js

@@ -1,86 +1,85 @@
-const chalk = require('chalk')
-const {
-  updateProfile,
-  profilePath
-} = require('../profile')
-const { handleError } = require('../error')
-const {
-  validateNonEmpty,
-  getCACert
-} = require('../utils')
-const https = require('https')
-const axios = require('axios').default
-const prompts = require('prompts')
+const chalk = require('chalk');
+const { updateProfile, profilePath } = require('../profile');
+const { handleError } = require('../error');
+const { validateNonEmpty, getCACert } = require('../utils');
+const https = require('https');
+const axios = require('axios').default;
+const prompts = require('prompts');
 
 async function builder (yargs) {
-  yargs.option('verbose', {
-    alias: 'v',
-    type: 'boolean',
-    describe: 'Console will receive verbose error output'
-  }).option('endpoint', {
-    type: 'input',
-    describe: 'Server endpoint e.g. https://app.corellium.com',
-    demandOption: true,
-    string: true,
-    default: process.env.ENDPOINT,
-    validateNonEmpty
-  }).option('username', {
-    type: 'input',
-    describe: 'Username',
-    demandOption: false,
-    string: true,
-    default: process.env.USERNAME,
-    validateNonEmpty
-  }).option('password', {
-    type: 'password',
-    describe: 'Password',
-    demandOption: false,
-    string: true,
-    prompt: 'if-no-arg',
-    default: process.env.PASSWORD,
-    validateNonEmpty
-  }).option('apitoken', {
-    type: 'password',
-    describe: 'API Token',
-    demandOption: false,
-    string: true,
-    validateNonEmpty
-  })
+  yargs
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+    })
+    .option('endpoint', {
+      type: 'input',
+      describe: 'Server endpoint e.g. https://app.corellium.com',
+      demandOption: true,
+      string: true,
+      default: process.env.ENDPOINT,
+      validateNonEmpty,
+    })
+    .option('username', {
+      type: 'input',
+      describe: 'Username',
+      demandOption: false,
+      string: true,
+      default: process.env.USERNAME,
+      validateNonEmpty,
+    })
+    .option('password', {
+      type: 'password',
+      describe: 'Password',
+      demandOption: false,
+      string: true,
+      prompt: 'if-no-arg',
+      default: process.env.PASSWORD,
+      validateNonEmpty,
+    })
+    .option('apitoken', {
+      type: 'password',
+      describe: 'API Token',
+      demandOption: false,
+      string: true,
+      validateNonEmpty,
+    });
 }
 
 async function handler (argv) {
-  const { username, apitoken, endpoint } = argv
-  let { password } = argv
+  const { username, apitoken, endpoint } = argv;
+  let { password } = argv;
 
   if (username && !password) {
-    password = (await prompts({
-      message: 'Enter your password',
-      name: 'password',
-      type: 'text',
-      style: 'invisible'
-    })).password
+    password = (
+      await prompts({
+        message: 'Enter your password',
+        name: 'password',
+        type: 'text',
+        style: 'invisible',
+      })
+    ).password;
   }
 
-  const sanitizedEndpoint = endpoint.slice(-1) === '/' ? endpoint.slice(0, -1) : endpoint
+  const sanitizedEndpoint = endpoint.slice(-1) === '/' ? endpoint.slice(0, -1) : endpoint;
 
   // We need a special agent just for login because we can't assume profile has been written yet
-  const CACert = await getCACert({ endpoint: sanitizedEndpoint })
-  axios.defaults.httpsAgent = new https.Agent({ ca: CACert })
+  const CACert = await getCACert({ endpoint: sanitizedEndpoint });
+  axios.defaults.httpsAgent = new https.Agent({ ca: CACert });
 
   try {
-    let data
+    let data;
 
     if (apitoken) {
-      data = (await axios.post(`${sanitizedEndpoint}/api/v1/tokens`, { apiToken: apitoken })).data
+      data = (await axios.post(`${sanitizedEndpoint}/api/v1/tokens`, { apiToken: apitoken })).data;
     } else {
-      data = (await axios.post(`${sanitizedEndpoint}/api/v1/tokens`, { username, password })).data
+      data = (await axios.post(`${sanitizedEndpoint}/api/v1/tokens`, { username, password })).data;
     }
-    await updateProfile({ token: data.token, expiration: data.expiration, endpoint: sanitizedEndpoint })
-    console.log(
-      chalk.green(`Login successful, profile saved to ${profilePath}`)
-    )
+    await updateProfile({ token: data.token, expiration: data.expiration, endpoint: sanitizedEndpoint });
+    console.log(chalk.green(`Login successful, profile saved to ${profilePath}`));
   } catch (err) {
-    handleError(err, 'Login failed', argv.v)
+    handleError(err, 'Login failed', argv.v);
   }
 }
 
@@ -88,5 +87,6 @@ module.exports = {
   builder,
   handler,
   command: 'login',
-  describe: 'Login and save authentication token to local profile.\r\nOptionally supply an API Token instead of credentials.'
-}
+  describe:
+    'Login and save authentication token to local profile.\r\nOptionally supply an API Token instead of credentials.',
+};

package/src/commands/logout.js

@@ -1,24 +1,22 @@
-const chalk = require('chalk')
-const { deleteProfile } = require('../profile')
-const { handleError } = require('../error')
+const chalk = require('chalk');
+const { deleteProfile } = require('../profile');
+const { handleError } = require('../error');
 
 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',
+  });
 }
 
 async function handler (argv) {
   try {
-    const profilePath = await deleteProfile()
+    const profilePath = await deleteProfile();
 
-    console.log(
-      chalk.green(`Logout successful, deleted profile at ${profilePath}`)
-    )
+    console.log(chalk.green(`Logout successful, deleted profile at ${profilePath}`));
   } catch (err) {
-    handleError(err, 'Logout failed', argv.verbose)
+    handleError(err, 'Logout failed', argv.verbose);
   }
 }
 
@@ -26,5 +24,5 @@ module.exports = {
   builder,
   handler,
   command: 'logout',
-  describe: 'Logout and remove local profile'
-}
+  describe: 'Logout and remove local profile',
+};

package/src/commands/mast/constants.js

@@ -1,3 +1,3 @@
 module.exports = {
-  MAST_API_BASE_PATH: 'v1/services/mast'
-}
+  MAST_API_BASE_PATH: 'v1/services/mast',
+};

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 Client = require('../../clients/Client');
+const { handleError } = require('../../error');
+const { MAST_API_BASE_PATH } = require('./constants');
 
 /**
  * Create an assessment via corellium-mast API.
@@ -15,37 +15,37 @@ async function builder (yargs) {
       type: 'string',
       demandOption: true,
       describe: 'virtual device id',
-      default: process.env.INSTANCE
+      default: process.env.INSTANCE,
     })
     .option('bundle', {
       alias: 'b',
       type: 'string',
       demandOption: true,
-      describe: 'application bundle id'
+      describe: 'application bundle id',
     })
     .option('wordlist', {
       alias: 'w',
       type: 'string',
       demandOption: false,
-      describe: 'wordlist image id'
+      describe: 'wordlist image id',
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'console will receive verbose error output',
-      default: false
-    })
+      default: false,
+    });
 }
 
 async function handler (argv) {
-  const { instance, bundle, wordlist, verbose } = argv
-  const client = new Client(argv)
+  const { instance, bundle, wordlist, verbose } = 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)
-    console.log(JSON.stringify(res))
+    const body = { instanceId: instance, bundleId: bundle, wordlistId: wordlist };
+    const res = await client._fetch('POST', `${MAST_API_BASE_PATH}/${instance}/assessments`, body);
+    console.log(JSON.stringify(res));
   } catch (error) {
-    handleError(error, 'create-assessment failed', verbose)
+    handleError(error, 'create-assessment failed', verbose);
   }
 }
 
@@ -53,5 +53,5 @@ module.exports = {
   builder,
   handler,
   command: 'create-assessment',
-  describe: 'Create MATRIX assessment for a given instance and application'
-}
+  describe: 'Create MATRIX assessment for a given instance and application',
+};

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

@@ -1,7 +1,7 @@
-const Client = require('../../clients/Client')
-const { handleError } = require('../../error')
-const log = require('../../logging')
-const { MAST_API_BASE_PATH } = require('./constants')
+const Client = require('../../clients/Client');
+const { handleError } = require('../../error');
+const log = require('../../logging');
+const { MAST_API_BASE_PATH } = require('./constants');
 
 /**
  * Delete an assessment via corellium-mast API.
@@ -15,30 +15,30 @@ async function builder (yargs) {
       alias: 'a',
       type: 'string',
       demandOption: true,
-      describe: 'MATRIX assessment id'
+      describe: 'MATRIX assessment id',
     })
     .option('instance', {
       alias: 'i',
       type: 'string',
       demandOption: true,
-      describe: 'virtual device id'
+      describe: 'virtual device id',
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'console will receive verbose error output',
-      default: false
-    })
+      default: false,
+    });
 }
 
 async function handler (argv) {
-  const { assessment, instance, verbose } = argv
-  const client = new Client(argv)
+  const { assessment, instance, verbose } = argv;
+  const client = new Client(argv);
   try {
-    await client._fetch('DELETE', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}`)
-    log.info('Assessment deleted.')
+    await client._fetch('DELETE', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}`);
+    log.info('Assessment deleted.');
   } catch (error) {
-    handleError(error, 'delete-assessment failed', verbose)
+    handleError(error, 'delete-assessment failed', verbose);
   }
 }
 
@@ -46,5 +46,5 @@ module.exports = {
   builder,
   handler,
   command: 'delete-assessment',
-  describe: 'Delete MATRIX assessment'
-}
+  describe: 'Delete MATRIX assessment',
+};

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 Client = require('../../clients/Client');
+const { handleError } = require('../../error');
+const { MAST_API_BASE_PATH } = require('./constants');
 
 /**
  * Download assessment report via corellium-mast API.
@@ -14,7 +14,7 @@ async function builder (yargs) {
       alias: 'a',
       type: 'string',
       demandOption: true,
-      describe: 'MATRIX assessment id'
+      describe: 'MATRIX assessment id',
     })
     // NOTE: only required due to coordinator proxy needing to authenticate access to instance
     .option('instance', {
@@ -22,31 +22,34 @@ async function builder (yargs) {
       type: 'string',
       demandOption: true,
       describe: 'virtual device id',
-      default: process.env.INSTANCE
+      default: process.env.INSTANCE,
     })
     .option('format', {
       alias: 'f',
       type: 'string',
       describe: 'The desired format of the report.',
       choices: ['html', 'json'],
-      default: 'html'
+      default: 'html',
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'console will receive verbose error output',
-      default: false
-    })
+      default: false,
+    });
 }
 
 async function handler (argv) {
-  const { assessment, instance, format, verbose } = argv
-  const client = new Client(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}`)
-    console.log(format === 'json' ? JSON.stringify(res, null, 2) : res) // print deep json
+    const res = await client._fetch(
+      'GET',
+      `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}/download?format=${format}`,
+    );
+    console.log(format === 'json' ? JSON.stringify(res, null, 2) : res); // print deep json
   } catch (error) {
-    handleError(error, 'download-report failed', verbose)
+    handleError(error, 'download-report failed', verbose);
   }
 }
 
@@ -54,5 +57,5 @@ module.exports = {
   builder,
   handler,
   command: 'download-report',
-  describe: 'Download MATRIX assessment report'
-}
+  describe: 'Download MATRIX assessment report',
+};

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 Client = require('../../clients/Client');
+const { handleError } = require('../../error');
+const { MAST_API_BASE_PATH } = require('./constants');
 
 /**
  * Get an assessment via corellium-mast API.
@@ -14,7 +14,7 @@ async function builder (yargs) {
       alias: 'a',
       type: 'string',
       demandOption: true,
-      describe: 'MATRIX assessment id'
+      describe: 'MATRIX assessment id',
     })
     // NOTE: only required due to coordinator proxy needing to authenticate access to instance
     .option('instance', {
@@ -22,24 +22,24 @@ async function builder (yargs) {
       type: 'string',
       demandOption: true,
       describe: 'virtual device id',
-      default: process.env.INSTANCE
+      default: process.env.INSTANCE,
     })
     .option('verbose', {
       alias: 'v',
       type: 'boolean',
       describe: 'console will receive verbose error output',
-      default: false
-    })
+      default: false,
+    });
 }
 
 async function handler (argv) {
-  const { assessment, instance, verbose } = argv
-  const client = new Client(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}`)
-    console.log(JSON.stringify(res))
+    const res = await client._fetch('GET', `${MAST_API_BASE_PATH}/${instance}/assessments/${assessment}`);
+    console.log(JSON.stringify(res));
   } catch (error) {
-    handleError(error, 'get-assessment failed', verbose)
+    handleError(error, 'get-assessment failed', verbose);
   }
 }
 
@@ -47,5 +47,5 @@ module.exports = {
   builder,
   handler,
   command: 'get-assessment',
-  describe: 'Get MATRIX assessment'
-}
+  describe: 'Get MATRIX assessment',
+};