Provision
—— XP

Практика: .gitignore и утечка пароля

практика~25 минут+375 XP

Репозиторий с конфигами быстро обрастает мусором: журналы, временные файлы, а хуже всего — файл с паролями, который лежит рядом с конфигом и легко уходит в коммит вместе с ним. Сейчас ты заведёшь защиту от этого, а потом нарочно её обойдёшь, чтобы увидеть, чем кончается утечка.

Работаем в ~/infra. Пароль в практике учебный, но обращайся с ним так, будто он настоящий.

Шаг 1. Добавить второй конфиг

В миссии раздела про nginx ты сделал сайт app. Скопируем его в репозиторий. Если миссию пропустил, возьми любой файл из /etc/nginx/sites-available/.

ubuntu@stand:~$
cd ~/infra
cp /etc/nginx/sites-available/app nginx/

Шаг 2. Насорить

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

ubuntu@stand:~$
echo "debug start" > debug.log
echo "DB_PASSWORD=supersecret" > .env

Шаг 3. Посмотреть, что видит Git

Спросим короткий статус, прежде чем что-то добавлять.

ubuntu@stand:~$
git status -s
ubuntu@stand:~$
?? .env
?? debug.log
?? nginx/app

Все три файла не отслеживаются. Одна команда git add . — и пароль с журналом уедут в историю вместе с конфигом. Точка в git add . значит «всё в текущем каталоге».

Шаг 4. Сначала пароль

Самое опасное в списке — .env: журнал в истории неприятен, пароль в истории — авария. Начнём с него. Создай в корне репозитория файл с одной строкой.

nano .gitignore
.env

Сохрани и снова спроси статус.

ubuntu@stand:~$
git status -s
ubuntu@stand:~$
?? .gitignore
?? debug.log
?? nginx/app

.env пропал из списка: Git его больше не замечает. Спросим, какое правило его скрыло, флаг -v печатает подробности.

ubuntu@stand:~$
git check-ignore -v .env
ubuntu@stand:~$
.gitignore:1:.env	.env

Файл, номер строки и правило — так ищут, почему Git «не видит» файл.

Шаг 5. Журналы

debug.log по-прежнему в списке. Журналов будет много и с разными именами, поэтому правило — шаблоном: звёздочка значит «любые символы». Допиши второй строкой:

nano .gitignore
.env
*.log
ubuntu@stand:~$
git status -s
ubuntu@stand:~$
?? .gitignore
?? nginx/app

Остались только файлы, которым место в репозитории. Новые правила дописывают по мере того, как появляются файлы: закрытые ключи *.key, временный каталог tmp/. Писать их заранее, на всякий случай, не нужно.

Шаг 6. Шаблон переменных

Коллеге нужно знать, какие переменные заполнить. Для этого — шаблон без значений.

nano .env.example
DB_PASSWORD=

Шаг 7. Закоммитить

Теперь git add . безопасен: исключённое он не тронет.

ubuntu@stand:~$
git add .
git status -s
ubuntu@stand:~$
A  .env.example
A  .gitignore
A  nginx/app

Буква A — added, «новый файл в индексе». Пароля и журнала в списке нет.

ubuntu@stand:~$
git commit -m "nginx: сайт app, .gitignore и шаблон .env"

Шаг 8. Устроить утечку

Теперь сделаем ошибку, которую однажды сделает каждый. Флаг -f (force) у git add добавляет файл, несмотря на .gitignore. На работе так бывает, когда «очень надо было быстро».

ubuntu@stand:~$
git add -f .env
git commit -m "временно: env для коллеги"

Шаг 9. Убедиться, что пароль в истории

Команда git show с записью коммит:файл печатает файл таким, каким он был в этом коммите. HEAD — последний коммит.

ubuntu@stand:~$
git show HEAD:.env
ubuntu@stand:~$
DB_PASSWORD=supersecret

Пароль лежит в истории. Если бы ты сделал push, он был бы у всех, кто потом сделает pull.

Шаг 10. Снять файл с учёта

Флаг --cached убирает файл из репозитория, оставляя на диске.

ubuntu@stand:~$
git rm --cached .env
ubuntu@stand:~$
rm '.env'
ubuntu@stand:~$
git commit -m "убрать .env из репозитория"

Шаг 11. Пароль всё ещё в истории

Посмотрим, что лежит в предыдущем коммите. HEAD~1 значит «на один коммит раньше последнего».

ubuntu@stand:~$
git show HEAD~1:.env
ubuntu@stand:~$
DB_PASSWORD=supersecret

Файл пропал из текущей версии, но не из истории: любой, у кого есть репозиторий, достанет пароль одной командой. Поэтому правильный ответ на утечку — сменить пароль там, где он действует. Здесь «базы» нет, так что просто поменяй значение в своём .env на новое и запомни порядок: сначала смена секрета, потом уборка в репозитории.

Шаг 12. Посмотреть историю файла

Если дописать имя файла после --, git log покажет только коммиты, которые его трогали.

ubuntu@stand:~$
git log --oneline -- .env
ubuntu@stand:~$
e41a9d7 (HEAD -> main) убрать .env из репозитория
9b02c55 временно: env для коллеги

Два коммита: появление и удаление. Именно так утечку находят задним числом — и именно поэтому её нельзя «просто удалить».

Что спросят на собеседовании

  • Зачем в репозитории .env.example?
    Он показывает, какие переменные нужны приложению, без настоящих значений. Новый человек копирует его в .env и заполняет.
  • Как проверить, почему Git не видит файл?
    git check-ignore -v с именем файла покажет, какой .gitignore и какая строка его скрыли.
Практика 03+375 XP

Держать репозиторий чистым: .gitignore с первого дня, .env.example вместо .env и правильная реакция на пароль, попавший в историю.

  • .gitignore в репозитории
  • Правила исключают журналы и .env
  • Шаблон переменных в репозитории
  • Настоящий .env не отслеживается
  • Журналы не попали в репозиторий
  • Утечка воспроизведена и закрыта
Команда сдачи — выполни на своей машине
команда
cd ~/infra; git status -s; git ls-files; cat .gitignore; git ls-files --error-unmatch .env 2>&1; git log --oneline -- .env

Нашёл ошибку или непонятное место? Наведи на абзац — слева появится «+», нажми и напиши, что не так. Замечание увидит автор курса.Нашёл ошибку или непонятное место? Нажми «+» справа от заголовка раздела и напиши, что не так. Замечание увидит автор курса.