Dela via

AdvancedSecurity-Codeql-Init@1 – Avancerad säkerhet Initiera CodeQL v1-uppgift

  • Artikel

Initierar CodeQL-databasen som förberedelse för att skapa.

Du måste ha GitHub Advanced Security för Azure DevOps aktiverat för lagringsplatsen som genomsöks.

Syntax

# Advanced Security Initialize CodeQL v1
# Initializes the CodeQL database in preparation for building.
- task: AdvancedSecurity-Codeql-Init@1
  inputs:
    #enableAutomaticCodeQLInstall: false # boolean. Enable automatic CodeQL detection and installation. Default: false.
    #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....
    #buildtype: 'Manual' # 'Manual' | 'None'. Select build mode (manual vs none). Default: Manual.
  # 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).

Ingångar

enableAutomaticCodeQLInstall - Aktivera automatisk CodeQL-identifiering och installation
boolean. Standardvärde: false.

Om du väljer det här alternativet kommer uppgiften att automatiskt söka efter CodeQL på agenten. Om CodeQL inte är korrekt konfigurerat eller vid den senaste versionen installeras den senaste versionen automatiskt av uppgiften.


languages - språk för att analysera
string. Tillåtna värden: csharp, cpp, go, java, javascript, python, ruby, swift.

Programmeringsspråket som ska analyseras. Flera språk kan avgränsas med ett kommatecken.

Du kan ange språket här i uppgiften eller ange språket i en pipelinevariabel med namnet advancedsecurity.codeql.language. Om båda anges har värdet som anges i aktiviteten företräde.


querysuite - CodeQL Query Suite som ska användas för analys.
string. Tillåtna värden: Select a query suite..., code-scanning, security-extended, security-experimental, security-and-quality. Standardvärde: Select a query suite....

Frågesviten, d.v.s. regeluppsättning, som används för analys. Du kan ange värdet här i aktiviteten eller ange det i en pipelinevariabel med namnet advancedsecurity.codeql.querysuite. Om båda anges har värdet som anges i aktiviteten företräde. Standardvärdet är Select a query suite... vilket anger att frågesviten måste anges i variabeln advancedsecurity.codeql.querysuite.


buildtype - Välj byggläge (manuellt jämfört med inget)
string. Tillåtna värden: Manual, None. Standardvärde: Manual.

Ange Manual om du vill skapa projektet manuellt innan du kör CodeQL-analysen. Ange None om du vill köra CodeQL-analysen utan att skapa projektet.

Mer information om de olika bygglägena, inklusive en jämförelse av fördelarna med varje byggläge, finns i CodeQL-kodgenomsökning för kompilerade språk. Om du vill använda autobuildlägger du till uppgiften AdvancedSecurity-CodeQL-Autobuild@1 i pipelinen. Mer information finns i Code scanning build mode customization.


ram - Alternativ för att styra RAM-användning i MB
string.

Ange den totala mängden RAM-minne som frågeutvärderingen ska tillåtas använda.

Du kan ange ram här i aktiviteten eller ange den i en pipelinevariabel med namnet advancedsecurity.codeql.ram. Om båda anges har värdet som anges i aktiviteten företräde.


threads - Använd så här många trådar för att utvärdera frågor
string.

Du kan skicka 0 för att använda en tråd per kärna på datorn, eller -N för att lämna N-kärnor oanvända (förutom att fortfarande använda minst en tråd).

Du kan ange threads här i aktiviteten eller ange den i en pipelinevariabel med namnet advancedsecurity.codeql.threads. Om båda anges har värdet som anges i aktiviteten företräde.


codeqlpathstoignore - Ange en lista över sökvägar som ska undantas i CodeQL-analysen
string.

Du kan ange flera sökvägar avgränsade med kommatecken. Sökvägarna måste vara i förhållande till den sourcesfolder där CodeQL körs, vilket är standardvariabeln för Build.SourcesDirectory pipelinemiljö. Om du till exempel vill ignorera katalogen $(Build.SourcesDirectory)/donotscan anger du codeqlpathstoignore: donotscan i stället för codeqlpathstoignore: $(Build.SourcesDirectory)/donotscan.

Viktig

Inställningen codeqlpathstoignore gäller endast när du kör CodeQL-uppgifterna på ett tolkat språk (Python, Ruby och JavaScript/TypeScript) eller när du analyserar ett kompilerat språk utan att skapa koden (stöds för närvarande för C# och Java).


codeqlpathstoinclude - Ange en lista över ytterligare sökvägar som ska ingå i CodeQL-analysen
string.

Du kan ange flera sökvägar avgränsade med kommatecken. Sökvägarna måste vara i förhållande till den sourcesfolder där CodeQL körs, vilket är standardvariabeln för Build.SourcesDirectory pipelinemiljö. Om du till exempel vill ta med katalogen $(Build.SourcesDirectory)/app anger du codeqlpathstoinclude: app i stället för codeqlpathstoinclude: $(Build.SourcesDirectory)/app.

Viktig

Inställningen codeqlpathstoinclude gäller endast när du kör CodeQL-uppgifterna på ett tolkat språk (Python, Ruby och JavaScript/TypeScript) eller när du analyserar ett kompilerat språk utan att skapa koden (stöds för närvarande för C# och Java).


sourcesfolder - Anger mappen som innehåller de källor som ska analyseras
string.

Om du inte anger det här värdet används standardkällans mapp för pipelineinfrastrukturen (tillhandahålls av variabeln Build.SourcesDirectory).


loglevel - Ange loggnivån för CodeQL-analys
string. Tillåtna värden: 0 (varning), 1 (utförlig), 2 (felsökning), _ (standard (varning)). Standardvärde: _.

Ange loggningsnivå.

Du kan ange loglevel här i aktiviteten eller ange den i en pipelinevariabel med namnet advancedsecurity.codeql.loglevel. Om båda anges har värdet som anges i aktiviteten företräde, såvida inte standardvärdet _ för loglevel i aktiviteten anges. Om _ anges används värdet från advancedsecurity.codeql.loglevel om det är tillgängligt.


configfilepath - Använd detta för att aktivera anpassad frågeanalys i codeql (sökvägen måste vara absolut).
string.

Om sökvägen inte anges fortsätter codeql-analysen med standardfrågor.


codeqltoolsdirectory - Ange en anpassad CodeQL-verktygskatalog (sökvägen måste vara absolut)
string.

Om sökvägen inte anges används standardvärdet för $agent_toolsdirectory.


Alternativ för aktivitetskontroll

Alla aktiviteter har kontrollalternativ utöver sina uppgiftsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Ingen.

Anmärkningar

Du måste ha GitHub Advanced Security för Azure DevOps aktiverat för lagringsplatsen som genomsöks.

Viktig

Den här uppgiften stöds endast med Azure Repos Git-lagringsplatser.

Pipelinen måste anropa aktiviteterna i följande ordning.

  1. Initiera CodeQL
  2. Skapa automatiskt (eller dina anpassade bygguppgifter)
  3. Utföra CodeQL-analys

Autobuild-uppgiften är valfri och kan ersättas med dina anpassade bygguppgifter. Antingen AutoBuild eller dina anpassade bygguppgifter måste köras för att projektet ska kunna analyseras.

Krav

Krav Beskrivning
Pipelinetyper YAML, klassisk version, klassisk version
Körs på Agent, DeploymentGroup
kräver Ingen
funktioner Den här aktiviteten uppfyller inte några krav på efterföljande uppgifter i jobbet.
Kommandobegränsningar Någon
variabler som kan Någon
Agentversion Alla agentversioner som stöds.
Aktivitetskategori Bygga

Se även