Skip to content

Commit

Permalink
Unite relative path conversion (#947)
Browse files Browse the repository at this point in the history
  • Loading branch information
@sverdlov93
sverdlov93 authored Sep 12, 2023
1 parent 7931ffa commit 36ab1fb
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 157 deletions.
24 changes: 6 additions & 18 deletions xray/formats/conversion.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,32 +146,20 @@ func ConvertToSecretsTableRow(rows []SourceCodeRow) (tableRows []secretsTableRow
tableRows = append(tableRows, secretsTableRow{
severity: rows[i].Severity,
file: rows[i].File,
lineColumn: (strconv.Itoa(rows[i].StartLine) + ":" + strconv.Itoa(rows[i].StartColumn)),
text: rows[i].Snippet,
lineColumn: strconv.Itoa(rows[i].StartLine) + ":" + strconv.Itoa(rows[i].StartColumn),
secret: rows[i].Snippet,
})
}
return
}

func ConvertToIacTableRow(rows []SourceCodeRow) (tableRows []iacTableRow) {
func ConvertToIacOrSastTableRow(rows []SourceCodeRow) (tableRows []iacOrSastTableRow) {
for i := range rows {
tableRows = append(tableRows, iacTableRow{
tableRows = append(tableRows, iacOrSastTableRow{
severity: rows[i].Severity,
file: rows[i].File,
lineColumn: (strconv.Itoa(rows[i].StartLine) + ":" + strconv.Itoa(rows[i].StartColumn)),
text: rows[i].Snippet,
})
}
return
}

func ConvertToSastTableRow(rows []SourceCodeRow) (tableRows []sastTableRow) {
for i := range rows {
tableRows = append(tableRows, sastTableRow{
severity: rows[i].Severity,
file: rows[i].File,
lineColumn: (strconv.Itoa(rows[i].StartLine) + ":" + strconv.Itoa(rows[i].StartColumn)),
text: rows[i].Snippet,
lineColumn: strconv.Itoa(rows[i].StartLine) + ":" + strconv.Itoa(rows[i].StartColumn),
finding: rows[i].Finding,
})
}
return
Expand Down
1 change: 0 additions & 1 deletion xray/formats/simplejsonapi.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ type SourceCodeRow struct {
Severity string `json:"severity"`
SeverityNumValue int `json:"-"` // For sorting
Location
Type string `json:"type"`
Finding string `json:"finding,omitempty"`
ScannerDescription string `json:"scannerDescription,omitempty"`
CodeFlow [][]Location `json:"codeFlow,omitempty"`
Expand Down
13 changes: 3 additions & 10 deletions xray/formats/table.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,19 +127,12 @@ type secretsTableRow struct {
severity string `col-name:"Severity"`
file string `col-name:"File"`
lineColumn string `col-name:"Line:Column"`
text string `col-name:"Secret"`
secret string `col-name:"Secret"`
}

type iacTableRow struct {
type iacOrSastTableRow struct {
severity string `col-name:"Severity"`
file string `col-name:"File"`
lineColumn string `col-name:"Line:Column"`
text string `col-name:"Finding"`
}

type sastTableRow struct {
severity string `col-name:"Severity"`
file string `col-name:"File"`
lineColumn string `col-name:"Line:Column"`
text string `col-name:"Finding"`
finding string `col-name:"Finding"`
}
2 changes: 1 addition & 1 deletion xray/utils/analyzermanager.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const (
EntitlementsMinVersion = "3.66.5"
ApplicabilityFeatureId = "contextual_analysis"
AnalyzerManagerZipName = "analyzerManager.zip"
defaultAnalyzerManagerVersion = "1.2.4.1953469"
defaultAnalyzerManagerVersion = "1.2.4.2000151"
minAnalyzerManagerVersionForSast = "1.3"
analyzerManagerDownloadPath = "xsc-gen-exe-analyzer-manager-local/v1"
analyzerManagerDirName = "analyzerManager"
Expand Down
52 changes: 25 additions & 27 deletions xray/utils/resultstable.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,23 +302,22 @@ func PrepareSecrets(secrets []*sarif.Run) []formats.SourceCodeRow {
func prepareSecrets(secrets []*sarif.Run, isTable bool) []formats.SourceCodeRow {
var secretsRows []formats.SourceCodeRow
for _, secretRun := range secrets {
for _, secret := range secretRun.Results {
currSeverity := GetSeverity(GetResultSeverity(secret), Applicable)
for _, location := range secret.Locations {
for _, secretResult := range secretRun.Results {
currSeverity := GetSeverity(GetResultSeverity(secretResult), Applicable)
for _, location := range secretResult.Locations {
secretsRows = append(secretsRows,
formats.SourceCodeRow{
Severity: currSeverity.printableTitle(isTable),
Finding: GetResultMsgText(secret),
Finding: GetResultMsgText(secretResult),
SeverityNumValue: currSeverity.numValue,
Location: formats.Location{
File: GetLocationFileName(location),
File: GetRelativeLocationFileName(location, secretRun.Invocations),
StartLine: GetLocationStartLine(location),
StartColumn: GetLocationStartColumn(location),
EndLine: GetLocationEndLine(location),
EndColumn: GetLocationEndColumn(location),
Snippet: GetLocationSnippet(location),
},
Type: *secret.RuleID,
},
)
}
Expand Down Expand Up @@ -350,28 +349,27 @@ func PrepareIacs(iacs []*sarif.Run) []formats.SourceCodeRow {
func prepareIacs(iacs []*sarif.Run, isTable bool) []formats.SourceCodeRow {
var iacRows []formats.SourceCodeRow
for _, iacRun := range iacs {
for _, iac := range iacRun.Results {
for _, iacResult := range iacRun.Results {
scannerDescription := ""
if rule, err := iacRun.GetRuleById(*iac.RuleID); err == nil {
if rule, err := iacRun.GetRuleById(*iacResult.RuleID); err == nil {
scannerDescription = GetRuleFullDescription(rule)
}
currSeverity := GetSeverity(GetResultSeverity(iac), Applicable)
for _, location := range iac.Locations {
currSeverity := GetSeverity(GetResultSeverity(iacResult), Applicable)
for _, location := range iacResult.Locations {
iacRows = append(iacRows,
formats.SourceCodeRow{
Severity: currSeverity.printableTitle(isTable),
Finding: GetResultMsgText(iac),
Finding: GetResultMsgText(iacResult),
ScannerDescription: scannerDescription,
SeverityNumValue: currSeverity.numValue,
Location: formats.Location{
File: GetLocationFileName(location),
File: GetRelativeLocationFileName(location, iacRun.Invocations),
StartLine: GetLocationStartLine(location),
StartColumn: GetLocationStartColumn(location),
EndLine: GetLocationEndLine(location),
EndColumn: GetLocationEndColumn(location),
Snippet: GetLocationSnippet(location),
},
Type: *iac.RuleID,
},
)
}
Expand All @@ -389,7 +387,7 @@ func PrintIacTable(iacs []*sarif.Run, entitledForIacScan bool) error {
if entitledForIacScan {
iacRows := prepareIacs(iacs, true)
log.Output()
return coreutils.PrintTable(formats.ConvertToIacTableRow(iacRows), "Infrastructure as Code Vulnerabilities",
return coreutils.PrintTable(formats.ConvertToIacOrSastTableRow(iacRows), "Infrastructure as Code Vulnerabilities",
"✨ No Infrastructure as Code vulnerabilities were found ✨", false)
}
return nil
Expand All @@ -402,30 +400,30 @@ func PrepareSast(sasts []*sarif.Run) []formats.SourceCodeRow {
func prepareSast(sasts []*sarif.Run, isTable bool) []formats.SourceCodeRow {
var sastRows []formats.SourceCodeRow
for _, sastRun := range sasts {
for _, sast := range sastRun.Results {
for _, sastResult := range sastRun.Results {
scannerDescription := ""
if rule, err := sastRun.GetRuleById(*sast.RuleID); err == nil {
if rule, err := sastRun.GetRuleById(*sastResult.RuleID); err == nil {
scannerDescription = GetRuleFullDescription(rule)
}
currSeverity := GetSeverity(GetResultSeverity(sast), Applicable)
flows := toSourceCodeCodeFlowRow(sast.CodeFlows, isTable)
for _, location := range sast.Locations {
currSeverity := GetSeverity(GetResultSeverity(sastResult), Applicable)

for _, location := range sastResult.Locations {
codeFlows := GetLocationRelatedCodeFlowsFromResult(location, sastResult)
sastRows = append(sastRows,
formats.SourceCodeRow{
Severity: currSeverity.printableTitle(isTable),
Finding: GetResultMsgText(sast),
Finding: GetResultMsgText(sastResult),
ScannerDescription: scannerDescription,
SeverityNumValue: currSeverity.numValue,
Location: formats.Location{
File: GetLocationFileName(location),
File: GetRelativeLocationFileName(location, sastRun.Invocations),
StartLine: GetLocationStartLine(location),
StartColumn: GetLocationStartColumn(location),
EndLine: GetLocationEndLine(location),
EndColumn: GetLocationEndColumn(location),
Snippet: GetLocationSnippet(location),
},
Type: *sast.RuleID,
CodeFlow: flows,
CodeFlow: codeFlowToLocationFlow(codeFlows, sastRun.Invocations, isTable),
},
)
}
Expand All @@ -439,7 +437,7 @@ func prepareSast(sasts []*sarif.Run, isTable bool) []formats.SourceCodeRow {
return sastRows
}

func toSourceCodeCodeFlowRow(flows []*sarif.CodeFlow, isTable bool) (flowRows [][]formats.Location) {
func codeFlowToLocationFlow(flows []*sarif.CodeFlow, invocations []*sarif.Invocation, isTable bool) (flowRows [][]formats.Location) {
if isTable {
// Not displaying in table
return
Expand All @@ -449,7 +447,7 @@ func toSourceCodeCodeFlowRow(flows []*sarif.CodeFlow, isTable bool) (flowRows []
rowFlow := []formats.Location{}
for _, stackTraceEntry := range stackTrace.Locations {
rowFlow = append(rowFlow, formats.Location{
File: GetLocationFileName(stackTraceEntry.Location),
File: GetRelativeLocationFileName(stackTraceEntry.Location, invocations),
StartLine: GetLocationStartLine(stackTraceEntry.Location),
StartColumn: GetLocationStartColumn(stackTraceEntry.Location),
EndLine: GetLocationEndLine(stackTraceEntry.Location),
Expand All @@ -467,7 +465,7 @@ func PrintSastTable(sast []*sarif.Run, entitledForSastScan bool) error {
if entitledForSastScan {
sastRows := prepareSast(sast, true)
log.Output()
return coreutils.PrintTable(formats.ConvertToSastTableRow(sastRows), "Static Application Security Testing (SAST)",
return coreutils.PrintTable(formats.ConvertToIacOrSastTableRow(sastRows), "Static Application Security Testing (SAST)",
"✨ No Static Application Security Testing vulnerabilities were found ✨", false)
}
return nil
Expand Down Expand Up @@ -979,7 +977,7 @@ func getCveApplicability(cve formats.CveRow, applicabilityScanResults []*sarif.R
for _, location := range foundResult.Locations {
applicability.Evidence = append(applicability.Evidence, formats.Evidence{
Location: formats.Location{
File: GetLocationFileName(location),
File: GetRelativeLocationFileName(location, applicabilityRun.Invocations),
StartLine: GetLocationStartLine(location),
StartColumn: GetLocationStartColumn(location),
EndLine: GetLocationEndLine(location),
Expand Down
32 changes: 0 additions & 32 deletions xray/utils/resultwriter.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,50 +92,18 @@ func printScanResultsTables(results *ExtendedScanResults, isBinaryScan, includeV
return
}
}
ConvertRunsPathsToRelative(results.SecretsScanResults)
if err = PrintSecretsTable(results.SecretsScanResults, results.EntitledForJas); err != nil {
return
}
ConvertRunsPathsToRelative(results.IacScanResults)
if err = PrintIacTable(results.IacScanResults, results.EntitledForJas); err != nil {
return
}
if !IsSastSupported() {
return
}
ConvertRunsPathsToRelative(results.SastScanResults)
return PrintSastTable(results.SastScanResults, results.EntitledForJas)
}

// The paths at Sarif runs are absolute.
// Use this method if you need to translate the file paths to relative
func ConvertRunsPathsToRelative(runs []*sarif.Run) {
for _, sarifRun := range runs {
for _, invocation := range sarifRun.Invocations {
if wd := GetInvocationWorkingDirectory(invocation); len(wd) > 0 {
ConvertRunPathsToRelative(sarifRun, wd)
}
}
}
}

func ConvertRunPathsToRelative(sarifRun *sarif.Run, wd string) {
for _, sarifResult := range sarifRun.Results {
// Convert paths in locations
for _, location := range sarifResult.Locations {
SetLocationFileName(location, ExtractRelativePath(GetLocationFileName(location), wd))
}
// Convert paths in code flows
for _, codeFlows := range sarifResult.CodeFlows {
for _, threadFlows := range codeFlows.ThreadFlows {
for _, location := range threadFlows.Locations {
SetLocationFileName(location.Location, ExtractRelativePath(GetLocationFileName(location.Location), wd))
}
}
}
}
}

func printMessages(messages []string) {
if len(messages) > 0 {
log.Output()
Expand Down
Loading

0 comments on commit 36ab1fb

Please sign in to comment.