-
Notifications
You must be signed in to change notification settings - Fork 496
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added support for sarif formatted violation reports
- Loading branch information
1 parent
bea2473
commit d574068
Showing
4 changed files
with
97 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| Copyright (C) 2020 Accurics, Inc. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package writer | ||
|
|
||
| import ( | ||
| "github.com/accurics/terrascan/pkg/policy" | ||
| "github.com/owenrumney/go-sarif/sarif" | ||
| "io" | ||
| ) | ||
|
|
||
| const ( | ||
| sarifFormat supportedFormat = "sarif" | ||
| ) | ||
|
|
||
| func init() { | ||
| RegisterWriter(sarifFormat, SarifWriter) | ||
| } | ||
|
|
||
| // SarifWriter writes sarif formatted violation results report | ||
| func SarifWriter(data interface{}, writer io.Writer) error { | ||
| outputData := data.(policy.EngineOutput) | ||
| //summary := outputData.Summary | ||
| report, err := sarif.New(sarif.Version210) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| run := sarif.NewRun("terrascan", "https://github.com/accurics/terrascan") | ||
| // add a run to the report | ||
| report.AddRun(run) | ||
|
|
||
| // for each result add the rule, location and result to the report | ||
| for _, violation := range outputData.Violations { | ||
| m := make(map[string]string) | ||
| m["category"] = violation.Category | ||
| m["severity"] = violation.Severity | ||
|
|
||
| rule := run.AddRule(string(violation.RuleID)). | ||
| WithDescription(violation.Description).WithName(violation.RuleName).WithProperties(m) | ||
|
|
||
| run.AddResult(rule.ID). | ||
| WithMessage(sarif.NewTextMessage(violation.Description)). | ||
| WithMessage(sarif.NewMarkdownMessage(violation.Description)). | ||
| WithLevel(string(violation.Severity)). | ||
| WithLocation(sarif.NewLocation(). | ||
| WithPhysicalLocation(sarif.NewPhysicalLocation(). | ||
| WithArtifactLocation(sarif.NewSimpleArtifactLocation(violation.File)). | ||
| WithContextRegion(sarif.NewRegion().WithStartLine(violation.LineNumber)))) | ||
| } | ||
|
|
||
| // print the report to anything that implements `io.Writer` | ||
| return report.PrettyWrite(writer) | ||
| } |