Implement WAFPolicy controller

Author: ciarams87

internal/controller/manager.go

@@ -48,6 +48,7 @@ import (
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies/clientsettings"
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies/observability"
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies/upstreamsettings"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies/wafsettings"
 	ngxvalidation "github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/validation"
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/provisioner"
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/state"
@@ -326,6 +327,10 @@ func createPolicyManager(
 			GVK:       mustExtractGVK(&ngfAPIv1alpha1.UpstreamSettingsPolicy{}),
 			Validator: upstreamsettings.NewValidator(validator),
 		},
+		{
+			GVK:       mustExtractGVK(&ngfAPIv1alpha1.WAFPolicy{}),
+			Validator: wafsettings.NewValidator(validator),
+		},
 	}
 
 	return policies.NewManager(mustExtractGVK, cfgs...)
@@ -507,6 +512,12 @@ func registerControllers(
 				controller.WithK8sPredicate(k8spredicate.GenerationChangedPredicate{}),
 			},
 		},
+		{
+			objectType: &ngfAPIv1alpha1.WAFPolicy{},
+			options: []controller.Option{
+				controller.WithK8sPredicate(k8spredicate.GenerationChangedPredicate{}),
+			},
+		},
 	}
 
 	if cfg.ExperimentalFeatures {
@@ -745,6 +756,7 @@ func prepareFirstEventBatchPreparerArgs(cfg config.Config) ([]client.Object, []c
 		&ngfAPIv1alpha1.ClientSettingsPolicyList{},
 		&ngfAPIv1alpha2.ObservabilityPolicyList{},
 		&ngfAPIv1alpha1.UpstreamSettingsPolicyList{},
+		&ngfAPIv1alpha1.WAFPolicyList{},
 		partialObjectMetadataList,
 	}
 

internal/controller/manager_test.go

@@ -68,6 +68,7 @@ func TestPrepareFirstEventBatchPreparerArgs(t *testing.T) {
 				&ngfAPIv1alpha1.ClientSettingsPolicyList{},
 				&ngfAPIv1alpha2.ObservabilityPolicyList{},
 				&ngfAPIv1alpha1.UpstreamSettingsPolicyList{},
+				&ngfAPIv1alpha1.WAFPolicyList{},
 			},
 		},
 		{
@@ -97,6 +98,7 @@ func TestPrepareFirstEventBatchPreparerArgs(t *testing.T) {
 				&ngfAPIv1alpha1.ClientSettingsPolicyList{},
 				&ngfAPIv1alpha2.ObservabilityPolicyList{},
 				&ngfAPIv1alpha1.UpstreamSettingsPolicyList{},
+				&ngfAPIv1alpha1.WAFPolicyList{},
 			},
 		},
 		{
@@ -124,6 +126,7 @@ func TestPrepareFirstEventBatchPreparerArgs(t *testing.T) {
 				&ngfAPIv1alpha2.ObservabilityPolicyList{},
 				&ngfAPIv1alpha1.SnippetsFilterList{},
 				&ngfAPIv1alpha1.UpstreamSettingsPolicyList{},
+				&ngfAPIv1alpha1.WAFPolicyList{},
 			},
 		},
 		{
@@ -154,6 +157,7 @@ func TestPrepareFirstEventBatchPreparerArgs(t *testing.T) {
 				&ngfAPIv1alpha2.ObservabilityPolicyList{},
 				&ngfAPIv1alpha1.SnippetsFilterList{},
 				&ngfAPIv1alpha1.UpstreamSettingsPolicyList{},
+				&ngfAPIv1alpha1.WAFPolicyList{},
 			},
 		},
 	}

internal/controller/nginx/config/generator.go

@@ -16,6 +16,7 @@ import (
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies/clientsettings"
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies/observability"
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies/upstreamsettings"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies/wafsettings"
 	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/dataplane"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/file"
 )
@@ -44,6 +45,9 @@ const (
 	// includesFolder is the folder where are all include files are stored.
 	includesFolder = configFolder + "/includes"
 
+	// appProtectBundleFolder is the folder where the NGINX App Protect WAF bundles are stored.
+	appProtectBundleFolder = "/etc/app_protect/bundles"
+
 	// httpConfigFile is the path to the configuration file with HTTP configuration.
 	httpConfigFile = httpFolder + "/http.conf"
 
@@ -119,10 +123,15 @@ func (g GeneratorImpl) Generate(conf dataplane.Configuration) []agent.File {
 	policyGenerator := policies.NewCompositeGenerator(
 		clientsettings.NewGenerator(),
 		observability.NewGenerator(conf.Telemetry),
+		wafsettings.NewGenerator(),
 	)
 
 	files = append(files, g.executeConfigTemplates(conf, policyGenerator)...)
 
+	for id, bundle := range conf.WAF.WAFBundles {
+		files = append(files, generateWAFBundle(id, bundle))
+	}
+
 	for id, bundle := range conf.CertBundles {
 		files = append(files, generateCertBundle(id, bundle))
 	}
@@ -245,3 +254,19 @@ func generateCertBundle(id dataplane.CertBundleID, cert []byte) agent.File {
 func generateCertBundleFileName(id dataplane.CertBundleID) string {
 	return filepath.Join(secretsFolder, string(id)+".crt")
 }
+
+func generateWAFBundle(id dataplane.WAFBundleID, bundle []byte) agent.File {
+	return agent.File{
+		Meta: &pb.FileMeta{
+			Name:        GenerateWAFBundleFileName(id),
+			Hash:        filesHelper.GenerateHash(bundle),
+			Permissions: file.RegularFileMode,
+			Size:        int64(len(bundle)),
+		},
+		Contents: bundle,
+	}
+}
+
+func GenerateWAFBundleFileName(id dataplane.WAFBundleID) string {
+	return filepath.Join(appProtectBundleFolder, string(id)+".tgz")
+}

internal/controller/nginx/config/policies/policy.go

@@ -26,6 +26,8 @@ type Policy interface {
 type GlobalSettings struct {
 	// TelemetryEnabled is whether telemetry is enabled in the NginxProxy resource.
 	TelemetryEnabled bool
+	// WAFEnabled is whether WAF is enabled in the NginxProxy resource.
+	WAFEnabled bool
 }
 
 // ValidateTargetRef validates a policy's targetRef for the proper group and kind.

internal/controller/nginx/config/policies/wafsettings/generator.go

@@ -0,0 +1,124 @@
+package wafsettings
+
+import (
+	"fmt"
+	"text/template"
+
+	filesHelper "github.com/nginx/agent/v3/pkg/files"
+
+	ngfAPI "github.com/nginx/nginx-gateway-fabric/apis/v1alpha1"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/http"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/policies"
+	"github.com/nginx/nginx-gateway-fabric/internal/framework/helpers"
+)
+
+var tmpl = template.Must(template.New("waf policy").Parse(wafTemplate))
+
+const wafTemplate = `
+{{- if .BundlePath }}
+app_protect_enable on;
+app_protect_policy_file "{{ .BundlePath }}";
+{{- end }}
+{{- if .SecurityLogs }}
+app_protect_security_log_enable on;
+{{- range .SecurityLogs }}
+{{- if .LogProfile }}
+app_protect_security_log "{{ .LogProfile }}" {{ .Destination }};
+{{- else if .LogProfileBundlePath }}
+app_protect_security_log "{{ .LogProfileBundlePath }}" {{ .Destination }};
+{{- end }}
+{{- end }}
+{{- end }}
+`
+
+// Generator generates nginx configuration based on a WAF policy.
+type Generator struct {
+	policies.UnimplementedGenerator
+}
+
+// NewGenerator returns a new instance of Generator.
+func NewGenerator() *Generator {
+	return &Generator{}
+}
+
+// GenerateForServer generates policy configuration for the server block.
+func (g Generator) GenerateForServer(pols []policies.Policy, _ http.Server) policies.GenerateResultFiles {
+	return generate(pols)
+}
+
+// GenerateForLocation generates policy configuration for a normal location block.
+func (g Generator) GenerateForLocation(pols []policies.Policy, _ http.Location) policies.GenerateResultFiles {
+	return generate(pols)
+}
+
+func generate(pols []policies.Policy) policies.GenerateResultFiles {
+	files := make(policies.GenerateResultFiles, 0, len(pols))
+
+	for _, pol := range pols {
+		wp, ok := pol.(*ngfAPI.WAFPolicy)
+		if !ok {
+			continue
+		}
+
+		fields := map[string]any{}
+
+		if wp.Spec.PolicySource != nil && wp.Spec.PolicySource.FileLocation != "" {
+			fileLocation := wp.Spec.PolicySource.FileLocation
+			// use SHA of file location as file path name
+			bundleName := filesHelper.GenerateHash([]byte(fileLocation))
+			bundlePath := fmt.Sprintf("%s/%s.tgz", "/etc/app_protect/bundles", bundleName)
+			fields["BundlePath"] = bundlePath
+		}
+
+		if len(wp.Spec.SecurityLogs) > 0 {
+			securityLogs := make([]map[string]string, 0, len(wp.Spec.SecurityLogs))
+
+			for _, secLog := range wp.Spec.SecurityLogs {
+				logEntry := map[string]string{}
+
+				if secLog.LogProfile != nil {
+					logEntry["LogProfile"] = string(*secLog.LogProfile)
+				}
+
+				if secLog.LogProfileBundle != nil && secLog.LogProfileBundle.FileLocation != "" {
+					bundleName := filesHelper.GenerateHash([]byte(secLog.LogProfileBundle.FileLocation))
+					bundlePath := fmt.Sprintf("%s/%s.tgz", "/etc/app_protect/bundles", bundleName)
+					logEntry["LogProfileBundlePath"] = bundlePath
+				}
+
+				destination := formatSecurityLogDestination(secLog.Destination)
+				logEntry["Destination"] = destination
+
+				securityLogs = append(securityLogs, logEntry)
+			}
+
+			fields["SecurityLogs"] = securityLogs
+		}
+
+		files = append(files, policies.File{
+			Name:    fmt.Sprintf("WafPolicy_%s_%s.conf", wp.Namespace, wp.Name),
+			Content: helpers.MustExecuteTemplate(tmpl, fields),
+		})
+	}
+
+	return files
+}
+
+func formatSecurityLogDestination(dest ngfAPI.SecurityLogDestination) string {
+	switch dest.Type {
+	case ngfAPI.SecurityLogDestinationTypeStderr:
+		return "stderr"
+	case ngfAPI.SecurityLogDestinationTypeFile:
+		if dest.File != nil {
+			return dest.File.Path
+		}
+		return "stderr"
+	case ngfAPI.SecurityLogDestinationTypeSyslog:
+		if dest.Syslog != nil {
+			return fmt.Sprintf("syslog:server=%s", dest.Syslog.Server)
+		}
+		return "stderr"
+	default:
+		return "stderr"
+	}
+}