Sobre a varredura de código

Você pode usar Varredura de código para encontrar vulnerabilidades e erros de segurança no código do seu projeto no GitHub.

Varredura de código is available as part of Segurança Avançada GitHub, which is free during the beta release. Para obter mais informações, consulte "Sobre Segurança Avançada GitHub".

Nota: Varredura de código está atualmente em versão beta e sujeito a alterações.

Sobre o Varredura de código

Varredura de código é um recurso que você usa para analisar o código em um repositório de GitHub para localizar vulnerabilidades de segurança e erros de codificação. Quaisquer problemas identificados pela análise são exibidos em GitHub AE.

Você pode usar Varredura de código para encontrar, triar e priorizar correções de problemas existentes em seu código. Varredura de código também impede que os desenvolvedores apresentem novos problemas. É possível programar verificações para dias e horários específicos ou acionar varreduras quando ocorre um evento específico no repositório, como, por exemplo, um push.

Se Varredura de código encontrar uma vulnerabilidade potencial ou erro no seu código, GitHub exibirá um alerta no repositório. Depois de corrigir o código que desencadeou o alerta, GitHub fechará o alerta. Para obter mais informações, consulte "Gerenciar alertas de Varredura de código para o seu repositório".

Para monitorar os resultados de Varredura de código nos seus repositórios ou organização, você pode usar webhooks e a API de Varredura de código. Para obter informações sobre os webhooks para Varredura de código, consulte "Eventos de webhook e cargas". Para obter informações sobre os pontos de extremidade da API, consulte "Varredura de código".

Para começar com Varredura de código, consulte "Configurar Varredura de código para um repositório".

Sobre o CodeQL

Você pode visualizar e contribuir para as consultas do Varredura de código no repositório github/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.

QL é a linguagem de consulta que move CodeQL. QL é uma linguagem de programação lógica voltada para objetos. GitHub, especialistas em idiomas e pesquisadores de segurança criam as consultas usadas para Varredura de código e as consultas são de código aberto. A comunidade mantém e atualiza as consultas para melhorar a análise e reduzir falsos positivos. Para obter mais informações, consulte CodeQL no site do GitHub Security Lab.

Para obter mais informações sobre os pontos de extremidade da API para Varredura de código, consulte "Varredura de código".

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

Você pode visualizar e contribuir para as consultas do Varredura de código no repositório github/codeql. Para obter mais informações, consulte CodeQL consultas na documentação do CodeQL.

Sobre ferramentas de Varredura de código de terceiros

Varredura de código é interoperável com ferramentas de escaneamento de código de terceiros que saem dados de análise estática de resultados de mudança de formato (SARIF). SARIF é um padrão aberto. Para obter mais informações, consulte "SARIF output for Varredura de código."

Você pode executar ferramentas de análise de terceiros em GitHub AE usando ações ou em um sistema CI externo. Para mais informações consulte "Configurar a verificação de código para um repositório" ou "Enviar um arquivo SARIF para o GitHub".

Leia mais

Esse documento ajudou você?Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.