sarif utils

Sarif-utils

Perpustakaan saat ini menyediakan serangkaian utilitas, diarahkan untuk bekerja dengan file .sarif .
Sarif - Hasil Analisis Statis Format pertukaran , adalah format standar berbasis JSON untuk output alat analisis statis, diuraikan oleh Microsoft.

Modul Fix-Patches

Ada berbagai alat analisis statis, tetapi umumnya semuanya disatukan oleh satu konsep - untuk mendeteksi kerentanan perangkat lunak.

Dengan demikian, pada output dari karya alat analisis statis, akan ada serangkaian warnings ,
yang diarahkan ke bau kode. Beberapa alat telah melangkah lebih jauh dan memberikan kesempatan
Untuk secara otomatis fix bau kode tersebut.

Dengan demikian, file SARIF , yang bisa menjadi salah satu format yang mungkin untuk laporan alat analisis statis, akan berisi bagian yang sesuai untuk warnings dan fixes , yang diperoleh oleh alat tersebut, yang diarahkan ke kerentanan yang sesuai dalam file target.

Modul Fix-Patches diatur untuk bekerja dengan bagian fix object dari file yang diformat SARIF .

• fix object mewakili perbaikan yang diusulkan untuk masalah, ditunjukkan oleh alat.
  Ini menentukan satu set artefak untuk dimodifikasi. Untuk setiap artefak, ini menentukan daerah untuk dihapus, dan menyediakan konten baru untuk dimasukkan.
• Fix-Patches , pada gilirannya, akan mengurai bagian tersebut, membuat salinan file target, yang disajikan dalam SARIF , dan secara otomatis menerapkan perbaikan pada salinan ini.

Output hasil akan berisi daftar jalur ke salinan file target yang disediakan dengan perbaikan yang diterapkan.

Catatan: Jika file SARIF akan berisi beberapa perbaikan untuk wilayah yang sama dalam satu file, hanya perbaikan pertama yang akan ditambahkan.

Bagaimana menggunakan:

Perpustakaan menyediakan API yang mudah digunakan untuk memperbaiki tambalan yang diterapkan, itu hanya perlu menyediakan jalur ke file SARIF , yang berisi daftar perbaikan ( fix objects ) untuk file target dan daftar jalur ke file-file ini, dengan cara, di mana mereka disajikan dalam SARIF (melalui jalur absolut/relatif).

    val processedFiles : List < Path > = SarifFixAdapter (
                                        sarifFile = sarifFilePath,
                                        targetFiles = listOfTargetFilesPaths,
                                        testRoot = " /path/to/test/root/directory/ " .toPath()
                                      ).process()