2019-10-10 14:37:08 -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.
|
|
|
|
|
|
|
|
package caddyhttp
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
2020-02-25 21:22:50 -05:00
|
|
|
"crypto/tls"
|
|
|
|
"crypto/x509"
|
|
|
|
"encoding/pem"
|
caddyhttp: add http.request.local{,.host,.port} placeholder (#6182)
* caddyhttp: add `http.request.local{,.host,.port}` placeholder
This is the counterpart of `http.request.remote{,.host,.port}`.
`http.request.remote` operates on the remote client's address, while
`http.request.local` operates on the address the connection arrived on.
Take the following example:
- Caddy serving on `203.0.113.1:80`
- Client on `203.0.113.2`
`http.request.remote.host` would return `203.0.113.2` (client IP)
`http.request.local.host` would return `203.0.113.1` (server IP)
`http.request.local.port` would return `80` (server port)
I find this helpful for debugging setups with multiple servers and/or
multiple network paths (multiple IPs, AnyIP, Anycast).
Co-authored-by: networkException <git@nwex.de>
* caddyhttp: add unit test for `http.request.local{,.host,.port}`
* caddyhttp: add integration test for `http.request.local.port`
* caddyhttp: fix `http.request.local.host` placeholder handling with unix sockets
The implementation matches the one of `http.request.remote.host` now and
returns the unix socket path (just like `http.request.local` already did)
instead of an empty string.
---------
Co-authored-by: networkException <git@nwex.de>
2024-03-27 16:36:53 -05:00
|
|
|
"net"
|
2019-10-10 14:37:08 -05:00
|
|
|
"net/http"
|
|
|
|
"net/http/httptest"
|
|
|
|
"testing"
|
|
|
|
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
|
|
)
|
|
|
|
|
|
|
|
func TestHTTPVarReplacement(t *testing.T) {
|
2022-09-05 14:53:41 -05:00
|
|
|
req, _ := http.NewRequest(http.MethodGet, "/foo/bar.tar.gz", nil)
|
2019-10-10 14:37:08 -05:00
|
|
|
repl := caddy.NewReplacer()
|
caddyhttp: add http.request.local{,.host,.port} placeholder (#6182)
* caddyhttp: add `http.request.local{,.host,.port}` placeholder
This is the counterpart of `http.request.remote{,.host,.port}`.
`http.request.remote` operates on the remote client's address, while
`http.request.local` operates on the address the connection arrived on.
Take the following example:
- Caddy serving on `203.0.113.1:80`
- Client on `203.0.113.2`
`http.request.remote.host` would return `203.0.113.2` (client IP)
`http.request.local.host` would return `203.0.113.1` (server IP)
`http.request.local.port` would return `80` (server port)
I find this helpful for debugging setups with multiple servers and/or
multiple network paths (multiple IPs, AnyIP, Anycast).
Co-authored-by: networkException <git@nwex.de>
* caddyhttp: add unit test for `http.request.local{,.host,.port}`
* caddyhttp: add integration test for `http.request.local.port`
* caddyhttp: fix `http.request.local.host` placeholder handling with unix sockets
The implementation matches the one of `http.request.remote.host` now and
returns the unix socket path (just like `http.request.local` already did)
instead of an empty string.
---------
Co-authored-by: networkException <git@nwex.de>
2024-03-27 16:36:53 -05:00
|
|
|
localAddr, _ := net.ResolveTCPAddr("tcp", "192.168.159.1:80")
|
2019-10-10 14:37:08 -05:00
|
|
|
ctx := context.WithValue(req.Context(), caddy.ReplacerCtxKey, repl)
|
caddyhttp: add http.request.local{,.host,.port} placeholder (#6182)
* caddyhttp: add `http.request.local{,.host,.port}` placeholder
This is the counterpart of `http.request.remote{,.host,.port}`.
`http.request.remote` operates on the remote client's address, while
`http.request.local` operates on the address the connection arrived on.
Take the following example:
- Caddy serving on `203.0.113.1:80`
- Client on `203.0.113.2`
`http.request.remote.host` would return `203.0.113.2` (client IP)
`http.request.local.host` would return `203.0.113.1` (server IP)
`http.request.local.port` would return `80` (server port)
I find this helpful for debugging setups with multiple servers and/or
multiple network paths (multiple IPs, AnyIP, Anycast).
Co-authored-by: networkException <git@nwex.de>
* caddyhttp: add unit test for `http.request.local{,.host,.port}`
* caddyhttp: add integration test for `http.request.local.port`
* caddyhttp: fix `http.request.local.host` placeholder handling with unix sockets
The implementation matches the one of `http.request.remote.host` now and
returns the unix socket path (just like `http.request.local` already did)
instead of an empty string.
---------
Co-authored-by: networkException <git@nwex.de>
2024-03-27 16:36:53 -05:00
|
|
|
ctx = context.WithValue(ctx, http.LocalAddrContextKey, localAddr)
|
2019-10-10 14:37:08 -05:00
|
|
|
req = req.WithContext(ctx)
|
|
|
|
req.Host = "example.com:80"
|
2022-09-30 14:29:33 -05:00
|
|
|
req.RemoteAddr = "192.168.159.32:1234"
|
2020-02-25 21:22:50 -05:00
|
|
|
|
|
|
|
clientCert := []byte(`-----BEGIN CERTIFICATE-----
|
|
|
|
MIIB9jCCAV+gAwIBAgIBAjANBgkqhkiG9w0BAQsFADAYMRYwFAYDVQQDDA1DYWRk
|
|
|
|
eSBUZXN0IENBMB4XDTE4MDcyNDIxMzUwNVoXDTI4MDcyMTIxMzUwNVowHTEbMBkG
|
|
|
|
A1UEAwwSY2xpZW50LmxvY2FsZG9tYWluMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
|
|
|
|
iQKBgQDFDEpzF0ew68teT3xDzcUxVFaTII+jXH1ftHXxxP4BEYBU4q90qzeKFneF
|
|
|
|
z83I0nC0WAQ45ZwHfhLMYHFzHPdxr6+jkvKPASf0J2v2HDJuTM1bHBbik5Ls5eq+
|
|
|
|
fVZDP8o/VHKSBKxNs8Goc2NTsr5b07QTIpkRStQK+RJALk4x9QIDAQABo0swSTAJ
|
|
|
|
BgNVHRMEAjAAMAsGA1UdDwQEAwIHgDAaBgNVHREEEzARgglsb2NhbGhvc3SHBH8A
|
|
|
|
AAEwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADgYEANSjz2Sk+
|
|
|
|
eqp31wM9il1n+guTNyxJd+FzVAH+hCZE5K+tCgVDdVFUlDEHHbS/wqb2PSIoouLV
|
|
|
|
3Q9fgDkiUod+uIK0IynzIKvw+Cjg+3nx6NQ0IM0zo8c7v398RzB4apbXKZyeeqUH
|
|
|
|
9fNwfEi+OoXR6s+upSKobCmLGLGi9Na5s5g=
|
|
|
|
-----END CERTIFICATE-----`)
|
|
|
|
|
|
|
|
block, _ := pem.Decode(clientCert)
|
|
|
|
if block == nil {
|
|
|
|
t.Fatalf("failed to decode PEM certificate")
|
|
|
|
}
|
|
|
|
|
|
|
|
cert, err := x509.ParseCertificate(block.Bytes)
|
|
|
|
if err != nil {
|
|
|
|
t.Fatalf("failed to decode PEM certificate: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
req.TLS = &tls.ConnectionState{
|
|
|
|
Version: tls.VersionTLS13,
|
|
|
|
HandshakeComplete: true,
|
2022-09-30 14:29:33 -05:00
|
|
|
ServerName: "example.com",
|
2020-02-25 21:22:50 -05:00
|
|
|
CipherSuite: tls.TLS_AES_256_GCM_SHA384,
|
|
|
|
PeerCertificates: []*x509.Certificate{cert},
|
|
|
|
NegotiatedProtocol: "h2",
|
|
|
|
NegotiatedProtocolIsMutual: true,
|
|
|
|
}
|
|
|
|
|
2019-10-10 14:37:08 -05:00
|
|
|
res := httptest.NewRecorder()
|
|
|
|
addHTTPVarsToReplacer(repl, req, res)
|
|
|
|
|
|
|
|
for i, tc := range []struct {
|
2022-09-05 14:53:41 -05:00
|
|
|
get string
|
2019-10-14 13:09:43 -05:00
|
|
|
expect string
|
2019-10-10 14:37:08 -05:00
|
|
|
}{
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.scheme",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "https",
|
2019-10-10 14:37:08 -05:00
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.method",
|
|
|
|
expect: http.MethodGet,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
get: "http.request.host",
|
2019-10-10 14:37:08 -05:00
|
|
|
expect: "example.com",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.port",
|
2019-10-10 14:37:08 -05:00
|
|
|
expect: "80",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.hostport",
|
2019-10-10 14:37:08 -05:00
|
|
|
expect: "example.com:80",
|
|
|
|
},
|
caddyhttp: add http.request.local{,.host,.port} placeholder (#6182)
* caddyhttp: add `http.request.local{,.host,.port}` placeholder
This is the counterpart of `http.request.remote{,.host,.port}`.
`http.request.remote` operates on the remote client's address, while
`http.request.local` operates on the address the connection arrived on.
Take the following example:
- Caddy serving on `203.0.113.1:80`
- Client on `203.0.113.2`
`http.request.remote.host` would return `203.0.113.2` (client IP)
`http.request.local.host` would return `203.0.113.1` (server IP)
`http.request.local.port` would return `80` (server port)
I find this helpful for debugging setups with multiple servers and/or
multiple network paths (multiple IPs, AnyIP, Anycast).
Co-authored-by: networkException <git@nwex.de>
* caddyhttp: add unit test for `http.request.local{,.host,.port}`
* caddyhttp: add integration test for `http.request.local.port`
* caddyhttp: fix `http.request.local.host` placeholder handling with unix sockets
The implementation matches the one of `http.request.remote.host` now and
returns the unix socket path (just like `http.request.local` already did)
instead of an empty string.
---------
Co-authored-by: networkException <git@nwex.de>
2024-03-27 16:36:53 -05:00
|
|
|
{
|
|
|
|
get: "http.request.local.host",
|
|
|
|
expect: "192.168.159.1",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
get: "http.request.local.port",
|
|
|
|
expect: "80",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
get: "http.request.local",
|
|
|
|
expect: "192.168.159.1:80",
|
|
|
|
},
|
2019-10-10 14:37:08 -05:00
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.remote.host",
|
2022-09-30 14:29:33 -05:00
|
|
|
expect: "192.168.159.32",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
get: "http.request.remote.host/24",
|
|
|
|
expect: "192.168.159.0/24",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
get: "http.request.remote.host/24,32",
|
|
|
|
expect: "192.168.159.0/24",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
get: "http.request.remote.host/999",
|
|
|
|
expect: "",
|
2019-10-10 14:37:08 -05:00
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.remote.port",
|
2019-10-10 14:37:08 -05:00
|
|
|
expect: "1234",
|
|
|
|
},
|
2019-10-14 13:09:43 -05:00
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.host.labels.0",
|
2019-10-14 13:09:43 -05:00
|
|
|
expect: "com",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.host.labels.1",
|
2019-10-14 13:09:43 -05:00
|
|
|
expect: "example",
|
|
|
|
},
|
2020-06-30 12:42:55 -05:00
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.host.labels.2",
|
|
|
|
expect: "",
|
2020-06-30 12:42:55 -05:00
|
|
|
},
|
2020-02-25 21:22:50 -05:00
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.uri.path.file",
|
|
|
|
expect: "bar.tar.gz",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
get: "http.request.uri.path.file.base",
|
|
|
|
expect: "bar.tar",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
// not ideal, but also most correct, given that files can have dots (example: index.<SHA>.html) TODO: maybe this isn't right..
|
|
|
|
get: "http.request.uri.path.file.ext",
|
|
|
|
expect: ".gz",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
get: "http.request.tls.cipher_suite",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "TLS_AES_256_GCM_SHA384",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.proto",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "h2",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.proto_mutual",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "true",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.resumed",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "false",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.server_name",
|
2022-09-30 14:29:33 -05:00
|
|
|
expect: "example.com",
|
2020-02-25 21:22:50 -05:00
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.version",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "tls1.3",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.fingerprint",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "9f57b7b497cceacc5459b76ac1c3afedbc12b300e728071f55f84168ff0f7702",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.issuer",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "CN=Caddy Test CA",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.serial",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "2",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.subject",
|
2020-02-25 21:22:50 -05:00
|
|
|
expect: "CN=client.localdomain",
|
|
|
|
},
|
2020-06-11 17:19:07 -05:00
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.san.dns_names",
|
2020-06-11 17:19:07 -05:00
|
|
|
expect: "[localhost]",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.san.dns_names.0",
|
2020-06-11 17:19:07 -05:00
|
|
|
expect: "localhost",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.san.dns_names.1",
|
|
|
|
expect: "",
|
2020-06-11 17:19:07 -05:00
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.san.ips",
|
2020-06-11 17:19:07 -05:00
|
|
|
expect: "[127.0.0.1]",
|
|
|
|
},
|
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.san.ips.0",
|
2020-06-11 17:19:07 -05:00
|
|
|
expect: "127.0.0.1",
|
|
|
|
},
|
2020-09-16 16:06:51 -05:00
|
|
|
{
|
2022-09-05 14:53:41 -05:00
|
|
|
get: "http.request.tls.client.certificate_pem",
|
2021-05-10 13:01:27 -05:00
|
|
|
expect: string(clientCert) + "\n", // returned value comes with a newline appended to it
|
2020-09-16 16:06:51 -05:00
|
|
|
},
|
2019-10-10 14:37:08 -05:00
|
|
|
} {
|
2022-09-05 14:53:41 -05:00
|
|
|
actual, got := repl.GetString(tc.get)
|
|
|
|
if !got {
|
|
|
|
t.Errorf("Test %d: Expected to recognize the placeholder name, but didn't", i)
|
|
|
|
}
|
2019-10-10 14:37:08 -05:00
|
|
|
if actual != tc.expect {
|
2022-09-05 14:53:41 -05:00
|
|
|
t.Errorf("Test %d: Expected %s to be '%s' but got '%s'",
|
|
|
|
i, tc.get, tc.expect, actual)
|
2019-10-10 14:37:08 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|