Sobre a code scanning com o CodeQL
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.
Existem duas maneiras principais de usar CodeQL análise para code scanning:
- Adicione o fluxo de trabalho de CodeQL ao seu repositório. Isso usa a github/codeql-action para executar a CodeQL CLI. Para obter mais informações, confira "Como configurar a code scanning para um repositório".
- Execute a CLI de CodeQL diretamente em um sistema dew CI externo e faça o upload dos resultados para GitHub. Para obter mais informações, confira "Sobre a verificação de código do CodeQL no seu sistema de CI ".
Sobre o CodeQL
O CodeQL trata o código como dados, permitindo que você encontre possíveis vulnerabilidades em seu código com maior confiança do que os analisadores estáticos tradicionais.
- Você gera um banco de dados de CodeQL para representar a sua base de código.
- Em seguida, você executa consultas de CodeQL nesse banco de dados para identificar problemas na base de código.
- Os resultados da consulta são exibidos como alertas de code scanning em GitHub quando você usa CodeQL com code scanning.
O CodeQL dá suporte a linguagens compiladas e interpretadas e pode encontrar vulnerabilidades e erros no código escrito nas linguagens compatíveis.
- C/C++
- C#
- Go
- Java/Kotlin
- JavaScript/TypeScript
- Python
- Ruby
Notas:
- A análise do CodeQL para Kotlin está na versão beta. Durante a versão beta, a análise do CodeQL para Kotlin será menos abrangente do que para outras linguagens.
- Use
javapara analisar o código escrito em Java, Kotlin ou ambos. - Use
javascriptpara 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".
Sobre consultas de CodeQL
GitHub especialistas, pesquisadores de segurança e contribuidores da comunidade escrevem e mantêm as consultas padrão de CodeQL usadas por code scanning. As consultas são regularmente atualizadas para melhorar a análise e reduzir quaisquer resultados falso-positivos. As consultas são código aberto, ou seja, você pode visualizar as consultas e contribuir com elas no repositório github/codeql. Para obter mais informações, confira CodeQL no site do CodeQL. Você também pode escrever suas consultas. Para obter mais informações, confira "Sobre as consultas do CodeQL na documentação do CodeQL.
Você pode executar consultas adicionais como parte da sua análise de digitalização de código. Essas consultas precisam pertencer a um pacote de consultas (beta) publicado do CodeQL ou a um pacote QL em um repositório. Os pacotes (beta) de CodeQL oferecem os seguintes benefícios sobre os pacotes QL tradicionais:
- Quando um pacote de consulta (beta) CodeQL é publicado em GitHub Container registry, todas as dependências transitórias exigidas pelas consultas e um cache de compilação estão incluídas no pacote. Isto melhora o desempenho e garante que a execução de consultas no pacote dê resultados idênticos toda vez até que você fizer a autalização para uma nova versão do pacote ou para o CLI.
- Os pacotes QL não incluem dependências transitivas, ou seja, as consultas do pacote podem depender apenas das bibliotecas padrão (em outras palavras, as bibliotecas referenciadas por uma instrução
import LANGUAGEna consulta) ou das bibliotecas no mesmo pacote QL da consulta.
Para obter mais informações, confira "Sobre os pacotes do CodeQL e "Sobre os pacotes do QL na documentação do CodeQL.
Observação: a funcionalidade de gerenciamento de pacotes do CodeQL, incluindo pacotes do CodeQL, está atualmente em beta e está sujeita a alterações.