@corellium/corellium-cli 1.2.9 → 1.3.1

package/README.md

@@ -15,8 +15,12 @@ npm install -g @corellium/corellium-cli
 ## Development
 
 1. Clone the repo
-2. Install dependencies: `npm install`
-3. Link with `npm link`
+2. Ensure NPM has access to private package registery for dependencies
+    - Create a Personal Access Token with read_api scope in GitLab.
+    - Authenticate to the registry. (in ~/.npmrc): ``npm config set -- //[FQDN HERE]/api/v4/packages/npm/:_authToken=[TOKEN HERE]``
+    - Set the registry. (in ~/.npmrc): `npm config set @corellium:registry https://[FQDN HERE]/api/v4/packages/npm/`
+3. Install dependencies: `npm ci`
+4. Link with `npm link`
 
 *Note*: if you are running it locally create `.env` file and put the following line there `NODE_TLS_REJECT_UNAUTHORIZED=0`
 

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="1715965392380" 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="1716906748524" 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-17T17:03:12.387Z
+                at 2024-05-28T14:32:28.531Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@corellium/corellium-cli",
-  "version": "1.2.9",
+  "version": "1.3.1",
   "description": "Corellium CLI Tool",
   "scripts": {
     "corellium": "node index.js",

package/src/clients/Agent.js

@@ -25,6 +25,9 @@ class AgentCLI extends Client {
 
   ready = async () => await this._fetch('GET', `${this.agentBasePath()}/app/ready/`, {})
 
+  // only for iOS
+  unlock = async () => await this._fetch('POST', `${this.agentBasePath()}/system/unlock/`)
+
   /**
    * List files on device
    * @returns {Promise<Array<{object}>>}

package/src/commands/images/create.js

@@ -6,7 +6,7 @@ const { getApi } = require('../../utils')
 async function builder (yargs) {
   yargs.option('project', {
     type: 'input',
-    describe: 'Project Id',
+    describe: 'Project UUID',
     string: true
   })
     .option('format', {
@@ -22,7 +22,7 @@ async function builder (yargs) {
     })
     .option('instance', {
       type: 'input',
-      describe: 'Instance Id',
+      describe: 'Instance UUID',
       string: true
     })
     .positional('imageName', {
@@ -33,11 +33,13 @@ async function builder (yargs) {
     .positional('imageType', {
       type: 'string',
       describe: 'Image type to upload',
-      demandOption: true
+      demandOption: true,
+      choices: ['fwbinary', 'kernel', 'devicetree', 'ramdisk', 'loaderfile', 'sepf']
     })
     .positional('encoding', {
       type: 'string',
-      describe: 'Encoding, e.g. plain or encrypted'
+      describe: 'Encoding',
+      choices: ['plain', 'encrypted']
     })
     .positional('file', {
       type: 'string',
@@ -74,5 +76,5 @@ module.exports = {
   builder,
   handler,
   command: 'create [project] [instance] <imageName> <imageType> <encoding> <file>',
-  describe: 'Create image and optionally associate with a project/instance'
+  describe: 'Create image and associate it with a project or instance (you must specify either the project or instance UUID)'
 }

package/src/commands/instances/get.js

@@ -0,0 +1,44 @@
+const { handleError } = require('../../error')
+const { getApi } = require('../../utils')
+
+async function builder (yargs) {
+  yargs
+    .option('instance', {
+      alias: 'i',
+      type: 'string',
+      demandOption: true,
+      describe: 'virtual device id'
+    })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output'
+    })
+}
+
+async function handler (argv) {
+  const api = await getApi()
+
+  try {
+    const instance = await api.v1GetInstance(argv.instance)
+    if (!instance) {
+      throw new Error(`Instance ${argv.instance} not found`)
+    }
+    console.log(JSON.stringify({
+      id: instance.id,
+      flavor: instance.flavor,
+      type: instance.type,
+      state: instance.state,
+      os: instance.os
+    }))
+  } catch (err) {
+    handleError(err, 'Get instance failed', argv.verbose)
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'get',
+  describe: 'Get instance'
+}

package/src/commands/instances/index.js

@@ -10,7 +10,9 @@ const subcommands = [
   require('./ready'),
   require('./file'),
   require('./apps'),
-  require('./input')
+  require('./input'),
+  require('./unlock'),
+  require('./get')
 ]
 
 let _yargs

package/src/commands/instances/unlock.js

@@ -0,0 +1,51 @@
+// this is for iOS only
+
+const chalk = require('chalk')
+const AgentCLI = require('../../clients/Agent')
+const { handleError } = require('../../error')
+const { getApi } = require('../../utils')
+
+async function builder (yargs) {
+  yargs
+    .option('instance', {
+      alias: 'i',
+      type: 'string',
+      demandOption: true,
+      describe: 'virtual device id'
+    })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output'
+    })
+}
+
+async function handler (argv) {
+  const api = await getApi()
+
+  try {
+    // verify instance type
+    const instance = await api.v1GetInstance(argv.instance)
+    if (!instance) {
+      throw new Error(`Instance ${argv.instance} not found`)
+    }
+    if (instance.type !== 'ios') {
+      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}`)
+    )
+  } catch (err) {
+    handleError(err, 'Unlock failed', argv.verbose)
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'unlock',
+  describe: 'Unlock iOS device'
+}