Назад к обновлениям
New releaseAug 25, 2026

redact v0.2.2

Удаляет из строк произвольного формата содержимое, похожее на учётные данные, до того, как они попадут в журналы или телеметрию. Часть набора инструментов phpboyscout на Go. · https://redact.go.phpboyscout.uk

Поделиться

redact

Удаляет похожее на учётные данные содержимое из свободных строк до того, как они попадут в журналы, телеметрию или любую стороннюю поверхность

Go Reference Pipeline Coverage phpboyscout Go toolkit

Часть phpboyscout Go toolkit: небольшие Go-модули без привязки к фреймворкам, извлечённые из go-tool-base. Документация: redact.go.phpboyscout.uk


gitlab.com/phpboyscout/go/redact удаляет похожее на учётные данные содержимое из свободных строк на границе между доверенными и недоверенными поверхностями наблюдаемости, такими как поставщики телеметрии, агрегаторы журналов и хранилища метрик. Сообщения об ошибках, аргументы команд и значения HTTP-заголовков регулярно случайно содержат секреты (URL со встроенными данными пользователя, флаг --api-key=sk-… в os.Args, заголовок Authorization, процитированный в ошибке экспорта). Пропустите их через redact.String на пути наружу, и они никогда не покинут процесс в открытом виде.

Устройство

  • Ноль зависимостей. Чистая стандартная библиотека (regexp, strings), так что в ваш граф попадает только сам модуль. Это обеспечивается защитой depfootprint_test.go, которая ограничивает тесты testify и go/errors из экосистемы.
  • Редактирование на границе. Очищайте там, где данные покидают хост, а не везде.
  • Консервативность по умолчанию. Запасной вариант для непрозрачных токенов требует ≥41 символа, поэтому он никогда не даёт ложных срабатываний на UUID, MD5 или SHA-1.

Установка

go get gitlab.com/phpboyscout/go/redact

Использование

import "gitlab.com/phpboyscout/go/redact"

safe := redact.String("failed calling https://user:[email protected]?api_key=sk-abc123…")
// → credentials in the URL userinfo, the api_key query param, and the sk- token are masked

msg := redact.Error(err) // redact.String applied to err.Error() (nil-safe)

if redact.IsSensitiveHeaderKey("Authorization") { /* … redact this header's value … */ }

redact.String удаляет userinfo из URL для любой схемы (https://, postgres://, redis://, …), присваивания учётных данных вида name=value, поля учётных данных в JSON, такие как "access_token" и "client_secret", токены в заголовке Authorization, JWT, известные префиксы провайдеров (sk-, ghp_, glpat-, AIza, AKIA, Slack, Hugging Face), а также длинные непрозрачные токены. SensitiveHeaderKeys / IsSensitiveHeaderKey определяют заголовки, значения которых следует редактировать.

Ограничения

Каталоги шаблонов никогда не достигают 100% полноты, и этот намеренно консервативен:

  • Нет конфигурации. Вы не можете добавить, отключить или изменить порядок шаблона. Пакет экспортирует четыре символа и ничего для настройки. Вместо этого компонуйте вокруг него.
  • String не маскирует произвольные значения заголовков. Он знает Authorization: и ничего больше; X-API-Key: … проходит без изменений. Для этого и предназначены символы заголовков.
  • Нестандартные и короткие секреты проскакивают. Универсальный запасной вариант требует 41 символ, и каждый префикс провайдера имеет жёсткую минимальную длину. Он также щадит последовательность, которая читается как слова, поэтому парольная фраза из словарных слов проходит.
  • Шаблоны только ASCII, и редактирование одностороннее: нечего обращать и нет записи о том, что было заменено.

What redact does not do описывает полную границу.

Документация

Полные руководства, справочник и модель угроз: redact.go.phpboyscout.uk. Сгенерированная документация API и запускаемые примеры: pkg.go.dev.

Лицензия

См. LICENSE.

Категории