AdvancedSecurity-Codeql-Init@1 – Tarefa Inicializar CodeQL v1 de Segurança Avançada
Inicializa o banco de dados CodeQL em preparação para a criação.
Você deve ter GitHub Advanced Security para o Azure DevOps habilitado para o repositório que está sendo verificado.
Syntax
# Advanced Security Initialize CodeQL v1
# Initializes the CodeQL database in preparation for building.
- task: AdvancedSecurity-Codeql-Init@1
inputs:
#languages: # 'csharp' | 'cpp' | 'go' | 'java' | 'javascript' | 'python' | 'ruby' | 'swift'. Languages to analyze.
#querysuite: 'Select a query suite...' # 'Select a query suite...' | 'code-scanning' | 'security-extended' | 'security-experimental' | 'security-and-quality'. CodeQL Query Suite to use for analysis. Default: Select a query suite....
# Advanced
#ram: # string. Options to control RAM usage in MB.
#threads: # string. Use this many threads to evaluate queries.
#codeqlpathstoignore: # string. Set a list of paths to exclude in the CodeQL analysis.
#codeqlpathstoinclude: # string. Set a list of additional paths to include in the CodeQL analysis.
#sourcesfolder: # string. Sets the folder that contains the sources to be analyzed.
#loglevel: '_' # '0' | '1' | '2' | '_'. Set the log level for the CodeQL analysis. Default: _.
#configfilepath: # string. Use this to enable custom query analysis in codeql (path must be absolute).
#codeqltoolsdirectory: # string. Set a custom CodeQL tools directory (path must be absolute).
Entradas
languages - Idiomas a serem analisados
string. Valores permitidos: csharp, , cpp, go, java, javascript, python, ruby, swift.
A linguagem de programação a ser analisada. Vários idiomas podem ser separados por uma vírgula.
Você pode definir o idioma aqui na tarefa ou especificar o idioma em uma variável de pipeline chamada advancedsecurity.codeql.language. Se ambos forem definidos, o valor especificado na tarefa terá precedência.
querysuite - CodeQL Query Suite a ser usado para análise.
string. Valores permitidos: Select a query suite..., , code-scanning, security-extended, security-experimental, security-and-quality. Valor padrão: Select a query suite....
O conjunto de consultas, ou seja, conjunto de regras, usado para análise. Você pode especificar o valor aqui na tarefa ou especifique-o em uma variável de pipeline chamada advancedsecurity.codeql.querysuite. Se ambos forem definidos, o valor especificado na tarefa terá precedência. O valor padrão é Select a query suite... o que indica que o conjunto de consultas deve ser especificado na advancedsecurity.codeql.querysuite variável.
ram - Opções para controlar o uso de RAM em MB
string.
Defina a quantidade total de RAM que o avaliador de consulta deve ter permissão para usar.
Você pode especificar ram aqui na tarefa ou especifique-a em uma variável de pipeline chamada advancedsecurity.codeql.ram. Se ambos forem definidos, o valor especificado na tarefa terá precedência.
threads - Use muitos threads para avaliar consultas
string.
Você pode transmitir 0 para usar um thread por núcleo no computador ou -N para manter N núcleos não utilizados (com a exceção de que ainda será usado, pelo menos, um thread).
Você pode especificar threads aqui na tarefa ou especifique-a em uma variável de pipeline chamada advancedsecurity.codeql.threads. Se ambos forem definidos, o valor especificado na tarefa terá precedência.
codeqlpathstoignore - Definir uma lista de caminhos a serem excluídos na análise do CodeQL
string.
Você pode fornecer vários caminhos separados por vírgulas. Os caminhos devem ser relativos ao local em que o sourcesfolder CodeQL está em execução, que usa como padrão a variável de ambiente de Build.SourcesDirectory pipeline. Por exemplo, para ignorar o $(Build.SourcesDirectory)/donotscan diretório, defina codeqlpathstoignore: donotscan em vez de codeqlpathstoignore: $(Build.SourcesDirectory)/donotscan.
codeqlpathstoinclude - Definir uma lista de caminhos adicionais a serem incluídos na análise do CodeQL
string.
Você pode fornecer vários caminhos separados por vírgulas. Os caminhos devem ser relativos ao local em que o sourcesfolder CodeQL está em execução, que usa como padrão a variável de ambiente de Build.SourcesDirectory pipeline. Por exemplo, para incluir o $(Build.SourcesDirectory)/app diretório, defina codeqlpathstoinclude: app em vez de codeqlpathstoinclude: $(Build.SourcesDirectory)/app.
sourcesfolder - Define a pasta que contém as fontes a serem analisadas
string.
Se você não fornecer esse valor, a pasta de fontes padrão para a infraestrutura de pipeline será usada (fornecida pela Build.SourcesDirectory variável).
loglevel - Definir o nível de log para a análise do CodeQL
string. Valores permitidos: 0 (Aviso), 1 (Detalhado), 2 (Depuração) _ (Padrão (Aviso)). Valor padrão: _.
Especifique o nível de registro em log.
Você pode especificar loglevel aqui na tarefa ou especifique-a em uma variável de pipeline chamada advancedsecurity.codeql.loglevel. Se ambos forem definidos, o valor especificado na tarefa terá precedência, a menos que o valor _ padrão para loglevel na tarefa seja especificado. Se _ for especificado, o valor de advancedsecurity.codeql.loglevel será usado se disponível.
configfilepath - Use isso para habilitar a análise de consulta personalizada no codeql (o caminho deve ser absoluto).
string.
Se o caminho não for fornecido, a análise do codeql continuará com consultas padrão.
codeqltoolsdirectory - Definir um diretório personalizado de ferramentas do CodeQL (o caminho deve ser absoluto)
string.
Se o caminho não for fornecido, o valor padrão de $agent_toolsdirectory será utilizado.
Opções de controle da tarefa
Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.
Variáveis de saída
Nenhum.
Comentários
Você deve ter GitHub Advanced Security para o Azure DevOps habilitado para o repositório que está sendo verificado.
Importante
Essa tarefa tem suporte apenas com Azure Repos repositórios Git.
O pipeline deve chamar as tarefas na ordem a seguir.
- Inicializar o CodeQL
- AutoBuild (ou suas tarefas de build personalizadas)
- Executar análise do CodeQL
A tarefa AutoBuild é opcional e pode ser substituída por suas tarefas de build personalizadas. O AutoBuild ou suas tarefas de build personalizadas devem ser executados para que seu projeto seja analisado.
Requisitos
| Requisito | Descrição |
|---|---|
| Tipos de pipeline | YAML, build clássico, versão clássica |
| É executado em | Agent, DeploymentGroup |
| Demandas | Nenhum |
| Funcionalidades | Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho. |
| Restrições de comando | Qualquer |
| Variáveis configuráveis | Qualquer |
| Versão do agente | Todas as versões do agente com suporte. |
| Categoria da tarefa | Build |