AdvancedSecurity-Codeql-Analyze@1 – Tarefa de análise de CodeQL de Execução de CodeQL de Segurança Avançada v1

Artigo
07/02/2024

Analisa o código num repositório Git de Repositórios do Azure para encontrar vulnerabilidades de segurança e erros de codificação. Tem de ter GitHub Advanced Security para o Azure DevOps ativado para o repositório que está a ser analisado.

Syntax

# Advanced Security Perform CodeQL analysis v1
# Finalizes the CodeQL database and runs the analysis queries.
- task: AdvancedSecurity-Codeql-Analyze@1
  inputs:
    #WaitForProcessing: false # boolean. Enable Wait for Processing. Default: false.
    #WaitForProcessingInterval: '5' # string. Optional. Use when WaitForProcessing = true. Wait for Processing Time Interval. Default: 5.
    #WaitForProcessingTimeout: '120' # string. Optional. Use when WaitForProcessing = true. Wait for Processing Timeout. Default: 120.

Entradas

WaitForProcessing - Ativar Espera para Processamento
boolean. Valor predefinido: false.

Aguarde que a Segurança Avançada processe o ficheiro SARIF publicado antes de concluir.

WaitForProcessingInterval - Aguarde pelo Intervalo de Tempo de Processamento
string. Opcional. Utilize quando WaitForProcessing = true. Valor predefinido: 5.

Tempo, em segundos, para aguardar entre cada chamada para a Segurança Avançada para verificar o estado de processamento SARIF.

WaitForProcessingTimeout - Aguarde pelo Tempo Limite de Processamento
string. Opcional. Utilize quando WaitForProcessing = true. Valor predefinido: 120.

Tempo, em segundos, para aguardar que a Segurança Avançada processe o ficheiro SARIF antes de concluir.

Opções de controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

Importante

Esta tarefa é suportada apenas com repositórios Git de Repositórios do Azure.

Pré-requisitos

Para que a tarefa seja concluída com êxito e preencha o separador Segurança Avançada do repositório analisado, a Segurança Avançada tem de estar ativada para esse repositório antes de executar uma compilação com a tarefa de análise de dependências incluída.

A tarefa está disponível para ser executada em agentes autoalojados, bem como em agentes alojados na Microsoft. Para agentes autoalojados, veja instruções adicionais de configuração do agente autoalojado.

O pipeline tem de chamar as tarefas pela seguinte ordem.

Inicializar CodeQL
AutoBuild (ou as suas tarefas de compilação personalizadas)
Efetuar a análise do CodeQL

A tarefa de Construção Automática é opcional e pode ser substituída pelas suas tarefas de compilação personalizadas. A Construção Automática ou as suas tarefas de compilação personalizadas têm de ser executadas para que o seu projeto seja analisado.

A tarefa de análise tem de aparecer após a tarefa de inicialização para concluir com êxito.

# Initialize CodeQL database 
- task: AdvancedSecurity-Codeql-Init@1
  inputs: 
    languages: 'csharp' 
  displayName: 'Advanced Security Initialize CodeQL' 

# Build project using Autobuild or your own custom build steps 
- task: AdvancedSecurity-Codeql-Autobuild@1
  displayName: 'Advanced Security Autobuild' 

# Run analysis 
- task: AdvancedSecurity-Codeql-Analyze@1 
  displayName: 'Advanced Security Code Scanning'

Requisitos

Requisito	Description
Tipos de pipeline	YAML, Compilação clássica, Versão clássica
É executado em	Agent, DeploymentGroup
Exigências	Nenhuma
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos	Qualquer
Variáveis de definição	Qualquer
Versão do agente	Todas as versões de agente suportadas.
Categoria da tarefa	Compilação

Ver também

Análise de código para GitHub Advanced Security

Partilhar via