sarif-utils
0.2.2indexedUtilities facilitate working with SARIF files by parsing fix object sections, creating copies of target files, and automatically applying proposed fixes to these copies.
10
Stars
—
Used by
dependents
—
Health
/ 100
Utilities facilitate working with SARIF files by parsing fix object sections, creating copies of target files, and automatically applying proposed fixes to these copies.
Current library provide the set of utilities, directed to work with
.sarif files.
SARIF - Static Analysis Results Interchange Format, is a standard,
JSON-based format for the output of static analysis tools, elaborated by Microsoft.
There are different static analysis tool, but generally all of them are united by one concept - to detect software vulnerabilities.
Thus, at the output of the work of static analysis tool, there will be the set of warnings,
which are pointed to the code smells. Some tools have gone further and provide an opportunity
to automatically fix such code smells.
Accordingly, SARIF files, which could be the one of possible formats for reports of static analysis tools,
will contain corresponding sections for warnings and fixes, obtained by such tools,
which are pointed to the corresponding vulnerabilities in target files.
Fix-Patches module is set to work with fix object sections from SARIF - formatted files.
fix object represents a proposed fix for the problem, indicated by tool.Fix-Patches, in its turn, will parse such sections, create copy of target files, which are presented in SARIF,
and automatically apply fixes to these copies.The result output will contain the list of paths to the copies of provided target files with applied fixes.
Note: If SARIF file will contain multiple fixes for the same region in one file, only the first fix will be appied.
Library provides easy-to-use API for fix patches applying, it's just need to provide
the path to SARIF file, which contain the list of fixes (fix objects) for target files and the list of paths to these files,
in the manner, in which they are presented in SARIF (via absolute/relative paths).
val processedFiles: List<Path> = SarifFixAdapter(
sarifFile = sarifFilePath,
targetFiles = listOfTargetFilesPaths,
testRoot = "/path/to/test/root/directory/".toPath()
).process()
Surfaced from shared tags and platforms — no rankings paid for.