프로젝트 가져오기에서 디렉토리 및 파일 제외
파일은 재테스트에서 제외되므로 Snyk Code에 의해 테스트되지 않으며 코드 분석 결과에 나타나지 않습니다. SCM 통합을 통해 프로젝트를 가져오는 경우, 가져오기 창 하단에 폴더만 제외 대상으로 추가하십시오.
Snyk Code에서 테스트할 리포지토리를 가져올 때, .snyk 파일을 사용하여 가져오기 프로세스에서 특정 디렉토리와 파일을 제외할 수 있습니다. .snyk 파일은 쉘 매칭 패턴(정규 표현식)을 포함할 수 있는 YAML 정책 파일로, 가져오기 프로세스에서 제외할 디렉토리와 파일을 지정할 수 있게 해줍니다. .snyk 파일은 가져오려는 리포지토리에 생성되어야 합니다.
Snyk Code에서
.snyk파일은 가져오기에서 디렉토리 및 파일을 제외하는 용도로만 사용할 수 있습니다. 다른 Snyk 제품에서와 같이 취약점을 무시하거나 다른 작업에는 사용할 수 없습니다.현재
.snyk파일의exclude옵션은 Snyk 웹 UI 및 CLI 환경에만 적용됩니다. IDE 환경에서 Snyk Code를 사용할 때는exclude옵션을 사용할 수 없습니다.특정 상황에서 잘못된
.snyk파일이 있는 경우 제외된 파일이 제외되지 않을 수 있습니다. 이러한 상황에서는.snyk파일 없이 스캔이 계속됩니다.
프로덕션에 게시하거나 컴파일하지 않는 디렉토리와 파일만 제외하는 것을 고려하십시오. 기존 취약점이 있는 제외된 파일이나 디렉토리를 통해 추적이 진행되는 경우, Snyk이 잠재적인 문제를 놓칠 수 있습니다.
테스트된 리포지토리에 .snyk 파일을 생성하여 Snyk Code CLI 테스트에서 디렉토리 및 파일을 제외하는 데 이 섹션의 지침을 사용할 수도 있습니다.
.snyk 파일의 제외 구문
Snyk Code 테스트에서 파일 및 디렉토리를 제외하는 데 사용하는 구문
.snyk 파일을 사용하여 파일과 디렉토리를 제외하려면 다음 구문을 사용하십시오.
global 또는 code를 사용할 수 있습니다. 둘 중 하나는 Snyk 코드 테스트에서 지정된 디렉토리와 파일을 제외합니다. code는 Snyk Code 분석에만 적용됩니다. global은 현재 Snyk Code를 사용한 분석에만 적용되지만 향후 다른 제품에도 적용될 수 있습니다.
.snyk 파일 생성 시 고려 사항
규칙의 경로는
.snyk파일 위치를 기준으로 상대적이어야 합니다../로 시작하는 경로를 사용하지 마십시오.유효한 규칙이 되려면 모든 규칙 앞에 대시가 있어야 합니다:
- <exclusion_rule>별표 문자
*와 같은 특수 문자 및 패턴으로 시작하는 규칙의 경우 큰따옴표(" ")로 묶어야 합니다. 이렇게 하면 규칙이 단일 엔티티로 처리되어 잠재적인 오해나 의도하지 않은 동작을 방지할 수 있습니다. 예:"*/src"들여쓰기 사용 시 다음 사항을 고려하십시오.
.snykYAML 파일에서 구문을 사용할 때 줄 바꿈과 들여쓰기에 주의하십시오. 잘못된 들여쓰기를 사용하면 제외 사양이 실행되지 않습니다.들여쓰기에 탭을 사용하지 마십시오. 들여쓰기에는 공백(space)만 사용하십시오.
구문을 올바르게 사용하고 있는지 확인하려면 YAML Lint와 같은 YAML 유효성 검사기를 사용할 수 있습니다. 일부 YAML 유효성 검사기는 들여쓰기에 탭과 공백의 사용을 구분하지 못할 수 있음에 유의하십시오. 탭을 사용하는 경우 유효성 검사기가 구문을 승인할 수 있지만 제외 사양은 실행되지 않습니다.
쉘 매칭 패턴 구문에 대한 자세한 내용은 예를 들어 다음을 참조하십시오.
GNU Org - Shell Pattern Matching
.snyk 파일을 사용하여 가져오기에서 디렉토리 및 파일 제외
.snyk 파일을 사용하여 가져오기 프로세스에서 디렉토리 및 파일을 제외하려면 다음 단계를 따르십시오.
1. 가져오려는 리포지토리에 .snyk이라는 YAML 파일을 생성합니다. 예:
.snyk 파일.2. .snyk 파일에 다음 구문에 따라 가져오기에서 제외할 디렉토리 또는 파일 또는 둘 다를 지정합니다.
예:
3. Snyk 웹 UI에서 다음 방법 중 하나로 리포지토리를 가져옵니다.
리포지토리가 이미 Snyk에 가져온 상태라면 다음과 같이 리포지토리를 재테스트합니다.
프로젝트(Projects) 페이지에서 리포지토리의 코드 분석(Code analysis) 프로젝트를 클릭합니다. 그런 다음 코드 분석 페이지에서 **지금 다시 테스트(Retest now)**를 클릭합니다.
리포지토리를 아직 Snyk에 가져오지 않았다면 리포지토리를 가져옵니다.
제외하도록 선택한 디렉토리 및/또는 파일 없이 리포지토리가 Snyk으로 가져와집니다.
예제: Snyk Code 분석에서 두 개의 파일 제외
Snyk Code를 사용하여 취약점을 테스트하려는 snyk-goof라는 리포지토리가 있습니다. 이 리포지토리를 Snyk으로 가져온 후, 세 개의 파일에서 발견된 10개의 취약점 문제 목록을 얻습니다.
이제 Snyk Code 분석에서 app.js 및 db.js 파일을 제외하려고 합니다. 이를 위해 다음을 수행합니다.
1. GitHub의 snyk-goof 리포지토리에 .snyk 파일을 생성합니다.
.snyk 파일이 생성된 snyk-goof 리포지토리2. .snyk 파일에 app.js 및 db.js 파일을 가져오기에서 제외하기 위해 다음 명령을 입력합니다.
.snyk 파일 명령3. 리포지토리의 코드 분석 페이지에서 **지금 다시 테스트(Retest now)**를 클릭하여 "snyk-goof" 리포지토리를 재테스트합니다.
app.js 및 db.js 파일은 재테스트에서 제외되므로 Snyk Code에 의해 테스트되지 않으며 코드 분석 결과에 나타나지 않습니다. 이제 5개의 취약점 문제만 발견됩니다.
Last updated