Skip to content

Reject unsupported finding severities in baselines #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bomly-guy merged 1 commit into from
Jul 23, 2026
Merged

Reject unsupported finding severities in baselines #300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion internal/baseline/baseline.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ func (d Document) Validate() error {
default:
return fmt.Errorf("baseline entry %d has unsupported policy_status %q", idx, entry.PolicyStatus)
}
if entry.Severity != "" && sdk.ParseSeverityLevel(string(entry.Severity)) != entry.Severity {
if !validBaselineSeverity(entry.Severity) {
return fmt.Errorf("baseline entry %d has unsupported severity %q", idx, entry.Severity)
}
switch entry.Reachability {
Expand Down Expand Up @@ -154,6 +154,24 @@ func (d Document) Validate() error {
return nil
}

func validBaselineSeverity(severity sdk.SeverityLevel) bool {
switch severity {
case "",
sdk.SeverityUnknown,
sdk.SeverityLevel("n/a"),
sdk.SeverityLow,
sdk.SeverityMedium,
sdk.SeverityHigh,
sdk.SeverityCritical,
sdk.SeverityNote,
sdk.SeverityWarning,
sdk.SeverityError:
return true
default:
return false
}
}

// Load reads and validates a baseline document.
func Load(path string) (Document, error) {
data, err := os.ReadFile(path)
Expand Down
35 changes: 35 additions & 0 deletions internal/baseline/baseline_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,41 @@ func TestDocumentUsesFriendlyPolicyStatusField(t *testing.T) {
}
}

func TestDocumentRejectsUnsupportedSeverity(t *testing.T) {
document := NewDocument([]sdk.Finding{{
ID: "rule", Kind: sdk.FindingKindPackage, Auditor: "package",
RuleID: "rule", PackageRef: "pkg:npm/example@1.0.0",
}}, nil)
document.Entries[0].Severity = sdk.SeverityLevel("urgent")
if err := document.Validate(); err == nil || !strings.Contains(err.Error(), `unsupported severity "urgent"`) {
t.Fatalf("Validate() error = %v", err)
}
}

func TestDocumentAcceptsFindingSeverityVocabulary(t *testing.T) {
for _, severity := range []sdk.SeverityLevel{
"",
sdk.SeverityUnknown,
sdk.SeverityLevel("n/a"),
sdk.SeverityLow,
sdk.SeverityMedium,
sdk.SeverityHigh,
sdk.SeverityCritical,
sdk.SeverityNote,
sdk.SeverityWarning,
sdk.SeverityError,
} {
document := NewDocument([]sdk.Finding{{
ID: "rule", Kind: sdk.FindingKindPackage, Auditor: "package",
RuleID: "rule", PackageRef: "pkg:npm/example@1.0.0",
}}, nil)
document.Entries[0].Severity = severity
if err := document.Validate(); err != nil {
t.Errorf("severity %q rejected: %v", severity, err)
}
}
}

func TestResolvePathSelections(t *testing.T) {
root := t.TempDir()
sbomPath := filepath.Join(root, "bom.json")
Expand Down