Code test

사용법

snyk code test [<OPTIONS>] [<PATH>]

설명

snyk code test 명령은 알려진 보안 문제에 대한 소스 코드를 테스트합니다 (정적 애플리케이션 보안 테스트).

종료 코드

가능한 종료 코드 및 그 의미:

0: 성공 (스캔 완료), 취약점 없음 1: 조치 필요 (스캔 완료), 취약점 발견 2: 실패, 명령을 다시 실행하십시오. 디버그 로그를 출력하려면 -d를 사용하십시오. 3: 실패, 지원되는 프로젝트가 감지되지 않았습니다.

Snyk CLI 구성

디버그

디버그 로그를 출력하려면 -d 옵션을 사용하십시오.

옵션

--report

Snyk 웹 UI와 결과를 공유합니다.

이렇게 하면 Snyk 계정에 현재 문제의 스냅샷이 있는 프로젝트가 생성되거나 기존 프로젝트에 스냅샷이 추가됩니다.

이 옵션을 사용한 후 Snyk 웹사이트에 로그인하여 프로젝트를 보고 스냅샷을 확인하십시오.

예시: $ snyk code test --report

--project-name=<PROJECT_NAME>

--report를 사용할 때 필수입니다. 사용자 지정 Snyk 프로젝트 이름을 지정합니다.

예시: $ snyk code test --report --project-name=my-project

--target-name=<TARGET_NAME>

--report 옵션과 함께 사용할 수 있습니다.

프로젝트의 대상 이름을 설정하거나 재정의합니다.

--target-reference=<TARGET_REFERENCE>

--report 옵션과 함께 사용할 수 있습니다.

이 프로젝트를 구별하는 참조(예: 분기 이름 또는 버전)를 지정합니다. 동일한 참조를 가진 프로젝트는 해당 참조를 기반으로 그룹화될 수 있습니다.

현재 Git 분기로 설정하는 예시:

snyk code test --report --target-reference="$(git branch --show-current)"

최신 Git 태그로 설정하는 예시:

snyk code test --report --target-reference="$(git describe --tags --abbrev=0)"

--remote-repo-url=<URL>

리포지토리의 원격 URL을 설정하거나 재정의합니다.

예시: --remote-repo-url=https://gitlab.com/example/project는 주어진 URL에 대한 대상을 생성하고 UI에서는 /example/project/로 표시됩니다.

--org=<ORG_ID>

특정 Snyk 조직에 연결된 Snyk 명령을 실행하려면 <ORG_ID>를 지정합니다. <ORG_ID>는 개인 테스트 제한에 영향을 미칩니다.

여러 조직이 있는 경우 CLI에서 다음을 사용하여 기본값을 설정할 수 있습니다.

$ snyk config set org=<ORG_ID>

모든 새로 테스트된 프로젝트가 기본 조직에서 테스트되도록 기본값을 설정합니다. 기본값을 재정의해야 하는 경우 --org=<ORG_ID> 옵션을 사용하십시오.

기본값: 계정 설정에서 현재 선호하는 조직인 <ORG_ID>

참고: --org=<orgslugname>을 사용할 수도 있습니다. ORG_ID는 CLI와 API 모두에서 작동합니다. 조직 슬러그 이름은 CLI에서는 작동하지만 API에서는 작동하지 않습니다.

orgslugname은 Snyk UI에서 조직 URL에 표시된 슬러그 이름과 일치해야 합니다. https://app.snyk.io/org/[orgslugname]. orgname은 작동하지 않습니다.

자세한 내용은 CLI에서 사용할 조직을 선택하는 방법 문서를 참조하십시오.

--json

결과를 JSON 데이터 구조로 콘솔에 인쇄합니다.

예시: $ snyk code test --json

--json-file-output=<OUTPUT_FILE_PATH>

--json 옵션을 사용하든 안 하든 상관없이 테스트 출력을 JSON 데이터 구조로 지정된 파일에 직접 저장합니다.

표준 출력을 사용하여 사람이 읽을 수 있는 테스트 출력을 표시하고 동시에 JSON 데이터 구조 출력을 파일에 저장하는 데 사용됩니다.

SAST의 경우 문제가 발견되지 않으면 Snyk은 json 파일을 생성하지 않습니다. 반면 오픈소스의 경우 Snyk은 문제가 발견되든 안 되든 파일을 생성합니다.

예시: $ snyk code test --json-file-output=vuln.json

--sarif

결과를 SARIF 형식으로 반환합니다.

예시: $ snyk code test --sarif

--sarif-file-output=<OUTPUT_FILE_PATH>

--sarif 옵션을 사용하든 안 하든 상관없이 테스트 출력을 SARIF 형식으로 <OUTPUT_FILE_PATH> 파일에 직접 저장합니다.

이는 표준 출력을 사용하여 사람이 읽을 수 있는 테스트 출력을 표시하고 동시에 SARIF 형식 출력을 파일에 저장하려는 경우에 특히 유용합니다.

--severity-threshold=<low|medium|high>

지정된 수준 이상의 취약점만 보고합니다.

참고: Snyk Code 구성 문제는 critical 심각도 수준을 사용하지 않습니다.