Configuration

Конфигурация

Основной файл конфигурации:

~/.local/share/custodes/.env

Открыть его можно командой:

custodes config

Пример

banwords=SSH_KEY,API_KEY,password,token
logo_custodes=yes
output_violations=yes
lang_custodes=ru

Параметры

banwords

Обязательный список запрещённых строк, разделённых запятыми:

banwords=SSH_KEY,API_KEY,password,token

Особенности текущей реализации:

• поиск регистрозависимый: API_KEY и api_key — разные строки;
• используется поиск подстроки, а не регулярное выражение;
• пробелы по краям каждого элемента удаляются;
• пустые элементы игнорируются;
• если параметр отсутствует или пуст, проверка завершится с ошибкой.

Чтобы учесть разные варианты написания, перечислите их отдельно:

banwords=API_KEY,api_key,ApiKey,password,PASSWORD

logo_custodes

Показывает ASCII-логотип при блокировке:

logo_custodes=yes

Только точное значение yes включает логотип. Любое другое значение считается выключенным.

output_violations

Показывает файлы и добавленные строки, в которых найдены совпадения:

output_violations=yes

Только точное значение yes включает подробный вывод.

Учтите: подробный вывод может повторно показать секрет в терминале или CI-логе. Для чувствительной среды лучше отключить эту настройку.

lang_custodes

Выбирает язык сообщений:

lang_custodes=ru

Поддерживаемые значения:

• ru — русский;
• eng — английский.

Если указано другое значение, CLI использует английский язык.

Рекомендации по правилам

• Добавляйте названия переменных и характерные маркеры секретов, а не сами рабочие секреты.
• Начните с небольшого списка и расширяйте его по результатам использования.
• Проверяйте правила на тестовом коммите, чтобы оценить ложные срабатывания.
• Не добавляйте пользовательский .env Custodes в репозитории проектов.