sarif utils

sarif-utils

ไลบรารีปัจจุบันจัดเตรียมชุดยูทิลิตี้ซึ่งกำกับการทำงานกับไฟล์ .sarif
Sarif - ผลการวิเคราะห์แบบคงที่รูปแบบการแลกเปลี่ยน เป็นรูปแบบมาตรฐานที่ใช้ JSON สำหรับผลลัพธ์ของเครื่องมือการวิเคราะห์แบบคงที่ซึ่งอธิบายโดย Microsoft

โมดูล Fix-Patches

มีเครื่องมือการวิเคราะห์แบบคงที่ที่แตกต่างกัน แต่โดยทั่วไปแล้วทั้งหมดจะรวมกันเป็นหนึ่งเดียว - เพื่อตรวจจับช่องโหว่ของซอฟต์แวร์

ดังนั้นที่ผลลัพธ์ของการทำงานของเครื่องมือการวิเคราะห์แบบคงที่จะมีชุดของ warnings
ซึ่งชี้ไปที่รหัสกลิ่น เครื่องมือบางอย่างได้ไปไกลกว่านี้และให้โอกาส
เพื่อ fix กลิ่นรหัสดังกล่าวโดยอัตโนมัติ

ดังนั้นไฟล์ SARIF ซึ่งอาจเป็นหนึ่งในรูปแบบที่เป็นไปได้สำหรับรายงานเครื่องมือวิเคราะห์แบบคงที่จะมีส่วนที่สอดคล้องกันสำหรับ warnings และ fixes ที่ได้รับจากเครื่องมือดังกล่าวซึ่งชี้ไปที่ช่องโหว่ที่สอดคล้องกันในไฟล์เป้าหมาย

โมดูล Fix-Patches ถูกตั้งค่าให้ทำงานกับส่วน fix object จากไฟล์ SARIF - Formatted Files

• fix object แสดงถึงการแก้ไขที่เสนอสำหรับปัญหาที่ระบุโดยเครื่องมือ
  มันระบุชุดของสิ่งประดิษฐ์เพื่อแก้ไข สำหรับแต่ละสิ่งประดิษฐ์จะระบุภูมิภาคที่จะลบและจัดหาเนื้อหาใหม่เพื่อแทรก
• ในทางกลับกันของ Fix-Patches จะแยกวิเคราะห์ส่วนดังกล่าวสร้างสำเนาของไฟล์เป้าหมายซึ่งนำเสนอใน SARIF และใช้การแก้ไขโดยอัตโนมัติกับสำเนาเหล่านี้

ผลลัพธ์ผลลัพธ์จะมีรายการพา ธ ไปยังสำเนาของไฟล์เป้าหมายที่ให้มาพร้อมกับการแก้ไขที่ใช้

หมายเหตุ: หากไฟล์ SARIF จะมีการแก้ไขหลายรายการสำหรับภูมิภาคเดียวกันในไฟล์เดียวจะมีเพียงการแก้ไขครั้งแรกเท่านั้น

วิธีใช้:

ไลบรารีให้ API ที่ใช้งานง่ายสำหรับการใช้แพตช์แก้ไขมันเป็นเพียงการจัดเตรียมพา ธ ไปยังไฟล์ SARIF ซึ่งมีรายการของการแก้ไข ( fix objects ) สำหรับไฟล์เป้าหมายและรายการพา ธ ไปยังไฟล์เหล่านี้ในลักษณะที่นำเสนอใน SARIF

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