SonarQube не отображает отчет об уязвимости безопасности Python в Bandit - PullRequest
0 голосов
/ 31 января 2019

Обзор

Я использую SonarQube 7.4.0.18908 для сбора покрытия кода и выполнения статического анализа кода для проекта Python 3.6.Сервер работает в AWS.Все работает как положено (см. Скриншот ниже).

Теперь я хотел бы добавить сканирование безопасности для проекта.Я «выбрал» Bandit , но на самом деле это, кажется, единственный инструмент, который в настоящее время интегрируется с SonarQube для Python, как описано в Импорт отчетов о проблемах с бандитами .Плагин SonarPython поддерживает анализ Bandit, который установлен на сервере SonarQube.Для локального создания отчета об уязвимости я использую модуль Bandit 1.5.1 pip3.

Проблема

Отчет об уязвимости не отображается - возможно, даже не загружен - в SonarQube (см. Тот же снимок экрана ниже).

Шаги для воспроизведения

Я добавил эту строку в файл sonar-project.properties проекта:

sonar.python.bandit.reportPaths=bandit-report.json

Затем запустил отчет:

pip3 install bandit==1.5.1
bandit --format json --output bandit-report.json --recursive src

Я проверил, что bandit-report.json содержит правильные данные:

{
  "errors": [],
  "generated_at": "2019-01-30T14:49:18Z",
  "metrics": {
...
"results": [
    {
      "code": "8 def prepare_df_for_comparison(df, name, ignore_columns=None, sort_columns=None):\n9     assert df is not None\n10 \n11     # upper-case all columns\n12     df.columns = [x.upper() for x in df.columns]\n",
      "filename": "./build/lib/tasks/compare_df.py",
      "issue_confidence": "HIGH",
      "issue_severity": "LOW",
      "issue_text": "Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.",
...

Затем я опубликовал в SonarQube:

sonar-scanner

Вывод сканера:

INFO: Scanner configuration file: NONE
INFO: Project root configuration file: /root_dir/sonar-project.properties
INFO: SonarQube Scanner 3.2.0.1227
INFO: Java 1.8.0_191 Oracle Corporation (64-bit)
INFO: Linux 4.9.125-linuxkit amd64
INFO: User cache: /root/.sonar/cache
INFO: SonarQube server 7.4.0
INFO: Default locale: "en_US", source code encoding: "UTF-8" (analysis is platform dependent)
INFO: Publish mode
INFO: Load global settings
INFO: Load global settings (done) | time=126ms
INFO: Server id: <snip>
INFO: User cache: /root/.sonar/cache
INFO: Load/download plugins
INFO: Load plugins index
INFO: Load plugins index (done) | time=102ms
INFO: Load/download plugins (done) | time=130ms
INFO: Loaded core extensions:
INFO: Process project properties
INFO: Load project repositories
INFO: Load project repositories (done) | time=84ms
INFO: Load quality profiles
INFO: Load quality profiles (done) | time=33ms
INFO: Load active rules
INFO: Load active rules (done) | time=554ms
INFO: Load metrics repository
INFO: Load metrics repository (done) | time=27ms
INFO: Project key: security-scan
INFO: Project base dir: /root_dir/src
INFO: -------------  Scan Security Scan
INFO: Base dir: /root_dir/src
INFO: Working dir: /root_dir/src/.scannerwork
INFO: Source paths: config, dag_factories, operators, tasks
INFO: Test paths: tests
INFO: Source encoding: UTF-8, default locale: en_US
INFO: Load server rules
INFO: Load server rules (done) | time=187ms
INFO: Language is forced to py
INFO: Index files
INFO: Excluded sources:
INFO:   **/*.pyc
INFO:   **/*.ini
INFO: Excluded tests:
INFO:   **/*.pyc
INFO: 95 files indexed
INFO: 82 files ignored because of inclusion/exclusion patterns
INFO: Quality profile for py: Sonar way
INFO: Sensor Python Squid Sensor [python]
WARN: Metric 'comment_lines_data' is deprecated. Provided value is ignored.
INFO: Sensor Python Squid Sensor [python] (done) | time=2831ms
INFO: Sensor PythonXUnitSensor [python]
INFO: Sensor PythonXUnitSensor [python] (done) | time=318ms
INFO: Sensor JaCoCo XML Report Importer [jacoco]
INFO: Sensor JaCoCo XML Report Importer [jacoco] (done) | time=6ms
INFO: Sensor SonarJavaXmlFileSensor [java]
INFO: Sensor SonarJavaXmlFileSensor [java] (done) | time=1ms
INFO: Sensor Zero Coverage Sensor
INFO: Sensor Zero Coverage Sensor (done) | time=54ms
INFO: SCM Publisher is disabled
INFO: 3 files had no CPD blocks
INFO: Calculating CPD for 61 files
INFO: CPD calculation finished
INFO: Analysis report generated in 2349ms, dir size=617 KB
INFO: Analysis reports compressed in 15384ms, zip size=233 KB
INFO: Analysis report uploaded in 108ms
INFO: ANALYSIS SUCCESSFUL, you can browse https://sonarqube.mydomain/dashboard?id=security-scan
INFO: Note that you will be able to access the updated dashboard once the server has processed the submitted analysis report
INFO: More about the report processing at https://sonarqube.mydomain/api/ce/task?id=<snip>
INFO: Task total time: 26.187 s
INFO: ------------------------------------------------------------------------
INFO: EXECUTION SUCCESS
INFO: ------------------------------------------------------------------------
INFO: Total time: 27.558s
INFO: Final Memory: 16M/295M
INFO: ------------------------------------------------------------------------

Вот полный sonar-project.properties файл:

sonar.host.url=https://sonarqube.mydomain
sonar.scm.disabled=true

sonar.projectKey=security-scan
sonar.projectName=Security Scan
sonar.projectVersion=1.0

sonar.language=py

sonar.sources=src
sonar.tests=tests
sonar.python.coverage.reportPath=coverage.xml

sonar.python.bandit.reportPaths=bandit-report.json

sonar.exclusions=**/*.pyc,**/*.ini
sonar.test.exclusions=**/*.pyc

Но нигде в пользовательском интерфейсе SonarQube я не вижу этот отчет.Чего мне не хватает?

Связанные проблемы

Код Python для анализа безопасности с использованием Bandit .

Это единственная связанная проблема, которую я мог найти на SO,Моя проблема в другом.Как я уже упоминал, бандитский отчет генерируется правильно локально.Но проблема, похоже, связана с загрузкой в ​​SonarQube.

Пустой скриншот отчета об уязвимости

Ответы [ 2 ]

0 голосов
/ 29 июля 2019

Вам нужно добавить файл .bandit в корневой каталог вашего проекта и определить там правила.

, тогда вам также нужно установить pip install bandit в вашу среду.Надеюсь, это работает для вас.этот способ работает для меня, и он генерирует отчет в соответствии с правилами.

0 голосов
/ 31 января 2019

Мы недавно добавили поддержку Bandit в SonarPython.

Используете ли вы SonarPython 1.11 в своем экземпляре SonarQube 7.4?Вы можете проверить это в $ SQ_HOME / extensions / plugins.Если это не так, просто замените sonar-python-plugin-xxx.jar на 1.11, и это должно решить вашу проблему.

https://docs.sonarqube.org/display/PLUG/SonarPython

Спасибо

...