snyk-to-html

CLI는 빌드를 실패시키는 직접적이거나 자동화된 방법을 제공하며, --json 또는 --sarif 형식을 사용하지 않으면 기본적으로 요약 정보만 제공합니다. 이 출력을 파일로 보낼 수 있습니다. 이러한 파일에는 발견된 문제가 포함됩니다. 형식은 사람이 읽을 수 없습니다.

snyk-to-html (Snyk JSON to HTML Mapper)을 사용하여 다음을 수행할 수 있습니다.

• 스캔 출력의 일부로 읽을 수 있는 빌드 아티팩트 생성

• 브라우저에서 볼 수 있는 취약점의 전체 컨텍스트 HTML 보고서 생성

이 페이지에서는 snyk-to-html 설치, JSON 또는 SARIF 형식의 테스트 결과를 HTML 파일로 내보내는 snyk-to-html 도구 사용 및 브라우저에서 테스트 결과 보기 방법을 설명합니다.

오픈소스(SCA) 스캔의 경우 json 출력만 지원됩니다. sarif 출력은 오픈소스 테스트에 대해 snyk-to-html 프로세스에서 결과가 반환되지 않습니다.

snyk-to-html 설치

snyk-to-html을 설치하려면 시스템에 필요한 권한이 있어야 합니다. 설치에 실패하면 IT 관리자에게 필요한 권한을 요청하십시오.

npm을 사용하여 snyk-to-html을 설치할 수 있습니다.

npm install snyk-to-html -g

snyk-to-html 플러그인을 로컬에 설치하려면 snyk-to-html GitHub 리포지토리를 복제하고 스크립트를 사용하십시오.

npm install
npm run build
node ./dist/index.js

snyk-to-html 도구 사용

snyk-to-html을 snyk test 명령의 일부로 실행하여 테스트 출력의 일부로 읽을 수 있는 빌드 아티팩트를 생성할 수 있습니다.

또한 결과를 JSON 파일로 내보내는 옵션으로 snyk test 명령을 실행한 다음 snyk-to-html을 사용하여 JSON 파일을 HTML로 변환할 수 있습니다. Snyk Code 결과를 JSON 또는 SARIF 파일로 내보내고 해당 파일을 HTML로 변환할 수 있습니다.

snyk-to-html 명령을 실행할 때 다음 명령 옵션으로 사용자 지정할 수 있습니다.

짧게	길게	설명	기본값
-i	--input	테스트 결과가 포함된 JSON 또는 SARIF 파일의 입력 경로입니다. SARIF 형식은 오픈소스 스캔 결과에는 지원되지 않습니다.	stdin
-o	--output	HTML 결과의 출력 파일 이름 앞에 붙습니다. 예시: -o results.html	stdout
-t	--template	HTML 생성을 위한 템플릿 위치입니다.	template/test-report.hbs
-s	--summary	세부 정보 보고서 대신 요약만 포함된 HTML 파일을 생성합니다.	세부 정보 취약점 보고서
-a	--actionable-remediation	사용 가능한 경우 실행 가능한 해결 정보를 표시합니다.	해당 없음
-d	--debug	디버그 모드에서 명령을 실행합니다.	해당 없음

snyk-to-html 명령은 표준 종료 코드를 생성하지 않습니다.

snyk-to-html에 대한 도움말을 표시하려면 snyk-to-html --help 또는 --h 명령을 사용하십시오.

CI/CD 파이프라인에서 snyk-to-html 명령을 사용하려면 Azure Pipelines에 대한 해결 방법 예시는 Snyk CI/CD 통합 예제를 참조하십시오.

자세한 내용은 snyk-to-html 명령 옵션 사용을 참조하십시오.

테스트 출력의 일부로 읽을 수 있는 빌드 아티팩트 생성

snyk test 명령의 일부로 snyk-to-html을 실행하여 빌드 아티팩트를 생성하려면 다음 단계를 따르십시오. 이렇게 하면 결과가 snyk-to-html로 직접 스트리밍됩니다.

1. 테스트하려는 리포지토리의 루트 폴더로 디렉토리를 변경합니다.

2. 리포지토리를 테스트하고 결과를 JSON 형식으로 내보내고 플러그인을 사용하여 출력을 results-[scantype].html이라는 HTML 파일로 변환합니다.

각 Snyk 스캔 방법에 사용할 명령은 다음과 같습니다. 명령을 실행하면 이 예시의 이름 중 하나를 가진 HTML 파일이 리포지토리 폴더에 생성되어 HTML 형식으로 테스트 결과 보기를 할 수 있습니다.

Snyk 오픈소스 명령

results-opensource.html이라는 파일을 생성하려면 다음 줄을 실행하십시오.

snyk test --json | snyk-to-html -o results-opensource.html

Snyk 컨테이너 명령

results-container.html이라는 파일을 생성하려면 다음을 실행하십시오.

snyk container test [image] --json | snyk-to-html -o results-container.html

Snyk 코드 명령

results-code.html이라는 파일을 생성하려면 다음을 실행하십시오.

snyk code test --json | snyk-to-html -o results-code.html

Snyk IaC 명령

관련 파일이 있는 하위 폴더로 이동하여 results-iac.html이라는 파일을 생성하려면 다음 줄을 실행하십시오.

snyk iac test --json | snyk-to-html -o results-iac.html

브라우저에서 볼 HTML로 JSON 또는 SARIF 파일 변환

자동화를 위해 결과에 대한 프로그래밍 방식 액세스를 위해 JSON 파일을 생성하거나 이전 스캔에서 이미 가지고 있을 수 있습니다. 이 JSON 출력을 snyk-to-html로 보내 HTML 파일을 생성할 수 있습니다.

snyk test를 실행한 다음 출력 파일을 HTML로 변환하려면 다음 단계를 따르십시오.

1. 테스트하려는 리포지토리의 루트 폴더로 디렉토리를 변경합니다.

2. 각 제품에 대해 적절한 test 명령을 실행합니다. snyk test --json-file-output=results-opensource.json

   snyk code test --json-file-output=results-code.json

   snyk container test [image] --json-file-output=results-container.json

   snyk iac test --json-file-output=results-iac.json

   출력을 도구로 파이프하기 전에 종료 코드가 프로세스를 중지하면 다음 참고 사항을 참조하십시오.

3. JSON 파일을 snyk-to-html로 전달하여 HTML로 변환합니다. 입력 파일은 유효한 JSON이어야 하며 UTF-8 인코딩을 사용해야 합니다. 생성한 출력 파일의 이름을 사용해야 합니다. snyk-to-html -i results-opensource.json -o results-opensource.html snyk-to-html -i results-code.json -o results-code.html snyk-to-html -i results-container.json -o results-container.html snyk-to-html -i results-iac.json -o results-iac.html

snyk test --json > result-opensource.json과 같이 여러 단계 접근 방식을 사용하고 결과를 플러그인에 전달할 때 종료 코드는 snyk-to-html 또는 snyk-filter와 같은 도구에 출력 파일을 전달하는 단계에 도달하기 전에 빌드 시스템에서 프로세스를 중지하거나 중단할 수 있습니다. 빌드 도구의 기능에 따라 몇 가지 옵션이 있습니다.

1. 종료 코드를 매개변수에 캡처하여 오류 상태 확인 외에 프로세스로 반환되는 것을 방지합니다.

2. ||true 또는 특정 논리를 사용하여 종료 코드가 프로세스를 종료하는 것을 방지합니다. 이 작업을 수행할 때는 네트워크 또는 Snyk 플랫폼 문제 또는 기타 스캔 결과가 아닌 문제와 같은 오류 상태를 나타내는 모든 반환 코드가 무시된다는 점에 유의하십시오. JSON 사용의 다음 단계는 실패할 가능성이 있습니다. 스크립트의 다음 단계로 진행하기 전에 종료 코드를 검토하는 것이 좋습니다.

3. 그러한 옵션이 있는 경우 단계를 continue on failure로 설정합니다.

snyk-to-html 명령 옵션 사용

다음 예시는 snyk 테스트 명령을 보여주지만 컨테이너, 코드 및 IaC에 대한 snyk test 명령에서도 작동합니다.

보고서의 간단한 버전 표시

-s 또는 --summary 옵션을 사용하여 보고서의 요약만 표시합니다.

snyk-to-html -i results.json -o results.html -s

실행 가능한 해결책 표시

취약점을 해결하기 위해 취할 수 있는 조치를 표시하려면 -a 또는 --actionable-remediation 옵션을 사용하십시오.

snyk-to-html -i results.json -o results.html -a

보고서는 수정, 업그레이드 및 패치를 수정이 해결하는 취약점 수와 심각도별로 순서를 지정합니다. 이를 가이드로 사용하여 패키지 업그레이드 및 패치 순서를 선택할 수 있습니다.

Snyk은 다음 패키지 관리자에 대한 해결책 권고를 지원합니다.

• npm

• Yarn

• RubyGems

• Maven

• Gradle

• sbt

• Pip

HTML 형식으로 테스트 결과 보기

HTML 파일을 보려면 리포지토리에서 출력 파일을 찾아 두 번 클릭합니다. HTML 파일에 다른 이름을 사용한 경우 해당 파일을 찾아 엽니다.

테스트 결과 보고서가 브라우저에서 열립니다. 다음 예시는 snyk code test 결과를 보여줍니다. 각 문제에 해당하는 버튼을 클릭하여 발견된 문제에 대한 데이터 흐름 및 수정 분석 정보를 볼 수 있습니다.

문제에 대한 데이터 흐름 및 수정 분석 버튼을 강조 표시하는 Snyk 코드 보고서

라이선스

라이선스: Apache 라이선스, 버전 2.0