의존성 방화벽 시작하기
GitLab v19.6Offering: GitLab.com, GitLab Self-Managed
요약
의존성 방화벽을 설정하고 첫 결과를 확인합니다. 이 가이드의 정책은 warn 모드를 사용하므로 시험해 보는 동안에는 아무것도 차단되지 않습니다. CI/CD job에서는 job 스크립트에서 glab df를 통해 패키지 관리자를 실행하고, GLAB_ENABLE_CI_AUTOLOGIN CI/CD 변수를 true로 설정합니다.
의존성 방화벽을 설정하고 첫 결과를 확인합니다. 방화벽을 켜고, 일치하는 항목을 차단하지 않고 보고만 하는 정책을 추가하고, 패키지를 설치한 다음 방화벽이 확인한 내용을 읽습니다.
이 가이드의 정책은 warn 모드를 사용하므로 시험해 보는 동안에는 아무것도 차단되지 않습니다.
마지막 단계에서는 적용 모드로 전환하는 방법을 다룹니다.
소요 시간은 약 15분입니다.
사전 요구 사항:
- 네임스페이스가 Premium 또는 Ultimate 티어를 사용할 수 있어야 합니다.
- GitLab.com에서는 최상위 그룹의 Owner 권한이 있어야 합니다. GitLab Self-Managed에서는 관리자여야 합니다.
- 이 기능이 지원하는 패키지 관리자를 사용하는 프로젝트가 필요합니다. 이 가이드는 npm을 사용합니다.
인증#
CI/CD에서 의존성 방화벽 사용#
CI/CD job에서는 job 스크립트에서 glab df를 통해 패키지 관리자를 실행하고,
GLAB_ENABLE_CI_AUTOLOGIN CI/CD 변수를 true로 설정합니다. 그러면 CLI가 CI/CD job 토큰으로 로그인하므로
job에 다른 자격 증명이 필요하지 않습니다.
job 토큰은 해당 프로젝트의 패키지만 평가할 수 있습니다. job을 트리거한 사용자는 사전 요구 사항에 나열된 권한 중 하나가 필요합니다.
패키지가 하나라도 차단되면 실패하는 job의 예시는
glab dependency-firewall ci-summary를 참조합니다.
개발 워크스테이션에서 인증#
다음 명령을 실행해 인증할 수 있습니다. 자세한 내용은 GitLab으로 인증을 참조합니다.
glab auth login
방화벽 켜기#
GitLab.com에서는 다음과 같이 진행합니다.
- 상단 바에서 Search or go to를 선택하고 최상위 그룹을 찾습니다.
- Settings > Secure를 선택합니다.
- Enable dependency firewall 토글을 켭니다.
GitLab Self-Managed에서는 다음과 같이 진행합니다.
- 오른쪽 상단에서 Admin을 선택합니다.
- Settings > Security and compliance를 선택합니다.
- Dependency firewall을 확장합니다.
- Enable dependency firewall 체크박스를 선택한 다음 Save changes를 선택합니다.
아직 평가되는 항목은 없습니다. 방화벽에는 정책이 필요하며, 다음 단계에서 정책을 추가합니다.
경고 모드의 정책 추가#
정책은 보안 정책 프로젝트에 있습니다. 그룹에 보안 정책 프로젝트가 없다면 첫 정책을 저장할 때 GitLab이 생성합니다.
-
상단 바에서 Search or go to를 선택하고 그룹을 찾습니다.
-
Secure > Policies를 선택합니다.
-
New policy를 선택합니다.
-
Dependency firewall policy에서 Select policy를 선택합니다.
-
편집기는 양식 형태의 규칙 모드로 열립니다. 대신 정책을 붙여넣으려면 .yaml mode를 선택합니다.
-
편집기의 내용을 다음 정책으로 바꿉니다.
dependency_firewall_policy: - name: Audit high-risk packages description: Reports packages with critical vulnerabilities or malicious code. enabled: true enforcement_type: warn rules: - type: risk_severity denied: # threshold is the number of vulnerabilities you permit. # 0 permits none, so a single critical vulnerability matches. - severity: critical threshold: 0 - type: malicious denied: - is_malicious: true -
Configure with a merge request를 선택합니다.
-
머지 리퀘스트를 검토하고 머지합니다.
이 정책은 심각한 취약점이 있거나 악성으로 표시된 모든 패키지를 보고합니다.
enforcement_type이 warn이므로 아무것도 차단되지 않습니다.
방화벽을 통해 패키지 설치#
GitLab CLI는 각 패키지를 GitLab으로 전송하고, GitLab은 이를 정책에 따라 평가합니다. 먼저 CLI를 설치하고 인증합니다.
정책이 적용되는 프로젝트를 클론한 다음, 평소 사용하는 명령 앞에 glab df를 붙여 의존성을 설치합니다.
git clone https://gitlab.example.com/my-group/my-project.git
cd my-project
glab df npm install
npm은 평소처럼 실행됩니다. CLI는 해석한 각 패키지를 정책에 따라 검사합니다.
결과 읽기#
npm이 끝나면 CLI가 방화벽이 확인한 내용을 출력합니다.
╭──────────────────────────────────────────────────────────────────────────────────╮
│ ▲ GitLab Dependency Firewall │
│ 1 package warning │
├──────────────────────────────────────────────────────────────────────────────────┤
│ PACKAGE VERSION REASON │
│ ▲ lodash 4.17.15 Package 'lodash' violates 'Audit high-risk packages' policy │
╰──────────────────────────────────────────────────────────────────────────────────╯
▲는 경고가 발생한 패키지를 나타냅니다. 정책이 enforced 모드였다면 이 패키지에는 ✖가 표시되고
npm은 실패했을 것입니다.
요약이 출력되지 않으면 어떤 패키지도 정책과 일치하지 않은 것입니다. 알려진 취약점이 있는
glab df npm install lodash@4.17.15를 실행해 일치 결과를 확인합니다.
패키지를 설치하지 않고 확인하려면 glab df package pkg:npm/lodash@4.17.15를 실행합니다.
자세한 내용은 glab dependency-firewall package를 참조합니다.
GitLab에서 같은 결과를 보려면 그룹 또는 프로젝트에서 Secure > Dependency firewall을 선택합니다. 대시보드는 차단된 항목과 경고가 발생한 항목의 수를 집계하고 각 활성 규칙을 나열합니다.
적용 모드로 전환#
경고 내용이 차단하려는 항목과 일치하면 정책을 변경해 이를 적용합니다.
- Secure > Policies를 선택합니다.
- 정책 행에서 Edit을 선택합니다.
- Enforcement mode에서 Enforce를 선택합니다. .yaml mode에서는
enforcement_type을enforced로 설정합니다. - Configure with a merge request를 선택한 다음 검토하고 머지합니다.
이제 일치하는 패키지는 거부됩니다. 패키지 관리자는 403 Forbidden 응답을 받고 설치가 실패하며,
이로써 패키지가 머신이나 파이프라인에 도달하지 못합니다.
적용은 단계적으로 확대합니다. policy_scope를 사용해 먼저 몇 개의 프로젝트에만 정책을 적용하고,
계속 게시해야 하는 서비스 계정은 우회 설정으로 예외 처리합니다.
다음 단계#
- 라이선스에 대한 규칙을 추가하거나 위험 심각도 임계값을 조정합니다.