Настройка проверки секретов в ваших репозиториях

Включение Проверка секретов

Вы можете включить Проверка секретов для любого репозиторий, принадлежащий организации. После включения secret scanning сканирует все секреты во всем журнале Git во всех ветвях, имеющихся в репозитории GitHub.

Вы можете использовать страницу параметров организации для "Безопасность и анализ кода", чтобы включить code scanning для всех общедоступных репозиториев в организации:

1. На ваше предприятие перейдите на главную страницу репозитория. 1. Под именем репозитория щелкните Параметры. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку Параметры.

   

2. В разделе "Безопасность" боковой панели щелкните Безопасность и анализ кода.

3. Если Advanced Security еще не включено для этого репозитория, справа от "GitHub Advanced Security" нажмите кнопку Включить.

4. Проверьте влияние включения Advanced Security, а затем нажмите Включить GitHub Advanced Security для этого репозитория.

5. Если включить Advanced Security, для этого репозитория может быть автоматически включено secret scanning, в зависимости от параметров организации. Если "Secret scanning" отображается с кнопкой Включить, значит вам все еще нужно включить secret scanning, нажав кнопку Включить. Если вы видите кнопку Отключить, значит secret scanning уже включено.

   

6. Если вы хотите включить защиту отправки, то можете нажать кнопку Включить справа от пункта "Защита отправки". Когда вы включаете защиту отправки, secret scanning также проверяет отправки на наличие секретов с высокой достоверностью (с малой частотой ложноположительных результатов). Secret scanning перечисляет все обнаруженные секреты, чтобы автор мог просмотреть секреты и удалить их или, при необходимости, разрешить отправку этих секретов. Дополнительные сведения см. в разделе Защита отправок с помощью сканирования секретов.

7. Прежде чем включать secret scanning, необходимо сначала включить GitHub Advanced Security. Справа от "GitHub Advanced Security" нажмите кнопку Включить.

8. Нажмите кнопку Включить GitHub Advanced Security для этого репозитория, чтобы подтвердить действие.

9. Справа от Secret scanning нажмите Включить.

Исключение каталогов из Проверка секретов

Вы можете настроить файл secret_scanning.yml для исключения каталогов из secret scanning, в том числе при использовании защиты от push-уведомлений. Например, можно исключить каталоги, содержащие тесты или случайно созданное содержимое.

1. На ваше предприятие перейдите на главную страницу репозитория.

2. Над списком файлов в раскрывающемся списке Добавить файл щелкните Создать файл.

3. В поле имени файла введите .github/secret_scanning.yml.

4. В разделе Изменить новый файл введите paths-ignore: и следом пути, которые хотите исключить из secret scanning.

   paths-ignore:
     - "foo/bar/*.js"
   

   Можно использовать специальные символы для фильтрации путей, например, *. Дополнительные сведения о шаблонах фильтров см. в разделе Синтаксис рабочего процесса для GitHub Actions.

   Примечания.

   • Если в paths-ignore имеется более 1000 записей, то secret scanning исключит из проверки только первые 1000 записей.
   • Если размер secret_scanning.yml больше 1 МБ, secret scanningпропустит весь файл.

Вы также можете пропускать отдельные оповещения из secret scanning. Дополнительные сведения см. в разделе Управление оповещениями о проверке секретов.

Дополнительные материалы

• "Управление параметрами безопасности и анализа для организации"
• "Определение пользовательских шаблонов для проверки секретов"