-
Notifications
You must be signed in to change notification settings - Fork 23
/
forwarded_for.go
222 lines (202 loc) · 7.47 KB
/
forwarded_for.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
package listenerutil
import (
"context"
"fmt"
"net"
"net/http"
"net/textproto"
"strings"
"github.com/hashicorp/go-sockaddr"
)
type key int
const (
remoteAddrKey key = iota
missingPortErrStr = "missing port in address"
)
// ErrResponseFn provides a func to call whenever WrapForwardedForHandler
// encounters an error
type ErrResponseFn func(w http.ResponseWriter, status int, err error)
// WrapForwaredForHandler is an http middleware handler which uses the
// XForwardedFor* listener config settings to determine how/if X-Forwarded-For
// are trusted/allowed for an inbound request. In the end, if a "trusted"
// X-Forwarded-For header is found, then the request RemoteAddr will be
// overwritten with it before the request is served.
func WrapForwardedForHandler(h http.Handler, l *ListenerConfig, respErrFn ErrResponseFn) (http.Handler, error) {
if h == nil {
return nil, fmt.Errorf("missing http handler: %w", ErrInvalidParameter)
}
if l == nil {
return nil, fmt.Errorf("missing listener config: %w", ErrInvalidParameter)
}
if respErrFn == nil {
return nil, fmt.Errorf("missing response error function: %w", ErrInvalidParameter)
}
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
trusted, remoteAddr, err := TrustedFromXForwardedFor(r, l)
if err != nil {
respErrFn(w, http.StatusBadRequest, err)
return
}
if trusted == nil || remoteAddr == nil {
h.ServeHTTP(w, r)
return
}
newCtx, err := newOrigRemoteAddrCtx(r.Context(), r.RemoteAddr)
if err != nil {
respErrFn(w, http.StatusBadRequest, fmt.Errorf("error setting orig remote header ctx: %w", err))
return
}
r = r.WithContext(newCtx)
switch {
case trusted.Port != "":
r.RemoteAddr = net.JoinHostPort(trusted.Host, trusted.Port)
default:
// setting remote address to a combination is a bit different, but
// it's needed to satisfies the requirement that remote addr always
// have a port which is likely relied upon by downstream callers in
// the call chain.
//
// this is intentionally the default since it's very likely the
// "trusted" address will not have a port making this the most
// likely execution path
r.RemoteAddr = net.JoinHostPort(trusted.Host, remoteAddr.Port)
}
h.ServeHTTP(w, r)
return
}), nil
}
// Addr represents only the Host and Port of a TCP address.
type Addr struct {
Host string
Port string
}
// TrustedFromXForwardedFor will use the XForwardedFor* listener config settings
// to determine how/if X-Forwarded-For are trusted/allowed for an inbound
// request. Important: return values of nil, nil, nil are valid and simply
// means that no "trusted" header was found and no error was raised as well.
// Errors can be raised for a number of conditions based on the listener config
// settings, especially when the config setting for
// XForwardedForRejectNotPresent is set to true which means if a "trusted"
// header can't be found the request should be rejected.
func TrustedFromXForwardedFor(r *http.Request, l *ListenerConfig) (trustedAddress *Addr, remoteAddress *Addr, e error) {
if r == nil {
return nil, nil, fmt.Errorf("missing http request: %w", ErrInvalidParameter)
}
if l == nil {
return nil, nil, fmt.Errorf("missing listener config: %w", ErrInvalidParameter)
}
rejectNotPresent := l.XForwardedForRejectNotPresent
hopSkips := l.XForwardedForHopSkips
authorizedAddrs := l.XForwardedForAuthorizedAddrs
rejectNotAuthz := l.XForwardedForRejectNotAuthorized
headers, headersOK := r.Header[textproto.CanonicalMIMEHeaderKey("X-Forwarded-For")]
if !headersOK || len(headers) == 0 {
if !rejectNotPresent {
return nil, nil, nil
}
return nil, nil, fmt.Errorf("missing x-forwarded-for header and configured to reject when not present")
}
// http request remote address will always have a remoteAddrHost:port
// (see:
// https://cs.opensource.google/go/go/+/refs/tags/go1.17.3:src/net/http/request.go;l=279-286)
var remoteAddr Addr
var err error
remoteAddr.Host, remoteAddr.Port, err = net.SplitHostPort(r.RemoteAddr)
if err != nil {
// If not rejecting treat it like we just don't have a valid
// header because we can't do a comparison against an address we
// can't understand
if !rejectNotPresent {
return nil, nil, nil
}
return nil, nil, fmt.Errorf("error parsing client hostport: %w", err)
}
addr, err := sockaddr.NewIPAddr(remoteAddr.Host)
if err != nil {
// We treat this the same as the case above
if !rejectNotPresent {
return nil, nil, nil
}
return nil, nil, fmt.Errorf("error parsing client address: %w", err)
}
var found bool
for _, authz := range authorizedAddrs {
if authz.Contains(addr) {
found = true
break
}
}
if !found {
// If we didn't find it and aren't configured to reject, simply
// don't trust it
if !rejectNotAuthz {
return nil, nil, nil
}
return nil, nil, fmt.Errorf("client address not authorized for x-forwarded-for and configured to reject connection")
}
// At this point we have at least one value and it's authorized
// Split comma separated ones, which are common. This brings it in line
// to the multiple-header case.
var acc []*Addr
for _, header := range headers {
vals := strings.Split(header, ",")
for _, v := range vals {
// validate the header contains a valid IP
v = strings.TrimSpace(v)
h, p, err := net.SplitHostPort(v)
switch {
case err != nil && strings.Contains(err.Error(), missingPortErrStr):
h = v
case err != nil && !strings.Contains(err.Error(), missingPortErrStr):
if !rejectNotPresent {
return nil, nil, nil
}
return nil, nil, fmt.Errorf("error parsing client address host/port (%s) from header", v)
}
ip := net.ParseIP(h)
if ip == nil {
if !rejectNotPresent {
return nil, nil, nil
}
return nil, nil, fmt.Errorf("error parsing client address (%s) from header", v)
}
acc = append(acc, &Addr{Host: h, Port: p})
}
}
indexToUse := int64(len(acc)) - 1 - hopSkips
if indexToUse < 0 {
// This is likely an error in either configuration or other
// infrastructure. We could either deny the request, or we
// could simply not trust the value. Denying the request is
// "safer" since if this logic is configured at all there may
// be an assumption it can always be trusted. Given that we can
// deny accepting the request at all if it's not from an
// authorized address, if we're at this point the address is
// authorized (or we've turned off explicit rejection) and we
// should assume that what comes in should be properly
// formatted.
return nil, nil, fmt.Errorf("malformed x-forwarded-for configuration or request, hops to skip (%d) would skip before earliest chain link (chain length %d)", hopSkips, len(headers))
}
return acc[indexToUse], &remoteAddr, nil
}
// newOrigRemoteAddrCtx will return a context containing a value for the
// provided original remote address
func newOrigRemoteAddrCtx(ctx context.Context, origRemoteAddr string) (context.Context, error) {
const op = "event.NewRequestInfoContext"
if ctx == nil {
return nil, fmt.Errorf("%s: missing context: %w", op, ErrInvalidParameter)
}
if origRemoteAddr == "" {
return nil, fmt.Errorf("%s: missing original remote address: %w", op, ErrInvalidParameter)
}
return context.WithValue(ctx, remoteAddrKey, origRemoteAddr), nil
}
// OrigRemoteAddrFromCtx attempts to get the original remote address value from
// the context provided
func OrigRemoteAddrFromCtx(ctx context.Context) (string, bool) {
if ctx == nil {
return "", false
}
orig, ok := ctx.Value(remoteAddrKey).(string)
return orig, ok
}