filter component

Author: northdpole

components/filters/severity/component.yaml

@@ -0,0 +1,13 @@
+name: severity
+description: "Tags all findings below a certain severity as 'Filtered Out'"
+type: filter
+parameters:
+  - name: minimum_severity
+    type: string
+    value: "High"
+steps:
+  - name: filters
+    image: components/filters/severity
+    env_vars:
+      MINIMUM_SEVERITY: "{{.parameters.minimum_severity}}"
+    executable: /bin/app

components/filters/severity/go.mod

@@ -0,0 +1,57 @@
+module github.com/smithy-security/smithy/components/filters/severity
+
+go 1.23.7
+
+require github.com/smithy-security/smithy/sdk v0.0.7-alpha
+
+require (
+	ariga.io/atlas v0.29.0 // indirect
+	github.com/Masterminds/goutils v1.1.1 // indirect
+	github.com/Masterminds/semver/v3 v3.2.0 // indirect
+	github.com/Masterminds/sprig/v3 v3.2.3 // indirect
+	github.com/abice/go-enum v0.6.0 // indirect
+	github.com/agext/levenshtein v1.2.3 // indirect
+	github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
+	github.com/bmatcuk/doublestar v1.3.4 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/go-errors/errors v1.5.1 // indirect
+	github.com/go-openapi/inflect v0.19.0 // indirect
+	github.com/golang/mock v1.6.0 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/hashicorp/hcl/v2 v2.18.1 // indirect
+	github.com/huandu/xstrings v1.3.3 // indirect
+	github.com/imdario/mergo v0.3.13 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
+	github.com/jackc/pgx/v5 v5.6.0 // indirect
+	github.com/jonboulle/clockwork v0.4.0 // indirect
+	github.com/labstack/gommon v0.4.1 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-sqlite3 v1.14.24 // indirect
+	github.com/mattn/goveralls v0.0.12 // indirect
+	github.com/mitchellh/copystructure v1.2.0 // indirect
+	github.com/mitchellh/go-wordwrap v1.0.1 // indirect
+	github.com/mitchellh/reflectwalk v1.0.2 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/shopspring/decimal v1.2.0 // indirect
+	github.com/smithy-security/pkg/env v0.0.1 // indirect
+	github.com/spf13/cast v1.3.1 // indirect
+	github.com/sqlc-dev/sqlc v1.27.0 // indirect
+	github.com/urfave/cli/v2 v2.26.0 // indirect
+	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
+	github.com/zclconf/go-cty v1.14.4 // indirect
+	go.uber.org/mock v0.5.0 // indirect
+	golang.org/x/crypto v0.24.0 // indirect
+	golang.org/x/mod v0.18.0 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/sync v0.8.0 // indirect
+	golang.org/x/sys v0.22.0 // indirect
+	golang.org/x/text v0.16.0 // indirect
+	golang.org/x/tools v0.22.0 // indirect
+	golang.org/x/tools/cmd/cover v0.1.0-deprecated // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240528184218-531527333157 // indirect
+	google.golang.org/grpc v1.65.0 // indirect
+	google.golang.org/protobuf v1.35.1 // indirect
+)

components/filters/severity/go.sum

@@ -0,0 +1,40 @@
+package main
+
+import (
+	"context"
+	"log"
+	"log/slog"
+	"time"
+
+	"github.com/smithy-security/smithy/sdk/component"
+	vf "github.com/smithy-security/smithy/sdk/component/vulnerability-finding"
+	v1 "github.com/smithy-security/smithy/sdk/gen/ocsf_schema/v1"
+)
+
+type SeverityFilter struct{}
+
+func (s SeverityFilter) Filter(ctx context.Context, findings []*vf.VulnerabilityFinding) ([]*vf.VulnerabilityFinding, bool, error) {
+	component.LoggerFromContext(ctx).Info("Running Severity Filter")
+	findings_filtered := 0
+	for _, f := range findings {
+		switch f.Finding.SeverityId {
+		case v1.VulnerabilityFinding_SEVERITY_ID_UNKNOWN:
+		case v1.VulnerabilityFinding_SEVERITY_ID_INFORMATIONAL:
+		case v1.VulnerabilityFinding_SEVERITY_ID_LOW:
+		case v1.VulnerabilityFinding_SEVERITY_ID_MEDIUM:
+			f.Finding.Enrichments = append(f.Finding.Enrichments, &v1.Enrichment{})
+			findings_filtered++
+		}
+	}
+	component.LoggerFromContext(ctx).Info("filtered", slog.Int("findings_filtered", findings_filtered))
+	return findings, findings_filtered > 0, nil
+}
+
+func main() {
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
+	defer cancel()
+
+	if err := component.RunFilter(ctx, SeverityFilter{}); err != nil {
+		log.Fatalf("unexpected run error: %v", err)
+	}
+}