sarif

Documentation

Index

• Constants
• func FromSmithyEnrichedIssuesRun(responses []*v1.EnrichedLaunchToolResponse, reportDuplicates bool) (*sarif.Report, error)
• func FromSmithyRawIssuesRun(responses []*v1.LaunchToolResponse) (*sarif.Report, error)
• type ExtraContextLanguage
• type SmithyIssueCollection
  • func ToSmithy(inFile string, language ExtraContextLanguage) ([]*SmithyIssueCollection, error)

Constants

const (
	LevelError   = "error"
	LevelWarning = "warning"
	LevelNote    = "note"
	LevelNone    = "none"
)

Functions

func FromSmithyEnrichedIssuesRun

func FromSmithyEnrichedIssuesRun(responses []*v1.EnrichedLaunchToolResponse, reportDuplicates bool) (*sarif.Report, error)

FromSmithyEnrichedIssuesRun transforms a set of LaunchToolResponse to ONE sarif document with one run per launch tool response, by default it skips duplicates unless reportDuplicates is set to true.

func FromSmithyRawIssuesRun

func FromSmithyRawIssuesRun(responses []*v1.LaunchToolResponse) (*sarif.Report, error)

FromSmithyRawIssuesRun accepts a set of Smithy LaunchToolResponses and transforms them to a Sarif file.

Types

type ExtraContextLanguage

type ExtraContextLanguage string

const (
	ExtraContextLanguageUnspecified ExtraContextLanguage = "unspecified"
	ExtraContextLanguagePython      ExtraContextLanguage = "python"
	ExtraContextLanguageJS          ExtraContextLanguage = "javascript"
)

type SmithyIssueCollection

type SmithyIssueCollection struct {
	ToolName string
	Issues   []*v1.Issue
}

SmithyIssueCollection represents all the findings in a single Sarif file converted to smithy format.

func ToSmithy

func ToSmithy(inFile string, language ExtraContextLanguage) ([]*SmithyIssueCollection, error)

ToSmithy accepts a sarif file and transforms each run to SmithyIssueCollection ready to be written to a results file.