summaryrefslogtreecommitdiff
path: root/modules/caddyhttp/headers/caddyfile.go
diff options
context:
space:
mode:
Diffstat (limited to 'modules/caddyhttp/headers/caddyfile.go')
-rw-r--r--modules/caddyhttp/headers/caddyfile.go179
1 files changed, 131 insertions, 48 deletions
diff --git a/modules/caddyhttp/headers/caddyfile.go b/modules/caddyhttp/headers/caddyfile.go
index d893cab..75498b2 100644
--- a/modules/caddyhttp/headers/caddyfile.go
+++ b/modules/caddyhttp/headers/caddyfile.go
@@ -15,7 +15,9 @@
package headers
import (
+ "fmt"
"net/http"
+ "reflect"
"strings"
"github.com/caddyserver/caddy/v2/caddyconfig/httpcaddyfile"
@@ -23,15 +25,16 @@ import (
)
func init() {
- httpcaddyfile.RegisterHandlerDirective("header", parseCaddyfile)
- httpcaddyfile.RegisterHandlerDirective("request_header", parseReqHdrCaddyfile)
+ httpcaddyfile.RegisterDirective("header", parseCaddyfile)
+ httpcaddyfile.RegisterDirective("request_header", parseReqHdrCaddyfile)
}
// parseCaddyfile sets up the handler for response headers from
// Caddyfile tokens. Syntax:
//
-// header [<matcher>] [[+|-]<field> [<value|regexp>] [<replacement>]] {
+// header [<matcher>] [[+|-|?]<field> [<value|regexp>] [<replacement>]] {
// [+]<field> [<value|regexp> [<replacement>]]
+// ?<field> <default_value>
// -<field>
// [defer]
// }
@@ -39,17 +42,23 @@ func init() {
// 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. Header operations
// are deferred to write-time if any headers are being deleted or if the
-// 'defer' subdirective is used.
-func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
- hdr := new(Handler)
-
- makeResponseOps := func() {
- if hdr.Response == nil {
- hdr.Response = &RespHeaderOps{
- HeaderOps: new(HeaderOps),
- }
+// 'defer' subdirective is used. + appends a header value, - deletes a field,
+// and ? conditionally sets a value only if the header field is not already
+// set.
+func parseCaddyfile(h httpcaddyfile.Helper) ([]httpcaddyfile.ConfigValue, error) {
+ matcherSet, err := h.ExtractMatcherSet()
+ if err != nil {
+ return nil, err
+ }
+
+ makeHandler := func() Handler {
+ return Handler{
+ Response: &RespHeaderOps{
+ HeaderOps: &HeaderOps{},
+ },
}
}
+ handler, handlerWithRequire := makeHandler(), makeHandler()
for h.Next() {
// first see if headers are in the initial line
@@ -64,10 +73,18 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
if h.NextArg() {
replacement = h.Val()
}
- makeResponseOps()
- CaddyfileHeaderOp(hdr.Response.HeaderOps, field, value, replacement)
- if len(hdr.Response.HeaderOps.Delete) > 0 {
- hdr.Response.Deferred = true
+ err := applyHeaderOp(
+ handler.Response.HeaderOps,
+ handler.Response,
+ field,
+ value,
+ replacement,
+ )
+ if err != nil {
+ return nil, h.Err(err.Error())
+ }
+ if len(handler.Response.HeaderOps.Delete) > 0 {
+ handler.Response.Deferred = true
}
}
@@ -75,12 +92,18 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
for h.NextBlock(0) {
field := h.Val()
if field == "defer" {
- hdr.Response.Deferred = true
+ handler.Response.Deferred = true
continue
}
if hasArgs {
- return nil, h.Err("cannot specify headers in both arguments and block")
+ return nil, h.Err("cannot specify headers in both arguments and block") // because it would be weird
}
+
+ // sometimes it is habitual for users to suffix a field name with a colon,
+ // as if they were writing a curl command or something; see
+ // https://caddy.community/t/v2-reverse-proxy-please-add-cors-example-to-the-docs/7349/19
+ field = strings.TrimSuffix(field, ":")
+
var value, replacement string
if h.NextArg() {
value = h.Val()
@@ -88,15 +111,34 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
if h.NextArg() {
replacement = h.Val()
}
- makeResponseOps()
- CaddyfileHeaderOp(hdr.Response.HeaderOps, field, value, replacement)
- if len(hdr.Response.HeaderOps.Delete) > 0 {
- hdr.Response.Deferred = true
+
+ handlerToUse := handler
+ if strings.HasPrefix(field, "?") {
+ handlerToUse = handlerWithRequire
+ }
+
+ err := applyHeaderOp(
+ handlerToUse.Response.HeaderOps,
+ handlerToUse.Response,
+ field,
+ value,
+ replacement,
+ )
+ if err != nil {
+ return nil, h.Err(err.Error())
}
}
}
- return hdr, nil
+ var configValues []httpcaddyfile.ConfigValue
+ if !reflect.DeepEqual(handler, makeHandler()) {
+ configValues = append(configValues, h.NewRoute(matcherSet, handler)...)
+ }
+ if !reflect.DeepEqual(handlerWithRequire, makeHandler()) {
+ configValues = append(configValues, h.NewRoute(matcherSet, handlerWithRequire)...)
+ }
+
+ return configValues, nil
}
// parseReqHdrCaddyfile sets up the handler for request headers
@@ -104,17 +146,27 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error)
//
// request_header [<matcher>] [[+|-]<field> [<value|regexp>] [<replacement>]]
//
-func parseReqHdrCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
- hdr := new(Handler)
+func parseReqHdrCaddyfile(h httpcaddyfile.Helper) ([]httpcaddyfile.ConfigValue, error) {
+ matcherSet, err := h.ExtractMatcherSet()
+ if err != nil {
+ return nil, err
+ }
+
+ configValues := []httpcaddyfile.ConfigValue{}
+
for h.Next() {
if !h.NextArg() {
return nil, h.ArgErr()
}
field := h.Val()
+ hdr := Handler{
+ Request: &HeaderOps{},
+ }
+
// sometimes it is habitual for users to suffix a field name with a colon,
// as if they were writing a curl command or something; see
- // https://caddy.community/t/v2-reverse-proxy-please-add-cors-example-to-the-docs/7349
+ // https://caddy.community/t/v2-reverse-proxy-please-add-cors-example-to-the-docs/7349/19
field = strings.TrimSuffix(field, ":")
var value, replacement string
@@ -131,13 +183,17 @@ func parseReqHdrCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler,
if hdr.Request == nil {
hdr.Request = new(HeaderOps)
}
- CaddyfileHeaderOp(hdr.Request, field, value, replacement)
+ if err := CaddyfileHeaderOp(hdr.Request, field, value, replacement); err != nil {
+ return nil, h.Err(err.Error())
+ }
+
+ configValues = append(configValues, h.NewRoute(matcherSet, hdr)...)
if h.NextArg() {
return nil, h.ArgErr()
}
}
- return hdr, nil
+ return configValues, nil
}
// CaddyfileHeaderOp applies a new header operation according to
@@ -148,32 +204,59 @@ func parseReqHdrCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler,
// 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, "+") {
+func CaddyfileHeaderOp(ops *HeaderOps, field, value, replacement string) error {
+ return applyHeaderOp(ops, nil, field, value, replacement)
+}
+
+func applyHeaderOp(ops *HeaderOps, respHeaderOps *RespHeaderOps, field, value, replacement string) error {
+ switch {
+ case strings.HasPrefix(field, "+"): // append
if ops.Add == nil {
ops.Add = make(http.Header)
}
ops.Add.Set(field[1:], value)
- } else if strings.HasPrefix(field, "-") {
+
+ case strings.HasPrefix(field, "-"): // delete
ops.Delete = append(ops.Delete, field[1:])
- } else {
- 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)
+ if respHeaderOps != nil {
+ respHeaderOps.Deferred = true
+ }
+
+ case strings.HasPrefix(field, "?"): // default (conditional on not existing) - response headers only
+ if respHeaderOps == nil {
+ return fmt.Errorf("%v: the default header modifier ('?') can only be used on response headers; for conditional manipulation of request headers, use matchers", field)
+ }
+ if respHeaderOps.Require == nil {
+ respHeaderOps.Require = &caddyhttp.ResponseMatcher{
+ Headers: make(http.Header),
}
- field = strings.TrimLeft(field, "+-")
- ops.Replace[field] = append(
- ops.Replace[field],
- Replacement{
- SearchRegexp: value,
- Replace: replacement,
- },
- )
}
+ field = strings.TrimPrefix(field, "?")
+ respHeaderOps.Require.Headers[field] = nil
+ if respHeaderOps.Set == nil {
+ respHeaderOps.Set = make(http.Header)
+ }
+ respHeaderOps.Set.Set(field, value)
+
+ case replacement != "": // replace
+ 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,
+ },
+ )
+
+ default: // set (overwrite)
+ if ops.Set == nil {
+ ops.Set = make(http.Header)
+ }
+ ops.Set.Set(field, value)
}
+
+ return nil
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-06 09:25:40 +0000