2019-06-30 17:07:58 -05:00
|
|
|
// Copyright 2015 Matthew Holt and The Caddy Authors
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
2019-05-20 16:46:47 -05:00
|
|
|
package headers
|
|
|
|
|
2020-11-20 14:38:16 -05:00
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
|
|
|
"net/http/httptest"
|
|
|
|
"reflect"
|
|
|
|
"testing"
|
2019-05-20 16:46:47 -05:00
|
|
|
|
2020-11-20 14:38:16 -05:00
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
|
|
"github.com/caddyserver/caddy/v2/modules/caddyhttp"
|
|
|
|
)
|
|
|
|
|
|
|
|
func TestHandler(t *testing.T) {
|
|
|
|
for i, tc := range []struct {
|
|
|
|
handler Handler
|
|
|
|
reqHeader http.Header
|
|
|
|
respHeader http.Header
|
|
|
|
respStatusCode int
|
|
|
|
expectedReqHeader http.Header
|
|
|
|
expectedRespHeader http.Header
|
|
|
|
}{
|
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Request: &HeaderOps{
|
|
|
|
Add: http.Header{
|
|
|
|
"Expose-Secrets": []string{"always"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
reqHeader: http.Header{
|
|
|
|
"Expose-Secrets": []string{"i'm serious"},
|
|
|
|
},
|
|
|
|
expectedReqHeader: http.Header{
|
|
|
|
"Expose-Secrets": []string{"i'm serious", "always"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Request: &HeaderOps{
|
|
|
|
Set: http.Header{
|
|
|
|
"Who-Wins": []string{"batman"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
reqHeader: http.Header{
|
|
|
|
"Who-Wins": []string{"joker"},
|
|
|
|
},
|
|
|
|
expectedReqHeader: http.Header{
|
|
|
|
"Who-Wins": []string{"batman"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Request: &HeaderOps{
|
|
|
|
Delete: []string{"Kick-Me"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
reqHeader: http.Header{
|
|
|
|
"Kick-Me": []string{"if you can"},
|
|
|
|
"Keep-Me": []string{"i swear i'm innocent"},
|
|
|
|
},
|
|
|
|
expectedReqHeader: http.Header{
|
|
|
|
"Keep-Me": []string{"i swear i'm innocent"},
|
|
|
|
},
|
|
|
|
},
|
2022-06-15 10:57:43 -05:00
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Request: &HeaderOps{
|
|
|
|
Delete: []string{
|
|
|
|
"*-suffix",
|
|
|
|
"prefix-*",
|
|
|
|
"*_*",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
reqHeader: http.Header{
|
|
|
|
"Header-Suffix": []string{"lalala"},
|
|
|
|
"Prefix-Test": []string{"asdf"},
|
|
|
|
"Host_Header": []string{"silly django... sigh"}, // see issue #4830
|
|
|
|
"Keep-Me": []string{"foofoofoo"},
|
|
|
|
},
|
|
|
|
expectedReqHeader: http.Header{
|
|
|
|
"Keep-Me": []string{"foofoofoo"},
|
|
|
|
},
|
|
|
|
},
|
2020-11-20 14:38:16 -05:00
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Request: &HeaderOps{
|
|
|
|
Replace: map[string][]Replacement{
|
|
|
|
"Best-Server": {
|
|
|
|
Replacement{
|
|
|
|
Search: "NGINX",
|
|
|
|
Replace: "the Caddy web server",
|
|
|
|
},
|
|
|
|
Replacement{
|
|
|
|
SearchRegexp: `Apache(\d+)`,
|
|
|
|
Replace: "Caddy",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
reqHeader: http.Header{
|
|
|
|
"Best-Server": []string{"it's NGINX, undoubtedly", "I love Apache2"},
|
|
|
|
},
|
|
|
|
expectedReqHeader: http.Header{
|
|
|
|
"Best-Server": []string{"it's the Caddy web server, undoubtedly", "I love Caddy"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Response: &RespHeaderOps{
|
|
|
|
Require: &caddyhttp.ResponseMatcher{
|
|
|
|
Headers: http.Header{
|
|
|
|
"Cache-Control": nil,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
HeaderOps: &HeaderOps{
|
|
|
|
Add: http.Header{
|
|
|
|
"Cache-Control": []string{"no-cache"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
respHeader: http.Header{},
|
|
|
|
expectedRespHeader: http.Header{
|
|
|
|
"Cache-Control": []string{"no-cache"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Response: &RespHeaderOps{
|
|
|
|
Require: &caddyhttp.ResponseMatcher{
|
|
|
|
Headers: http.Header{
|
|
|
|
"Cache-Control": []string{"no-cache"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
HeaderOps: &HeaderOps{
|
|
|
|
Delete: []string{"Cache-Control"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
respHeader: http.Header{
|
|
|
|
"Cache-Control": []string{"no-cache"},
|
|
|
|
},
|
|
|
|
expectedRespHeader: http.Header{},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Response: &RespHeaderOps{
|
|
|
|
Require: &caddyhttp.ResponseMatcher{
|
|
|
|
StatusCode: []int{5},
|
|
|
|
},
|
|
|
|
HeaderOps: &HeaderOps{
|
|
|
|
Add: http.Header{
|
|
|
|
"Fail-5xx": []string{"true"},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
respStatusCode: 503,
|
|
|
|
respHeader: http.Header{},
|
|
|
|
expectedRespHeader: http.Header{
|
|
|
|
"Fail-5xx": []string{"true"},
|
|
|
|
},
|
|
|
|
},
|
2021-09-13 11:13:32 -05:00
|
|
|
{
|
|
|
|
handler: Handler{
|
|
|
|
Request: &HeaderOps{
|
|
|
|
Replace: map[string][]Replacement{
|
|
|
|
"Case-Insensitive": {
|
|
|
|
Replacement{
|
|
|
|
Search: "issue4330",
|
|
|
|
Replace: "issue #4330",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
reqHeader: http.Header{
|
|
|
|
"case-insensitive": []string{"issue4330"},
|
|
|
|
"Other-Header": []string{"issue4330"},
|
|
|
|
},
|
|
|
|
expectedReqHeader: http.Header{
|
|
|
|
"case-insensitive": []string{"issue #4330"},
|
|
|
|
"Other-Header": []string{"issue4330"},
|
|
|
|
},
|
|
|
|
},
|
2020-11-20 14:38:16 -05:00
|
|
|
} {
|
|
|
|
rr := httptest.NewRecorder()
|
|
|
|
|
|
|
|
req := &http.Request{Header: tc.reqHeader}
|
|
|
|
repl := caddy.NewReplacer()
|
|
|
|
ctx := context.WithValue(req.Context(), caddy.ReplacerCtxKey, repl)
|
|
|
|
req = req.WithContext(ctx)
|
|
|
|
|
|
|
|
tc.handler.Provision(caddy.Context{})
|
|
|
|
|
|
|
|
next := nextHandler(func(w http.ResponseWriter, r *http.Request) error {
|
|
|
|
for k, hdrs := range tc.respHeader {
|
|
|
|
for _, v := range hdrs {
|
|
|
|
w.Header().Add(k, v)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
status := 200
|
|
|
|
if tc.respStatusCode != 0 {
|
|
|
|
status = tc.respStatusCode
|
|
|
|
}
|
|
|
|
w.WriteHeader(status)
|
|
|
|
|
|
|
|
if tc.expectedReqHeader != nil && !reflect.DeepEqual(r.Header, tc.expectedReqHeader) {
|
|
|
|
return fmt.Errorf("expected request header %v, got %v", tc.expectedReqHeader, r.Header)
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
})
|
|
|
|
|
|
|
|
if err := tc.handler.ServeHTTP(rr, req, next); err != nil {
|
2021-09-13 11:13:32 -05:00
|
|
|
t.Errorf("Test %d: %v", i, err)
|
2020-11-20 14:38:16 -05:00
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
|
|
|
actual := rr.Header()
|
|
|
|
if tc.expectedRespHeader != nil && !reflect.DeepEqual(actual, tc.expectedRespHeader) {
|
|
|
|
t.Errorf("Test %d: expected response header %v, got %v", i, tc.expectedRespHeader, actual)
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
type nextHandler func(http.ResponseWriter, *http.Request) error
|
|
|
|
|
|
|
|
func (f nextHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) error {
|
|
|
|
return f(w, r)
|
2019-05-20 16:46:47 -05:00
|
|
|
}
|