Секрети в репозиторії: gitleaks в pre-commit і CI і що робити при витоку
Якщо ключ уже втік - спочатку це
Порядок дій важливіший за інструменти, тому почнемо з кінця.
- 1.Відкличте та перевипустіть ключ у провайдера. Відразу, до чищення історії та розборів. Громадські репозиторії скануються ботами завжди, і ключ, який у публічний коміт, слід вважати скомпрометованим з моменту пуша.
- 2.Оновіть ключ у всіх оточеннях (секрети CI, змінні хостингу, менеджер секретів) та перезапустіть сервіси.
- 3.Перевірте журнал використання ключа у провайдера: виклики з незнайомих адрес, незвичайні обсяги, створені ресурси. Для хмарних ключів – нові інстанси та користувачі IAM.
- 4.Тільки потім вирішуйте, чи чистити історію. Переписати її можна через
git filter-repo, але клони, форки, кеші CI та копії у сервісів-дзеркал ви не контролюєте. Вилучення з історії - гігієна, а не усунення витоку. Якщо ключ відкликаний, він нешкідливий, де б не лежав.
Часта помилка: видалити файл новим коммітом і вважати проблему вирішеною. Значення залишається в історії і є однією командою git log -p.
Запобігання: gitleaks локально
gitleaks шукає в коді та історії рядки, схожі на ключі відомих сервісів, та високоентропійні значення за набором правил. Підключення через фреймворк pre-commit:
# .pre-commit-config.yaml
repos:
- repo: https://github.com/gitleaks/gitleaks
rev: v8.30.1 # конкретный тег; pre-commit autoupdate обновит его
hooks:
- id: gitleakspip install pre-commit # или brew install pre-commit pre-commit install # ставит хук в .git/hooks pre-commit run gitleaks --all-files
Хук перевіряє лише те, що ви комітите, тому працює швидко. Але він локальний: його немає колеги, який не виконав pre-commit install, і його відключає git commit --no-verify. Тому pre-commit – зручність для розробника, а справжній бар'єр – перевірка у CI.
Разова перевірка всієї історії існуючого репозиторію (у версіях 8.19 і новіші команди називаються git та dir; старі detect та protect збережені для сумісності):
gitleaks git --redact -v .
Прапор --redact приховує знайдені значення у виведенні - без нього звіт сам стає витіканням, якщо його скопіювати в тикет.
Перевірка в CI
# .github/workflows/secrets.yml
name: secrets
on: [pull_request, push]
permissions:
contents: read
jobs:
gitleaks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # полная история, иначе проверяется только последний коммит
- uses: gitleaks/gitleaks-action@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}Для репозиторіїв організацій gitleaks-action вимагає ліцензійний ключ (безкоштовний, видається на запит) у змінній GITLEAKS_LICENSE. Альтернатива без ключа - запускати сам бінарник або Docker-образ gitleaks за крок run.
Зробіть це завдання обов'язковою перевіркою у правилах захисту гілки. Тоді секрет, пропущений локально, зупиниться на PR ще до попадання в основну гілку.
Хибні спрацьовування
Тестові фікстури, приклади ключів із документації та хеші в lock-файлах іноді схожі на секрети. Варіанти:
- Коментар
gitleaks:allowу рядку — точковий виняток, видимий на рев'ю. - Файл
.gitleaksignoreз відбитками (fingerprint) конкретних знахідок зі звіту. - Власний
.gitleaks.toml, що розширює стандартні правила та задає винятки по коліях.
Не виключайте цілі каталоги на кшталт config/ — саме туди секрети потрапляють.
GitHub push protection
На GitHub є вбудований secret scanning із блокуванням пуша для відомих форматів токенів. Для публічних репозиторіїв він доступний безкоштовно, для приватних – у рамках платного GitHub Secret Protection. Він доповнює gitleaks: працює на стороні сервера і його не можна пропустити прапором, але знає лише формати партнерів GitHub і не бачить ваших власних секретів довільного вигляду.
Як не допускати витоків у принципі
.env*у.gitignoreз першого комміту, в репозиторії тільки.env.exampleз порожніми значеннями.- Ключі з мінімальними правами та окремі для кожного оточення: витік тестового ключа не повинен відкривати продакшен.
- Секрети в CI – через вбудоване сховище секретів, ніколи в YAML.
- Увага до логів: значення змінних оточення, роздруковані під час налагодження складання, залишаються в логах CI.
Чого не робити
- Не "шифрувати" ключ base64 перед коммітом. Сканери це не завжди зловлять, а атакуючий розкодує за секунду.
- Не відкладати ротацію до з'ясування, чи хтось скористався ключем. З'ясування займає годинник, ротація - хвилини.
- Не переписувати історію спільної гілки мовчки. Колеги з локальними копіями повернуть старі комміти за наступного пуша; погодьте та попросіть переклонювати репозиторій.