gitleaks/gitleaks

GitHub README 원문 앞부분(소개, 출력 예시, 설치, pre-commit 시작)만 읽고 옮겼어요. 설정·규칙·명령 옵션 등 뒷부분은 읽지 않아 partial로 표시해요.

중요한 공지

Gitleaks is feature complete.

작성자는 더 이상 새 기능을 Gitleaks에 병합하지 않고, 앞으로의 릴리스는 보안 패치만 내며, 관심을 Betterleaks로 옮긴다고 밝혀요.

무엇인가

Gitleaks는 git 저장소, 파일, 그리고 stdin으로 넣는 무엇이든에서 비밀번호, API 키, 토큰 같은 비밀 정보를 찾는 도구예요. 탐지 엔진 원리는 "Regex is (almost) all you need"라는 블로그 글에서 설명한다고 해요.

출력 예시

gitleaks git -v를 실행하면 찾은 항목마다 이런 정보를 보여 줘요.

• Finding(문제의 줄), Secret(찾은 비밀 값)
• RuleID(예: sidekiq-secret), Entropy
• File, Line, Commit, Author, Email, Date
• Fingerprint(커밋:파일:규칙:줄 조합)

설치

Homebrew, Docker, Go로 설치할 수 있고, releases 페이지에 여러 플랫폼용 바이너리도 있어요. 저장소의 pre-commit 훅이나 GitHub Action(Gitleaks-Action)으로도 쓸 수 있어요.

# macOS
brew install gitleaks

# Docker (DockerHub)
docker pull zricethezav/gitleaks:latest

# Docker (ghcr.io)
docker pull ghcr.io/gitleaks/gitleaks:latest

# 소스에서 (go 필요)
git clone https://github.com/gitleaks/gitleaks.git
cd gitleaks
make build

Docker로 쓸 때는 검사할 호스트 폴더를 -v로 컨테이너에 마운트하고 [COMMAND] [OPTIONS] [SOURCE_PATH]를 넘겨요.

pre-commit

pre-commit을 설치한 뒤 저장소 루트에 .pre-commit-config.yaml을 만들어 Gitleaks 훅을 등록하는 방법을 안내해요(이후 세부는 읽지 못했어요).