-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add sarif output support
- Loading branch information
Showing
9 changed files
with
3,672 additions
and
10 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,224 @@ | ||
| package formatter | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/owenrumney/go-sarif/v2/sarif" | ||
|
|
||
| "github.com/Legit-Labs/legitify/internal/common/severity" | ||
| "github.com/Legit-Labs/legitify/internal/outputer/scheme" | ||
| ) | ||
|
|
||
| type sarifFormatter struct { | ||
| colorizer sarifColorizer | ||
| } | ||
|
|
||
| func newSarifFormatter() OutputFormatter { | ||
| return &sarifFormatter{ | ||
| colorizer: sarifColorizer{}, | ||
| } | ||
| } | ||
|
|
||
| func (f *sarifFormatter) Format(s scheme.Scheme, failedOnly bool) ([]byte, error) { | ||
| report, err := sarif.New(sarif.Version210) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| typedOutput, ok := s.(*scheme.Flattened) | ||
| if !ok { | ||
| return nil, UnsupportedScheme{s} | ||
| } | ||
|
|
||
| run := sarif.NewRunWithInformationURI("legitify", "https://legitify.dev/") | ||
|
|
||
| for _, policyName := range s.AsOrderedMap().Keys() { | ||
| data := typedOutput.GetPolicyData(policyName) | ||
| policyInfo := data.PolicyInfo | ||
|
|
||
| pb := sarif.NewPropertyBag() | ||
| pb.Add("impact", policyInfo.Threat) | ||
| pb.Add("resolution", policyInfo.RemediationSteps) | ||
| pb.Add("precision", "high") | ||
| pb.Add("problem.severity", sarifProblemSeverity(policyInfo.Severity)) | ||
| pb.Add("security-severity", sarifSecuritySeverity(policyInfo.Severity)) | ||
|
|
||
| run.AddRule(policyInfo.FullyQualifiedPolicyName). | ||
| WithDescription(policyInfo.Description). | ||
| WithShortDescription(sarif.NewMultiformatMessageString(policyInfo.Title)). | ||
| WithProperties(pb.Properties). | ||
| WithTextHelp(getPlaintextPolicySummary(typedOutput, policyName)). | ||
| WithMarkdownHelp(getMarkdownPolicySummary(typedOutput, policyName)) | ||
|
|
||
| // Tools like legitify don't fit perfectly into the SARIF model, so we're going to follow the | ||
| // lead of OpenSSF's scorecard output as a starting point. | ||
| // https://github.com/ossf/scorecard/blob/273dccda33590b7b46e98e19a9154f9da5400521/pkg/testdata/check6.sarif | ||
|
|
||
| for _, violation := range data.Violations { | ||
|
|
||
| var entityId interface{} | ||
| var ok bool | ||
|
|
||
| if violation.Aux != nil { | ||
| entityId, ok = violation.Aux.Get("entityId") | ||
| } | ||
|
|
||
| if !ok || violation.Aux == nil { | ||
| entityId = "unknown" | ||
| } | ||
|
|
||
| run.AddDistinctArtifact(violation.ViolationEntityType) | ||
| run.CreateResultForRule(policyInfo.FullyQualifiedPolicyName). | ||
| WithLevel(sarifSeverity(policyInfo.Severity)). | ||
| WithMessage(sarif.NewTextMessage(policyInfo.Description)). | ||
| WithHostedViewerUri(violation.CanonicalLink). | ||
| AddLocation( | ||
| sarif.NewLocationWithPhysicalLocation( | ||
| sarif.NewPhysicalLocation(). | ||
| WithArtifactLocation( | ||
| sarif.NewArtifactLocation(). | ||
| WithUri(fmt.Sprintf("%v", entityId)). | ||
| WithUriBaseId("legitify"), | ||
| ), | ||
| ), | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| report.AddRun(run) | ||
|
|
||
| bytes, err := json.MarshalIndent(report, "", DefaultOutputIndent) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return bytes, nil | ||
| } | ||
|
|
||
| func (f *sarifFormatter) IsSchemeSupported(schemeType string) bool { | ||
| return true | ||
| } | ||
|
|
||
| // See https://github.com/github/docs/issues/21221 | ||
| func sarifSeverity(s severity.Severity) string { | ||
| switch s { | ||
| case severity.Critical: | ||
| return "error" | ||
| case severity.High: | ||
| return "error" | ||
| case severity.Medium: | ||
| return "warning" | ||
| case severity.Low: | ||
| return "note" | ||
| default: | ||
| return "none" | ||
| } | ||
| } | ||
|
|
||
| func sarifProblemSeverity(s severity.Severity) string { | ||
| switch s { | ||
| case severity.Critical: | ||
| return "error" | ||
| case severity.High: | ||
| return "error" | ||
| case severity.Medium: | ||
| return "warning" | ||
| case severity.Low: | ||
| return "recommendation" | ||
| default: | ||
| return "recommendation" | ||
| } | ||
| } | ||
|
|
||
| func sarifSecuritySeverity(s severity.Severity) string { | ||
| switch s { | ||
| case severity.Critical: | ||
| return "9.0" | ||
| case severity.High: | ||
| return "7.0" | ||
| case severity.Medium: | ||
| return "4.0" | ||
| case severity.Low: | ||
| return "1.0" | ||
| default: | ||
| return "1.0" | ||
| } | ||
| } | ||
|
|
||
| func getPlaintextPolicySummary(output *scheme.Flattened, policyName string) string { | ||
| sFormatter := newSarifFormatter() | ||
| typedFormatter := sFormatter.(*sarifFormatter) | ||
| pf := newSarifPolicyFormatter() | ||
| pc := newPoliciesContent(pf, typedFormatter.colorizer) | ||
| return string(pc.FormatPolicy(output, policyName)) | ||
| } | ||
|
|
||
| func getMarkdownPolicySummary(output *scheme.Flattened, policyName string) string { | ||
| mdFormatter := newMarkdownFormatter() | ||
| typedFormatter := mdFormatter.(*markdownFormatter) | ||
| pf := newMarkdownPolicyFormatter() | ||
| pc := newPoliciesContent(pf, typedFormatter.colorizer) | ||
| return string(pc.FormatPolicy(output, policyName)) | ||
| } | ||
|
|
||
| type sarifColorizer struct { | ||
| } | ||
|
|
||
| func (sc sarifColorizer) colorize(tColor themeColor, text interface{}) string { | ||
| return text.(string) | ||
| } | ||
|
|
||
| // plaintext policy formatting | ||
| type sarifPolicyFormatter struct { | ||
| colorizer sarifColorizer | ||
| } | ||
|
|
||
| func newSarifPolicyFormatter() sarifPolicyFormatter { | ||
| return sarifPolicyFormatter{colorizer: sarifColorizer{}} | ||
| } | ||
|
|
||
| func (sp sarifPolicyFormatter) FormatTitle(title string, severity severity.Severity) string { | ||
| color := severityToThemeColor(severity) | ||
| title = sp.colorizer.colorize(color, title) | ||
|
|
||
| return title | ||
| } | ||
|
|
||
| func (sp sarifPolicyFormatter) FormatSubtitle(title string) string { | ||
| return title | ||
| } | ||
|
|
||
| func (sp sarifPolicyFormatter) FormatText(depth int, format string, args ...interface{}) string { | ||
| return indentMultilineSpecial(depth, fmt.Sprintf(format, args...), sp.Indent(1), sp.Linebreak()) | ||
| } | ||
|
|
||
| func (sp sarifPolicyFormatter) FormatList(depth int, title string, list []string, ordered bool) string { | ||
| if len(list) == 0 { | ||
| return "" | ||
| } | ||
|
|
||
| var sb strings.Builder | ||
| bullet := "*" | ||
| sb.WriteString(sp.FormatText(depth, "%s\n", title)) | ||
| for i, step := range list { | ||
| if ordered { | ||
| bullet = fmt.Sprintf("%d.", i+1) | ||
| } | ||
| sb.WriteString(sp.FormatText(depth, "%s %s\n", bullet, step)) | ||
| } | ||
|
|
||
| return sb.String() | ||
| } | ||
|
|
||
| func (sp sarifPolicyFormatter) Linebreak() string { | ||
| return " \n" | ||
| } | ||
|
|
||
| func (sp sarifPolicyFormatter) Separator() string { | ||
| return "---" | ||
| } | ||
|
|
||
| func (sp sarifPolicyFormatter) Indent(depth int) string { | ||
| return strings.Repeat(" ", depth) | ||
| } |
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,52 @@ | ||
| package formatter_test | ||
|
|
||
| import ( | ||
| "os" | ||
| "fmt" | ||
| "context" | ||
| "encoding/json" | ||
| "testing" | ||
|
|
||
| "github.com/Legit-Labs/legitify/internal/outputer/formatter" | ||
| "github.com/Legit-Labs/legitify/internal/outputer/scheme/scheme_test" | ||
| "github.com/qri-io/jsonschema" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestFormatSarif(t *testing.T) { | ||
| sample := scheme_test.SchemeSample() | ||
|
|
||
| for _, f := range []bool{true, false} { | ||
| bytes, err := formatter.Format(formatter.Sarif, formatter.DefaultOutputIndent, sample, f) | ||
| require.Nilf(t, err, "Error formatting sarif: %v", err) | ||
| require.NotNil(t, bytes, "Error formatting sarif") | ||
| require.NotEmpty(t, bytes, "Error formatting sarif") | ||
|
|
||
| ctx := context.Background() | ||
|
|
||
| schemaData, err := os.ReadFile("formatter_test/sarif_v2.1.0_schema.json") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // QRI + JSON schema draft-07 compatibility | ||
| // See https://github.com/qri-io/jsonschema/issues/114#issuecomment-1102010496 | ||
| jsonschema.RegisterKeyword("definitions", jsonschema.NewDefs) | ||
|
|
||
| rs := &jsonschema.Schema{} | ||
| if err := json.Unmarshal(schemaData, rs); err != nil { | ||
| panic("unmarshal schema: " + err.Error()) | ||
| } | ||
|
|
||
| errs, err := rs.ValidateBytes(ctx, bytes) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| if len(errs) > 0 { | ||
| fmt.Println(errs[0].Error()) | ||
| } | ||
|
|
||
| require.Emptyf(t, errs, "SARIF output does not match schema: %v", errs) | ||
| } | ||
| } |
Oops, something went wrong.