View a markdown version of this page

Properti SARIF yang didukung - Amazon CodeCatalyst
Objek SariFlogmenjalankan objekobjek ToolComponentobjek ReportingDescriptorobjek hasilobjek lokasiObjek PhysicAllocationObjek LogicAllocationmemperbaiki objek

Amazon CodeCatalyst tidak lagi terbuka untuk pelanggan baru. Pelanggan yang sudah ada dapat terus menggunakan layanan ini seperti biasa. Lihat informasi yang lebih lengkap di Cara bermigrasi dari CodeCatalyst.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Properti SARIF yang didukung

Format Pertukaran Hasil Analisis Statis (SARIF) adalah format file output yang tersedia dalam analisis komposisi perangkat lunak (SCA) dan laporan analisis statis di Amazon. CodeCatalyst Contoh berikut menunjukkan cara mengkonfigurasi SARIF secara manual dalam laporan analisis statis:

Reports:
MySAReport:
Format: SARIFSA
IncludePaths:
    - output/sa_report.json
SuccessCriteria:
    StaticAnalysisFinding:
    Number: 25
    Severity: HIGH

CodeCatalyst mendukung properti SARIF berikut yang dapat digunakan untuk mengoptimalkan bagaimana hasil analisis akan muncul dalam laporan Anda.

Objek SariFlog

Nama Diperlukan Deskripsi

$schema

Ya

URI skema JSON SARIF untuk versi 2. 1.0.

version

Ya

CodeCatalyst hanya mendukung SARIF versi 2.1.0.

runs[]

Ya

File SARIF berisi array satu atau lebih run, yang masing-masing mewakili satu kali proses alat analisis.

menjalankan objek

Nama Diperlukan Deskripsi

tool.driver

Ya

Ob toolComponent jek yang menggambarkan alat analisis.

tool.name

Tidak

Properti yang menunjukkan nama alat yang digunakan untuk melakukan analisis.

results[]

Ya

Hasil alat analisis yang ditampilkan pada CodeCatalyst.

objek ToolComponent

Nama Diperlukan Deskripsi

name

Ya

Nama alat analisis.

properties.artifactScanned

Tidak

Jumlah total artefak yang dianalisis oleh alat.

rules[]

Ya

Array reportingDescriptor objek yang mewakili aturan. Berdasarkan aturan ini, alat analisis menemukan masalah dalam kode yang dianalisis.

objek ReportingDescriptor

Nama Diperlukan Deskripsi

id

Ya

Pengidentifikasi unik untuk aturan yang digunakan untuk mereferensikan temuan.

Panjang maksimum: 1.024 karakter

name

Tidak

Nama tampilan aturan.

Panjang maksimum: 1.024 karakter

shortDescription.text

Tidak

Deskripsi singkat dari aturan.

Panjang maksimum: 3.000 karakter

fullDescription.text

Tidak

Deskripsi lengkap aturan.

Panjang maksimum: 3.000 karakter

helpUri

Tidak

Sebuah string yang dapat dilokalkan untuk berisi URI absolut dari dokumentasi utama untuk aturan.

Panjang maksimum: 3.000 karakter

properties.unscore

Tidak

Bendera yang menunjukkan apakah temuan pemindaian telah dinilai.

properties.score.severity

Tidak

Satu set string tetap yang menentukan tingkat keparahan temuan.

Panjang maksimum: 1.024 karakter

properties.cvssv3_baseSeverity

Tidak

Peringkat keparahan kualitatif Sistem Penilaian Kerentanan Umum v3.1.

properties.cvssv3_baseScore

Tidak

Skor Dasar CVSS v3 mulai dari 0.0 - 10.0.

properties.cvssv2_severity

Tidak

Jika nilai CVSS v3 tidak tersedia, cari CodeCatalyst nilai CVSS v2.

properties.cvssv2_score

Tidak

Skor Dasar CVSS v2 berkisar antara 0.0 - 10.0.

properties.severity

Tidak

Satu set string tetap yang menentukan tingkat keparahan temuan.

Panjang maksimum: 1.024 karakter

defaultConfiguration.level

Tidak

Tingkat keparahan default suatu aturan.

objek hasil

Nama Diperlukan Deskripsi

ruleId

Ya

Pengidentifikasi unik untuk aturan yang digunakan untuk mereferensikan temuan.

Panjang maksimum: 1.024 karakter

ruleIndex

Ya

Indeks aturan terkait dalam komponen alatrules[].

message.text

Ya

Pesan yang menjelaskan hasil dan menampilkan pesan untuk setiap temuan.

Panjang maksimum: 3.000 karakter

rank

Tidak

Nilai antara 0,0 hingga 100,0 inklusif yang mewakili prioritas atau pentingnya hasil. Nilai skala ini 0,0 menjadi prioritas terendah dan 100,0 menjadi prioritas tertinggi.

level

Tidak

Tingkat keparahan hasilnya.

Panjang maksimum: 1.024 karakter

properties.unscore

Tidak

Bendera yang menunjukkan apakah temuan pemindaian telah dinilai.

properties.score.severity

Tidak

Satu set string tetap yang menentukan tingkat keparahan temuan.

Panjang maksimum: 1.024 karakter

properties.cvssv3_baseSeverity

Tidak

Peringkat keparahan kualitatif Sistem Penilaian Kerentanan Umum v3.1.

properties.cvssv3_baseScore

Tidak

Skor Dasar CVSS v3 mulai dari 0.0 - 10.0.

properties.cvssv2_severity

Tidak

Jika nilai CVSS v3 tidak tersedia, cari CodeCatalyst nilai CVSS v2.

properties.cvssv2_score

Tidak

Skor Dasar CVSS v2 berkisar antara 0.0 - 10.0.

properties.severity

Tidak

Satu set string tetap yang menentukan tingkat keparahan temuan.

Panjang maksimum: 1.024 karakter

locations[]

Ya

Kumpulan lokasi di mana hasilnya terdeteksi. Hanya satu lokasi yang harus disertakan kecuali masalah hanya dapat diperbaiki dengan membuat perubahan di setiap lokasi yang ditentukan. CodeCatalyst menggunakan nilai pertama dalam array lokasi untuk membuat anotasi hasilnya.

Jumlah location objek maksimum: 10

relatedLocations[]

Tidak

Daftar referensi lokasi tambahan dalam temuan.

Jumlah location objek maksimum: 50

fixes[]

Tidak

Array fix objek yang mewakili rekomendasi yang disediakan oleh alat pemindaian. CodeCatalyst menggunakan rekomendasi pertama dalam fixes array.

objek lokasi

Nama Diperlukan Deskripsi

physicalLocation

Ya

Mengidentifikasi artefak dan wilayah.

logicalLocations[]

Tidak

Kumpulan lokasi yang dijelaskan dengan nama tanpa mengacu pada artefak.

Objek PhysicAllocation

Nama Diperlukan Deskripsi

artifactLocation.uri

Ya

URI menunjukkan lokasi artefak, biasanya file baik di repositori atau dihasilkan selama pembuatan.

fileLocation.uri

Tidak

URI mundur yang menunjukkan lokasi file. Ini digunakan jika artifactLocation.uri mengembalikan kosong.

region.startLine

Ya

Nomor baris karakter pertama di wilayah tersebut.

region.startColumn

Ya

Nomor kolom karakter pertama di wilayah tersebut.

region.endLine

Ya

Nomor baris karakter terakhir di wilayah tersebut.

region.endColumn

Ya

Nomor kolom karakter terakhir di wilayah tersebut.

Objek LogicAllocation

Nama Diperlukan Deskripsi

fullyQualifiedName

Tidak

Informasi tambahan yang menggambarkan lokasi hasil.

Panjang maksimum: 1.024 karakter

memperbaiki objek

Nama Diperlukan Deskripsi

description.text

Tidak

Pesan yang menampilkan rekomendasi untuk setiap temuan.

Panjang maksimum: 3.000 karakter

artifactChanges.[0].artifactLocation.uri

Tidak

URI menunjukkan lokasi artefak yang perlu diperbarui.