reverse_proxy/headers: Expose header replacement ability in Caddyfile

Adds header_up and header_down subdirectives to reverse_proxy

2 files changed, 107 insertions, 36 deletions

diff --git a/modules/caddyhttp/headers/caddyfile.go b/modules/caddyhttp/headers/caddyfile.go
index 2fd6f06..c1444d0 100644
--- a/modules/caddyhttp/headers/caddyfile.go
+++ b/modules/caddyhttp/headers/caddyfile.go
@@ -30,26 +30,40 @@ func init() {
 // parseCaddyfile sets up the handler for response headers from
 // Caddyfile tokens. Syntax:
 //
-//     headers [<matcher>] [[+|-]<field> <value>] {
-//         [+][<field>] [<value>]
-//         [-<field>]
+//     headers [<matcher>] [[+|-]<field> [<value|regexp>] [<replacement>]] {
+//         [+]<field> [<value|regexp> [<replacement>]]
+//         -<field>
 //     }
 //
 // Either a block can be opened or a single header field can be configured
 // in the first line, but not both in the same directive.
 func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
 	hdr := new(Handler)
+
+	makeResponseOps := func() {
+		if hdr.Response == nil {
+			hdr.Response = &RespHeaderOps{
+				HeaderOps: new(HeaderOps),
+				Deferred:  true,
+			}
+		}
+	}
+
 	for h.Next() {
 		// first see if headers are in the initial line
 		var hasArgs bool
 		if h.NextArg() {
 			hasArgs = true
 			field := h.Val()
-			var value string
+			var value, replacement string
 			if h.NextArg() {
 				value = h.Val()
 			}
-			processCaddyfileLineRespHdr(hdr, field, value)
+			if h.NextArg() {
+				replacement = h.Val()
+			}
+			makeResponseOps()
+			CaddyfileHeaderOp(hdr.Response.HeaderOps, field, value, replacement)
 		}
 
 		// if not, they should be in a block
@@ -58,20 +72,25 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
 				return nil, h.Err("cannot specify headers in both arguments and block")
 			}
 			field := h.Val()
-			var value string
+			var value, replacement string
 			if h.NextArg() {
 				value = h.Val()
 			}
-			processCaddyfileLineRespHdr(hdr, field, value)
+			if h.NextArg() {
+				replacement = h.Val()
+			}
+			makeResponseOps()
+			CaddyfileHeaderOp(hdr.Response.HeaderOps, field, value, replacement)
 		}
 	}
+
 	return hdr, nil
 }
 
 // parseReqHdrCaddyfile sets up the handler for request headers
 // from Caddyfile tokens. Syntax:
 //
-//     request_header [<matcher>] [[+|-]<field> <value>]
+//     request_header [<matcher>] [[+|-]<field> [<value|regexp>] [<replacement>]]
 //
 func parseReqHdrCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
 	hdr := new(Handler)
@@ -80,27 +99,18 @@ func parseReqHdrCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler,
 			return nil, h.ArgErr()
 		}
 		field := h.Val()
-		var value string
+		var value, replacement string
 		if h.NextArg() {
 			value = h.Val()
 		}
+		if h.NextArg() {
+			replacement = h.Val()
+		}
 
 		if hdr.Request == nil {
 			hdr.Request = new(HeaderOps)
 		}
-		if strings.HasPrefix(field, "+") {
-			if hdr.Request.Add == nil {
-				hdr.Request.Add = make(http.Header)
-			}
-			hdr.Request.Add.Set(field[1:], value)
-		} else if strings.HasPrefix(field, "-") {
-			hdr.Request.Delete = append(hdr.Request.Delete, field[1:])
-		} else {
-			if hdr.Request.Set == nil {
-				hdr.Request.Set = make(http.Header)
-			}
-			hdr.Request.Set.Set(field, value)
-		}
+		CaddyfileHeaderOp(hdr.Request, field, value, replacement)
 
 		if h.NextArg() {
 			return nil, h.ArgErr()
@@ -109,24 +119,40 @@ func parseReqHdrCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler,
 	return hdr, nil
 }
 
-func processCaddyfileLineRespHdr(hdr *Handler, field, value string) {
-	if hdr.Response == nil {
-		hdr.Response = &RespHeaderOps{
-			HeaderOps: new(HeaderOps),
-			Deferred:  true,
-		}
-	}
+// CaddyfileHeaderOp applies a new header operation according to
+// field, value, and replacement. The field can be prefixed with
+// "+" or "-" to specify adding or removing; otherwise, the value
+// will be set (overriding any previous value). If replacement is
+// non-empty, value will be treated as a regular expression which
+// will be used to search and then replacement will be used to
+// complete the substring replacement; in that case, any + or -
+// prefix to field will be ignored.
+func CaddyfileHeaderOp(ops *HeaderOps, field, value, replacement string) {
 	if strings.HasPrefix(field, "+") {
-		if hdr.Response.Add == nil {
-			hdr.Response.Add = make(http.Header)
+		if ops.Add == nil {
+			ops.Add = make(http.Header)
 		}
-		hdr.Response.Add.Set(field[1:], value)
+		ops.Add.Set(field[1:], value)
 	} else if strings.HasPrefix(field, "-") {
-		hdr.Response.Delete = append(hdr.Response.Delete, field[1:])
+		ops.Delete = append(ops.Delete, field[1:])
 	} else {
-		if hdr.Response.Set == nil {
-			hdr.Response.Set = make(http.Header)
+		if replacement == "" {
+			if ops.Set == nil {
+				ops.Set = make(http.Header)
+			}
+			ops.Set.Set(field, value)
+		} else {
+			if ops.Replace == nil {
+				ops.Replace = make(map[string][]Replacement)
+			}
+			field = strings.TrimLeft(field, "+-")
+			ops.Replace[field] = append(
+				ops.Replace[field],
+				Replacement{
+					SearchRegexp: value,
+					Replace:      replacement,
+				},
+			)
 		}
-		hdr.Response.Set.Set(field, value)
 	}
 }
diff --git a/modules/caddyhttp/reverseproxy/caddyfile.go b/modules/caddyhttp/reverseproxy/caddyfile.go
index d8c63b4..83298d8 100644
--- a/modules/caddyhttp/reverseproxy/caddyfile.go
+++ b/modules/caddyhttp/reverseproxy/caddyfile.go
@@ -25,6 +25,7 @@ import (
 	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
 	"github.com/caddyserver/caddy/v2/caddyconfig/httpcaddyfile"
 	"github.com/caddyserver/caddy/v2/modules/caddyhttp"
+	"github.com/caddyserver/caddy/v2/modules/caddyhttp/headers"
 	"github.com/dustin/go-humanize"
 )
 
@@ -67,6 +68,10 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
 //         unhealthy_status <status>
 //         unhealthy_latency <duration>
 //
+//         # header manipulation
+//         header_up   [+|-]<field> [<value|regexp> [<replacement>]]
+//         header_down [+|-]<field> [<value|regexp> [<replacement>]]
+//
 //         # round trip
 //         transport <name> {
 //             ...
@@ -327,6 +332,46 @@ func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 				}
 				h.HealthChecks.Passive.UnhealthyLatency = caddy.Duration(dur)
 
+			case "header_up":
+				if h.Headers == nil {
+					h.Headers = new(headers.Handler)
+				}
+				if h.Headers.Request == nil {
+					h.Headers.Request = new(headers.HeaderOps)
+				}
+				args := d.RemainingArgs()
+				switch len(args) {
+				case 1:
+					headers.CaddyfileHeaderOp(h.Headers.Request, args[0], "", "")
+				case 2:
+					headers.CaddyfileHeaderOp(h.Headers.Request, args[0], args[1], "")
+				case 3:
+					headers.CaddyfileHeaderOp(h.Headers.Request, args[0], args[1], args[2])
+				default:
+					return d.ArgErr()
+				}
+
+			case "header_down":
+				if h.Headers == nil {
+					h.Headers = new(headers.Handler)
+				}
+				if h.Headers.Response == nil {
+					h.Headers.Response = &headers.RespHeaderOps{
+						HeaderOps: new(headers.HeaderOps),
+					}
+				}
+				args := d.RemainingArgs()
+				switch len(args) {
+				case 1:
+					headers.CaddyfileHeaderOp(h.Headers.Response.HeaderOps, args[0], "", "")
+				case 2:
+					headers.CaddyfileHeaderOp(h.Headers.Response.HeaderOps, args[0], args[1], "")
+				case 3:
+					headers.CaddyfileHeaderOp(h.Headers.Response.HeaderOps, args[0], args[1], args[2])
+				default:
+					return d.ArgErr()
+				}
+
 			case "transport":
 				if !d.NextArg() {
 					return d.ArgErr()