sarif

Documentation

Index

• type Report
  • func ReadReport(inputPath string, logger hclog.Logger, sourceFolder string) (*Report, error)
  • func (r Report) CollectSeverityInfo() map[string]int
  • func (r Report) EnrichResultsCodeFlowProperty()
  • func (r Report) EnrichResultsLevelProperty()
  • func (r Report) EnrichResultsLocationProperty(location *sarif.Location) error
  • func (r Report) EnrichResultsProperties()
  • func (r Report) EnrichResultsTitleProperty()
  • func (r Report) ExtractToolNameAndVersion() (*ToolMetadata, error)
  • func (r Report) RemoveDataflowDuplicates()
  • func (r Report) SortResultsByLevel()
• type ToolMetadata

Types

type Report

type Report struct {
	*sarif.Report
	// contains filtered or unexported fields
}

func ReadReport

func ReadReport(inputPath string, logger hclog.Logger, sourceFolder string) (*Report, error)

func (Report) CollectSeverityInfo

func (r Report) CollectSeverityInfo() map[string]int

function that collects information about amount of low, mediumn and high severity issues returns a map with this information, and a total amount of issues

func (Report) EnrichResultsCodeFlowProperty

func (r Report) EnrichResultsCodeFlowProperty()

EnrichResultsCodeFlowProperty function enriches code flow location properties with source code and URI values

func (Report) EnrichResultsLevelProperty

func (r Report) EnrichResultsLevelProperty()

EnrichResultsLevelProperty function to enrich results properties with level taken from corersponding rules propertiues "problem.severity" field

func (Report) EnrichResultsLocationProperty

func (r Report) EnrichResultsLocationProperty(location *sarif.Location) error

EnrichResultsLocationProperty function enriches sarif location properties with source code and URI values

func (Report) EnrichResultsProperties

func (r Report) EnrichResultsProperties()

EnrichResultsProperties function enriches sarif results properties with title, description, location and level values for better html report representation

func (Report) EnrichResultsTitleProperty

func (r Report) EnrichResultsTitleProperty()

EnrichResultsTitleProperty function enriches sarif results properties with title and description values

func (Report) ExtractToolNameAndVersion

func (r Report) ExtractToolNameAndVersion() (*ToolMetadata, error)

ExtractToolNameAndVersion function extracts tool name and version from a sarif report

func (Report) RemoveDataflowDuplicates

func (r Report) RemoveDataflowDuplicates()

remove codeflow duplicates each codeflow may have multiple threatflows. These threatflows may be equal for different codeflows. This function removes duplicates from codeflows if the codeflow is empty, it is removed

func (Report) SortResultsByLevel

func (r Report) SortResultsByLevel()

SortResultsByLevel function sorts sarif results by level

type ToolMetadata

type ToolMetadata struct {
	Name    string
	Version *string
}