---

gitlab.com/phpboyscout/go/redact는 신뢰할 수 있는 관측 가능성 표면과 신뢰할 수 없는 관측 가능성 표면(예: 텔레메트리 공급업체, 로그 집계기, 메트릭 저장소) 사이의 경계에서 자유 형식 문자열에서 자격 증명과 유사한 내용을 제거합니다. 오류 메시지, 명령 인수, HTTP 헤더 값은 실수로 비밀을 포함하는 경우가 흔합니다(사용자 정보가 포함된 URL, os.Args의 --api-key=sk-… 플래그, 내보내기 오류에 인용된 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은 모든 스킴(https://, postgres://, redis://, …)의 URL 사용자 정보, 자격 증명 name=value 할당, "access_token" 및 "client_secret"과 같은 JSON 자격 증명 필드, Authorization 헤더 토큰, JWT, 잘 알려진 공급자 접두사(sk-, ghp_, glpat-, AIza, AKIA, Slack), 그리고 긴 불투명 토큰을 제거합니다. SensitiveHeaderKeys / IsSensitiveHeaderKey는 값이 삭제되어야 하는 헤더를 식별합니다.

제한 사항

패턴 카탈로그는 결코 100% 재현율에 도달하지 못하며, 이 카탈로그는 의도적으로 보수적입니다:

• 구성 불가. 패턴을 추가, 비활성화 또는 재정렬할 수 없습니다. 이 패키지는 네 개의 심볼을 내보내며 조정할 수 있는 것은 없습니다. 대신 주변에서 구성하세요.
• String은 임의의 헤더 값을 마스킹하지 않습니다. Authorization:만 알고 그 외에는 아무것도 모르므로 X-API-Key: …는 그대로 통과합니다. 이를 위해 헤더 심볼이 존재합니다.
• 맞춤형 및 짧은 비밀은 빠져나갑니다. 포괄적 폴백은 41자가 필요하며, 각 공급자 접두사는 최소 길이가 정해져 있습니다.
• 패턴은 ASCII 전용이며, 삭제는 단방향입니다: 되돌릴 수 있는 것이 없고 무엇이 대체되었는지에 대한 기록도 없습니다.

redact가 하지 않는 일에서 전체 경계를 설명합니다.

문서

전체 가이드, 레퍼런스 및 위협 모델: redact.go.phpboyscout.uk. 생성된 API 문서 및 실행 가능한 예제: pkg.go.dev.

라이선스

LICENSE를 참조하세요.