Bagikan melalui

AdvancedSecurity-Codeql-Init@1 - Keamanan Tingkat Lanjut Menginisialisasi tugas CodeQL v1

  • Artikel

Menginisialisasi database CodeQL sebagai persiapan untuk membangun.

Anda harus mengaktifkan GitHub Advanced Security untuk Azure DevOps agar repositori dipindai.

Sintaks

# 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).

Input

languages - Bahasa yang akan dianalisis
string. Nilai yang diizinkan: csharp, , gocpp, java, javascript, python, ruby, swift.

Bahasa pemrograman untuk dianalisis. Beberapa bahasa dapat dipisahkan oleh koma.

Anda dapat mengatur bahasa di sini dalam tugas, atau Anda dapat menentukan bahasa dalam variabel alur bernama advancedsecurity.codeql.language. Jika keduanya diatur, nilai yang ditentukan dalam tugas lebih diutamakan.


querysuite - CodeQL Query Suite untuk digunakan untuk analisis.
string. Nilai yang diizinkan: Select a query suite..., code-scanning, security-extended, security-experimental, security-and-quality. Nilai default: Select a query suite....

Rangkaian kueri, yaitu set aturan, digunakan untuk analisis. Anda dapat menentukan nilai di sini dalam tugas, atau Anda dapat menentukannya dalam variabel alur bernama advancedsecurity.codeql.querysuite. Jika keduanya diatur, nilai yang ditentukan dalam tugas lebih diutamakan. Nilai default adalah Select a query suite... yang menunjukkan bahwa rangkaian kueri harus ditentukan dalam advancedsecurity.codeql.querysuite variabel .


ram - Opsi untuk mengontrol penggunaan RAM dalam MB
string.

Atur jumlah total RAM yang harus diizinkan untuk digunakan oleh evaluator kueri.

Anda dapat menentukan ram di sini dalam tugas, atau Anda dapat menentukannya dalam variabel alur bernama advancedsecurity.codeql.ram. Jika keduanya diatur, nilai yang ditentukan dalam tugas lebih diutamakan.


threads - Gunakan banyak utas ini untuk mengevaluasi kueri
string.

Anda dapat meneruskan 0 untuk menggunakan satu utas per inti pada mesin, atau -N untuk membiarkan inti N tidak digunakan (kecuali masih menggunakan setidaknya satu utas).

Anda dapat menentukan threads di sini dalam tugas, atau Anda dapat menentukannya dalam variabel alur bernama advancedsecurity.codeql.threads. Jika keduanya diatur, nilai yang ditentukan dalam tugas lebih diutamakan.


codeqlpathstoignore - Mengatur daftar jalur yang akan dikecualikan dalam analisis CodeQL
string.

Anda dapat menyediakan beberapa jalur yang dipisahkan oleh koma. Jalur harus relatif terhadap sourcesfolder tempat CodeQL berjalan, yang default ke Build.SourcesDirectory variabel lingkungan alur. Misalnya, untuk mengabaikan $(Build.SourcesDirectory)/donotscan direktori, atur codeqlpathstoignore: donotscan bukan codeqlpathstoignore: $(Build.SourcesDirectory)/donotscan.


codeqlpathstoinclude - Mengatur daftar jalur tambahan untuk disertakan dalam analisis CodeQL
string.

Anda dapat menyediakan beberapa jalur yang dipisahkan oleh koma. Jalur harus relatif terhadap sourcesfolder tempat CodeQL berjalan, yang default ke Build.SourcesDirectory variabel lingkungan alur. Misalnya, untuk menyertakan $(Build.SourcesDirectory)/app direktori, atur codeqlpathstoinclude: app bukan codeqlpathstoinclude: $(Build.SourcesDirectory)/app.


sourcesfolder - Mengatur folder yang berisi sumber yang akan dianalisis
string.

Jika Anda tidak memberikan nilai ini, folder sumber default untuk infrastruktur alur digunakan (disediakan oleh Build.SourcesDirectory variabel).


loglevel - Mengatur tingkat log untuk analisis CodeQL
string. Nilai yang diizinkan: 0 (Peringatan), 1 (Verbose), 2 (Debug), _ (Default (Peringatan)). Nilai default: _.

Tentukan tingkat pengelogan.

Anda dapat menentukan loglevel di sini dalam tugas, atau Anda dapat menentukannya dalam variabel alur bernama advancedsecurity.codeql.loglevel. Jika keduanya diatur, nilai yang ditentukan dalam tugas lebih diutamakan, kecuali nilai _ default untuk loglevel dalam tugas ditentukan. Jika _ ditentukan, nilai dari advancedsecurity.codeql.loglevel digunakan jika tersedia.


configfilepath - Gunakan ini untuk mengaktifkan analisis kueri kustom dalam codeql (jalur harus absolut).
string.

Jika jalur tidak disediakan, analisis codeql akan dilanjutkan dengan kueri default.


codeqltoolsdirectory - Mengatur direktori alat CodeQL kustom (jalur harus absolut)
string.

Jika jalur tidak disediakan, nilai $agent_toolsdirectory default akan digunakan.


Opsi kontrol tugas

Semua tugas memiliki opsi kontrol selain input tugas mereka. Untuk informasi selengkapnya, lihat Opsi kontrol dan properti tugas umum.

Variabel output

Tidak ada.

Keterangan

Anda harus mengaktifkan GitHub Advanced Security untuk Azure DevOps agar repositori dipindai.

Penting

Tugas ini hanya didukung dengan repositori Azure Repos Git.

Alur harus memanggil tugas dalam urutan berikut.

  1. Menginisialisasi CodeQL
  2. AutoBuild (atau tugas build kustom Anda)
  3. Melakukan analisis CodeQL

Tugas AutoBuild bersifat opsional dan dapat diganti dengan tugas build kustom Anda. Baik AutoBuild atau tugas build kustom Anda harus dijalankan agar proyek Anda dianalisis.

Persyaratan

Persyaratan Deskripsi
Jenis alur YAML, Build klasik, Rilis klasik
Berjalan pada Agen, DeploymentGroup
Permintaan Tidak ada
Kemampuan Tugas ini tidak memenuhi tuntutan untuk tugas berikutnya dalam pekerjaan.
Pembatasan perintah Apa pun
Variabel yang dapat diatur Apa pun
Versi agen Semua versi agen yang didukung.
Kategori tugas Build

Lihat juga