forked from caddyserver/forwardproxy
-
Notifications
You must be signed in to change notification settings - Fork 106
/
forwardproxy.go
845 lines (757 loc) · 24.9 KB
/
forwardproxy.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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
// Copyright 2017 Google Inc.
//
// 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.
//
// Caching is purposefully ignored.
package forwardproxy
import (
"bufio"
"bytes"
"context"
"crypto/subtle"
"crypto/tls"
"encoding/base64"
"errors"
"fmt"
"io"
"math/rand"
"net"
"net/http"
"net/url"
"os"
"path/filepath"
"strconv"
"strings"
"sync"
"time"
"unicode/utf8"
caddy "github.com/caddyserver/caddy/v2"
"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
"github.com/caddyserver/caddy/v2/modules/caddyhttp"
"github.com/caddyserver/forwardproxy/httpclient"
"go.uber.org/zap"
"golang.org/x/net/proxy"
)
func init() {
caddy.RegisterModule(Handler{})
}
// Handler implements a forward proxy.
//
// EXPERIMENTAL: This handler is still experimental and subject to breaking changes.
type Handler struct {
logger *zap.Logger
// Filename of the PAC file to serve.
PACPath string `json:"pac_path,omitempty"`
// If true, the Forwarded header will not be augmented with your IP address.
HideIP bool `json:"hide_ip,omitempty"`
// If true, the Via header will not be added.
HideVia bool `json:"hide_via,omitempty"`
// Host(s) (and ports) of the proxy. When you configure a client,
// you will give it the host (and port) of the proxy to use.
Hosts caddyhttp.MatchHost `json:"hosts,omitempty"`
// Optional probe resistance. (See documentation.)
ProbeResistance *ProbeResistance `json:"probe_resistance,omitempty"`
// How long to wait before timing out initial TCP connections.
DialTimeout caddy.Duration `json:"dial_timeout,omitempty"`
// Optionally configure an upstream proxy to use.
Upstream string `json:"upstream,omitempty"`
// Access control list.
ACL []ACLRule `json:"acl,omitempty"`
// Ports to be allowed to connect to (if non-empty).
AllowedPorts []int `json:"allowed_ports,omitempty"`
httpTransport *http.Transport
// overridden dialContext allows us to redirect requests to upstream proxy
dialContext func(ctx context.Context, network, address string) (net.Conn, error)
upstream *url.URL // address of upstream proxy
aclRules []aclRule
// TODO: temporary/deprecated - we should try to reuse existing authentication modules instead!
AuthCredentials [][]byte `json:"auth_credentials,omitempty"` // slice with base64-encoded credentials
}
// CaddyModule returns the Caddy module information.
func (Handler) CaddyModule() caddy.ModuleInfo {
return caddy.ModuleInfo{
ID: "http.handlers.forward_proxy",
New: func() caddy.Module { return new(Handler) },
}
}
// Provision ensures that h is set up properly before use.
func (h *Handler) Provision(ctx caddy.Context) error {
h.logger = ctx.Logger(h)
if h.DialTimeout <= 0 {
h.DialTimeout = caddy.Duration(30 * time.Second)
}
h.httpTransport = &http.Transport{
Proxy: http.ProxyFromEnvironment,
MaxIdleConns: 50,
IdleConnTimeout: 60 * time.Second,
TLSHandshakeTimeout: 10 * time.Second,
}
// access control lists
for _, rule := range h.ACL {
for _, subj := range rule.Subjects {
ar, err := newACLRule(subj, rule.Allow)
if err != nil {
return err
}
h.aclRules = append(h.aclRules, ar)
}
}
for _, ipDeny := range []string{
"10.0.0.0/8",
"127.0.0.0/8",
"172.16.0.0/12",
"192.168.0.0/16",
"::1/128",
"fe80::/10",
} {
ar, err := newACLRule(ipDeny, false)
if err != nil {
return err
}
h.aclRules = append(h.aclRules, ar)
}
h.aclRules = append(h.aclRules, &aclAllRule{allow: true})
if h.ProbeResistance != nil {
if h.AuthCredentials == nil {
return fmt.Errorf("probe resistance requires authentication")
}
if len(h.ProbeResistance.Domain) > 0 {
h.logger.Info("Secret domain used to connect to proxy: " + h.ProbeResistance.Domain)
}
}
dialer := &net.Dialer{
Timeout: time.Duration(h.DialTimeout),
KeepAlive: 30 * time.Second,
DualStack: true,
}
h.dialContext = dialer.DialContext
h.httpTransport.DialContext = func(ctx context.Context, network string, address string) (net.Conn, error) {
return h.dialContextCheckACL(ctx, network, address)
}
if h.Upstream != "" {
upstreamURL, err := url.Parse(h.Upstream)
if err != nil {
return fmt.Errorf("bad upstream URL: %v", err)
}
h.upstream = upstreamURL
if !isLocalhost(h.upstream.Hostname()) && h.upstream.Scheme != "https" {
return errors.New("insecure schemes are only allowed to localhost upstreams")
}
registerHTTPDialer := func(u *url.URL, _ proxy.Dialer) (proxy.Dialer, error) {
// CONNECT request is proxied as-is, so we don't care about target url, but it could be
// useful in future to implement policies of choosing between multiple upstream servers.
// Given dialer is not used, since it's the same dialer provided by us.
d, err := httpclient.NewHTTPConnectDialer(h.upstream.String())
if err != nil {
return nil, err
}
d.Dialer = *dialer
if isLocalhost(h.upstream.Hostname()) && h.upstream.Scheme == "https" {
// disabling verification helps with testing the package and setups
// either way, it's impossible to have a legit TLS certificate for "127.0.0.1" - TODO: not true anymore
h.logger.Info("Localhost upstream detected, disabling verification of TLS certificate")
d.DialTLS = func(network string, address string) (net.Conn, string, error) {
conn, err := tls.Dial(network, address, &tls.Config{InsecureSkipVerify: true}) // #nosec G402
if err != nil {
return nil, "", err
}
return conn, conn.ConnectionState().NegotiatedProtocol, nil
}
}
return d, nil
}
proxy.RegisterDialerType("https", registerHTTPDialer)
proxy.RegisterDialerType("http", registerHTTPDialer)
upstreamDialer, err := proxy.FromURL(h.upstream, dialer)
if err != nil {
return errors.New("failed to create proxy to upstream: " + err.Error())
}
if ctxDialer, ok := upstreamDialer.(dialContexter); ok {
// upstreamDialer has DialContext - use it
h.dialContext = ctxDialer.DialContext
} else {
// upstreamDialer does not have DialContext - ignore the context :(
h.dialContext = func(ctx context.Context, network string, address string) (net.Conn, error) {
return upstreamDialer.Dial(network, address)
}
}
}
return nil
}
func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error {
// start by splitting the request host and port
reqHost, _, err := net.SplitHostPort(r.Host)
if err != nil {
reqHost = r.Host // OK; probably just didn't have a port
}
var authErr error
if h.AuthCredentials != nil {
authErr = h.checkCredentials(r)
}
if h.ProbeResistance != nil && len(h.ProbeResistance.Domain) > 0 && reqHost == h.ProbeResistance.Domain {
return serveHiddenPage(w, authErr)
}
if h.Hosts.Match(r) && (r.Method != http.MethodConnect || authErr != nil) {
// Always pass non-CONNECT requests to hostname
// Pass CONNECT requests only if probe resistance is enabled and not authenticated
if h.shouldServePACFile(r) {
return h.servePacFile(w, r)
}
return next.ServeHTTP(w, r)
}
if authErr != nil {
if h.ProbeResistance != nil {
// probe resistance is requested and requested URI does not match secret domain;
// act like this proxy handler doesn't even exist (pass thru to next handler)
return next.ServeHTTP(w, r)
}
w.Header().Set("Proxy-Authenticate", "Basic realm=\"Caddy Secure Web Proxy\"")
return caddyhttp.Error(http.StatusProxyAuthRequired, authErr)
}
if r.ProtoMajor != 1 && r.ProtoMajor != 2 && r.ProtoMajor != 3 {
return caddyhttp.Error(http.StatusHTTPVersionNotSupported,
fmt.Errorf("unsupported HTTP major version: %d", r.ProtoMajor))
}
ctx := context.Background()
if !h.HideIP {
ctxHeader := make(http.Header)
for k, v := range r.Header {
if kL := strings.ToLower(k); kL == "forwarded" || kL == "x-forwarded-for" {
ctxHeader[k] = v
}
}
ctxHeader.Add("Forwarded", "for=\""+r.RemoteAddr+"\"")
ctx = context.WithValue(ctx, httpclient.ContextKeyHeader{}, ctxHeader)
}
if r.Method == http.MethodConnect {
if r.ProtoMajor == 2 || r.ProtoMajor == 3 {
if len(r.URL.Scheme) > 0 || len(r.URL.Path) > 0 {
return caddyhttp.Error(http.StatusBadRequest,
fmt.Errorf("CONNECT request has :scheme and/or :path pseudo-header fields"))
}
}
// HTTP CONNECT Fast Open: Directly responds with a 200 OK
// before attempting to connect to origin to reduce response latency.
// We merely close the connection if Open fails.
// Creates a padding header with length in [30, 30+32)
paddingLen := rand.Intn(32) + 30
padding := make([]byte, paddingLen)
bits := rand.Uint64()
for i := 0; i < 16; i++ {
// Codes that won't be Huffman coded.
padding[i] = "!#$()+<>?@[]^`{}"[bits&15]
bits >>= 4
}
for i := 16; i < paddingLen; i++ {
padding[i] = '~'
}
w.Header().Set("Padding", string(padding))
w.WriteHeader(http.StatusOK)
err := http.NewResponseController(w).Flush()
if err != nil {
return caddyhttp.Error(http.StatusInternalServerError,
fmt.Errorf("ResponseWriter flush error: %v", err))
}
hostPort := r.URL.Host
if hostPort == "" {
hostPort = r.Host
}
targetConn, err := h.dialContextCheckACL(ctx, "tcp", hostPort)
if err != nil {
return err
}
if targetConn == nil {
// safest to check both error and targetConn afterwards, in case fp.dial (potentially unstable
// from x/net/proxy) misbehaves and returns both nil or both non-nil
return caddyhttp.Error(http.StatusForbidden,
fmt.Errorf("hostname %s is not allowed", r.URL.Hostname()))
}
defer targetConn.Close()
switch r.ProtoMajor {
case 1: // http1: hijack the whole flow
return serveHijack(w, targetConn)
case 2: // http2: keep reading from "request" and writing into same response
fallthrough
case 3:
defer r.Body.Close()
return dualStream(targetConn, r.Body, w, r.Header.Get("Padding") != "")
}
panic("There was a check for http version, yet it's incorrect")
}
// Scheme has to be appended to avoid `unsupported protocol scheme ""` error.
// `http://` is used, since this initial request itself is always HTTP, regardless of what client and server
// may speak afterwards.
if r.URL.Scheme == "" {
r.URL.Scheme = "http"
}
if r.URL.Host == "" {
r.URL.Host = r.Host
}
r.Proto = "HTTP/1.1"
r.ProtoMajor = 1
r.ProtoMinor = 1
r.RequestURI = ""
removeHopByHop(r.Header)
if !h.HideIP {
r.Header.Add("Forwarded", "for=\""+r.RemoteAddr+"\"")
}
// https://tools.ietf.org/html/rfc7230#section-5.7.1
if !h.HideVia {
r.Header.Add("Via", strconv.Itoa(r.ProtoMajor)+"."+strconv.Itoa(r.ProtoMinor)+" caddy")
}
var response *http.Response
if h.upstream == nil {
// non-upstream request uses httpTransport to reuse connections
if r.Body != nil &&
(r.Method == "GET" || r.Method == "HEAD" || r.Method == "OPTIONS" || r.Method == "TRACE") {
// make sure request is idempotent and could be retried by saving the Body
// None of those methods are supposed to have body,
// but we still need to copy the r.Body, even if it's empty
rBodyBuf, err := io.ReadAll(r.Body)
if err != nil {
return caddyhttp.Error(http.StatusBadRequest,
fmt.Errorf("failed to read request body: %v", err))
}
r.GetBody = func() (io.ReadCloser, error) {
return io.NopCloser(bytes.NewReader(rBodyBuf)), nil
}
r.Body, _ = r.GetBody()
}
response, err = h.httpTransport.RoundTrip(r)
} else {
// Upstream requests don't interact well with Transport: connections could always be
// reused, but Transport thinks they go to different Hosts, so it spawns tons of
// useless connections.
// Just use dialContext, which will multiplex via single connection, if http/2
if creds := h.upstream.User.String(); creds != "" {
// set upstream credentials for the request, if needed
r.Header.Set("Proxy-Authorization", "Basic "+base64.StdEncoding.EncodeToString([]byte(creds)))
}
if r.URL.Port() == "" {
r.URL.Host = net.JoinHostPort(r.URL.Host, "80")
}
upsConn, err := h.dialContext(ctx, "tcp", r.URL.Host)
if err != nil {
return caddyhttp.Error(http.StatusBadGateway,
fmt.Errorf("failed to dial upstream: %v", err))
}
err = r.Write(upsConn)
if err != nil {
return caddyhttp.Error(http.StatusBadGateway,
fmt.Errorf("failed to write upstream request: %v", err))
}
response, err = http.ReadResponse(bufio.NewReader(upsConn), r)
if err != nil {
return caddyhttp.Error(http.StatusBadGateway,
fmt.Errorf("failed to read upstream response: %v", err))
}
}
if err := r.Body.Close(); err != nil {
return caddyhttp.Error(http.StatusBadGateway,
fmt.Errorf("failed to close response body: %v", err))
}
if response != nil {
defer response.Body.Close()
}
if err != nil {
if _, ok := err.(caddyhttp.HandlerError); ok {
return err
}
return caddyhttp.Error(http.StatusBadGateway,
fmt.Errorf("failed to read response: %v", err))
}
return forwardResponse(w, response)
}
func (h Handler) checkCredentials(r *http.Request) error {
pa := strings.Split(r.Header.Get("Proxy-Authorization"), " ")
if len(pa) != 2 {
return errors.New("Proxy-Authorization is required! Expected format: <type> <credentials>")
}
if strings.ToLower(pa[0]) != "basic" {
return errors.New("auth type is not supported")
}
for _, creds := range h.AuthCredentials {
if subtle.ConstantTimeCompare(creds, []byte(pa[1])) == 1 {
repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
buf := make([]byte, base64.StdEncoding.DecodedLen(len(creds)))
_, _ = base64.StdEncoding.Decode(buf, creds) // should not err ever since we are decoding a known good input
cred := string(buf)
repl.Set("http.auth.user.id", cred[:strings.IndexByte(cred, ':')])
// Please do not consider this to be timing-attack-safe code. Simple equality is almost
// mindlessly substituted with constant time algo and there ARE known issues with this code,
// e.g. size of smallest credentials is guessable. TODO: protect from all the attacks! Hash?
return nil
}
}
repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
buf := make([]byte, base64.StdEncoding.DecodedLen(len([]byte(pa[1]))))
n, err := base64.StdEncoding.Decode(buf, []byte(pa[1]))
if err != nil {
repl.Set("http.auth.user.id", "invalidbase64:"+err.Error())
return err
}
if utf8.Valid(buf[:n]) {
cred := string(buf[:n])
i := strings.IndexByte(cred, ':')
if i >= 0 {
repl.Set("http.auth.user.id", "invalid:"+cred[:i])
} else {
repl.Set("http.auth.user.id", "invalidformat:"+cred)
}
} else {
repl.Set("http.auth.user.id", "invalid::")
}
return errors.New("invalid credentials")
}
func (h Handler) shouldServePACFile(r *http.Request) bool {
return len(h.PACPath) > 0 && r.URL.Path == h.PACPath
}
func (h Handler) servePacFile(w http.ResponseWriter, r *http.Request) error {
fmt.Fprintf(w, pacFile, r.Host)
// fmt.Fprintf(w, pacFile, h.hostname, h.port)
return nil
}
// dialContextCheckACL enforces Access Control List and calls fp.DialContext
func (h Handler) dialContextCheckACL(ctx context.Context, network, hostPort string) (net.Conn, error) {
var conn net.Conn
if network != "tcp" && network != "tcp4" && network != "tcp6" {
// return nil, &proxyError{S: "Network " + network + " is not supported", Code: http.StatusBadRequest}
return nil, caddyhttp.Error(http.StatusBadRequest,
fmt.Errorf("network %s is not supported", network))
}
host, port, err := net.SplitHostPort(hostPort)
if err != nil {
// return nil, &proxyError{S: err.Error(), Code: http.StatusBadRequest}
return nil, caddyhttp.Error(http.StatusBadRequest, err)
}
if h.upstream != nil {
// if upstreaming -- do not resolve locally nor check acl
conn, err = h.dialContext(ctx, network, hostPort)
if err != nil {
// return conn, &proxyError{S: err.Error(), Code: http.StatusBadGateway}
return conn, caddyhttp.Error(http.StatusBadGateway, err)
}
return conn, nil
}
if !h.portIsAllowed(port) {
// return nil, &proxyError{S: "port " + port + " is not allowed", Code: http.StatusForbidden}
return nil, caddyhttp.Error(http.StatusForbidden,
fmt.Errorf("port %s is not allowed", port))
}
// in case IP was provided, net.LookupIP will simply return it
IPs, err := net.LookupIP(host)
if err != nil {
// return nil, &proxyError{S: fmt.Sprintf("Lookup of %s failed: %v", host, err),
// Code: http.StatusBadGateway}
return nil, caddyhttp.Error(http.StatusBadGateway,
fmt.Errorf("lookup of %s failed: %v", host, err))
}
// This is net.Dial's default behavior: if the host resolves to multiple IP addresses,
// Dial will try each IP address in order until one succeeds
for _, ip := range IPs {
if !h.hostIsAllowed(host, ip) {
continue
}
conn, err = h.dialContext(ctx, network, net.JoinHostPort(ip.String(), port))
if err == nil {
return conn, nil
}
}
return nil, caddyhttp.Error(http.StatusForbidden, fmt.Errorf("no allowed IP addresses for %s", host))
}
func (h Handler) hostIsAllowed(hostname string, ip net.IP) bool {
for _, rule := range h.aclRules {
switch rule.tryMatch(ip, hostname) {
case aclDecisionDeny:
return false
case aclDecisionAllow:
return true
}
}
// TODO: convert this to log entry
// fmt.Println("ERROR: no acl match for ", hostname, ip) // shouldn't happen
return false
}
func (h Handler) portIsAllowed(port string) bool {
portInt, err := strconv.Atoi(port)
if err != nil {
return false
}
if portInt <= 0 || portInt > 65535 {
return false
}
if len(h.AllowedPorts) == 0 {
return true
}
isAllowed := false
for _, p := range h.AllowedPorts {
if p == portInt {
isAllowed = true
break
}
}
return isAllowed
}
func serveHiddenPage(w http.ResponseWriter, authErr error) error {
const hiddenPage = `<html>
<head>
<title>Hidden Proxy Page</title>
</head>
<body>
<h1>Hidden Proxy Page!</h1>
%s<br/>
</body>
</html>`
const AuthFail = "Please authenticate yourself to the proxy."
const AuthOk = "Congratulations, you are successfully authenticated to the proxy! Go browse all the things!"
w.Header().Set("Content-Type", "text/html")
if authErr != nil {
w.Header().Set("Proxy-Authenticate", "Basic realm=\"Caddy Secure Web Proxy\"")
w.WriteHeader(http.StatusProxyAuthRequired)
_, _ = w.Write([]byte(fmt.Sprintf(hiddenPage, AuthFail)))
return authErr
}
_, _ = w.Write([]byte(fmt.Sprintf(hiddenPage, AuthOk)))
return nil
}
// Hijacks the connection from ResponseWriter, writes the response and proxies data between targetConn
// and hijacked connection.
func serveHijack(w http.ResponseWriter, targetConn net.Conn) error {
clientConn, bufReader, err := http.NewResponseController(w).Hijack()
if err != nil {
return caddyhttp.Error(http.StatusInternalServerError,
fmt.Errorf("hijack failed: %v", err))
}
defer clientConn.Close()
// bufReader may contain unprocessed buffered data from the client.
if bufReader != nil {
// snippet borrowed from `proxy` plugin
if n := bufReader.Reader.Buffered(); n > 0 {
rbuf, err := bufReader.Reader.Peek(n)
if err != nil {
return caddyhttp.Error(http.StatusBadGateway, err)
}
_, _ = targetConn.Write(rbuf)
}
}
// Since we hijacked the connection, we lost the ability to write and flush headers via w.
// Let's handcraft the response and send it manually.
res := &http.Response{
StatusCode: http.StatusOK,
Proto: "HTTP/1.1",
ProtoMajor: 1,
ProtoMinor: 1,
Header: make(http.Header),
}
res.Header.Set("Server", "Caddy")
buf := bufio.NewWriter(clientConn)
err = res.Write(buf)
if err != nil {
return caddyhttp.Error(http.StatusInternalServerError,
fmt.Errorf("failed to write response: %v", err))
}
err = buf.Flush()
if err != nil {
return caddyhttp.Error(http.StatusInternalServerError,
fmt.Errorf("failed to send response to client: %v", err))
}
return dualStream(targetConn, clientConn, clientConn, false)
}
const (
NoPadding = 0
AddPadding = 1
RemovePadding = 2
NumFirstPaddings = 8
)
// Copies data target->clientReader and clientWriter->target, and flushes as needed
// Returns when clientWriter-> target stream is done.
// Caddy should finish writing target -> clientReader.
func dualStream(target net.Conn, clientReader io.ReadCloser, clientWriter io.Writer, padding bool) error {
stream := func(w io.Writer, r io.Reader, paddingType int) error {
// copy bytes from r to w
bufPtr := bufferPool.Get().(*[]byte)
buf := *bufPtr
buf = buf[0:cap(buf)]
_, _err := flushingIoCopy(w, r, buf, paddingType)
bufferPool.Put(bufPtr)
if cw, ok := w.(closeWriter); ok {
_ = cw.CloseWrite()
}
return _err
}
if padding {
go stream(target, clientReader, RemovePadding)
return stream(clientWriter, target, AddPadding)
}
go stream(target, clientReader, NoPadding) //nolint: errcheck
return stream(clientWriter, target, NoPadding)
}
type closeWriter interface {
CloseWrite() error
}
// flushingIoCopy is analogous to buffering io.Copy(), but also attempts to flush on each iteration.
// If dst does not implement http.Flusher(e.g. net.TCPConn), it will do a simple io.CopyBuffer().
// Reasoning: http2ResponseWriter will not flush on its own, so we have to do it manually.
func flushingIoCopy(dst io.Writer, src io.Reader, buf []byte, paddingType int) (written int64, err error) {
rw, ok := dst.(http.ResponseWriter)
var rc *http.ResponseController
if ok {
rc = http.NewResponseController(rw)
}
var numPadding int
for {
var nr int
var er error
if paddingType == AddPadding && numPadding < NumFirstPaddings {
numPadding++
paddingSize := rand.Intn(256)
maxRead := 65536 - 3 - paddingSize
nr, er = src.Read(buf[3:maxRead])
if nr > 0 {
buf[0] = byte(nr / 256)
buf[1] = byte(nr % 256)
buf[2] = byte(paddingSize)
for i := 0; i < paddingSize; i++ {
buf[3+nr+i] = 0
}
nr += 3 + paddingSize
}
} else if paddingType == RemovePadding && numPadding < NumFirstPaddings {
numPadding++
nr, er = io.ReadFull(src, buf[0:3])
if nr > 0 {
nr = int(buf[0])*256 + int(buf[1])
paddingSize := int(buf[2])
nr, er = io.ReadFull(src, buf[0:nr])
if nr > 0 {
var junk [256]byte
_, er = io.ReadFull(src, junk[0:paddingSize])
}
}
} else {
nr, er = src.Read(buf)
}
if nr > 0 {
nw, ew := dst.Write(buf[0:nr])
if nw > 0 {
written += int64(nw)
}
if ew != nil {
err = ew
break
}
if rc != nil {
ef := rc.Flush()
if ef != nil {
err = ef
break
}
}
if nr != nw {
err = io.ErrShortWrite
break
}
}
if er != nil {
if er != io.EOF {
err = er
}
break
}
}
return
}
// Removes hop-by-hop headers, and writes response into ResponseWriter.
func forwardResponse(w http.ResponseWriter, response *http.Response) error {
w.Header().Del("Server") // remove Server: Caddy, append via instead
w.Header().Add("Via", strconv.Itoa(response.ProtoMajor)+"."+strconv.Itoa(response.ProtoMinor)+" caddy")
for header, values := range response.Header {
for _, val := range values {
w.Header().Add(header, val)
}
}
removeHopByHop(w.Header())
w.WriteHeader(response.StatusCode)
bufPtr := bufferPool.Get().(*[]byte)
buf := *bufPtr
buf = buf[0:cap(buf)]
_, err := io.CopyBuffer(w, response.Body, buf)
bufferPool.Put(bufPtr)
return err
}
func removeHopByHop(header http.Header) {
connectionHeaders := header.Get("Connection")
for _, h := range strings.Split(connectionHeaders, ",") {
header.Del(strings.TrimSpace(h))
}
for _, h := range hopByHopHeaders {
header.Del(h)
}
}
var hopByHopHeaders = []string{
"Keep-Alive",
"Proxy-Authenticate",
"Proxy-Authorization",
"Upgrade",
"Connection",
"Proxy-Connection",
"Te",
"Trailer",
"Transfer-Encoding",
}
const pacFile = `
function FindProxyForURL(url, host) {
if (host === "127.0.0.1" || host === "::1" || host === "localhost")
return "DIRECT";
return "HTTPS %s";
}
`
var bufferPool = sync.Pool{
New: func() interface{} {
buffer := make([]byte, 0, 64*1024)
return &buffer
},
}
////// used during provision only
func isLocalhost(hostname string) bool {
return hostname == "localhost" ||
hostname == "127.0.0.1" ||
hostname == "::1"
}
type dialContexter interface {
DialContext(ctx context.Context, network, address string) (net.Conn, error)
}
// ProbeResistance configures probe resistance.
type ProbeResistance struct {
Domain string `json:"domain,omitempty"`
}
func readLinesFromFile(filename string) ([]string, error) {
cleanFilename := filepath.Clean(filename)
file, err := os.Open(cleanFilename)
if err != nil {
return nil, err
}
defer file.Close()
var hostnames []string
scanner := bufio.NewScanner(file)
for scanner.Scan() {
hostnames = append(hostnames, scanner.Text())
}
return hostnames, scanner.Err()
}
// Interface guards
var (
_ caddy.Provisioner = (*Handler)(nil)
_ caddyhttp.MiddlewareHandler = (*Handler)(nil)
_ caddyfile.Unmarshaler = (*Handler)(nil)
)