Snyk Docker 액션

이 페이지는 Docker용 Snyk GitHub 액션 사용 지침 및 예시를 제공합니다. 일반적인 지침 및 정보는 Snyk 설정 및 취약점 확인을 위한 GitHub 액션을 참조하십시오.

Docker 액션을 사용하려면 Snyk API 토큰이 있어야 합니다. Snyk 토큰 가져오기를 참조하거나 무료로 가입할 수 있습니다.

Snyk Docker 액션을 사용하여 취약점 확인

Snyk Docker 액션을 사용하여 Docker 이미지의 취약점을 다음과 같이 확인할 수 있습니다.

name: Snyk을 사용하는 Docker용 예제 워크플로 
on: push
jobs:
  security:
    runs-on: ubuntu-latest
    steps:
    - name: Snyk을 실행하여 Docker 이미지의 취약점 확인
      uses: snyk/actions/docker@master
      env:
        SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
      with:
        image: your/image-to-test

Snyk Docker 액션 속성

Snyk Docker 액션에는 기본 이미지에 전달되는 속성이 있습니다. 이 속성은 with를 사용하여 액션에 전달됩니다.

속성	기본값	설명
args		Snyk 이미지에 대한 기본 인수를 재정의합니다.
command	test	test 또는 monitor와 같은 실행할 명령을 지정합니다.
image		테스트할 이미지의 이름입니다.
json	false	표준 출력 외에 결과를 snyk.json으로 저장합니다.
sarif	true	표준 출력 외에 결과를 snyk.sarif로 저장합니다.

예를 들어 Snyk Docker 액션을 사용하여 심각도가 높은 취약점만 다음과 같이 확인할 수 있습니다.

name: Snyk을 사용하는 Docker용 예제 워크플로 
on: push
jobs:
  security:
    runs-on: ubuntu-latest
    steps:
    - name: Snyk을 실행하여 Docker 이미지의 취약점 확인
      uses: snyk/actions/docker@master
      env:
        SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
      with:
        image: your/image-to-test
        args: --severity-threshold=high

Snyk Docker 액션을 사용하여 GitHub 코드 스캔에 Snyk 스캔 결과 업로드

Docker 액션은 또한 GitHub 코드 스캔과 통합을 지원하며 GitHub 보안 탭에 문제를 표시할 수 있습니다. args에서 --file=Dockerfile로 Dockerfile을 참조하는 한 snyk.sarif 파일이 생성되며, 이 파일은 GitHub 코드 스캔에 업로드할 수 있습니다.

name: Snyk 컨테이너
on: push
jobs:
  snyk:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Docker 이미지 빌드
      run: docker build -t your/image-to-test .
    - name: Snyk을 실행하여 Docker 이미지의 취약점 확인
      # Snyk은 취약점을 감지하면 빌드를 중단하는 데 사용될 수 있습니다.
      # 이 경우 GitHub 코드 스캔에 문제를 업로드하려고 합니다.
      continue-on-error: true
      uses: snyk/actions/docker@master
      env:
        # Snyk 액션을 사용하려면 Snyk API 토큰이 필요합니다.
        # https://docs.snyk.io/integrations/ci-cd-integrations/github-actions-integration#getting-your-snyk-token
        # 또는 https://snyk.io/login에서 무료로 가입할 수 있습니다.
        SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
      with:
        image: your/image-to-test
        args: --file=Dockerfile
    - name: 결과를 GitHub 코드 스캔에 업로드
      uses: github/codeql-action/upload-sarif@v3
      with:
        sarif_file: snyk.sarif

비공개 리포지토리에서 upload-sarif 옵션을 사용하려면 GitHub Advanced Security가 활성화되어 있어야 합니다.

Advanced Security must be enabled for this repository to use code scanning 오류가 표시되면 GitHub Advanced Security가 활성화되어 있는지 확인하십시오. 자세한 내용은 리포지토리 보안 및 분석 설정 관리를 참조하십시오.