Параметры запуска зависят от расположения файла apk, отправляемого на анализ. Так же, существуют обязательные параметры, которые необходимо указывать при любом виде запуска:
- stingray_url — сетевой адрес Stingray (путь до корня без последнего /), при использовании cloud версии — https://saas.mobile.appsec.world
- profile — id профиля для которого проводится анализ
- testcase — id testcase, который будет воспроизведен во время анализа; возможен запуск нескольких тесткейсов, для этого их id перечисляются через пробел
- token — CI/CD токен для доступа (как его получить можно посмотреть в документации)
- distribution_system — способ загрузки приложения, возможные опции: file и hockeyapp. Более подробно про них описано ниже в соответствующих разделах
- nowait — опциональный параметр, определяющий необходимость ожидания завершения сканирования. Если данный флаг установлен — скрипт не будет дожидаться завершения сканирования, а выйдет сразу же после запуска. Если флаг не стоит — скрипт будет ожидать завершения процесса анализа и формировать отчет.
Опциональные параметры:
- report — тип отчета, который будет сформирован по результатам проведенного анализа. Возможные опции:
- separate — одиночный отчет по проведенному сканированию, является отчетом по умолчанию при указании одного testcase id, при несколький testcase id создаст отдельный отчет для каждого запуска;
- standard — отчет по умолчанию при указании нескольких testcase id, совмещает дубликаты дефектов из нескольких сканирований в один (id сохраняются);
- grouping — отчет, группирующий дефекты одного типа с указанием всех деталей;
Можно указывать сразу несколько опций для создания отчетов нужных типов, например: — report separate grouping standard. Для сканирований с одним тесткейсом возможно создание отдельных и группирующих отчетов.
Примеры запуска
HockeyApp по bundle_identifier и указанием версии
Для запуска анализа приложения из системы HockeyApp:
python3.6 run-stingray-scan.py —distribution_system hockeyapp —hockey_token 18bc81146d374ba4b1182ed65e0b3aaa —bundle_id com.swordfishsecurity.demo —hockey_version 31337 —stingray_url «https://saas.mobile.appsec.world» —profile 2 —testcase 3 —token «eyJ0eXA4OiJKA1QiLbJhcGciO5JIU4I1NiJ1.eyJzdaJqZWNcX2lkIj53LCJle5AiOjf1OTM5OTU3MjB1.hfI6c4VN_U2mo5VfRoENPvJCvpxhLzjHqI0gxqgr2Bs»
В результате в системе HockeyApp будет найдено приложение с идентификатором пакета com.swordfishsecurity.demo и версией 31337. Он будет скачен и для него будет проведен автоматизированный анализ с профилем с id 2 и будет запущен тест-кейс с id 3.
HockeyApp по public_identifier и с последней доступной версией
Для запуска анализа последней версии приложения из системы HockeyApp по его публичному идентификатору:
python3.6 run-stingray-scan.py —distribution_system hockeyapp —hockey_token 18bc81146d374ba4b1182ed65e0b3aaa —public_id «1234567890abcdef1234567890abcdef» —stingray_url «https://saas.mobile.appsec.world» —profile 2 —testcase 3 —token «eyJ0eXA4OiJKA1QiLbJhcGciO5JIU4I1NiJ1.eyJzdaJqZWNcX2lkIj53LCJle5AiOjf1OTM5OTU3MjB1.hfI6c4VN_U2mo5VfRoENPvJCvpxhLzjHqI0gxqgr2Bs»
В результате в системе HockeyApp будет найдено приложение с уникальным публичным идентификатором 1234567890abcdef1234567890abcdef и последней доступной версией. Файл приложения будет скачен и для него будет проведен автоматизированный анализ с профилем с id 2 и будет запущен тест-кейс с id 3.