caddyhttp: only replace known placeholders in respond headers (#8014)

The respond directive expanded header field names and values with
repl.ReplaceAll, which blanks any {...} the replacer does not recognize

Header values are config data, often JSON or carrying literal braces, so a
value like {key:value} was sent empty and a-{b}-c came out a--c

Use ReplaceKnown, matching the header handler fix in #4880 (same class as
#4418) and the respond body expansion a few lines below, so unknown braces
survive and real placeholders still expand
pull/8017/head
Abdellatif Anaflous 2026-09-13 03:08:21 +01:00 committed by GitHub
parent a75817f550
commit 56e3a88efe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 52 additions and 2 deletions

View File

@ -194,10 +194,10 @@ func (s StaticResponse) ServeHTTP(w http.ResponseWriter, r *http.Request, next H
// set all headers
for field, vals := range s.Headers {
field = textproto.CanonicalMIMEHeaderKey(repl.ReplaceAll(field, ""))
field = textproto.CanonicalMIMEHeaderKey(repl.ReplaceKnown(field, ""))
newVals := make([]string, len(vals))
for i := range vals {
newVals[i] = repl.ReplaceAll(vals[i], "")
newVals[i] = repl.ReplaceKnown(vals[i], "")
}
w.Header()[field] = newVals
}

View File

@ -64,3 +64,53 @@ func fakeRequest() *http.Request {
r = r.WithContext(ctx)
return r
}
func TestStaticResponseHeadersKeepUnknownPlaceholders(t *testing.T) {
r := fakeRequest()
w := httptest.NewRecorder()
s := StaticResponse{
StatusCode: WeakString(strconv.Itoa(http.StatusOK)),
Headers: http.Header{
"X-Json": []string{`{"key":"value"}`},
"X-Lit": []string{"value-{not-a-real-placeholder}-kept"},
},
}
err := s.ServeHTTP(w, r, nil)
if err != nil {
t.Errorf("did not expect an error, but got: %v", err)
}
resp := w.Result()
if got, want := resp.Header.Get("X-Json"), `{"key":"value"}`; got != want {
t.Errorf("X-Json header = %q, want %q (unknown placeholders in header values must not be blanked)", got, want)
}
if got, want := resp.Header.Get("X-Lit"), "value-{not-a-real-placeholder}-kept"; got != want {
t.Errorf("X-Lit header = %q, want %q", got, want)
}
}
func TestStaticResponseHeadersStillReplaceKnownPlaceholders(t *testing.T) {
r := fakeRequest()
repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
repl.Set("testvar", "replaced")
w := httptest.NewRecorder()
s := StaticResponse{
StatusCode: WeakString(strconv.Itoa(http.StatusOK)),
Headers: http.Header{
"X-Var": []string{"value-{testvar}-end"},
},
}
err := s.ServeHTTP(w, r, nil)
if err != nil {
t.Errorf("did not expect an error, but got: %v", err)
}
if got, want := w.Result().Header.Get("X-Var"), "value-replaced-end"; got != want {
t.Errorf("X-Var header = %q, want %q (real placeholders must still expand)", got, want)
}
}