Определение пользовательского шаблона для репозитория
Перед тем как определить пользовательский шаблон, убедитесь, что он включён в вашем репозитории. Дополнительные сведения см. в разделе Включение проверки секретов для репозитория.
-
На GitHubперейдите на главную страницу репозитория.
-
Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".
-
В разделе "Безопасность" боковой панели щелкните Code security.
-
В разделе "Code security" найдите "GitHub Advanced Security".
-
В разделе "Secret scanning" в разделе "Пользовательские шаблоны" нажмите кнопку "Создать шаблон".
-
Введите сведения о новом пользовательском шаблоне. Необходимо по крайней мере указать имя шаблона и регулярное выражение для формата шаблона секрета.
- В поле "Имя шаблона" введите имя шаблона.
- В поле «Секретный формат» введите регулярное выражение формата вашего секретного узора.
- Вы можете щелкнуть дополнительные параметры для предоставления другого окружающего содержимого или дополнительных требований соответствия для формата секрета. См . раздел AUTOTITLE.
- Предоставьте пример тестовой строки для проверки соответствия конфигурации ожидаемым шаблонам.
-
Когда вы будете готовы протестировать новый пользовательский шаблон, чтобы определить совпадения в репозитории без создания оповещений, нажмите кнопку Сохранить и выполнить пробный прогон.
-
По завершении пробного запуска вы увидите выборку результатов (до 1000). Проверьте результаты и определите ложноположительные.
-
Измените новый пользовательский шаблон, чтобы устранить все проблемы с результатами, а затем, чтобы протестировать изменения, щелкните Сохранить и выполнить пробный запуск.
-
Когда вы удовлетворены новым пользовательским шаблоном, нажмите кнопку "Опубликовать шаблон".
-
При необходимости, чтобы включить защиту push-уведомлений для пользовательского шаблона, нажмите кнопку "Включить". Дополнительные сведения см. в разделе Сведения о защите push-уведомлений.
Примечание.
Кнопка "Включить" недоступна до тех пор, пока не будет выполнено сухое выполнение, и вы публикуете шаблон.
После создания вашей выкройки, secret scanning сканирует все секреты во всем журнале Git во всех ветвях, имеющихся в репозитории GitHub. для получения дополнительной информации о просмотре Оповещения о сканировании секретовсмотрите Управление оповещениями проверки секретов.
Определение пользовательского шаблона для организации
Прежде чем определить индивидуальный шаблон, убедитесь, что вы включили secret scanning репозитории, которые хотите отсканировать в вашей организации. Вы можете использовать security configurations для включения secret scanning во всех репозиториях вашей организации. Дополнительные сведения см. в разделе Сведения о включении функций безопасности в масштабе.
-
В правом верхнем углу GitHub, щелкните рисунок профиля, а затем выберите октикона "организация" aria-hidden="true" aria-label="organization" %} Ваши организации.
-
Выберите организацию, кликнув по ней.
-
Под именем организации щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".
-
В разделе «Безопасность» боковой панели выберите Code security выпадающее меню, затем нажмите Global settings.
-
В разделе «Пользовательские выкройки» нажмите « Новая выкройка».
-
Введите сведения о новом пользовательском шаблоне. Необходимо по крайней мере указать имя шаблона и регулярное выражение для формата шаблона секрета.
- В поле "Имя шаблона" введите имя шаблона.
- В поле «Секретный формат» введите регулярное выражение формата вашего секретного узора.
- Вы можете щелкнуть дополнительные параметры для предоставления другого окружающего содержимого или дополнительных требований соответствия для формата секрета. См . раздел AUTOTITLE.
- Предоставьте пример тестовой строки для проверки соответствия конфигурации ожидаемым шаблонам.
-
Когда вы будете готовы протестировать новый пользовательский шаблон, чтобы определить совпадения в выбранных репозиториях без создания оповещений, нажмите кнопку Сохранить и выполнить пробный прогон.
-
Выберите репозитории, в которых требуется выполнить пробное выполнение.
- Чтобы выполнить пробное выполнение во всей организации, щелкните Все репозитории в организации.
- Чтобы указать репозитории, в которых требуется выполнить пробное выполнение, щелкните Выбранные репозитории, а затем найдите и выберите до 10 репозиториев.
-
Когда вы будете готовы протестировать новый пользовательский шаблон, щелкните Выполнить.
-
По завершении пробного запуска вы увидите выборку результатов (до 1000). Проверьте результаты и определите ложноположительные.
-
Измените новый пользовательский шаблон, чтобы устранить все проблемы с результатами, а затем, чтобы протестировать изменения, щелкните Сохранить и выполнить пробный запуск.
-
Когда вы удовлетворены новым пользовательским шаблоном, нажмите кнопку "Опубликовать шаблон".
-
При необходимости, чтобы включить защиту push-уведомлений для пользовательского шаблона, нажмите кнопку "Включить". Дополнительные сведения см. в разделе Сведения о защите push-уведомлений.
Примечание.
- Параметр включения защиты push-уведомлений отображается только для опубликованных шаблонов.
- Защита от отправки пользовательских шаблонов применяется только к репозиториям в вашей организации, которые имеют secret scanning в качестве включенной защиты push-уведомлений.
- Включение защиты push-уведомлений для часто найденных пользовательских шаблонов может быть нарушено для участников.
После создания паттерна secret scanning просканируйте любые секреты в репозиториях вашей организации, включая всю историю Git на всех ветках. Владельцы организации и администраторы репозитория будут оповещены обо всех обнаруженных секретах и смогут просмотреть оповещение в репозитории, где обнаружен секрет. Для получения дополнительной информации о просмотре Оповещения о сканировании секретовсм. АВТОТИТРЫ.
Определение пользовательского шаблона для учетной записи предприятия
Перед определением пользовательского шаблона необходимо включить проверку секретов для учетной записи предприятия. Дополнительные сведения см. в разделе Включение GitHub Advanced Security для вашего предприятия.
Примечание.
- На уровне предприятия только создатель пользовательского шаблона может изменять шаблон и использовать его в пробном прогоне.
- Вы можете выполнять только сухой запуск в репозиториях, к которым у вас есть доступ к администрирования. Если владелец предприятия хочет получить доступ к выполнению сухих запусков в любом репозитории в организации, им необходимо назначить роль владелец организации. Дополнительные сведения см. в разделе Управление ролью в организации, принадлежащей предприятию.
-
В правом верхнем углу GitHub Enterprise Serverщелкните рисунок профиля, а затем выберите параметры Enterprise.
-
В левой части страницы на боковой панели учетной записи предприятия щелкните Policies.
-
В разделе "Policies", щелкните Code security.
-
В разделе «Code security», нажмите « Функции безопасности».
-
В разделе "Сканирование секретов настраиваемых шаблонов" нажмите кнопку "Создать шаблон".
-
Введите сведения о новом пользовательском шаблоне. Необходимо по крайней мере указать имя шаблона и регулярное выражение для формата шаблона секрета.
- В поле "Имя шаблона" введите имя шаблона.
- В поле «Секретный формат» введите регулярное выражение формата вашего секретного узора.
- Вы можете щелкнуть дополнительные параметры для предоставления другого окружающего содержимого или дополнительных требований соответствия для формата секрета. См . раздел AUTOTITLE.
- Предоставьте пример тестовой строки для проверки соответствия конфигурации ожидаемым шаблонам.
-
Когда вы будете готовы протестировать новый пользовательский шаблон, чтобы найти совпадения в вашей корпорации, но не создавать оповещения, нажмите кнопку Сохранить и выполнить пробный запуск.
-
Найдите и выберите до 10 репозиториев, в которых требуется выполнить пробный запуск.
-
Когда вы будете готовы протестировать новый пользовательский шаблон, щелкните Выполнить.
-
По завершении пробного запуска вы увидите выборку результатов (до 1000). Проверьте результаты и определите ложноположительные.
-
Измените новый пользовательский шаблон, чтобы устранить все проблемы с результатами, а затем, чтобы протестировать изменения, щелкните Сохранить и выполнить пробный запуск.
-
Когда вы удовлетворены новым пользовательским шаблоном, нажмите кнопку "Опубликовать шаблон".
-
При необходимости, чтобы включить защиту push-уведомлений для пользовательского шаблона, нажмите кнопку "Включить". Дополнительные сведения см. в разделе Сведения о защите push-уведомлений.
Примечание.
- Чтобы включить защиту push-уведомлений для пользовательских шаблонов, secret scanning в качестве защиты push-уведомлений необходимо включить на уровне предприятия.
- Включение защиты push-уведомлений для часто найденных пользовательских шаблонов может быть нарушено для участников.
После создания паттерна secret scanning отсканируйте любые секреты в репозиториях вашей организации с GitHub Advanced Security включённым доступом, включая всю историю Git на всех ветках. Владельцы организации и администраторы репозитория будут оповещены обо всех обнаруженных секретах и смогут просмотреть оповещение в репозитории, где обнаружен секрет. Для получения дополнительной информации о просмотре Оповещения о сканировании секретовсм. АВТОТИТРЫ.