Observação: O administrador do site deve habilitar Varredura de código para your GitHub Enterprise Server instance antes de usar este recurso. Para obter mais informações, consulte "Configurar o Varredura de código para seu aplicativo ".
Sobre Varredura de código com 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 Varredura de código.
Existem duas maneiras principais de usar CodeQL análise para Varredura de código:
- Adicione o fluxo de trabalho de CodeQL ao seu repositório. Isto usa o github/codeql-action para executar o CodeQL CLI. Para obter mais informações, consulte "Configurar Varredura de código para um repositório".
- Execute CodeQL CLI ou executor em um sistema de CI externo e faça o upload dos resultados para GitHub. Para obter mais informações, consulte "Sobre a digitalização de código 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 Varredura de código em GitHub Enterprise Server quando você usa CodeQL com Varredura de código.
O CodeQL é compatível com linguagens compiladas e interpretadas e é capaz de encontrar vulnerabilidades e erros no código escrito nos idiomas suportados.
- C/C++
- C#
- Go
- Java
- JavaScript/TypeScript
- Python
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 Varredura de código. As consultas são regularmente atualizadas para melhorar a análise e reduzir quaisquer resultados falso-positivos. As consultas são de código aberto.Portanto, você pode ver e contribuir para as consultas no repositório github/codeql. Para obter mais informações, consulte CodeQL no site CodeQL Você também pode escrever suas próprias consultas. Para obter mais informações, consulte "Sobre CodeQL consultas" na documentação do CodeQL.
Você pode executar consultas adicionais como parte da sua análise de digitalização de código.
As consultas que você deseja executar devem pertencer a um pacote QL em um repositório. As consultas só devem depender das bibliotecas-padrão (ou seja, as bibliotecas referenciadas por uma declaração de LINGUAGEM de importação na sua consulta), ou bibliotecas no mesmo pacote QL da consulta. Para obter mais informações, consulte "Sobre os pacotes de QL.