Package crypto.reporting

Class Reporter

java.lang.Object

crypto.analysis.CrySLAnalysisListener

crypto.reporting.ErrorMarkerListener

crypto.reporting.Reporter

All Implemented Interfaces:

ICrySLPerformanceListener, ICrySLResultsListener

Direct Known Subclasses:

CommandLineReporter, CSVReporter, CSVSummaryReporter, GitHubAnnotationReporter, SARIFReporter, TXTReporter

public abstract class Reporter
extends ErrorMarkerListener

Superclass for all reporters. This class is used to define and implement the basic parts, which all reporter should be able to support. This includes the computation of all statistics for the analysis and the basic logic for methods defined in the ICrySLResultsListener. This class is abstract. Subclasses have to call the constructor and overwrite the method handleAnalysisResults(), which is called after the analysis is finished.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.google.common.base.Stopwatch	analysisWatch	The stopwatch to measure to time for the actual analysis
protected Set<soot.SootMethod>	dataflowReachableMethods	A Set to store and count all reachable methods in the dataflow
protected Collection<IAnalysisSeed>	objects	A Collection to store and count all analyzed objects
protected ReportStatistics	statistics	An instance of ReportStatistics to store all relevant analysis statistics

Fields inherited from class crypto.reporting.ErrorMarkerListener

errorMarkerCount, errorMarkers, secureObjects

Constructor Summary

Constructors

Constructor	Description
Reporter(File outputFolder, String softwareID, List<CrySLRule> rules, long callgraphConstructionTime, boolean includeStatistics)	The constructor to initialize all attributes.

Method Summary

Modifier and Type	Method	Description
void	afterAnalysis()
void	beforeAnalysis()
void	discoveredSeed(IAnalysisSeed object)
Collection<IAnalysisSeed>	getObjects()
File	getOutputFolder()
List<CrySLRule>	getRules()
ReportStatistics	getStatistics()
abstract void	handleAnalysisResults()	This method is called after the analysis is finished and all statistics have been computed.
boolean	includeStatistics()
void	onSeedFinished(IAnalysisSeed seed, boomerang.results.ForwardBoomerangResults<typestate.TransitionFunction> forwardResults)

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

Field Detail

statistics

protected final ReportStatistics statistics

An instance of ReportStatistics to store all relevant analysis statistics

analysisWatch

protected final com.google.common.base.Stopwatch analysisWatch

The stopwatch to measure to time for the actual analysis

objects

protected final Collection<IAnalysisSeed> objects

A Collection to store and count all analyzed objects

dataflowReachableMethods

protected final Set<soot.SootMethod> dataflowReachableMethods

A Set to store and count all reachable methods in the dataflow

Constructor Detail

Reporter

public Reporter(File outputFolder,
                String softwareID,
                List<CrySLRule> rules,
                long callgraphConstructionTime,
                boolean includeStatistics)

The constructor to initialize all attributes. Since this class is abstract, all subclasses have to call this constructor.

Parameters:

outputFolder - A File for 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

getOutputFolder

public File getOutputFolder()

getRules

public List<CrySLRule> getRules()

includeStatistics

public boolean includeStatistics()

getStatistics

public ReportStatistics getStatistics()

getObjects

public Collection<IAnalysisSeed> getObjects()

beforeAnalysis

public void beforeAnalysis()

Specified by:

beforeAnalysis in interface ICrySLPerformanceListener

Overrides:

beforeAnalysis in class ErrorMarkerListener

discoveredSeed

public void discoveredSeed(IAnalysisSeed object)

Specified by:

discoveredSeed in interface ICrySLResultsListener

Overrides:

discoveredSeed in class ErrorMarkerListener

onSeedFinished

public void onSeedFinished(IAnalysisSeed seed,
                           boomerang.results.ForwardBoomerangResults<typestate.TransitionFunction> forwardResults)

Specified by:

onSeedFinished in interface ICrySLResultsListener

Overrides:

onSeedFinished in class ErrorMarkerListener

afterAnalysis

public void afterAnalysis()

Specified by:

afterAnalysis in interface ICrySLPerformanceListener

Overrides:

afterAnalysis in class ErrorMarkerListener

handleAnalysisResults

public abstract void handleAnalysisResults()

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.