feat: add scanner name normalization

Signed-off-by: lvlcn-t <[email protected]>

Author: lvlcn-t

apis/v1alpha1/enums.go

@@ -5,6 +5,10 @@ import (
 	"crypto/sha512"
 	"encoding/base64"
 	"encoding/hex"
+	"strings"
+
+	"golang.org/x/text/cases"
+	"golang.org/x/text/language"
 )
 
 // Action represents the action to take when
@@ -102,6 +106,11 @@ func (s ScannerName) String() string {
 	return string(s)
 }
 
+// Normalize returns the scanner name in a normalized format (capitalized).
+func (s ScannerName) Normalize() ScannerName {
+	return ScannerName(cases.Title(language.English).String(strings.ToLower(s.String())))
+}
+
 const (
 	// ScannerGitleaks is the name of the ScannerGitleaks scanner.
 	ScannerGitleaks ScannerName = "Gitleaks"

apis/v1alpha1/scanpolicy_types.go

@@ -27,7 +27,7 @@ type ScanPolicySpec struct {
 	EnableConfigMapMutation bool `json:"enableConfigMapMutation,omitempty"`
 
 	// Scanner defines which detection engine to use for identifying secrets.
-	// +kubebuilder:validation:Enum=Gitleaks
+	// +kubebuilder:validation:Enum=Gitleaks;gitleaks
 	// +kubebuilder:default=Gitleaks
 	Scanner ScannerName `json:"scanner,omitempty"`
 

chart/crds/secretdetection.lvlcn-t.dev_scanpolicies.yaml

@@ -88,6 +88,7 @@ spec:
                   secrets.
                 enum:
                 - Gitleaks
+                - gitleaks
                 type: string
             type: object
           status:

config/crd/bases/secretdetection.lvlcn-t.dev_scanpolicies.yaml

@@ -88,6 +88,7 @@ spec:
                   secrets.
                 enum:
                 - Gitleaks
+                - gitleaks
                 type: string
             type: object
           status:

go.mod

@@ -13,6 +13,7 @@ require (
 	github.com/stretchr/testify v1.10.0
 	github.com/zricethezav/gitleaks/v8 v8.27.2
 	go.uber.org/zap v1.27.0
+	golang.org/x/text v0.25.0
 	k8s.io/api v0.33.1
 	k8s.io/apimachinery v0.33.1
 	k8s.io/client-go v0.33.1
@@ -114,7 +115,6 @@ require (
 	golang.org/x/sync v0.14.0 // indirect
 	golang.org/x/sys v0.33.0 // indirect
 	golang.org/x/term v0.32.0 // indirect
-	golang.org/x/text v0.25.0 // indirect
 	golang.org/x/time v0.11.0 // indirect
 	golang.org/x/tools v0.33.0 // indirect
 	gomodules.xyz/jsonpatch/v2 v2.5.0 // indirect

scanners/gitleaks.go

@@ -13,6 +13,7 @@ type Gitleaks struct {
 }
 
 func NewGitleaksScanner() *Gitleaks {
+	// TODO: let the user configure gitleaks config via scan policies
 	c := config.ViperConfig{
 		Extend: config.Extend{
 			UseDefault: true,

scanners/scanner.go

@@ -34,7 +34,7 @@ var scanners = map[v1alpha1.ScannerName]Scanner{
 // Get returns the scanner for the given name.
 // If the scanner is not found, it returns nil.
 func Get(name v1alpha1.ScannerName) Scanner {
-	if scanner, ok := scanners[name]; ok {
+	if scanner, ok := scanners[name.Normalize()]; ok {
 		return scanner
 	}
 	return nil