Параметры запуска

Параметры запуска зависят от расположения файла 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. Для сканирований с одним тесткейсом возможно создание отдельных и группирующих отчетов.

Для загрузки приложения из системы дистрибуции AppCenter при запуске необходимо указать параметр distribution_system appcenter. Так же необходимо указать обязательные параметры:

  • appcenter_token — API токен для доступа. Как его получить можно узнать здесь;
  • appcenter_owner_name — владелец приложения, как узнать имя владельца можно здесь или в официальной документации;
  • appcenter_app_name — имя приложения в системе AppCenter. Как его узнать можно по ссылке;
  • appcenter_release_id или appcenter_app_version:
    • appcenter_release_id — идентификатор загружаемого релиза в системе AppCenter для конкретного приложения. Возможно выставить значение latest — тогда будет загружен последний доступный релиз приложения. Официальная документация;
    • appcenter_app_version — при указании данного параметра будет найдена и скачана конкретная версия приложения по коду его версии (указанной в Android Manifest) (поле version в документации);
Примеры запуска

AppCenter по id релиза

Для запуска анализа приложения по известному имени, владельцу и ID релиза необходимо выполнить следующую команду:

 

python3.6 run-stingray-scan.py —distribution_system appcenter —appcenter_token 18bc81146d374ba4b1182ed65e0b3aaa —appcenter_owner_name yshabalin_test_org_or_user —appcenter_app_name Swordfish_debug_version_of_test —appcenter_release_id 710 —stingray_url «https://saas.mobile.appsec.world» —profile 2 —testcase 3 —token «eyJ0eXA4OiJKA1QiLbJhcGciO5JIU4I1NiJ1.eyJzdaJqZWNcX2lkIj53LCJle5AiOjf1OTM5OTU3MjB1.hfI6c4VN_U2mo5VfRoENPvJCvpxhLzjHqI0gxqgr2Bs»

В результате у владельца (пользователя или организации yshabalin_test_org_or_user) будет найдено приложение Swordfish_debug_version_of_test с ID релиза 710. Данная версия релиза будет загружена и передана на анализ безопасности в Stingray

Для загрузки релиза с последней версией необходимо параметр appcenter_release_id latest. Тогда команда будет выглядеть следующим образом:

python3.6 run-stingray-scan.py —distribution_system appcenter —appcenter_token 18bc81146d374ba4b1182ed65e0b3aaa —appcenter_owner_name «yshabalin_test_org_or_user» —appcenter_app_name «Swordfish_debug_version_of_test» —appcenter_release_id latest —stingray_url «https://saas.mobile.appsec.world» —profile 2 —testcase 3 —token «eyJ0eXA4OiJKA1QiLbJhcGciO5JIU4I1NiJ1.eyJzdaJqZWNcX2lkIj53LCJle5AiOjf1OTM5OTU3MjB1.hfI6c4VN_U2mo5VfRoENPvJCvpxhLzjHqI0gxqgr2Bs»

и загружен последний доступный релиз для данного приложения.

 

AppCenter по версии приложения

Для запуска анализа приложения по известному имени, владельцу и версии приложения (version_code в Android Manifest) необходимо выполнить следующую команду:

python3.6 run-stingray-scan.py —distribution_system appcenter —appcenter_token 18bc81146d374ba4b1182ed65e0b3aaa —appcenter_owner_name «yshabalin_test_org_or_user» —appcenter_app_name «Swordfish_debug_version_of_test» —appcenter_app_version 31337 —stingray_url «https://saas.mobile.appsec.world» —profile 2 —testcase 3 —token «eyJ0eXA4OiJKA1QiLbJhcGciO5JIU4I1NiJ1.eyJzdaJqZWNcX2lkIj53LCJle5AiOjf1OTM5OTU3MjB1.hfI6c4VN_U2mo5VfRoENPvJCvpxhLzjHqI0gxqgr2Bs»

В результате у владельца (пользователя или организации yshabalin_test_org_or_user) будет найдено приложение Swordfish_debug_version_of_test и найден релиз, в котором была указана версия приложения 31337. Данная версия релиза будет загружена и передана на анализ безопасности в Stingray.

Предыдущая Системы CI/CD
Следующая Система дистрибуции HockeyApp
Содержание: