From 1b73e3862d312ac2057265bf2a5fd95760dbe9da Mon Sep 17 00:00:00 2001
From: Paul Jeannot <paul.jeannot95@gmail.com>
Date: Wed, 30 Aug 2023 00:59:43 +0200
Subject: logging: query filter for array of strings (#5779)

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
---
 modules/logging/filters.go      | 22 +++++++++++++++++-----
 modules/logging/filters_test.go | 36 +++++++++++++++++++++++++++++++++++-
 2 files changed, 52 insertions(+), 6 deletions(-)

(limited to 'modules')

diff --git a/modules/logging/filters.go b/modules/logging/filters.go
index 69ba9d1..233d5d7 100644
--- a/modules/logging/filters.go
+++ b/modules/logging/filters.go
@@ -373,9 +373,23 @@ func (m *QueryFilter) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 
 // Filter filters the input field.
 func (m QueryFilter) Filter(in zapcore.Field) zapcore.Field {
-	u, err := url.Parse(in.String)
+	if array, ok := in.Interface.(caddyhttp.LoggableStringArray); ok {
+		newArray := make(caddyhttp.LoggableStringArray, len(array))
+		for i, s := range array {
+			newArray[i] = m.processQueryString(s)
+		}
+		in.Interface = newArray
+	} else {
+		in.String = m.processQueryString(in.String)
+	}
+
+	return in
+}
+
+func (m QueryFilter) processQueryString(s string) string {
+	u, err := url.Parse(s)
 	if err != nil {
-		return in
+		return s
 	}
 
 	q := u.Query()
@@ -397,9 +411,7 @@ func (m QueryFilter) Filter(in zapcore.Field) zapcore.Field {
 	}
 
 	u.RawQuery = q.Encode()
-	in.String = u.String()
-
-	return in
+	return u.String()
 }
 
 type cookieFilterAction struct {
diff --git a/modules/logging/filters_test.go b/modules/logging/filters_test.go
index e9c3e77..8f7ba0d 100644
--- a/modules/logging/filters_test.go
+++ b/modules/logging/filters_test.go
@@ -83,7 +83,7 @@ func TestIPMaskMultiValue(t *testing.T) {
 	}
 }
 
-func TestQueryFilter(t *testing.T) {
+func TestQueryFilterSingleValue(t *testing.T) {
 	f := QueryFilter{[]queryFilterAction{
 		{replaceAction, "foo", "REDACTED"},
 		{replaceAction, "notexist", "REDACTED"},
@@ -102,6 +102,40 @@ func TestQueryFilter(t *testing.T) {
 	}
 }
 
+func TestQueryFilterMultiValue(t *testing.T) {
+	f := QueryFilter{
+		Actions: []queryFilterAction{
+			{Type: replaceAction, Parameter: "foo", Value: "REDACTED"},
+			{Type: replaceAction, Parameter: "notexist", Value: "REDACTED"},
+			{Type: deleteAction, Parameter: "bar"},
+			{Type: deleteAction, Parameter: "notexist"},
+			{Type: hashAction, Parameter: "hash"},
+		},
+	}
+
+	if f.Validate() != nil {
+		t.Fatalf("the filter must be valid")
+	}
+
+	out := f.Filter(zapcore.Field{Interface: caddyhttp.LoggableStringArray{
+		"/path1?foo=a&foo=b&bar=c&bar=d&baz=e&hash=hashed",
+		"/path2?foo=c&foo=d&bar=e&bar=f&baz=g&hash=hashed",
+	}})
+	arr, ok := out.Interface.(caddyhttp.LoggableStringArray)
+	if !ok {
+		t.Fatalf("field is wrong type: %T", out.Interface)
+	}
+
+	expected1 := "/path1?baz=e&foo=REDACTED&foo=REDACTED&hash=e3b0c442"
+	expected2 := "/path2?baz=g&foo=REDACTED&foo=REDACTED&hash=e3b0c442"
+	if arr[0] != expected1 {
+		t.Fatalf("query parameters in entry 0 have not been filtered correctly: got %s, expected %s", arr[0], expected1)
+	}
+	if arr[1] != expected2 {
+		t.Fatalf("query parameters in entry 1 have not been filtered correctly: got %s, expected %s", arr[1], expected2)
+	}
+}
+
 func TestValidateQueryFilter(t *testing.T) {
 	f := QueryFilter{[]queryFilterAction{
 		{},
-- 
cgit v1.2.3