
소스 코드와 git 이력에서 유출된 API 키, 토큰, 개인 키를 탐지하는 의존성 없는 시크릿 스캐너로, 마스킹된 출력과 바로 사용 가능한 GitLab CI 작업을 제공합니다.
소스 코드 및 git 이력을 위한 작고 의존성이 없는 시크릿 스캐너로, 바로 사용할 수 있는 GitLab CI 작업을 제공합니다.
유출된 API 키, 토큰, 개인 키, 비밀번호가 프로덕션에 도달하기 전에 찾아내며, 한 번 커밋되었다가 나중에 "제거"되었지만 여전히 이력에 남아 있는 시크릿까지 포함합니다.
$ secretscan scan . --history
[HIGH ] url-credentials deploy.sh:1 (commit 79831acaf3, Dev <[email protected]>)
Credentials embedded in a URL: Fake********
[HIGH ] aws-access-key-id settings.py:1 (commit 79831acaf3, Dev <[email protected]>)
AWS access key ID: AKIA************
2 potential secret(s) found.
해당 데모에서는 이후 커밋에서 AWS 키가 settings.py에서 삭제되었습니다. 단순 파일 스캔으로는 저장소가 깨끗하다고 나오지만, git log -p로 키를 여전히 복구할 수 있으므로 여전히 유출된 상태입니다.
password = "..." 규칙.changeme, ${API_KEY}, {{ vault_token }}, <your-password> 같은 값에 대한 플레이스홀더 필터.--rev-range base..HEAD는 새 커밋만 스캔합니다..secretscanignore(gitignore 스타일 글롭) 및 인라인 # secretscan:ignore.--fail-on 심각도 임계값을 지원하는 CI 친화적 종료 코드.pip install git+https://gitlab.com/DaveyD347/secrets-scanner.git
# or, from a clone
pip install -e ".[dev]"
secretscan scan # scan the current directory's files
secretscan scan path/to/repo --history # files + entire git history
secretscan scan . --history-only # history only
secretscan scan . --rev-range origin/main..HEAD # only commits not yet on main
secretscan scan . --format json -o findings.json
secretscan scan . --fail-on high # only fail on high/critical
secretscan rules # list rules
| 종료 코드 | 의미 |
|---|---|
| 0 | --fail-on 이상의 발견 사항 없음 |
| 1 | --fail-on 이상의 발견 사항 있음 |
| 2 | 사용 오류 (잘못된 경로, git 저장소 아님, ...) |
인라인 마커 추가:
EXAMPLE_KEY = "..." # secretscan:ignore
또는 저장소 루트에 .secretscanignore를 생성하세요:
# test fixtures
tests/fixtures/
*.lock
재사용 가능한 job을 모든 프로젝트에 추가하세요:
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
작업은 전체 이력을 복제하고(GIT_DEPTH: 0), 병합 요청 파이프라인에서는 새 커밋만 스캔하며 그 외의 경우에는
전체 이력을 스캔하고, 발견 사항이 있으면 파이프라인을 실패시키며, gl-secret-detection-report.json을
secret_detection 보고서로 업로드합니다. GitLab Ultimate에서는 해당 발견 사항이 병합 요청 보안 위젯과
취약점 보고서에 표시되며, 다른 등급에서는 보고서가 다운로드 가능한 아티팩트로 계속 보관됩니다. 임계값을 조정하려면
SECRETSCAN_FAIL_ON을 설정하세요.
이 저장소 자체의 .gitlab-ci.yml은 린트를 수행하고, 커버리지를 포함하여 Python 3.10부터 3.13까지 테스트하며,
스캐너를 자체 이력에 대해 실행합니다.
src/secretscan/rules.py)은 정규 표현식입니다. 첫 번째 캡처 그룹이 시크릿입니다.
일반 규칙은 최소 엔트로피도 설정하므로 password = "aaaaaaaaaaaa"는 탐지되지 않습니다..git, node_modules, 가상 환경, 바이너리(NUL 바이트 검사),
2 MB를 초과하는 파일, 그리고 .secretscanignore에 있는 모든 항목을 건너뜁니다.git log --all --reverse -p --unified=0을 실행하고 diff 스트림을 파싱하여,
각 @@ 헝크 헤더에서 현재 커밋, 파일, 새 쪽 라인 번호를 추적합니다. + 라인만 검사하므로
시크릿은 이후의 모든 커밋마다 한 번씩이 아니라, 이를 도입한 커밋에서 한 번만 보고됩니다.pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
테스트 픽스처에는 실제 자격 증명이 절대 포함되지 않습니다. tests/fakes.py의 가짜 토큰은 런타임에 조각들을 조립하여 생성되므로, 저장소 자체에는 완전한 토큰 형태의 문자열이 존재하지 않습니다. 이는 CI 자체 스캔을 깨끗하게 유지하고 GitLab 푸시 보호에 걸리지 않도록 합니다.
MIT