Code scanning with CodeQL - GitHub Docs (original) (raw)

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

Who can use this feature?

Code scanning is available for the following repository types:

• Public repositories on GitHub.com
• Organization-owned repositories on GitHub Team, GitHub Enterprise Cloud, or GitHub Enterprise Server, with GitHub Code Security enabled.

CodeQL is the code analysis engine developed by GitHub to automate security checks. You can analyze your code using CodeQL and display the results as code scanning alerts.

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 Configuring advanced setup for code scanning.
• 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.

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
• Ruby
• Rust
• Swift
• GitHub Actions workflows

Note

• Use java-kotlin to analyze code written in Java, Kotlin or both.
• Use javascript-typescript to analyze code written in JavaScript, TypeScript or both.

For more information, see the documentation on the CodeQL website: Supported languages and frameworks.

Important

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.

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 Workflow configuration options for code scanning.

For more information, see Customizing analysis with CodeQL packs.