HockeyApp Distribution System

Launch Parameters

The launch parameters depend on the location of the apk file to be sent for analysis.

Also, there are some mandatory parameters that must be specified for any type of launch:

  • url — Mobix network address (path to the root directory without the last "/"), when using the cloud version — https://saas.mobix.one;
  • profile_id — The analysis is performed for the profile with this id;
  • testcase_id — id of the test case reproduced during the analysis. It is possible to run several test cases. For this purpose, their id's are listed with a space. This is an optional parameter. If it is not set, a manual scan will be started and stopped after 20 seconds and the data will be sent for analysis;
  • token — CI/CD token for access, see the Integration section for more information;
  • distribution_system — Method to load the application. The possible options are: file, hockeyapp. These methods are described in more detail below in their corresponding sections;
  • company_id — Specifies the identifier of the company where the scan is performed;
  • architecture_id This is an optional parameter. Specifies the identifier of the operating system architecture where the scanning is performed;
  • nowait — Optional parameter that determines whether to wait for the scan to complete. If this flag is set, the script won't wait for the scan to complete, but exits immediately after launching it. If the flag is not set, the script will wait for the analysis process to complete and generate a report;
  • summary_report_json_file_name This is an optional parameter. Specifies the name of the JSON file. This file is used to upload scanning information in JSON format. If the parameter is missing, the information will not be saved in JSON;
  • pdf_report_file_name This is an optional parameter. Specifies the name of a PDF file for uploading scanning information in PDF format. If the parameter is missing, the PDF report will not be saved.

Launch Examples

HockeyApp by bundle_identifier and Application Version

To launch an application analysis from the HockeyApp system, run the following command:

mdast_cli --distribution_system hockeyapp --hockey_token 18bc81146d374ba4b1182ed65e0b3aaa 
--bundle_id com.appsec.demo --hockey_version 31337 --url "https://saas.mobix.one" 
--profile_id 2 --testcase_id 3 --company_id 1 --architecture_id 1 
--token "eyJ0eXA4OiJKA1QiLbJhcGciO5JIU4I1NiJ1..."

This will find an application in the HockeyApp system with the com.appsec.demo bundle ID and the 31337 version. This application will be downloaded and an automated analysis will be done for it with a profile with id 2 and a test case with id 3 will be run.

HockeyApp by public_identifier and the Latest Available Version

To run an analysis of the latest version of an application from the HockeyApp system by its public identifier, run the following command:

mdast_cli --distribution_system hockeyapp --hockey_token 18bc81146d374ba4b1182ed65e0b3aaa 
--public_id "1234567890abcdef1234567890abcdef" --url "https://saas.mobix.one" 
--profile_id 2 --testcase_id 3 --company_id 1 --architecture_id 1 
--token "eyJ0eXA4OiJKA1QiLbJhcGciO5JIU4I1NiJ1..."

As a result, the latest available application version with the unique 1234567890abcdef1234567890abcdef public identifier will be found in the HockeyApp system. This application will be downloaded and an automated analysis will be done for it with a profile with id 2 and a test case with id 3 will be run.