Observação
O administrador do site precisa habilitar a code scanning antes que você possa usar esse recurso. Para saber mais, confira Configurando a verificação de código para seu dispositivo.
Talvez você não consiga habilitar ou desabilitar o code scanning se um proprietário da empresa tiver definido uma política de GitHub Code Security no nível da empresa. Para saber mais, confira Como impor políticas para segurança e análise de código na empresa.
CodeQL é o mecanismo de análise de código desenvolvido por GitHub para automatizar verificações de segurança. Você pode analisar seu código usando CodeQL e exibir os resultados como alertas de 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 Como definir a configuração padrão da verificação de código.
-
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 Como definir a configuração avançada para verificação de código.
-
Run the CodeQL CLI directly in an external CI system and upload the results to GitHub. For more information, see Usando a varredura de código com seu sistema de CI existente.
Observação
On GitHub Enterprise Server 3.21, the CodeQL action uses CodeQL CLI version 2.24.3 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.
- You generate a CodeQL database to represent your codebase.
- Then you run CodeQL queries on that database to identify problems in the codebase.
- 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* Fluxos de trabalho do GitHub Actions
Observação
- Use
java-kotlinpara analisar o código escrito em Java, Kotlin ou ambos. - Use
javascript-typescriptpara analisar o código escrito em JavaScript, TypeScript ou ambos.
Para obter mais informações, confira a documentação no site do CodeQL: Linguagens e estruturas compatíveis.
Importante
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 Usar o editor de modelos do CodeQL.
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 Opções de configuração de fluxo de trabalho para verificação de código.
For more information, see Customizing analysis with CodeQL packs.