added logical location

tenable · May 26, 2021 · ea7c9ae · ea7c9ae
1 parent e54cac8
commit ea7c9ae
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/pkg/writer/sarif.go b/pkg/writer/sarif.go
@@ -62,14 +62,21 @@ func SarifWriter(data interface{}, writer io.Writer) error {
 		rule := run.AddRule(string(violation.RuleID)).
 			WithDescription(violation.Description).WithName(violation.RuleName).WithProperties(m)
 
+		location := sarif.NewLocation().
+			WithPhysicalLocation(sarif.NewPhysicalLocation().
+				WithArtifactLocation(sarif.NewSimpleArtifactLocation(violation.File)).
+				WithContextRegion(sarif.NewRegion().WithStartLine(violation.LineNumber)))
+
+		if len(violation.ResourceType) > 0 && len(violation.ResourceName) > 0 {
+			location.LogicalLocations = append(location.LogicalLocations, sarif.NewLogicalLocation().
+				WithKind(violation.ResourceType).WithName(violation.ResourceName))
+		}
+
 		run.AddResult(rule.ID).
 			WithMessage(sarif.NewTextMessage(violation.Description)).
 			WithMessage(sarif.NewMarkdownMessage(violation.Description)).
 			WithLevel(getSarifLevel(violation.Severity)).
-			WithLocation(sarif.NewLocation().
-				WithPhysicalLocation(sarif.NewPhysicalLocation().
-					WithArtifactLocation(sarif.NewSimpleArtifactLocation(violation.File)).
-					WithContextRegion(sarif.NewRegion().WithStartLine(violation.LineNumber))))
+			WithLocation(location)
 	}
 
 	// print the report to anything that implements `io.Writer`

diff --git a/pkg/writer/sarif_test.go b/pkg/writer/sarif_test.go
@@ -49,7 +49,13 @@ const expectedSarifOutput1 = `{
                         "contextRegion": {
                           "startLine": 20
                         }
-                      }
+                      },
+                      "logicalLocations": [
+                        {
+                          "name": "bucket",
+                          "kind": "aws_s3_bucket"
+                        }
+                      ]
                     }
                   ]
                 }