Snyk Code CLI 결과 보기

Snyk CLI를 사용하면 snyk code test 명령의 결과에 대해 다음 작업을 수행할 수 있습니다.

• Snyk Code CLI 결과 분석: 테스트 결과를 보고 취약점을 분석합니다.

• 심각도 수준별 결과 필터링: 터미널에 표시된 snyk code test 결과를 필터링하여 특정 심각도 수준 이상의 문제만 표시합니다.

• 테스트 결과 출력: 결과를 표준 CLI 형식으로 표시하는 대신 터미널에서 snyk code test 결과를 JSON 또는 SARIF 형식으로 출력합니다.

• 테스트 결과 내보내기: CLI Code 결과를 JSON 또는 SARIF 형식 파일로 내보냅니다.

snyk code test의 경우 JSON 및 SARIF 형식은 동일하므로 예제는 한 가지 형식으로만 표시됩니다.

snyk-to-html을 사용하여 CLI 결과를 HTML 형식으로 표시할 수도 있습니다.

Snyk Code CLI 결과 분석

CLI에서 snyk code test 명령을 실행하면 테스트 결과가 표시됩니다.

CLI의 Snyk Code 테스트 결과

Snyk 웹 UI에서 문제를 무시한 경우에도 해당 문제가 CLI 결과에 계속 나타날 수 있습니다. 이 페이지의 각 섹션은 표시된 결과의 한 섹션을 설명합니다.

Snyk Code에 의해 감지된 취약점 문제 목록

Snyk Code 테스트에서 발견된 문제 목록은 낮음에서 높음까지 문제의 심각도 수준별로 구성됩니다.

감지된 각 문제에 대해 다음 정보가 제공됩니다.

각 Snyk Code 문제에 대한 CLI 테스트 정보

• 헤더: 문제의 심각도 수준 및 취약점 유형.

• 경로: 문제가 발견된 파일 이름과 파일의 줄. 이러한 위치 세부 정보는 문제의 싱크(sink), 즉 테스트된 리포지토리에서 취약점이 실행될 수 있는 위치를 나타냅니다.

• 정보: 문제의 데이터 흐름에 대한 설명.

Info 섹션에 나타나는 메시지는 웹 UI의 데이터 흐름(Data flow) 섹션에 있는 메시지와 동일합니다.

데이터 흐름 섹의 Snyk Code 문제에 대한 CLI 테스트 정보

테스트 결과에 대한 일반 정보

테스트 결과에 대한 일반 정보에는 다음 세부 정보가 포함됩니다.

CLI 테스트 결과의 일반 정보 세부 정보

• 테스트 성공: 테스트가 완료되었는지 여부.

• 조직: 테스트가 실행된 조직의 Snyk ID 또는 내부 이름입니다. 자세한 내용은 CLI 테스트를 위한 Snyk 조직 설정을 참조하십시오.

• 테스트 유형: 결과를 생성한 테스트 명령의 유형입니다. Snyk Code의 경우 항상 Static code analysis입니다.

• 프로젝트 경로: 테스트된 리포지토리의 경로입니다.

테스트 결과 요약

테스트 결과 요약에는 다음 세부 정보가 포함됩니다.

Snyk Code 문제에 대한 CLI 테스트 결과 요약

• Snyk Code가 테스트된 리포지토리에서 발견한 취약점 문제의 수.

• 각 심각도 수준에서 발견된 문제의 수.

snyk code test 명령에는 종료 코드가 있습니다. 이러한 코드의 정의에 대한 도움말을 참조하십시오. 종료 코드를 보려면 snyk code test -d를 실행하십시오.

모든 CLI 명령에 대한 종료 코드 요약은 CLI 명령 및 옵션 요약을 참조하십시오.

심각도 수준별 결과 필터링

CLI 터미널에 표시되는 테스트 결과를 필터링하여 특정 심각도 수준 이상의 문제만 표시할 수 있습니다.

특정 심각도 수준 이상의 문제만 표시하려면 다음을 입력합니다.

snyk code test <path/to/folder> --severity-threshold=<low|medium|high>

결과에는 지정된 심각도 수준의 문제와 더 높은 심각도 수준의 문제만 포함됩니다.

예를 들어 snyk-goof-master 폴더에서 8개의 문제가 발견되었으며, 4개는 높음(High) 심각도 수준이고 4개는 중간(Medium)입니다.

높음 및 중간 심각도의 Snyk Code에 대한 CLI 테스트 결과

높음 심각도 수준 이상의 문제만 표시하려면 다음을 입력합니다.

snyk code test /Users/username/Documents/Repositories/snyk-goof-master --severity-threshold=high

결과에는 높음 심각도 수준의 4개 문제만 표시됩니다. 낮은 심각도 수준의 문제는 표시되지 않습니다.

높음 심각도의 Snyk Code에 대한 CLI 테스트 결과

JSON 및 SARIF 파일의 심각도 수준

snyk code test를 실행하여 발견된 문제의 심각도 수준은 JSON 및 SARIF 파일에서 다르게 표시됩니다. JSON 및 SARIF 결과의 심각도 수준은 다음과 같습니다.

• 높음(High) = error

• 중간(Medium) = warning

• 낮음(Low) = note/info

치명적(Critical) 지정은 Snyk Code에서 사용되지 않습니다.

터미널에 표시된 중간 수준 심각도의 예시는 다음과 같습니다.

JSON 또는 SARIF 출력의 중간 심각도

다음은 파일의 높음 수준 및 낮음 수준 심각도의 예시를 보여줍니다.

JSON 또는 SARIF 파일의 높음 및 낮음 심각도 수준

테스트 결과 출력

결과를 Snyk CLI 형식으로 표시하는 대신 터미널에서 snyk code test 결과를 JSON 또는 SARIF 형식으로 출력할 수 있습니다.

테스트 결과를 JSON 또는 SARIF 형식 파일로 내보낼 수도 있습니다. SARIF는 정적 분석 도구의 출력을 위한 개방형 표준입니다. 자세한 내용은 SARIF 사이트를 참조하십시오.

snyk code test를 실행하여 발견되고 JSON 및 SARIF 파일에 보고된 문제의 심각도 수준은 터미널의 결과와 다르게 표시됩니다. 자세한 내용은 JSON 및 SARIF 파일의 심각도 수준을 참조하십시오.

테스트 결과를 JSON 형식으로 출력하려면 다음을 입력합니다.

snyk code test <path/to/folder> --json

테스트 결과를 SARIF 형식으로 출력하려면 다음을 입력합니다.

snyk code test <path/to/folder> --sarif

테스트 결과가 터미널에 JSON 또는 SARIF 형식으로 나타납니다.

snyk code test의 경우 JSON 및 SARIF가 동일하므로 여기에는 JSON 예제만 표시됩니다. 이 예제는 다음 명령을 사용하여 터미널에서 snyk-goof-master 폴더의 테스트 결과를 JSON 형식으로 출력하는 방법을 보여줍니다.

snyk code test /Users/username/Documents/Repositories/snyk-goof-master --json

테스트 결과가 터미널에 JSON 형식으로 나타납니다.

snyk code test 결과 (JSON 형식)

테스트 결과 내보내기

snyk code test 결과를 JSON 또는 SARIF 형식 파일로 내보낼 수 있습니다. 결과를 내보낼 때 새 파일의 이름을 제공해야 합니다.

터미널에서 테스트 결과를 JSON 또는 SARIF 형식으로 출력할 수도 있습니다.

snyk code test를 실행하여 발견되고 JSON 및 SARIF 파일에 보고된 문제의 심각도 수준은 터미널의 결과와 다르게 표시됩니다. 자세한 내용은 JSON 및 SARIF 파일의 심각도 수준을 참조하십시오.

결과를 JSON 또는 SARIF 파일로 내보내기 위해 두 가지 방법을 사용할 수 있습니다. 다음 지침은 JSON 파일을 보여주지만 SARIF 파일도 내보낼 수 있습니다.

터미널에 표준 결과 표시와 함께 결과를 새 파일로 내보내기

snyk code test --json-file-output=<path/to/new_file> 명령은 Snyk CLI v. 1.910.0 이상에서 사용할 수 있습니다. Snyk CLI 버전을 업데이트하려면 Snyk CLI 설치 또는 업데이트를 참조하십시오.

터미널에 표준 결과 표시와 함께 결과를 새 JSON 파일로 내보내려면 다음 명령을 사용하십시오.

snyk code test --json-file-output=<path/to/new_json_file>

테스트 결과를 새 SARIF 파일로 내보내려면 다음 명령을 사용하십시오.

snyk code test --sarif-file-output=<path/to/new_sarif_file>

테스트 결과가 표준 형식으로 터미널에 나타나고 지정한 경로에 JSON 또는 SARIF 파일이 생성됩니다.

snyk code test의 경우 JSON 및 SARIF가 동일하므로 여기에는 JSON 예제만 표시됩니다. snyk-goof-master 폴더의 테스트 결과를 json이라는 JSON 파일로 내보내려면 리포지토리의 루트 폴더로 디렉토리를 변경하고 다음을 입력합니다.

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

터미널에 Code 테스트 결과가 표준 형식으로 나타납니다.

터미널의 snyk code test 결과

리포지토리 폴더에 JSON 파일이 생성됩니다.

리포지토리의 JSON 파일

터미널에 결과 표시 없이 결과를 새 파일로 내보내기

터미널에 결과를 표시하지 않고 결과를 새 JSON 파일로 내보내려면 다음 명령을 사용하십시오.

snyk code test --json > <path/to/new_json_file>

터미널에 결과를 표시하지 않고 결과를 SARIF 파일로 내보내려면 다음 명령을 사용하십시오.

snyk code test --sarif > <path/to/new_sarif_file>