murphysec-jenkins-tools

Интеграция функционала кодового анализа безопасности от Murphysec в Jenkins для повышения качества безопасности кода в продакшне

Обзор

Jenkins — это широко используемый проект непрерывной интеграции в предприятиях. Интеграция функционала кодового анализа безопасности в Jenkins позволяет проводить проверку безопасности кода до его сборки, что снижает риск утечки данных компании из-за проблем с безопасностью кода и уменьшает нагрузку при выпуске проекта. Все этапы непрерывной интеграции выполняются автоматически, что позволяет сократить повторяющиеся процессы и экономить время и трудозатраты.

Реализованный эффект

1. При каждом сборке Jenkins автоматически проверяется наличие сторонних открытых компонентов в коде и выявляются уязвимости
2. Настройка правил, при выявлении критических уязвимостей сборка прерывается
3. Результаты отправляются в группу Feishu, где их могут видеть все соответствующие инженеры

Способы интеграции

1. Настройка Jenkinsfile

• Разместите файл Jenkinsfile в корневом каталоге проекта

• Пример кода Jenkinsfile

Логика выполнения: после клонирования кода, с помощью CLI Murphysec проводится проверка кода, затем с помощью инструмента jq анализируются результаты проверки. Если в результатах проверки обнаружены компоненты с дефектами уровня "настоятельно рекомендуется исправить", процесс сборки прерывается.

• Пример скрипта для уведомлений в Feishu

2. Настройка пути к скрипту в Jenkins

• В настройках проекта в Jenkins перейдите в раздел Advanced Project Options -> Pipeline -> Script Path = Jenkinsfile. Таким образом, при выполнении CI-процесса Jenkins будет выполнять логику, описанную в файле Jenkinsfile.

3. Настройка Webhook в Jenkins

• Настройте Webhooks, чтобы проект автоматически запускал Jenkins при обновлении (Jenkins должен быть установлен с плагинами Git и GitLab Plugin)

• В разделе триггеров сборки выберите опцию Build when a change is .... Этот URL будет использоваться в разделе Webhooks проекта GitLab.

• Создайте секретный токен для проверки вебхуков GitLab

4. Настройка Webhook в GitLab

• Установите URL и Secret token, полученные при настройке Webhook в Jenkins, в GitLab

5. Уведомления в Feishu

• Обеспечьте обработку исключений, чтобы при возникновении ошибок на любом этапе своевременно отправлялись уведомления, что предотвратит проблемы с сборкой. Ниже приведена схема процесса сборки:

• Используйте вебхук бота Feishu для отправки результатов сборки в группу. Если проект не прошел проверку, результаты можно импортировать в систему для отправки разработчикам как справочную информацию для исправления.