AdvancedSecurity-Codeql-Init@1 - 고급 보안 CodeQL v1 작업 초기화

아티클
05/14/2024

빌드를 준비하기 위해 CodeQL 데이터베이스를 초기화합니다.

검사 중인 리포지토리에 대해 Azure DevOps에 대한 GitHub Advanced Security 사용하도록 설정되어 있어야 합니다.

Syntax

# Advanced Security Initialize CodeQL v1
# Initializes the CodeQL database in preparation for building.
- task: AdvancedSecurity-Codeql-Init@1
  inputs:
    #languages: # 'csharp' | 'cpp' | 'go' | 'java' | 'javascript' | 'python' | 'ruby' | 'swift'. Languages to analyze. 
    #querysuite: 'Select a query suite...' # 'Select a query suite...' | 'code-scanning' | 'security-extended' | 'security-experimental' | 'security-and-quality'. CodeQL Query Suite to use for analysis. Default: Select a query suite....
  # Advanced
    #ram: # string. Options to control RAM usage in MB. 
    #threads: # string. Use this many threads to evaluate queries. 
    #codeqlpathstoignore: # string. Set a list of paths to exclude in the CodeQL analysis. 
    #codeqlpathstoinclude: # string. Set a list of additional paths to include in the CodeQL analysis. 
    #sourcesfolder: # string. Sets the folder that contains the sources to be analyzed. 
    #loglevel: '_' # '0' | '1' | '2' | '_'. Set the log level for the CodeQL analysis. Default: _.
    #configfilepath: # string. Use this to enable custom query analysis in codeql (path must be absolute). 
    #codeqltoolsdirectory: # string. Set a custom CodeQL tools directory (path must be absolute).

입력

languages - 분석할 언어
string. 허용되는 값: csharp, , cpp, gojava, javascript, , python, ruby, swift.

분석할 프로그래밍 언어입니다. 여러 언어를 쉼표로 구분할 수 있습니다.

여기서 작업에서 언어를 설정하거나 라는 advancedsecurity.codeql.language파이프라인 변수에서 언어를 지정할 수 있습니다. 둘 다 설정되면 작업에 지정된 값이 우선합니다.

querysuite - 분석에 사용할 CodeQL Query Suite입니다.
string. 허용되는 값: Select a query suite..., code-scanning, security-extended, , security-experimental. security-and-quality 기본값은 Select a query suite...입니다.

분석에 사용되는 쿼리 도구 모음(예: 규칙 집합)입니다. 작업에서 여기에서 값을 지정하거나 라는 advancedsecurity.codeql.querysuite파이프라인 변수에서 지정할 수 있습니다. 둘 다 설정되면 작업에 지정된 값이 우선합니다. 기본값은 Select a query suite... 쿼리 도구 모음을 변수에 지정해야 했음을 advancedsecurity.codeql.querysuite 나타내는 입니다.

ram - RAM 사용량을 MB 단위로 제어하는 옵션
string.

쿼리 계산기에서 사용할 수 있어야 하는 총 RAM 양을 설정합니다.

작업에서 여기를 지정 ram 하거나 라는 advancedsecurity.codeql.ram파이프라인 변수에서 지정할 수 있습니다. 둘 다 설정되면 작업에 지정된 값이 우선합니다.

threads - 이 많은 스레드를 사용하여 쿼리 평가
string.

0을 전달하여 컴퓨터의 코어당 하나의 스레드를 사용하거나 -N을 전달하여 N 코어를 사용하지 않은 상태로 둘 수 있습니다(하나 이상의 스레드를 계속 사용).

작업에서 여기를 지정 threads 하거나 라는 advancedsecurity.codeql.threads파이프라인 변수에서 지정할 수 있습니다. 둘 다 설정되면 작업에 지정된 값이 우선합니다.

codeqlpathstoignore - CodeQL 분석에서 제외할 경로 목록 설정
string.

여러 경로를 쉼표로 구분하여 제공할 수 있습니다. 경로는 CodeQL이 sourcesfolder 실행되는 위치를 기준으로 해야 하며, 이 경로는 기본적으로 파이프라인 환경 변수로 설정 Build.SourcesDirectory 됩니다. 예를 들어 디렉터리를 무시 $(Build.SourcesDirectory)/donotscan 하려면 대신 codeqlpathstoignore: $(Build.SourcesDirectory)/donotscan를 설정합니다codeqlpathstoignore: donotscan.

codeqlpathstoinclude - CodeQL 분석에 포함할 추가 경로 목록 설정
string.

여러 경로를 쉼표로 구분하여 제공할 수 있습니다. 경로는 CodeQL이 sourcesfolder 실행되는 위치를 기준으로 해야 하며, 이 경로는 기본적으로 파이프라인 환경 변수로 설정 Build.SourcesDirectory 됩니다. 예를 들어 디렉터리를 포함 $(Build.SourcesDirectory)/app 하려면 대신 codeqlpathstoinclude: $(Build.SourcesDirectory)/app를 설정합니다codeqlpathstoinclude: app.

sourcesfolder - 분석할 원본이 포함된 폴더를 설정합니다.
string.

이 값을 제공하지 않으면 파이프라인 인프라의 기본 원본 폴더가 사용됩니다(변수에서 Build.SourcesDirectory 제공).

loglevel - CodeQL 분석에 대한 로그 수준 설정
string. 허용되는 값: 0 (경고), 1 (자세한 정보 표시), 2 (디버그), _ (기본값(경고)). 기본값은 _입니다.

로깅 수준을 지정합니다.

작업에서 여기를 지정 loglevel 하거나 라는 advancedsecurity.codeql.loglevel파이프라인 변수에서 지정할 수 있습니다. 둘 다 설정된 경우 작업의 기본값이 지정되지 않는 한 태스크에 지정된 값 _loglevel 이 우선합니다. 가 지정된 경우 _ 의 값 advancedsecurity.codeql.loglevel 이 사용 가능한 경우 사용됩니다.

configfilepath - codeql에서 사용자 지정 쿼리 분석을 사용하도록 설정하려면 이 방법을 사용합니다(경로는 절대 경로여야 합니다).
string.

경로가 제공되지 않으면 codeql 분석은 기본 쿼리를 진행합니다.

codeqltoolsdirectory - 사용자 지정 CodeQL 도구 디렉터리 설정(경로는 절대 경로여야 합니다).
string.

경로가 제공되지 않으면 의 기본값 $agent_toolsdirectory 이 사용됩니다.

작업 제어 옵션

모든 작업에는 작업 입력 외에 제어 옵션이 있습니다. 자세한 내용은 컨트롤 옵션 및 일반적인 작업 속성을 참조하세요.

출력 변수

없음

설명

검사 중인 리포지토리에 대해 Azure DevOps에 대한 GitHub Advanced Security 사용하도록 설정되어 있어야 합니다.

중요

이 작업은 Azure Repos Git 리포지토리에서만 지원됩니다.

파이프라인은 다음 순서로 작업을 호출해야 합니다.

CodeQL 초기화
AutoBuild(또는 사용자 지정 빌드 작업)
CodeQL 분석 수행

자동 빌드 작업은 선택 사항이며 사용자 지정 빌드 작업으로 대체될 수 있습니다. 자동 빌드 또는 사용자 지정 빌드 작업을 실행하여 프로젝트를 분석해야 합니다.

요구 사항

요구 사항	Description
파이프라인 유형	YAML, 클래식 빌드, 클래식 릴리스
실행 중	에이전트, DeploymentGroup
요청	없음
Capabilities	이 작업은 작업의 후속 작업에 대한 요구를 충족하지 않습니다.
명령 제한 사항	모두
설정 가능한 변수	모두
에이전트 버전	지원되는 모든 에이전트 버전.
작업 범주	빌드

추가 정보

GitHub Advanced Security 대한 코드 검사

Share via