sarifutils

package
v1.24.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 17, 2025 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	OriginSarifPropertyKey                  = "origin"
	WatchSarifPropertyKey                   = "watch"
	ViolationTypeSarifPropertyKey           = "type"
	PoliciesSarifPropertyKey                = "policies"
	JasIssueIdSarifPropertyKey              = "issueId"
	JasScannerIdSarifPropertyKey            = "scanner_id"
	FailPrSarifPropertyKey                  = "failPullRequest"
	CWEPropertyKey                          = "CWE"
	SarifImpactPathsRulePropertyKey         = "impactPaths"
	TokenValidationStatusSarifPropertyKey   = "tokenValidation"
	TokenValidationMetadataSarifPropertyKey = "metadata"
	CAUndeterminedReasonSarifPropertyKey    = "undetermined_reason"
)

Variables

This section is empty.

Functions

func AggregateMultipleRunsIntoSingle 

func AggregateMultipleRunsIntoSingle(runs []*sarif.Run, destination *sarif.Run)

func CombineMultipleRunsWithSameTool added in v1.16.1 

func CombineMultipleRunsWithSameTool(report *sarif.Report) (combined *sarif.Report)

func CombineReports 

func CombineReports(reports ...*sarif.Report) (combined *sarif.Report)

func ConvertRunsPathsToRelative 

func ConvertRunsPathsToRelative(runs ...*sarif.Run)

func ConvertRunsPathsToRelativeFromWd added in v1.23.0 

func ConvertRunsPathsToRelativeFromWd(wd string, runs ...*sarif.Run)

func CopyLocation 

func CopyLocation(location *sarif.Location) *sarif.Location

func CopyResult 

func CopyResult(result *sarif.Result) *sarif.Result

func CopyRules added in v1.13.0 

func CopyRules(rules ...*sarif.ReportingDescriptor) (copied []*sarif.ReportingDescriptor)

func CopyRun added in v1.13.0 

func CopyRun(run *sarif.Run) *sarif.Run

func CopyRunMetadata 

func CopyRunMetadata(run *sarif.Run) (copied *sarif.Run)

func CreateCodeFlow 

func CreateCodeFlow(threadFlows ...*sarif.ThreadFlow) *sarif.CodeFlow

func CreateDummyDriver 

func CreateDummyDriver(toolName string, rules ...*sarif.ReportingDescriptor) *sarif.ToolComponent

func CreateDummyLocationInPath 

func CreateDummyLocationInPath(fileName string) *sarif.Location

func CreateDummyLocationWithPathAndLogicalLocation 

func CreateDummyLocationWithPathAndLogicalLocation(fileName, logicalName, kind, property, value string) *sarif.Location

func CreateDummyPassingResult 

func CreateDummyPassingResult(ruleId string) *sarif.Result

func CreateDummyResult 

func CreateDummyResult(markdown, msg, ruleId, level string, locations ...*sarif.Location) *sarif.Result

func CreateDummyResultInPath 

func CreateDummyResultInPath(fileName string) *sarif.Result

func CreateDummyResultInPathWithPartialFingerprint added in v1.20.2 

func CreateDummyResultInPathWithPartialFingerprint(fileName string, partialFingerprints map[string]string) *sarif.Result

func CreateDummyResultWithFingerprint 

func CreateDummyResultWithFingerprint(markdown, msg, algorithm, value string, locations ...*sarif.Location) *sarif.Result

func CreateDummyResultWithPathAndLogicalLocation 

func CreateDummyResultWithPathAndLogicalLocation(fileName, logicalName, kind, property, value string) *sarif.Result

func CreateDummyRule added in v1.16.1 

func CreateDummyRule(impactPaths [][]formats.ComponentRow, ruleId, ruleDescription, summary, markdownDescription, maxCveScore string) *sarif.ReportingDescriptor

func CreateDummyRuleWithProperties added in v1.13.7 

func CreateDummyRuleWithProperties(id string, properties sarif.Properties) *sarif.ReportingDescriptor

func CreateLocation 

func CreateLocation(fileName string, startLine, startCol, endLine, endCol int, snippet string) *sarif.Location

func CreateLogicalLocationWithProperty 

func CreateLogicalLocationWithProperty(name, kind, property, value string) *sarif.LogicalLocation

func CreateResultWithDummyLocationAmdProperty 

func CreateResultWithDummyLocationAmdProperty(fileName, property, value string) *sarif.Result

func CreateResultWithLocations 

func CreateResultWithLocations(msg, ruleId, level string, locations ...*sarif.Location) *sarif.Result

func CreateResultWithOneLocation 

func CreateResultWithOneLocation(fileName string, startLine, startCol, endLine, endCol int, snippet, ruleId, level string) *sarif.Result

func CreateResultWithProperties 

func CreateResultWithProperties(msg, ruleId, level string, properties map[string]string, locations ...*sarif.Location) *sarif.Result

func CreateRunNameWithResults 

func CreateRunNameWithResults(toolName string, results ...*sarif.Result) *sarif.Run

func CreateRunWithDummyResultAndRuleInformation added in v1.13.7 

func CreateRunWithDummyResultAndRuleInformation(result *sarif.Result, ruleHelpMsg, ruleHelpMarkdown string, properties, values []string) *sarif.Run

func CreateRunWithDummyResultAndRuleProperties 

func CreateRunWithDummyResultAndRuleProperties(result *sarif.Result, properties, values []string) *sarif.Run

func CreateRunWithDummyResults 

func CreateRunWithDummyResults(results ...*sarif.Result) *sarif.Run

func CreateRunWithDummyResultsInWd 

func CreateRunWithDummyResultsInWd(wd string, results ...*sarif.Result) *sarif.Run

func CreateRunWithDummyResultsInWdWithHelp added in v1.13.7 

func CreateRunWithDummyResultsInWdWithHelp(helpMsg, helpMarkdown, wd string, results ...*sarif.Result) *sarif.Run

func CreateRunWithDummyResultsWithRuleInformation added in v1.13.7 

func CreateRunWithDummyResultsWithRuleInformation(toolName, ruleShortTxtDescription, ruleTxtDescription, ruleMarkdownDescription, ruleHelpMsg, ruleHelpMarkdown, wd string, results ...*sarif.Result) *sarif.Run

func CreateThreadFlow 

func CreateThreadFlow(locations ...*sarif.Location) *sarif.ThreadFlow

func GetDockerLayer added in v1.20.0 

func GetDockerLayer(location *sarif.Location) (layer, algorithm string)

func GetFullLocationFileName 

func GetFullLocationFileName(relative string, invocations []*sarif.Invocation) string

func GetInvocationWorkingDirectory 

func GetInvocationWorkingDirectory(invocation *sarif.Invocation) string

func GetLocationEndColumn 

func GetLocationEndColumn(location *sarif.Location) int

func GetLocationEndLine 

func GetLocationEndLine(location *sarif.Location) int

func GetLocationFileName 

func GetLocationFileName(location *sarif.Location) string

func GetLocationId 

func GetLocationId(location *sarif.Location) string

func GetLocationRelatedCodeFlowsFromResult 

func GetLocationRelatedCodeFlowsFromResult(location *sarif.Location, result *sarif.Result) (codeFlows []*sarif.CodeFlow)

func GetLocationSnippet 

func GetLocationSnippet(location *sarif.Location) *sarif.ArtifactContent

func GetLocationSnippetText 

func GetLocationSnippetText(location *sarif.Location) string

func GetLocationStartColumn 

func GetLocationStartColumn(location *sarif.Location) int

func GetLocationStartLine 

func GetLocationStartLine(location *sarif.Location) int

func GetLogicalLocation 

func GetLogicalLocation(kind string, location *sarif.Location) *sarif.LogicalLocation

func GetRelativeLocationFile added in v1.23.0 

func GetRelativeLocationFile(location *sarif.Location, wd string) string

func GetRelativeLocationFileName 

func GetRelativeLocationFileName(location *sarif.Location, invocations []*sarif.Invocation) string

func GetResultFailPrValue added in v1.20.0 

func GetResultFailPrValue(result *sarif.Result) (failPr bool)

func GetResultFileLocations 

func GetResultFileLocations(result *sarif.Result) []string

func GetResultFingerprint 

func GetResultFingerprint(result *sarif.Result) string

func GetResultIssueId added in v1.14.0 

func GetResultIssueId(result *sarif.Result) (issueId string)

func GetResultLocationSnippets 

func GetResultLocationSnippets(result *sarif.Result) []string

func GetResultMsgMarkdown added in v1.14.0 

func GetResultMsgMarkdown(result *sarif.Result) string

func GetResultMsgText 

func GetResultMsgText(result *sarif.Result) string

func GetResultPolicies added in v1.14.0 

func GetResultPolicies(result *sarif.Result) (policies []string)

func GetResultProperty 

func GetResultProperty(key string, result *sarif.Result) (value string)

func GetResultPropertyMetadata added in v1.20.0 

func GetResultPropertyMetadata(result *sarif.Result) string

func GetResultPropertyTokenValidation added in v1.20.0 

func GetResultPropertyTokenValidation(result *sarif.Result) string

func GetResultRuleId 

func GetResultRuleId(result *sarif.Result) string

func GetResultViolationType added in v1.23.0 

func GetResultViolationType(result *sarif.Result) (violationType string)

func GetResultWatches added in v1.14.0 

func GetResultWatches(result *sarif.Result) (watches string)

func GetResultsByRuleId added in v1.20.0 

func GetResultsByRuleId(ruleId string, runs ...*sarif.Run) (results []*sarif.Result)

func GetResultsLocationCount 

func GetResultsLocationCount(runs ...*sarif.Run) (count int)

func GetRuleById 

func GetRuleById(run *sarif.Run, ruleId string) *sarif.ReportingDescriptor

func GetRuleCWE added in v1.14.0 

func GetRuleCWE(rule *sarif.ReportingDescriptor) (cwe []string)

func GetRuleFullDescription 

func GetRuleFullDescription(rule *sarif.ReportingDescriptor) string

func GetRuleFullDescriptionMarkdown 

func GetRuleFullDescriptionMarkdown(rule *sarif.ReportingDescriptor) string

func GetRuleFullDescriptionText 

func GetRuleFullDescriptionText(rule *sarif.ReportingDescriptor) string

func GetRuleHelp 

func GetRuleHelp(rule *sarif.ReportingDescriptor) string

func GetRuleHelpMarkdown 

func GetRuleHelpMarkdown(rule *sarif.ReportingDescriptor) string

func GetRuleId added in v1.20.0 

func GetRuleId(rule *sarif.ReportingDescriptor) string

func GetRuleOrigin added in v1.20.0 

func GetRuleOrigin(rule *sarif.ReportingDescriptor) (origin string)

func GetRuleProperty 

func GetRuleProperty(key string, rule *sarif.ReportingDescriptor) string

func GetRuleScannerId added in v1.20.0 

func GetRuleScannerId(rule *sarif.ReportingDescriptor) (issueId string)

func GetRuleShortDescription 

func GetRuleShortDescription(rule *sarif.ReportingDescriptor) string

func GetRuleShortDescriptionText 

func GetRuleShortDescriptionText(rule *sarif.ReportingDescriptor) string

func GetRuleUndeterminedReason added in v1.20.0 

func GetRuleUndeterminedReason(rule *sarif.ReportingDescriptor) string

func GetRulesPropertyCount 

func GetRulesPropertyCount(property, value string, runs ...*sarif.Run) (count int)

func GetRunRules 

func GetRunRules(run *sarif.Run) []*sarif.ReportingDescriptor

func GetRunToolFullDescription 

func GetRunToolFullDescription(run *sarif.Run) string

func GetRunToolFullDescriptionMarkdown 

func GetRunToolFullDescriptionMarkdown(run *sarif.Run) string

func GetRunToolFullDescriptionText 

func GetRunToolFullDescriptionText(run *sarif.Run) string

func GetRunToolFullName 

func GetRunToolFullName(run *sarif.Run) string

func GetRunToolInformationURI 

func GetRunToolInformationURI(run *sarif.Run) string

func GetRunToolName 

func GetRunToolName(run *sarif.Run) string

func GetRunsByToolName 

func GetRunsByToolName(report *sarif.Report, toolName string) (filteredRuns []*sarif.Run)

func GetRunsByWorkingDirectory 

func GetRunsByWorkingDirectory(workingDirectory string, runs ...*sarif.Run) (filteredRuns []*sarif.Run)

func GetToolVersion 

func GetToolVersion(run *sarif.Run) string

func IsFingerprintsExists 

func IsFingerprintsExists(result *sarif.Result) bool

func NewLogicalLocation 

func NewLogicalLocation(name, kind string) *sarif.LogicalLocation

func NewPhysicalLocation 

func NewPhysicalLocation(physicalPath string) *sarif.PhysicalLocation

func NewPhysicalLocationWithRegion 

func NewPhysicalLocationWithRegion(physicalPath string, startRow, endRow, startCol, endCol int) *sarif.PhysicalLocation

func ReadScanRunsFromFile 

func ReadScanRunsFromFile(fileName string) (sarifRuns []*sarif.Run, err error)

func SetLocationFileName 

func SetLocationFileName(location *sarif.Location, fileName string)

func SetLocationSnippet 

func SetLocationSnippet(location *sarif.Location, snippet string)

func SetResultFingerprint 

func SetResultFingerprint(algorithm, value string, result *sarif.Result)

func SetResultMsgMarkdown 

func SetResultMsgMarkdown(markdown string, result *sarif.Result)

func SetRuleFullDescription added in v1.13.7 

func SetRuleFullDescription(msg, markdown string, rule *sarif.ReportingDescriptor)

func SetRuleHelp added in v1.13.7 

func SetRuleHelp(msg, markdown string, rule *sarif.ReportingDescriptor)

func SetRuleShortDescriptionText 

func SetRuleShortDescriptionText(value string, rule *sarif.ReportingDescriptor)

func SetRunToolFullDescriptionMarkdown 

func SetRunToolFullDescriptionMarkdown(markdown string, run *sarif.Run)

func SetRunToolFullDescriptionText 

func SetRunToolFullDescriptionText(txt string, run *sarif.Run)

func SetRunToolName 

func SetRunToolName(toolName string, run *sarif.Run)

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.