GitLeaks GitLab CI 컴포넌트

GitLab CI용 Gitleaks 컴포넌트입니다 - git 저장소에서 비밀번호, API 키, 토큰과 같은 하드코딩된 시크릿을 탐지하고 방지하는 SAST 도구입니다.

기능

• 시크릿 탐지: 저장소에서 하드코딩된 시크릿 및 민감 정보를 스캔합니다
• 포괄적인 규칙: 다양한 유형의 시크릿을 탐지하기 위한 광범위한 내장 규칙 집합
• 사용자 정의 구성: 로컬 및 원격 구성 파일 지원
• 다중 출력 형식: JSON, SARIF 및 기타 보고서 형식 지원
• 유연한 인수: Gitleaks에 추가 플래그를 직접 전달
• 원격 구성: 원격 URL에서 구성 파일을 다운로드하여 사용
• 구성 가능한 작업 설정: 작업 이름, 단계 및 컨테이너 이미지 사용자 정의

사용법

기본 사용법

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest

stages:
  - test

사용자 정의 구성 사용

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_CONFIG: ".gitleaks.toml"
      GITLEAKS_EXTRA_ARGS: "--verbose --report-format sarif"

stages:
  - test

원격 구성 사용

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_REMOTE_CONFIG: "https://gitlab.com/niclas-zone/ci/gitleaks/-/raw/main/configs/gitleaks.toml"

stages:
  - test

입력

구성 파일

로컬 구성

.gitleaks.toml 파일을 저장소 루트에 배치하거나 GITLEAKS_CONFIG를 사용하여 경로를 지정합니다.

원격 구성

GITLEAKS_REMOTE_CONFIG를 설정하여 URL에서 구성 파일을 다운로드합니다. 여러 프로젝트에서 구성을 공유할 때 유용합니다.

기본 구성

로컬 또는 원격 구성이 지정되지 않은 경우, 컴포넌트는 Gitleaks의 기본 제공 규칙을 사용합니다.

아티팩트

컴포넌트는 다음 아티팩트를 생성합니다:

• gitleaks-report.json: JSON 형식의 스캔 결과 (또는 --report-format 인수에 따른 다른 형식)

문서

Gitleaks 구성 및 옵션에 대한 자세한 내용은 다음을 참조하십시오:

• Gitleaks 문서
• 구성 가이드
• 명령줄 옵션