Skip to main content

About code scanning with CodeQL

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

代码扫描 可用于 GitHub Enterprise Server 中的组织拥有的存储库。 此功能需要 GitHub Advanced Security 的许可证。 更多信息请参阅“GitHub 的产品”。

Note: Your site administrator must enable 代码扫描 for 您的 GitHub Enterprise Server 实例 before you can use this feature. For more information, see "Configuring 代码扫描 for your appliance."

About 代码扫描 with CodeQL

CodeQL 是由 GitHub 开发的代码分析引擎,用于自动执行安全检查。 可以使用 CodeQL 分析代码,并将结果显示为 代码扫描 警报。

There are two main ways to use CodeQL analysis for 代码扫描:

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

About CodeQL

CodeQL treats code like data, allowing you to 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 代码扫描 alerts in GitHub Enterprise Server when you use CodeQL with 代码扫描.

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

  • C/C++
  • C#
  • Go
  • Java
  • JavaScript/TypeScript
  • Python
  • Ruby

注意:Ruby 的 CodeQL 分析目前处于测试阶段。 在测试期间,Ruby 的分析将不如 CodeQL 其他语言的分析那么全面。

更多信息请参阅 CodeQL 网站上的文档:“支持的语言和框架”。

About CodeQL queries

GitHub experts, security researchers, and community contributors write and maintain the default CodeQL queries used for 代码扫描. The queries are regularly updated to improve analysis and reduce any false positive results. The queries are open source, so you can view and contribute to the queries in the github/codeql repository. For more information, see CodeQL on the CodeQL website. You can also write your own queries. For more information, see "About CodeQL queries" in the CodeQL documentation.

You can run additional queries as part of your code scanning analysis. The queries you want to run must belong to a QL pack in a repository. Queries must only depend on the standard libraries (that is, the libraries referenced by an import LANGUAGE statement in your query), or libraries in the same QL pack as the query. For more information, see "About QL packs."