Code scanning with CodeQL

You can use CodeQL to identify vulnerabilities and errors in your code. The results are shown as code scanning alerts in GitHub.

누가 이 기능을 사용할 수 있나요?

Code scanning은 다음 리포지토리 유형에서 사용할 수 있습니다.

  • GitHub.com에 대한 퍼블릭 리포지토리
  • GitHub Team, GitHub Enterprise Cloud 또는 GitHub Enterprise Server에 대한 조직 소유의 리포지토리로, GitHub Code Security 가 활성화되어 있습니다.

이 기사에서

참고

사이트 관리자가 먼저 code scanning을 사용하도록 설정해야 이 기능을 사용할 수 있습니다. 자세한 내용은 어플라이언스에 대한 코드 검사 구성을(를) 참조하세요.

엔터프라이즈 소유자가 엔터프라이즈 수준에서 code scanning 정책을 설정한 경우 GitHub Code Security을 사용하거나 사용하지 않도록 설정할 수 없습니다. 자세한 내용은 엔터프라이즈에 대한 코드 보안 및 분석을 위한 정책 적용을(를) 참조하세요.

CodeQL은 보안 검사를 자동화하기 위해 GitHub에서 개발한 코드 분석 엔진입니다. CodeQL을 사용하여 코드를 분석하고 결과를 code scanning 경고로 표시할 수 있습니다.

There are three main ways to use CodeQL analysis for code scanning:

  • Use default setup to quickly configure CodeQL analysis for code scanning on your repository. Default setup automatically chooses the languages to analyze, query suite to run, and events that trigger scans. If you prefer, you can manually select the query suite to run and languages to analyze. After you enable CodeQL, GitHub Actions will execute workflow runs to scan your code. For more information, see Configuring default setup for code scanning.

  • Use advanced setup to add the CodeQL workflow to your repository. This generates a customizable workflow file which uses the github/codeql-action to run the CodeQL CLI. For more information, see 코드 검사에 대한 고급 설정 구성.

  • Run the CodeQL CLI directly in an external CI system and upload the results to GitHub. For more information, see Using code scanning with your existing CI system.

참고

On GitHub Enterprise Server 3.17, the CodeQL action uses CodeQL CLI version 2.20.7 by default. We recommend that you use the same version of the CodeQL CLI if you run analysis in an external CI system.

For information about code scanning alerts, see Code scanning alerts.

About CodeQL

CodeQL is a programming language and associated tools that treat code like data. It was created explicitly to make it easier to analyze code and find potential vulnerabilities in your code with greater confidence than traditional static analyzers.

  1. You generate a CodeQL database to represent your codebase.
  2. Then you run CodeQL queries on that database to identify problems in the codebase.
  3. The query results are shown as code scanning alerts in GitHub when you use CodeQL with code scanning.

CodeQL supports both compiled and interpreted languages, and can find vulnerabilities and errors in code that's written in the supported languages.

CodeQL supports the following languages:

  • C/C++
  • C#
  • Go
  • Java/Kotlin
  • JavaScript/TypeScript
  • Python
  • 루비
  • Rust(공개 미리 보기)
  • Swift

참고

  • Java, Kotlin 또는 둘 다로 작성된 코드를 분석하는 데 java-kotlin을 사용합니다.
  • JavaScript, TypeScript 또는 둘 다로 작성된 코드를 분석하는 데 javascript-typescript을(를) 사용합니다.

자세한 내용은 CodeQL 웹 사이트의 설명서의 지원되는 언어와 프레임워크를 참조하세요.

중요

CodeQL does not support languages that are not listed above. This includes, but is not limited to, PHP, Scala, and others. Attempting to use CodeQL with unsupported languages may result in no alerts being generated and incomplete analysis.

Modeling custom or niche frameworks

GitHub experts, security researchers, and community contributors write libraries to model the flow of data in popular frameworks and libraries. If you use custom dependencies that aren't modeled, then you can use the CodeQL extension for Visual Studio Code to create models for these dependencies and use them to extend your analysis. For more information, see Using the CodeQL model editor.

CodeQL queries

GitHub experts, security researchers, and community contributors write and maintain the default CodeQL queries used for code scanning. The queries are regularly updated to improve analysis and reduce any false positive results. For details of the queries available in the default and extended packs, see Queries included in the default and security-extended query suites.

Writing your own queries

The queries are open source, so you can view and contribute to the queries in the github/codeql repository. For more information, see About CodeQL queries in the CodeQL documentation.

Running additional queries

If you are scanning your code with advanced setup or an external CI system, you can run additional queries as part of your analysis.

These queries must belong to a published CodeQL query pack or a CodeQL pack in a repository.

  • When a CodeQL query pack is published to the GitHub Container registry, all the transitive dependencies required by the queries and a compilation cache are included in the package. This improves performance and ensures that running the queries in the pack gives identical results every time until you upgrade to a new version of the pack or the CLI.

  • CodeQL query packs can be downloaded from multiple GitHub container registries. For more information, see 코드 검색을 위한 워크플로 구성 옵션.

For more information, see Customizing analysis with CodeQL packs.