Executando um executor de CodeQL no seu sistema de CI

Note: The Executor do CodeQL is being deprecated. Please use the CodeQL CLI version 2.6.2 or greater instead. GitHub Enterprise Server 3.3 will be the final release series that supports the Executor do CodeQL. On GitHub Enterprise Cloud, the Executor do CodeQL will be supported until March 2022. For more information, see the CodeQL runner deprecation.

Sobre o Executor do CodeQL

O Executor do CodeQL é uma ferramenta que você pode usar para executar Varredura de código no código que você está processando em um sistema de integração contínua de terceiros (CI). 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. Para obter informações, consulte "Sobre Varredura de código com CodeQL."

Em muitos casos, é mais fácil configurar CodeQL Varredura de código usando CodeQL CLI diretamente no seu sistema de CI.

Como alternativa, você pode usar GitHub Actions para executar Varredura de código em GitHub. Para obter informações, consulte "Configurar Varredura de código para um repositório".

O Executor do CodeQL é uma ferramenta de linha de comando que executa a análise de CodeQL em um checkout de um repositório do GitHub. Você adiciona o executor ao seu sistema de terceiros e, em seguida, chama o executor para analisar o código e fazer o upload dos resultados para o GitHub. Estes resultados são exibidos como alertas do Varredura de código no repositório.

Observação:

O Executor do CodeQL usa o CLI de CodeQL para analisar o código e, portanto, tem as mesmas condições da licença. É grátis usar em repositórios públicos que são mantidos no GitHub.com, e disponíveis para uso em repositórios privados que são propriedade de clientes com uma licença do Segurança Avançada. Para obter informações, consulte "GitHub Termos e Condições de do CLI de CodeQL " e "CodeQL".

Fazer o download do Executor do CodeQL

Você pode fazer o download de Executor do CodeQL de https://github.com/github/codeql-action/releases. Em alguns sistemas operacionais, talvez você precise alterar as permissões para o arquivo baixado antes de executá-lo.

No Linux:

chmod +x codeql-runner-linux

No macOS:

chmod +x codeql-runner-macos
sudo xattr -d com.apple.quarantine codeql-runner-macos

No Windows, o arquivo codeql-runner-win.exe normalmente não exige alteração de permissões.

Adicionar Executor do CodeQL ao seu sistema de CI

Após fazer o download de Executor do CodeQL e verificar se pode ser executado, você deverá disponibilizar o executor para cada servidor de CI que você pretende usar para Varredura de código. Por exemplo, você pode configurar cada servidor para que copie o executor de um local central interno. Como alternativa, você poderia usar a API REST para obter o executor diretamente do GitHub, por exemplo:

wget https://github.com/github/codeql-action/releases/latest/download/codeql-runner-linux
chmod +x codeql-runner-linux

Além disso, cada servidor de CI também precisa:

Um aplicativo GitHub ou um token de acesso pessoal para Executor do CodeQL usar. Você deve usar um token de acesso com o escopo do repositório, ou um aplicativo GitHub com a permissão de gravação de security_events e metadados e permissões de leitura de conteúdo. Para obter informações, consulte "Criar Aplicativos do GitHub" e "Criar um token de acesso pessoal".
Acesso ao pacote de CodeQL associado a esta versão do Executor do CodeQL. Este pacote contém consultas e bibliotecas necessárias para a análise de CodeQL mais o CLI de CodeQL, que é usado internamente pelo executor. Para obter informações, consulte "CLI de CodeQL".

As opções para fornecer acesso ao pacote deCodeQL são:

Permita o acesso dos servidores de CI a https://github. om/github/codeql-action para que Executor do CodeQL possa fazer o download do pacote automaticamente.
Faça o download/extraia o pacote manualmente, armazene-o com outros recursos centrais e use --codeql-path o sinalizador para especificar o local do pacote nas chamadas para inicializar o Executor do CodeQL.

Chamar Executor do CodeQL

Você deve chamar Executor do CodeQL no local de checkout do repositório que deseja analisar. Os dois comandos principais são:

init necessário para inicializar o executor e criar um banco de dados de CodeQL para que cada linguagem seja analisada. Estas bases de dados são preenchidas e analisadas por comandos subsequentes.
análise necessário para preencher os bancos de dados CodeQL, analisá-los e fazer o upload dos resultados para GitHub.

Para ambos os comandos, você deve especificar a URL de GitHub, o repositório **OWNER/NAME e o Aplicativos do GitHub ou token de acesso pessoal para usar para autenticação. Você também precisa especificar a localização do pacote CodeQL, a menos que o servidor CI tenha acesso para fazer o download diretamente do repositório github/codeql-action.

Você pode configurar o local onde o Executor do CodeQL armazena o pacote do CodeQL para futuras análises em um servidor usando o sinalizador --tools-dir e onde armazena arquivos temporários durante a análise usando --temp-dir.

Para visualizar a referência de linha de comando para o executor, use o sinalizador -h. Por exemplo, para listar todos os comandos executados: codeql-runner-OS -h ou para listar todos os sinalizadores disponíveis para o comando init executado: codeql-runner-OS init -h (em que OS varia de acordo com o executável que você está usando). Para obter mais informações, consulte "Configurar o Varredura de código no seu sistema de CI".

Notas:

SARIF upload supports a maximum of 5000 results per upload. Todos os resultados acima deste limite são ignorados. Se uma ferramenta gerar muitos resultados, você deverá atualizar a configuração para focar nos resultados para as regras ou consultas mais importantes.
For each upload, SARIF upload supports a maximum size of 10 MB for the gzip-compressed SARIF file. Any uploads over this limit will be rejected. If your SARIF file is too large because it contains too many results, you should update the configuration to focus on results for the most important rules or queries.

Exemplo básico

Este exemplo executa a análise do CodeQL em um servidor de Linux CI para o repositório octo-org/example-repo hospedado em https://github.com. O processo é muito simples porque o repositório contém apenas linguagens que podem ser analisadas diretamente pelo CodeQL, sem ser criado (ou seja, Go, JavaScript, Python e TypeScript).

Neste exemplo, o servidor tem acesso para fazer o download do pacote CodeQL diretamente do repositório github/codeql-action. Portanto, não há necessidade de usar o sinalizador --codeql-path.

Confira o repositório a ser analisado.
Mova para o diretório para o local onde o repositório está reservado.

Inicialize Executor do CodeQL e crie banco de dados do CodeQL para as linguagens detectadas.

$ echo "$TOKEN" | /path/to-runner/codeql-runner-linux init --repository octo-org/example-repo
    --github-url https://github.com --github-auth-stdin
> Cleaning temp directory /srv/checkout/example-repo/codeql-runner
> ...
> Banco de dados do CodeQL criado em /srv/checkout/example-repo/codeql-runner/codeql_databases/javascript.

Preencha os bancos de dados de CodeQL, analise-os e faça o upload dos resultados para GitHub. Os resultados aparecerão na aba Segurança do seu repositório.

$ echo "$TOKEN" | /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo
    --github-url https://github.com --github-auth-stdin
    --commit 5b6a3078b31dc346e5ce7b86837d6abbe7a18bbd --ref refs/heads/my-branch
> Finalizing database creation
> ...
> POST /repos/octo-org/example-repo/code-scanning/sarifs - 202 in 786ms
> Successfully uploaded results

Para fazer o upload dos resultados de Varredura de código como verificações de pull request, especifique do pull request usando --ref sinalizador. Recomendamos configurar Executor do CodeQL para que seja executado no evento de webhook pull_request.

$ echo "$TOKEN" | /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo
    --github-url https://github.com --github-auth-stdin
    --commit 1dc7a1346e5ce7b86835b68bbda3078b37d6abbe --ref refs/pull/123/merge
> Finalizing database creation
> ...
> POST /repos/octo-org/example-repo/code-scanning/sarifs - 202 in 786ms
> Successfully uploaded results

Para mais informações sobre a visualização de alertas de Varredura de código, consulte "Alertas de verificação de código de triagem em pull requests" e "Gerenciar alertas de verificação de códigos para o seu repositório".

Exemplo de linguagem compilada

Este exemplo é semelhante ao exemplo anterior. No entanto, desta vez, o repositório tem o código em C/C++, C# ou Java. Para criar um banco de dados de CodeQL para essas linguagens, o CLI precisa monitorar a criação. No final do processo de inicialização, o executor informa o comando que você precisa configurar o ambiente antes de criar o código. Você precisa executar esse comando antes de chamar o processo de criação normal da CI e, em seguida, executar o comando analisar.

Confira o repositório a ser analisado.
Mova para o diretório para o local onde o repositório está reservado.