English

Создание конфигурации для поиска секретов¶

Для начала работы с модулем Secrets необходимо предварительно создать VCS или CLI проект в разделе Настройки -> Проекты.
Задать конфигурацию движка секретов в разделе Настройки -> Секреты, открыв форму по кнопке Добавить.
В форме конфигурации необходимо указать имя, выбрать движок для поиска секретов в коде и прописать ему стандартную конфигурацию – она будет передана на вход движка при сканировании.

В поле Инструмент проверки можно выбрать один из поддерживаемых движков:

Gitleaks 8.27.0;
TruffleHog 3.93.8.

Пример конфигурации для Gitleaks:

title = "Gitleaks title"

[extend]
useDefault = true

Engine configuration example

Подробнее с конфигурированием движка Gitleaks можно ознакомиться в документации инструмента.

Пример конфигурации для TruffleHog:

detectors:
  - name: generic-api-key
    keywords:
      - key
      - api
      - token
      - secret
      - client
      - passwd
      - password
      - auth
      - access
    regex:
      # регулярное выражение generic-api-key из Gitleaks
      generic-api-key: "(?i)(?:key|api|token|secret|client|passwd|password|auth|access)(?:[0-9a-z\\-_\\t .]{0,20})(?:[\\s|']|[\\s|\"]){0,3}(?:=|>|:{1,3}=|\\|\\|:|<=|=>|:|\\?=)(?:'|\"|\\s|=|\\x60){0,5}([0-9a-z\\-_.=]{10,150})(?:['|\"|\\n|\\r|\\s|\\x60|;]|$)"

Подробнее с конфигурированием движка TruffleHog можно ознакомиться в документации инструмента.

Создание конфигурации движка секретов по умолчанию¶

Для задания конфигурации по умолчанию необходимо в настройках конфигурации нажать на кнопку Установить по умолчанию.

Set default engine configuration example

Редактирование конфигурации по умолчанию

Нельзя установить более одной конфигурации по умолчанию, а также удалить используемую по умолчанию конфигурацию.

Для использования в проекте конфигурации по умолчанию необходимо в настройках проекта в разделе Секреты установить чек-бокс По умолчанию. В круглых скобках будет указана конфигурация, используемая в данный момент по умолчанию.

Set default engine configuration in project example

Изменение конфигурации по умолчанию

При установке новой конфигурации по умолчанию во всех проектах, где установлен чек-бокс По умолчанию, будет использована новая установленная конфигурация.

Конфигурация движка секретов у нового проекта

При создании нового проекта для сканирования секретов автоматически будет установлена конфигурация по умолчанию. Конфигурацию можно изменить в настройках проекта в разделе Секреты.

Страница была полезна?