Package crypto.reporting

Class SARIFReporter

java.lang.Object

crypto.analysis.CrySLAnalysisListener

crypto.reporting.ErrorMarkerListener

crypto.reporting.Reporter

crypto.reporting.SARIFReporter

All Implemented Interfaces:

ICrySLPerformanceListener, ICrySLResultsListener

public class SARIFReporter
extends Reporter

This class extends the class Reporter by generating an analysis report and write it into a JSON file in the SARIF format.

Field Summary

Fields inherited from class crypto.reporting.Reporter

analysisWatch, dataflowReachableMethods, objects, statistics

Fields inherited from class crypto.reporting.ErrorMarkerListener

errorMarkerCount, errorMarkers, secureObjects

Constructor Summary

Constructors

Constructor	Description
SARIFReporter(String reportDir, String softwareId, List<CrySLRule> rules, long callgraphConstructionTime, boolean includeStatistics)	Subclass of Reporter.

Method Summary

Modifier and Type	Method	Description
void	handleAnalysisResults()	This method is called after the analysis is finished and all statistics have been computed.

Methods inherited from class crypto.reporting.Reporter

afterAnalysis, beforeAnalysis, discoveredSeed, getObjects, getOutputFolder, getRules, getStatistics, includeStatistics, onSeedFinished

Methods inherited from class crypto.reporting.ErrorMarkerListener

addProgress, afterConstraintCheck, afterPredicateCheck, beforeConstraintCheck, beforePredicateCheck, boomerangQueryFinished, boomerangQueryStarted, checkedConstraints, collectedValues, ensuredPredicates, filterQuotes, onSecureObjectFound, onSeedTimeout, reportError, seedStarted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SARIFReporter

public SARIFReporter(String reportDir,
                     String softwareId,
                     List<CrySLRule> rules,
                     long callgraphConstructionTime,
                     boolean includeStatistics)

Subclass of Reporter. Creates an instance of SARIFReporter, which can be used to create a json file containing the analysis report in the SARIF format.

Parameters:

reportDir - A String path giving the location of the report directory. The reportPath should end without an ending file separator.

softwareId - A String for the analyzed software.

rules - A List of CrySLRule containing the rules the program is analyzed with.

callgraphConstructionTime - The time in milliseconds for the construction of the callgraph.

includeStatistics - Set this value to true, if the analysis report should contain some analysis statistics (e.g. the callgraph construction time). If this value is set to false, no statistics will be output.

Method Detail

handleAnalysisResults

public void handleAnalysisResults()

Description copied from class: Reporter

This method is called after the analysis is finished and all statistics have been computed. A subclass can override this method to extend the actions after the analysis, e.g. creating an analysis report and write it into a file.

Specified by:

handleAnalysisResults in class Reporter