[Tip] CodeQL 간단 사용법

간단하게 codeQL 사용법을 정리해보겠다.

 

세팅

https://github.com/github/codeql-cli-binaries

GitHub - github/codeql-cli-binaries: Binaries for the CodeQL CLI

여기 release 페이지에서 최신 codeql을 다운받는다.

 

환경 변수

codeql 실행 파일의 환경 변수를 설정해준다. 

 

환경 변수 설정 후 실행 결과

그럼 위와 같이 다른 폴더에서도 codeql을 실행할 수 있다.

 

https://github.com/github/codeql

GitHub - github/codeql: CodeQL: the libraries and queries that power security researchers around the world, as well as code scan

이어서 위 깃허브 페이지를 clone 해준다. 여기서는 codeql 쿼리들이 모여 있다.

 

혹은

 

codeql pack download codeql/python-queries

로 최신 쿼리팩을 다운받아볼 수 있다. (지피티 피셜)

 

실행

codeql database create my_flask_db `
  --language=python `
  --source-root=.

위 명령어로 데이터베이스를 생성한다.

 

codeql database analyze my_flask_db `
  C:\경로\codeql-suites\python-security-and-quality.qls `
  --format=sarif-latest `
  --output=results.sarif

위 명령과 같이 데이터베이스를 지정하고, 경로를 지정하고, 포맷을 지정하고, 결과 파일명을 지정해야한다. 그럼 결과값을 얻을 수 있다.

 

에러

https://github.com/github/codeql/discussions/13839

Error was: Unknown kind "Table". [UNSUPPORTED_KIND] · github codeql · Discussion #13839

간혹 `@kind` 관련한 에러가 발생하는데, 이럴 땐 경로를 디렉터리로 주기보단 필요한 부분들만 파일들만 추려서 수행해보자.