InfoGrab DocsInfoGrab Docs

새 의존성 스캔, SBOM 스캔 API

요약

초점: 새 의존성 스캔 분석기가 GitLab SBOM Vulnerability Scan API를 호출하여 CycloneDX SBOM을 gl-dependency-scanning-report.json으로 변환하는 방식입니다.

초점: 새 의존성 스캔 분석기가 GitLab SBOM Vulnerability Scan API를 호출하여 CycloneDX SBOM을 gl-dependency-scanning-report.json으로 변환하는 방식입니다. 이 API는 서버 측에서 SBOM을 Package Metadata DB(PMDB) 권고와 대조하고 취약점 데이터를 결과 파일로 반환합니다. 이 흐름은 일시적이며 분석기 대상입니다. security_findings나 vulnerabilities를 생성하지 않으며, 이는 나중에 보고서가 수집될 때 생성됩니다 (CycloneDX에서 보안 발견 사항으로 참조).

dependency_scanning_sbom_scan_api 기능 플래그로 제어되며, 엔드포인트는 잡 토큰 인증을 사용합니다. 모든 경로는 ee/ 아래에 있습니다.

Mermaid 다이어그램 (19줄)
소스 코드 보기
flowchart TD
  A["CI job: new dependency-scanning analyzer<br/>generates a CycloneDX SBOM"] --> C["POST /jobs/:id/sbom_scans<br/>(upload SBOM + optional sbom_digest)"]
  %% preceded by POST /jobs/:id/sbom_scans/authorize (workhorse direct-upload authorize)
  C --> D["CreateSbomScanService#execute<br/>create ephemeral SbomScan; return advisory_db_state"]
  D --> F["ProcessSbomScanWorker"]
  F --> H["ProcessSbomScanService (async)"]

subgraph SCAN["async scan — does NOT write to Vulnerability Management"] H --> I["parse SBOM (Parsers::Sbom::Cyclonedx)<br/>validate: dependency_scanning source + GitLab taxonomy"] I --> J["VulnerabilityScanning::SecurityReportBuilder<br/>match components vs advisories (AdvisoryUtils + FindingBuilder)"] ADV[("pm_advisories / pm_affected_packages")] -.->|"advisory match"| J J --> K["Reports::Security::Report(:dependency_scanning)"] K --> L["save_result → result_file (JSON) on the ephemeral SbomScan"] end

A -.->|"optional: reuse by digest<br/>POST /sbom_scans/:sbom_digest (SbomScanResultCachingService)"| M L --> M["analyzer polls GET /jobs/:id/sbom_scans/:sbom_scan_id"] M --> N["analyzer writes gl-dependency-scanning-report.json"] N -.->|"later ingested by the pipeline"| O["gl-dependency-scanning-report.json path<br/>(see CycloneDX to security findings)"]

단계#

  1. 분석기가 SBOM을 생성합니다. 새 의존성 스캔 분석기가 CI 잡에서 실행되며, 의존성 스캔을 위한 GitLab CycloneDX 속성 분류 체계를 따르는 CycloneDX SBOM을 생성합니다.
  2. 업로드를 인가합니다. 분석기가 POST /jobs/:id/sbom_scans/authorize를 호출하며, 이 호출은 CreateSbomScanService#authorize를 사용하여 Workhorse 직접 업로드 헤더를 반환합니다(dependency_scanning_sbom_scan_api_upload로 속도가 제한됩니다).
  3. SBOM을 업로드합니다. POST /jobs/:id/sbom_scans가 파일을 업로드합니다. CreateSbomScanService#execute가 일시적인 SbomScan 레코드를 생성하고 ProcessSbomScanWorker를 통해 처리를 큐에 넣습니다. 응답에는 advisory_db_state(PMDB 권고 동기화 상태)가 포함되어, 분석기가 권고 데이터가 얼마나 최신인지 알 수 있습니다.
  4. 비동기 스캔. ProcessSbomScanService가 SBOM을 파싱하고 (Parsers::Sbom::Cyclonedx), dependency_scanning 소스의 cyclonedx인지 검증한 다음, VulnerabilityScanning::SecurityReportBuilder를 실행하여 AdvisoryUtils와 FindingBuilder로 컴포넌트를 PMDB 권고 (pm_advisories / pm_affected_packages)와 대조합니다. 이는 CycloneDX에서 보안 발견 사항으로 워크플로가 사용하는 것과 같은 빌더이지만, 여기서는 출력이 데이터베이스가 아니라 파일로 갑니다.
  5. 결과를 저장합니다. save_result가 결과로 나온 Reports::Security::Report(:dependency_scanning)를 일시적인 SbomScan에 연결된 JSON result_file로 저장합니다. security_findings나 vulnerabilities는 기록되지 않습니다.
  6. 폴링하고 다운로드합니다. 분석기가 GET /jobs/:id/sbom_scans/:sbom_scan_id를 폴링합니다. 진행 중이면 202, 완료되면 result_file과 함께 200, 실패하면 410을 반환합니다.
  7. 선택 사항, 다이제스트로 재사용합니다. 업로드하기 전에(또는 업로드하는 대신) 분석기가 POST /jobs/:id/sbom_scans/:sbom_digest(SbomScanResultCachingService)를 호출하여 동일한 SBOM 다이제스트와 purl 유형에 대한 기존 결과를 재사용하고 재스캔을 건너뛸 수 있습니다 (dependency_scanning_sbom_scan_api_reuse로 속도가 제한됩니다). 같은 잡에서 반복해서 호출하면 다른 스캔을 만들지 않고 해당 잡의 기존 스캔을 반환합니다.
  8. 보고서를 출력합니다. 분석기가 다운로드한 결과를 표준 의존성 스캔 보고서 아티팩트인 gl-dependency-scanning-report.json으로 기록합니다.
Note

이는 CycloneDX에서 보안 발견 사항으로 워크플로와 겹치는 부분입니다. 공유되는 부분은 cyclonedx SBOM 데이터로 취약점 보고서를 구성하는 로직인 VulnerabilityScanning::SecurityReportBuilder(AdvisoryUtils 및 FindingBuilder 포함)입니다. 두 워크플로는 같은 빌더를 실행하여 SBOM 컴포넌트를 PMDB 권고와 대조하고 Reports::Security::Report(:dependency_scanning)를 생성합니다. 차이는 그 보고서를 어떻게 처리하느냐뿐입니다. 이 API는 보고서를 result_file에 저장하고, 해당 워크플로는 security_findings로 수집합니다.

연결 방식: 여기서 생성된 보고서는 CycloneDX에서 보안 발견 사항으로 워크플로의 gl-dependency-scanning-report.json 경로의 입력이 되며, security_findings로 수집됩니다. 분석기가 이 API를 통해 이미 그 보고서를 생성했으므로, 같은 잡이 cyclonedx를 파이프라인 아티팩트로도 업로드하면 저장 단계는 이중 수집을 피하기 위해 cyclonedx 발견 사항 합성을 건너뜁니다.

관련 항목#

새 의존성 스캔, SBOM 스캔 API

GitLab v19.6
원문 보기

요약

초점: 새 의존성 스캔 분석기가 GitLab SBOM Vulnerability Scan API를 호출하여 CycloneDX SBOM을 gl-dependency-scanning-report.json으로 변환하는 방식입니다.

초점: 새 의존성 스캔 분석기가 GitLab SBOM Vulnerability Scan API를 호출하여 CycloneDX SBOM을 gl-dependency-scanning-report.json으로 변환하는 방식입니다. 이 API는 서버 측에서 SBOM을 Package Metadata DB(PMDB) 권고와 대조하고 취약점 데이터를 결과 파일로 반환합니다. 이 흐름은 일시적이며 분석기 대상입니다. security_findings나 vulnerabilities를 생성하지 않으며, 이는 나중에 보고서가 수집될 때 생성됩니다 (CycloneDX에서 보안 발견 사항으로 참조).

dependency_scanning_sbom_scan_api 기능 플래그로 제어되며, 엔드포인트는 잡 토큰 인증을 사용합니다. 모든 경로는 ee/ 아래에 있습니다.

Mermaid 다이어그램 (19줄)
소스 코드 보기
flowchart TD
  A["CI job: new dependency-scanning analyzer<br/>generates a CycloneDX SBOM"] --> C["POST /jobs/:id/sbom_scans<br/>(upload SBOM + optional sbom_digest)"]
  %% preceded by POST /jobs/:id/sbom_scans/authorize (workhorse direct-upload authorize)
  C --> D["CreateSbomScanService#execute<br/>create ephemeral SbomScan; return advisory_db_state"]
  D --> F["ProcessSbomScanWorker"]
  F --> H["ProcessSbomScanService (async)"]

subgraph SCAN["async scan — does NOT write to Vulnerability Management"] H --> I["parse SBOM (Parsers::Sbom::Cyclonedx)<br/>validate: dependency_scanning source + GitLab taxonomy"] I --> J["VulnerabilityScanning::SecurityReportBuilder<br/>match components vs advisories (AdvisoryUtils + FindingBuilder)"] ADV[("pm_advisories / pm_affected_packages")] -.->|"advisory match"| J J --> K["Reports::Security::Report(:dependency_scanning)"] K --> L["save_result → result_file (JSON) on the ephemeral SbomScan"] end

A -.->|"optional: reuse by digest<br/>POST /sbom_scans/:sbom_digest (SbomScanResultCachingService)"| M L --> M["analyzer polls GET /jobs/:id/sbom_scans/:sbom_scan_id"] M --> N["analyzer writes gl-dependency-scanning-report.json"] N -.->|"later ingested by the pipeline"| O["gl-dependency-scanning-report.json path<br/>(see CycloneDX to security findings)"]

단계#

  1. 분석기가 SBOM을 생성합니다. 새 의존성 스캔 분석기가 CI 잡에서 실행되며, 의존성 스캔을 위한 GitLab CycloneDX 속성 분류 체계를 따르는 CycloneDX SBOM을 생성합니다.
  2. 업로드를 인가합니다. 분석기가 POST /jobs/:id/sbom_scans/authorize를 호출하며, 이 호출은 CreateSbomScanService#authorize를 사용하여 Workhorse 직접 업로드 헤더를 반환합니다(dependency_scanning_sbom_scan_api_upload로 속도가 제한됩니다).
  3. SBOM을 업로드합니다. POST /jobs/:id/sbom_scans가 파일을 업로드합니다. CreateSbomScanService#execute가 일시적인 SbomScan 레코드를 생성하고 ProcessSbomScanWorker를 통해 처리를 큐에 넣습니다. 응답에는 advisory_db_state(PMDB 권고 동기화 상태)가 포함되어, 분석기가 권고 데이터가 얼마나 최신인지 알 수 있습니다.
  4. 비동기 스캔. ProcessSbomScanService가 SBOM을 파싱하고 (Parsers::Sbom::Cyclonedx), dependency_scanning 소스의 cyclonedx인지 검증한 다음, VulnerabilityScanning::SecurityReportBuilder를 실행하여 AdvisoryUtils와 FindingBuilder로 컴포넌트를 PMDB 권고 (pm_advisories / pm_affected_packages)와 대조합니다. 이는 CycloneDX에서 보안 발견 사항으로 워크플로가 사용하는 것과 같은 빌더이지만, 여기서는 출력이 데이터베이스가 아니라 파일로 갑니다.
  5. 결과를 저장합니다. save_result가 결과로 나온 Reports::Security::Report(:dependency_scanning)를 일시적인 SbomScan에 연결된 JSON result_file로 저장합니다. security_findings나 vulnerabilities는 기록되지 않습니다.
  6. 폴링하고 다운로드합니다. 분석기가 GET /jobs/:id/sbom_scans/:sbom_scan_id를 폴링합니다. 진행 중이면 202, 완료되면 result_file과 함께 200, 실패하면 410을 반환합니다.
  7. 선택 사항, 다이제스트로 재사용합니다. 업로드하기 전에(또는 업로드하는 대신) 분석기가 POST /jobs/:id/sbom_scans/:sbom_digest(SbomScanResultCachingService)를 호출하여 동일한 SBOM 다이제스트와 purl 유형에 대한 기존 결과를 재사용하고 재스캔을 건너뛸 수 있습니다 (dependency_scanning_sbom_scan_api_reuse로 속도가 제한됩니다). 같은 잡에서 반복해서 호출하면 다른 스캔을 만들지 않고 해당 잡의 기존 스캔을 반환합니다.
  8. 보고서를 출력합니다. 분석기가 다운로드한 결과를 표준 의존성 스캔 보고서 아티팩트인 gl-dependency-scanning-report.json으로 기록합니다.
Note

이는 CycloneDX에서 보안 발견 사항으로 워크플로와 겹치는 부분입니다. 공유되는 부분은 cyclonedx SBOM 데이터로 취약점 보고서를 구성하는 로직인 VulnerabilityScanning::SecurityReportBuilder(AdvisoryUtils 및 FindingBuilder 포함)입니다. 두 워크플로는 같은 빌더를 실행하여 SBOM 컴포넌트를 PMDB 권고와 대조하고 Reports::Security::Report(:dependency_scanning)를 생성합니다. 차이는 그 보고서를 어떻게 처리하느냐뿐입니다. 이 API는 보고서를 result_file에 저장하고, 해당 워크플로는 security_findings로 수집합니다.

연결 방식: 여기서 생성된 보고서는 CycloneDX에서 보안 발견 사항으로 워크플로의 gl-dependency-scanning-report.json 경로의 입력이 되며, security_findings로 수집됩니다. 분석기가 이 API를 통해 이미 그 보고서를 생성했으므로, 같은 잡이 cyclonedx를 파이프라인 아티팩트로도 업로드하면 저장 단계는 이중 수집을 피하기 위해 cyclonedx 발견 사항 합성을 건너뜁니다.

관련 항목#