• 스키마
  • 최상위 섹션
  • [secrets] 구성 섹션
    • interpolate
  • [[secrets.ruleset]] 섹션
  • [secrets.ruleset.identifier] 섹션
  • [secrets.ruleset.override] 섹션
  • [[secrets.passthrough]] 섹션
    • Passthrough 유형

사용자 지정 규칙 집합 스키마

파이프라인 비밀 감지의 동작을 사용자 정의하는 여러 종류의 규칙 집합을 사용하여 분석기 규칙 집합을 사용자 정의할 수 있습니다.

스키마

파이프라인 비밀 감지 규칙 집합의 사용자 정의는 엄격한 스키마를 준수해야 합니다. 다음 섹션에서는 각 옵션과 해당 섹션에 적용되는 스키마를 설명합니다.

최상위 섹션

최상위 섹션에는 TOML 테이블로 정의된 하나 이상의 _구성 섹션_이 포함됩니다.

구성 예시:

[secrets]
...

[secrets] 구성 섹션

[secrets] 섹션을 사용하여 분석기의 동작을 사용자 정의할 수 있습니다. 유효한 속성은 수행 중인 구성의 종류에 따라 달라집니다.

interpolate

경고: 비밀이 노출되는 위험을 줄이려면 이 기능을 주의해서 사용하세요.

아래 예시는 구성에서 $GITURL 환경 변수를 사용하여 개인 리포지토리에 액세스하는 구성을 보여줍니다. 변수에는 사용자 이름과 토큰 (예: https://user:token@url)이 포함되어 있어서 구성 파일에 명시적으로 저장되지 않습니다.

[secrets]
  description = "내 개인 원격 규칙 집합"
  interpolate = true

  [[secrets.passthrough]]
    type  = "git"
    value = "$GITURL"
    ref = "main"

[[secrets.ruleset]] 섹션

[[secrets.ruleset]] 섹션은 단일 미리 정의된 규칙을 대상으로 수정합니다. 분석기에 대해 이러한 섹션을 하나 이상 정의할 수 있습니다.

구성 예시:

[secrets]
  [[secrets.ruleset]]
    disable = true
    ...

[secrets.ruleset.identifier] 섹션

[secrets.ruleset.identifier] 섹션에는 수정하려는 미리 정의된 규칙의 식별자가 정의됩니다.

type 및 value에 대한 올바른 값은 분석기의 CI 작업에서 생성된 gl-secret-detection-report.json을 확인하여 결정할 수 있습니다. 이 파일은 분석기의 작업 결과물로써 작업 아티팩트로 다운로드할 수 있습니다.

예를 들어, 아래 스니펫은 gitlab_personal_access_token 규칙에서 하나의 식별자를 가진 결과를 보여줍니다. JSON 객체의 type 및 value 키는 이 섹션에서 제공해야 하는 값과 일치합니다.

...
  "vulnerabilities": [
    {
      "id": "fccb407005c0fb58ad6cfcae01bea86093953ed1ae9f9623ecc3e4117675c91a",
      "category": "secret_detection",
      "name": "GitLab personal access token",
      "description": "커밋 5c124166에서 GitLab 개인 액세스 토큰을 찾았습니다.",
      ...
      "identifiers": [
        {
          "type": "gitleaks_rule_id",
          "name": "Gitleaks rule ID gitlab_personal_access_token",
          "value": "gitlab_personal_access_token"
        }
      ]
    }
    ...
  ]
...

구성 예시:

[secrets]
  [[secrets.ruleset]]
    [secrets.ruleset.identifier]
      type = "gitleaks_rule_id"
      value = "gitlab_personal_access_token"
    ...

[secrets.ruleset.override] 섹션

[secrets.ruleset.override] 섹션을 사용하여 미리 정의된 규칙의 속성을 재정의할 수 있습니다.

참고: message는 분석기에서 여전히 채워지지만 사용되지 않게 되었습니다 (영문) 그리고 name 및 description 로 대체되었습니다.

구성 예시:

[secrets]
  [[secrets.ruleset]]
    [secrets.ruleset.override]
      severity = "Medium"
      name = "systemd machine-id"
    ...

[[secrets.passthrough]] 섹션

[[secrets.passthrough]] 섹션을 사용하면 사용자 지정 구성을 합성할 수 있습니다.

분석기당 최대 20개의 이러한 섹션을 정의할 수 있습니다. 그런 다음 Passthrough는 완전한 구성으로 평가되는 _passthrough chain_으로 결합되어 분석기의 사전 정의된 규칙을 대체하거나 확장하는 데 사용할 수 있습니다.

Passthrough는 순서대로 평가됩니다. 연쇄에서 나중에 나오는 Passthroughs는 우선 순위가 높으며(모드에 따라) 이전의 Passthroughs에 의해 생성된 데이터를 덮어쓰거나 추가할 수 있습니다. 기존 구성을 사용하거나 수정해야 할 때 Passthrough를 사용하세요.

단일 Passthrough에 의해 생성된 구성의 크기는 10MB로 제한됩니다.

Passthrough 유형