@corellium/corellium-cli 1.0.4 → 1.0.6

package/src/commands/instances/list.js

@@ -3,7 +3,8 @@ const { displayTable } = require('../../table')
 const { getApi } = require('../../utils')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {
@@ -31,7 +32,7 @@ async function handler (argv) {
     }
     await displayTable(argv.format, instances, [
       'id', 'flavor', 'type', 'state', 'os'
-    ], [{ column: 3, width: 5 }, { column: 2, width: 4 }])
+    ], [{ column: 3, width: 5 }, { column: 2, width: 4 }, { column: 1, width: 6 }])
   } catch (error) {
     const errorMessage = getErrorMessage(error)
     console.error(`List failed: ${errorMessage}`)

package/src/commands/instances/start.js

@@ -8,7 +8,8 @@ async function builder (yargs) {
     describe: 'Instance id',
     demandOption: true
   })
-    .option('detailed-errors', {
+    .option('verbose', {
+      alias: 'v',
       type: 'boolean',
       describe: 'Console will receive verbose error output'
     })

package/src/commands/instances/stop.js

@@ -8,7 +8,8 @@ async function builder (yargs) {
     describe: 'Instance id',
     demandOption: true
   })
-    .option('detailed-errors', {
+    .option('verbose', {
+      alias: 'v',
       type: 'boolean',
       describe: 'Console will receive verbose error output'
     })

package/src/commands/instances/upgrade.js

@@ -0,0 +1,90 @@
+const log = require('../../logging')
+const InstanceCLI = require('./Instance')
+const { getErrorMessage } = require('../../error')
+const { waitForState, waitForIntervalMilliSec } = require('../../utils')
+
+const waitForMinutes = 15
+
+async function builder (yargs) {
+  yargs
+    .positional('instanceId', {
+      type: 'string',
+      describe: 'Instance id',
+      demandOption: true
+    })
+    .positional('os', {
+      type: 'string',
+      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
+    })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+      demandOption: false
+    })
+    .option('format', {
+      type: 'input',
+      describe: 'Output format (default is table) e.g. json',
+      string: true,
+      choices: ['json', 'csv'],
+      demandOption: false
+    })
+    .option('wait', {
+      type: 'boolean',
+      describe: 'Wait for the instance to be ready',
+      demandOption: false
+    })
+}
+
+async function handler (argv) {
+  try {
+    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 = ''
+              if (info.restoreStatus && info.restoreStatus.stage) {
+                restoreStatus = ` -> ${info.restoreStatus.stage}` + (info.restoreStatus.progress ? `(${parseInt(info.restoreStatus.progress)}%)` : '')
+              }
+              const report = ` - ${info.state}${restoreStatus}`
+              if (lastReport !== report) {
+                log.info(report)
+              }
+              lastReport = report
+            }
+          }
+        : () => { /* 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)
+      // 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(`Successfully upgraded instance ${argv.instanceId} to ${os}`)
+  } catch (err) {
+    const errorMessage = getErrorMessage(err)
+    log.error(`Upgrade iOS version failed: ${errorMessage}`)
+    if (argv.detailedErrors) { log.error(err) }
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'upgrade <instanceId> <os> [--osbuild <buildid>] [--wait] [--format <\'json\' | \'csv\'>] [--verbose]',
+  describe: 'Upgrade iOS version for instance'
+}

package/src/commands/login.js

@@ -10,9 +10,11 @@ const {
 } = require('../utils')
 const https = require('https')
 const axios = require('axios').default
+const prompts = require('prompts')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('endpoint', {
@@ -44,7 +46,17 @@ async function builder (yargs) {
 }
 
 async function handler (argv) {
-  const { username, password, apitoken, endpoint } = 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
+  }
 
   // We need a special agent just for login because we can't assume profile has been written yet
   const CACert = await getCACert({ endpoint })

package/src/commands/logout.js

@@ -2,7 +2,8 @@ const asciiArt = require('ascii-art')
 const { deleteProfile } = require('../profile')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   })

package/src/commands/projects/create.js

@@ -3,7 +3,8 @@ const { displayTable } = require('../../table')
 const { getAxios } = require('../../utils')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   })

package/src/commands/projects/delete.js

@@ -7,7 +7,8 @@ async function builder (yargs) {
     type: 'string',
     describe: 'Project ID',
     demandOption: true
-  }).option('detailed-errors', {
+  }).option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   })

package/src/commands/projects/list.js

@@ -3,7 +3,8 @@ const { displayTable } = require('../../table')
 const { getApi } = require('../../utils')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('format', {

package/src/commands/webplayer/create.js

@@ -5,7 +5,8 @@ const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {

package/src/commands/webplayer/destroy.js

@@ -4,7 +4,8 @@ const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {

package/src/commands/webplayer/list.js

@@ -5,7 +5,8 @@ const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {

package/src/commands/webplayer/login.js

@@ -4,7 +4,8 @@ const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {

package/src/error.js

@@ -1,7 +1,20 @@
 
+function getUserErrorMessage (body) {
+  const keys = ['errorID', 'error']
+  if (body && body.errorID === 'UserError') {
+    const err = Object.keys(body)
+      .filter(key => !keys.includes(key))
+      .reduce((obj, key) => {
+        obj[key] = body[key]
+        return obj
+      }, {})
+    return JSON.stringify(err)
+  }
+  return ''
+}
 function getErrorMessage (error) {
   return (error.body && error.body.error)
-    ? error.body.error
+    ? `${error.body.error} ${getUserErrorMessage(error.body)}`
     : (error.error && error.error.message)
         ? error.error.message
         : error

package/src/utils.js

@@ -9,6 +9,8 @@ axios.defaults.headers.common['User-Agent'] = `corellium-cli v${require('../pack
 const superagent = require('superagent')
 const https = require('https')
 
+const waitForIntervalMilliSec = 5000
+
 const planOptions = (planId) => {
   let usageBased = false
   let cores, licenseType
@@ -50,11 +52,14 @@ const sleep = (milliseconds) => {
   return new Promise((resolve) => setTimeout(resolve, milliseconds))
 }
 
-const waitForState = async (instanceId, fn, state, attempts = 20) => {
+const waitForState = async (instanceId, fn, state, attempts = 20, reporterFn = null) => {
   const response = await fn(instanceId)
+  if (typeof reporterFn === 'function') {
+    reporterFn(response)
+  }
   if (response.state !== state && attempts > 0) {
-    await sleep(5000)
-    await waitForState(instanceId, fn, state, --attempts)
+    await sleep(waitForIntervalMilliSec)
+    await waitForState(instanceId, fn, state, --attempts, reporterFn)
   }
 }
 
@@ -143,5 +148,7 @@ module.exports = {
   getApi,
   getAxios,
   validateNonEmpty,
-  getCACert
+  getCACert,
+  sleep,
+  waitForIntervalMilliSec
 }

package/example/WebPlayerSample.js

@@ -1,319 +0,0 @@
-#!/usr/bin/env node
-
-const path = require('path')
-const asciiArt = require('ascii-art')
-const { exec } = require('child_process')
-const { promisify } = require('util')
-const execp = promisify(exec)
-
-require('dotenv').config()
-
-const endpoint = process.env.ENDPOINT
-const username = process.env.USERNAME
-const password = process.env.PASSWORD
-const project = process.env.PROJECT
-const flavor = process.env.FLAVOR
-const version = process.env.VERSION
-const apitoken = process.env.APIKEY // Admin's API token
-const expiration = 24 * 60 * 60 // 24 hours (in seconds)
-const maxAgentTimeout = 120 // seconds
-let projectId, instanceId
-
-const frontendFeatureSet = {
-  apps: true,
-  connect: true,
-  console: true,
-  coretrace: true,
-  deviceControl: true,
-  deviceDelete: true,
-  files: true,
-  frida: true,
-  images: true,
-  messaging: true,
-  netmon: true,
-  network: true,
-  portForwarding: true,
-  powerManagement: true,
-  profile: true,
-  sensors: true,
-  settings: true,
-  snapshots: true,
-  strace: true,
-  system: true
-}
-const features = JSON.stringify(JSON.stringify(frontendFeatureSet))
-
-const execOptions = { cwd: path.join(__dirname, '../.') }
-
-const now = () => new Date().getTime()
-
-const sleep = (milliseconds) => {
-  return new Promise((resolve) => setTimeout(resolve, milliseconds))
-}
-
-/**
- * Return a timestamp as delta T formatted -> mm:ss.msec
- * @return {string}
- */
-const INFO_COLOR = 'green'
-const CMD_COLOR = 'magenta'
-const ERROR_COLOR = 'red'
-const TIMESTAMP_COLOR = 'cyan'
-const startTime = now()
-const ts = () => asciiArt.style(new Date((now() - startTime)).toISOString().slice(14, 23) + ':', TIMESTAMP_COLOR, true)
-/**
- * Logging with timestamp
- * @param args
- */
-const logInfo = (...args) => {
-  args.unshift(ts())
-  console.log.bind(console, ...args)()
-}
-
-const logResult = (...args) => {
-  args.unshift(asciiArt.style('', INFO_COLOR))
-  args.unshift(ts())
-  args[2] = '\b' + args[2]
-  args.push(asciiArt.style('', INFO_COLOR, true))
-  console.log.bind(console, ...args)()
-}
-
-const logError = (...args) => {
-  args.unshift(asciiArt.style('', ERROR_COLOR))
-  args.unshift(ts())
-  args[2] = '\b' + args[2]
-  args.push(asciiArt.style('', ERROR_COLOR, true))
-  console.error.bind(console, ...args)()
-}
-
-/**
- * Execute a command on the local host
- * @param {string} cmd
- * @param {object} options
- * @return {Promise<{stdout, stderr}>}
- */
-async function execLocal (cmd, options = { quiet: false }) {
-  const { quiet } = options
-  if (!quiet) { logInfo(asciiArt.style('[CorelliumCLI] ' + cmd, CMD_COLOR, true)) }
-  let { stdout, stderr } = await execp(cmd, execOptions)
-  stdout = stdout && stdout.trim()
-  stderr = stderr && stderr.trim()
-  // if (stdout && stdout.length) logResult('[execLocal] stdout.:', stdout)
-  // if (stderr && stderr.length) logError('[execLocal] stderr.:', stderr)
-  return { stdout, stderr }
-}
-
-/**
- * Parse command results
- * @param {any} data
- * @returns {any}
- */
-const parse = (data) => { try { return JSON.parse(data) } catch (_e) { return data } }
-
-/**
- * List All Web Players
- */
-const listSessions = async (sessionId) => {
-  const session = sessionId ? ` --session ${sessionId}` : ''
-  const { stdout: result } = await execLocal(`node index.js webplayer list --project ${projectId}${session} --format json`)
-  const sessions = parse(result)
-  if (Array.isArray(sessions)) {
-    logResult('Existing WebPlayers:', sessions.map(s => s.identifier))
-  } else {
-    logError('[listSessions]', sessions)
-  }
-}
-
-// Find project by name or identifier
-const findProject = async (id) => {
-  const { stdout: result } = await execLocal('node index.js project list --format json')
-  // logInfo(result)
-  const projects = parse(result)
-  if (Array.isArray(projects)) {
-    const proj = projects.find(p => p.id === id || p.name === id)
-    if (!proj) {
-      throw new Error(`Could not find project ${id}`)
-    }
-    logResult(`Found project ${proj.id} - ${proj.name}`)
-    return proj
-  }
-}
-
-/**
- * @return {Promise<object | undefined>}
- */
-const createInstance = async () => {
-  const { stdout: result } = await execLocal(`node index.js instance create ${flavor} ${version} ${projectId} --format json`)
-  // logResult(`"${result}"`)
-  try {
-    const instances = parse(result)
-    if (Array.isArray(instances)) {
-      return instances[0]
-    } else if (typeof instances === 'string') {
-      return [instances]
-    }
-  } catch (err) {
-    console.error(err)
-  }
-}
-
-const findInstance = async (id) => {
-  let { stdout: result } = await execLocal(`node index.js instance list --project ${projectId} --format json`)
-  // logResult(`"${result}"`)
-  if (result === '') { result = '[]' }
-  const instances = parse(result)
-  if (Array.isArray(instances)) {
-    const inst = instances.find(i => i.id === id || i.name === id || i.flavor === id)
-    if (inst) {
-      logInfo(`Found instance ${instanceId} - ${inst.name || inst.flavor} - State: ${inst.state}`)
-      return inst
-    }
-  }
-}
-
-const startInstance = async () => {
-  logInfo(`startInstance: ${instanceId}`)
-  let { stdout: result } = await execLocal(`node index.js instance list --project ${projectId} --format json`)
-  // logResult(`"${result}"`)
-  const inst = await findInstance(instanceId)
-  if (inst) {
-    if (inst.state === 'on') {
-      logInfo(`${inst.name || inst.flavor} is ON`)
-    } else {
-      logInfo(`${inst.name || inst.flavor} is OFF. Turning on ${inst.name || inst.flavor}...`);
-      ({ stdout: result } = await execLocal(`node index.js instance start ${instanceId}`))
-      logInfo(result)
-    }
-  }
-}
-
-const _stopInstance = async () => {
-  logInfo(`stopInstance: ${instanceId}`)
-  let { stdout: result } = await execLocal(`node index.js instance list --project ${projectId} --format json`)
-  // logResult(`"${result}"`)
-  const inst = await findInstance(instanceId)
-  if (inst) {
-    if (inst.state === 'on') {
-      logInfo(`${inst.name || inst.flavor} is ON. Turning off ${inst.name || inst.flavor}...`);
-      ({ stdout: result } = await execLocal(`node index.js instance stop ${instanceId}`))
-      logInfo(result)
-    } else {
-      logInfo(`${inst.name || inst.flavor} is already OFF.`)
-    }
-  }
-}
-
-const waitForAgentReady = async (timeout) => {
-  logInfo(`Waiting up to ${timeout / 1000} seconds for an agent to become available...`)
-  const options = { quiet: false } // Used to toggle verbosity so we only show one polling command
-  const startTime = now()
-  const timeoutTime = startTime + timeout
-  let agentObtained
-  let dots = '\r'
-  do {
-    let { stdout: result } = await execLocal(`node index.js agent ready --project ${projectId} --instance ${instanceId}`, options)
-    // logResult(`"${result}"`)
-    options.quiet = true
-    dots = dots + '.'
-    process.stdout.write(dots)
-    if (typeof result !== 'string' || result.length === 0) { result = '{"ready": false}' }
-    try {
-      const status = parse(result)
-      agentObtained = status.ready
-      // eslint-disable-next-line no-empty
-    } catch (_err) {}
-    if (!agentObtained) await sleep(2000)
-  } while (!agentObtained && (now() < timeoutTime))
-  if (now() >= timeoutTime) {
-    throw new Error(`Timed out waiting for agent to become available on instance ${instanceId}`)
-  }
-  process.stdout.write('\r')
-  logResult(`Agent available after ${Math.trunc((now() - startTime) / 1000)} seconds`)
-}
-
-// Log in as administrator
-const adminLogin = async () => {
-  let cmd
-  if (apitoken) {
-    cmd = `node index.js login --endpoint ${endpoint} --apitoken ${apitoken}`
-  } else {
-    cmd = `node index.js login --endpoint ${endpoint} --username ${username} --password ${password}`
-  }
-  const { stdout: result } = await execLocal(cmd)
-  logResult(result)
-}
-
-/**
- * Main script
- */
-(async () => {
-  await adminLogin()
-
-  // Locate project
-  const p = await findProject(project)
-  if (p) projectId = p.id
-  if (!projectId) throw new Error('Missing projectId')
-
-  // Locate project
-  const i = await findInstance(flavor)
-  instanceId = i ? i.id : (await createInstance())[0]
-  if (!instanceId) throw new Error('Unable to get an instance')
-
-  // Show existing sessions
-  logInfo('Show all sessions')
-  await listSessions()
-
-  // Create a Web Player session and extract the new session ID
-  let { stdout: result } = await execLocal(`node index.js webplayer create --project ${projectId} --instance ${instanceId} --features ${features} --expiresIn ${expiration}`)
-  const parsed = parse(result)
-  if (!Array.isArray(parsed)) { throw new Error('Web Player creation failed') }
-  const { identifier: sessionId } = parsed[0]
-  logResult(`Created Web Player Session ${sessionId}`)
-
-  logInfo('Show all sessions')
-  await listSessions()
-
-  // Verify listing a single session
-  logInfo('Show newly created session only')
-  await listSessions(sessionId);
-
-  // Log into the Web Player session
-  ({ stdout: result } = await execLocal(`node index.js webplayer login --project ${projectId} --session ${sessionId}`))
-  logResult(result)
-
-  // Device must be ON before using agent
-  await startInstance()
-
-  try {
-    // Wait for an agent to become available
-    await waitForAgentReady(maxAgentTimeout * 1000);
-
-    // List files
-    ({ stdout: result } = await execLocal(`node index.js agent files --project ${projectId} --instance ${instanceId}`))
-    logResult('\n', result);
-
-    // List apps
-    ({ stdout: result } = await execLocal(`node index.js agent apps --project ${projectId} --instance ${instanceId}`))
-    logResult('\n', result)
-  } catch (err) {
-    logError(err)
-  }
-
-  // Turn off instance
-  // await stopInstance()
-
-  // Re-login in as administrator since the session has been destroyed
-  await adminLogin()
-
-  // Destroy the Web Player session
-  // ({ stdout: result } = await execLocal(`node index.js webplayer destroy --project ${projectId} --session ${sessionId}`))
-  // logResult(result)
-
-  await listSessions()
-})()
-  .then(() => {
-    logInfo('-=DONE=-\n\n')
-  })
-  .catch(err => {
-    logError(err)
-  })