traefik/vendor/github.com/vulcand/oxy/forward/fwd.go

450 lines
13 KiB
Go
Raw Normal View History

2017-02-07 21:33:23 +00:00
// package forwarder implements http handler that forwards requests to remote server
// and serves back the response
// websocket proxying support based on https://github.com/yhat/wsutil
package forward
import (
"crypto/tls"
"io"
"net/http"
2017-11-22 17:20:03 +00:00
"net/http/httptest"
"net/http/httputil"
2017-02-07 21:33:23 +00:00
"net/url"
"os"
2017-09-29 19:04:03 +00:00
"reflect"
2017-02-07 21:33:23 +00:00
"strings"
"time"
2017-11-22 17:20:03 +00:00
log "github.com/Sirupsen/logrus"
"github.com/gorilla/websocket"
2017-02-07 21:33:23 +00:00
"github.com/vulcand/oxy/utils"
)
// ReqRewriter can alter request headers and body
type ReqRewriter interface {
Rewrite(r *http.Request)
}
type optSetter func(f *Forwarder) error
// PassHostHeader specifies if a client's Host header field should
// be delegated
func PassHostHeader(b bool) optSetter {
return func(f *Forwarder) error {
2017-11-22 17:20:03 +00:00
f.httpForwarder.passHost = b
2017-02-07 21:33:23 +00:00
return nil
}
}
// RoundTripper sets a new http.RoundTripper
// Forwarder will use http.DefaultTransport as a default round tripper
func RoundTripper(r http.RoundTripper) optSetter {
return func(f *Forwarder) error {
2017-11-22 17:20:03 +00:00
f.httpForwarder.roundTripper = r
2017-02-07 21:33:23 +00:00
return nil
}
}
// Rewriter defines a request rewriter for the HTTP forwarder
func Rewriter(r ReqRewriter) optSetter {
return func(f *Forwarder) error {
f.httpForwarder.rewriter = r
return nil
}
}
2017-11-22 17:20:03 +00:00
// PassHostHeader specifies if a client's Host header field should
// be delegated
func WebsocketTLSClientConfig(tcc *tls.Config) optSetter {
2017-02-07 21:33:23 +00:00
return func(f *Forwarder) error {
2017-11-22 17:20:03 +00:00
f.httpForwarder.tlsClientConfig = tcc
2017-02-07 21:33:23 +00:00
return nil
}
}
// ErrorHandler is a functional argument that sets error handler of the server
func ErrorHandler(h utils.ErrorHandler) optSetter {
return func(f *Forwarder) error {
f.errHandler = h
return nil
}
}
2017-11-22 17:20:03 +00:00
// Stream specifies if HTTP responses should be streamed.
func Stream(stream bool) optSetter {
return func(f *Forwarder) error {
f.stream = stream
return nil
}
}
// Logger defines the logger the forwarder will use.
//
// It defaults to logrus.StandardLogger(), the global logger used by logrus.
func Logger(l *log.Logger) optSetter {
2017-02-07 21:33:23 +00:00
return func(f *Forwarder) error {
f.log = l
return nil
}
}
2017-11-22 17:20:03 +00:00
func StateListener(stateListener UrlForwardingStateListener) optSetter {
return func(f *Forwarder) error {
f.stateListener = stateListener
return nil
}
}
func ResponseModifier(responseModifier func(*http.Response) error) optSetter {
return func(f *Forwarder) error {
f.httpForwarder.modifyResponse = responseModifier
return nil
}
}
func StreamingFlushInterval(flushInterval time.Duration) optSetter {
return func(f *Forwarder) error {
f.httpForwarder.flushInterval = flushInterval
return nil
}
}
type ErrorHandlingRoundTripper struct {
http.RoundTripper
errorHandler utils.ErrorHandler
}
func (rt ErrorHandlingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
res, err := rt.RoundTripper.RoundTrip(req)
if err != nil {
// We use the recorder from httptest because there isn't another `public` implementation of a recorder.
recorder := httptest.NewRecorder()
rt.errorHandler.ServeHTTP(recorder, req, err)
res = recorder.Result()
err = nil
}
return res, err
}
2017-02-07 21:33:23 +00:00
// Forwarder wraps two traffic forwarding implementations: HTTP and websockets.
// It decides based on the specified request which implementation to use
type Forwarder struct {
*httpForwarder
*handlerContext
2017-11-22 17:20:03 +00:00
stateListener UrlForwardingStateListener
stream bool
2017-02-07 21:33:23 +00:00
}
// handlerContext defines a handler context for error reporting and logging
type handlerContext struct {
errHandler utils.ErrorHandler
}
// httpForwarder is a handler that can reverse proxy
// HTTP traffic
type httpForwarder struct {
roundTripper http.RoundTripper
rewriter ReqRewriter
passHost bool
2017-11-22 17:20:03 +00:00
flushInterval time.Duration
modifyResponse func(*http.Response) error
2017-02-07 21:33:23 +00:00
2017-11-22 17:20:03 +00:00
tlsClientConfig *tls.Config
log *log.Logger
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
const (
defaultFlushInterval = time.Duration(100) * time.Millisecond
StateConnected = iota
StateDisconnected
)
type UrlForwardingStateListener func(*url.URL, int)
2017-02-07 21:33:23 +00:00
// New creates an instance of Forwarder based on the provided list of configuration options
func New(setters ...optSetter) (*Forwarder, error) {
f := &Forwarder{
2017-11-22 17:20:03 +00:00
httpForwarder: &httpForwarder{log: log.StandardLogger()},
handlerContext: &handlerContext{},
2017-02-07 21:33:23 +00:00
}
for _, s := range setters {
if err := s(f); err != nil {
return nil, err
}
}
2017-11-22 17:20:03 +00:00
if !f.stream {
f.flushInterval = 0
} else if f.flushInterval == 0 {
f.flushInterval = defaultFlushInterval
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
2017-02-07 21:33:23 +00:00
if f.httpForwarder.rewriter == nil {
h, err := os.Hostname()
if err != nil {
h = "localhost"
}
f.httpForwarder.rewriter = &HeaderRewriter{TrustForwardHeader: true, Hostname: h}
}
2017-11-22 17:20:03 +00:00
if f.httpForwarder.roundTripper == nil {
f.httpForwarder.roundTripper = http.DefaultTransport
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
2017-02-07 21:33:23 +00:00
if f.errHandler == nil {
f.errHandler = utils.DefaultHandler
}
2017-11-22 17:20:03 +00:00
if f.tlsClientConfig == nil {
f.tlsClientConfig = f.httpForwarder.roundTripper.(*http.Transport).TLSClientConfig
}
f.httpForwarder.roundTripper = ErrorHandlingRoundTripper{
RoundTripper: f.httpForwarder.roundTripper,
errorHandler: f.errHandler,
}
2017-02-07 21:33:23 +00:00
return f, nil
}
// ServeHTTP decides which forwarder to use based on the specified
// request and delegates to the proper implementation
func (f *Forwarder) ServeHTTP(w http.ResponseWriter, req *http.Request) {
2017-11-22 17:20:03 +00:00
if f.log.Level >= log.DebugLevel {
logEntry := f.log.WithField("Request", utils.DumpHttpRequest(req))
logEntry.Debug("vulcand/oxy/forward: begin ServeHttp on request")
defer logEntry.Debug("vulcand/oxy/forward: competed ServeHttp on request")
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
if f.stateListener != nil {
f.stateListener(req.URL, StateConnected)
defer f.stateListener(req.URL, StateDisconnected)
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
if IsWebsocketRequest(req) {
f.httpForwarder.serveWebSocket(w, req, f.handlerContext)
} else {
f.httpForwarder.serveHTTP(w, req, f.handlerContext)
2017-06-29 14:41:44 +00:00
}
2017-11-22 17:20:03 +00:00
}
2017-06-29 14:41:44 +00:00
2017-11-22 17:20:03 +00:00
func (f *httpForwarder) getUrlFromRequest(req *http.Request) *url.URL {
// If the Request was created by Go via a real HTTP request, RequestURI will
// contain the original query string. If the Request was created in code, RequestURI
// will be empty, and we will use the URL object instead
u := req.URL
if req.RequestURI != "" {
parsedURL, err := url.ParseRequestURI(req.RequestURI)
2017-02-07 21:33:23 +00:00
if err == nil {
2017-11-22 17:20:03 +00:00
u = parsedURL
} else {
f.log.Warnf("vulcand/oxy/forward: error when parsing RequestURI: %s", err)
2017-02-07 21:33:23 +00:00
}
}
2017-11-22 17:20:03 +00:00
return u
}
2017-10-24 12:38:02 +00:00
2017-11-22 17:20:03 +00:00
// Modify the request to handle the target URL
func (f *httpForwarder) modifyRequest(outReq *http.Request, target *url.URL) {
outReq.URL = utils.CopyURL(outReq.URL)
outReq.URL.Scheme = target.Scheme
outReq.URL.Host = target.Host
2017-02-07 21:33:23 +00:00
2017-11-22 17:20:03 +00:00
u := f.getUrlFromRequest(outReq)
2017-02-07 21:33:23 +00:00
2017-11-22 17:20:03 +00:00
outReq.URL.Path = u.Path
outReq.URL.RawPath = u.RawPath
outReq.URL.RawQuery = u.RawQuery
outReq.RequestURI = "" // Outgoing request should not have RequestURI
2017-02-07 21:33:23 +00:00
// Do not pass client Host header unless optsetter PassHostHeader is set.
if !f.passHost {
2017-11-22 17:20:03 +00:00
outReq.Host = target.Host
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
2017-02-07 21:33:23 +00:00
outReq.Proto = "HTTP/1.1"
outReq.ProtoMajor = 1
outReq.ProtoMinor = 1
if f.rewriter != nil {
f.rewriter.Rewrite(outReq)
}
}
// serveHTTP forwards websocket traffic
2017-11-22 17:20:03 +00:00
func (f *httpForwarder) serveWebSocket(w http.ResponseWriter, req *http.Request, ctx *handlerContext) {
if f.log.Level >= log.DebugLevel {
logEntry := f.log.WithField("Request", utils.DumpHttpRequest(req))
logEntry.Debug("vulcand/oxy/forward/websocket: begin ServeHttp on request")
defer logEntry.Debug("vulcand/oxy/forward/websocket: competed ServeHttp on request")
}
outReq := f.copyWebSocketRequest(req)
2017-02-07 21:33:23 +00:00
dialer := websocket.DefaultDialer
2017-11-22 17:20:03 +00:00
if outReq.URL.Scheme == "wss" && f.tlsClientConfig != nil {
dialer.TLSClientConfig = f.tlsClientConfig.Clone()
// WebSocket is only in http/1.1
2017-10-20 15:38:04 +00:00
dialer.TLSClientConfig.NextProtos = []string{"http/1.1"}
2017-02-07 21:33:23 +00:00
}
targetConn, resp, err := dialer.Dial(outReq.URL.String(), outReq.Header)
2017-02-07 21:33:23 +00:00
if err != nil {
2017-09-29 19:04:03 +00:00
if resp == nil {
ctx.errHandler.ServeHTTP(w, req, err)
} else {
2017-11-22 17:20:03 +00:00
log.Errorf("vulcand/oxy/forward/websocket: Error dialing %q: %v with resp: %d %s", outReq.Host, err, resp.StatusCode, resp.Status)
2017-09-29 19:04:03 +00:00
hijacker, ok := w.(http.Hijacker)
if !ok {
2017-11-22 17:20:03 +00:00
log.Errorf("vulcand/oxy/forward/websocket: %s can not be hijack", reflect.TypeOf(w))
2017-09-29 19:04:03 +00:00
ctx.errHandler.ServeHTTP(w, req, err)
return
}
2017-11-22 17:20:03 +00:00
conn, _, errHijack := hijacker.Hijack()
if errHijack != nil {
log.Errorf("vulcand/oxy/forward/websocket: Failed to hijack responseWriter")
ctx.errHandler.ServeHTTP(w, req, errHijack)
2017-09-29 19:04:03 +00:00
return
}
defer conn.Close()
2017-11-22 17:20:03 +00:00
errWrite := resp.Write(conn)
if errWrite != nil {
log.Errorf("vulcand/oxy/forward/websocket: Failed to forward response")
ctx.errHandler.ServeHTTP(w, req, errWrite)
2017-09-29 19:04:03 +00:00
return
}
}
2017-02-07 21:33:23 +00:00
return
}
2017-11-22 17:20:03 +00:00
// Only the targetConn choose to CheckOrigin or not
upgrader := websocket.Upgrader{CheckOrigin: func(r *http.Request) bool {
return true
}}
utils.RemoveHeaders(resp.Header, WebsocketUpgradeHeaders...)
underlyingConn, err := upgrader.Upgrade(w, req, resp.Header)
2017-02-07 21:33:23 +00:00
if err != nil {
2017-11-22 17:20:03 +00:00
log.Errorf("vulcand/oxy/forward/websocket: Error while upgrading connection : %v", err)
2017-02-07 21:33:23 +00:00
return
}
defer underlyingConn.Close()
defer targetConn.Close()
errc := make(chan error, 2)
2017-11-22 17:20:03 +00:00
replicate := func(dst io.Writer, src io.Reader, dstName string, srcName string) {
_, errCopy := io.Copy(dst, src)
if errCopy != nil {
f.log.Errorf("vulcand/oxy/forward/websocket: Error when copying from %s to %s using io.Copy: %v", srcName, dstName, errCopy)
} else {
f.log.Infof("vulcand/oxy/forward/websocket: Copying from %s to %s using io.Copy completed without error.", srcName, dstName)
}
errc <- errCopy
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
go replicate(targetConn.UnderlyingConn(), underlyingConn.UnderlyingConn(), "backend", "client")
// Try to read the first message
2017-11-22 17:20:03 +00:00
msgType, msg, err := targetConn.ReadMessage()
if err != nil {
2017-11-22 17:20:03 +00:00
log.Errorf("vulcand/oxy/forward/websocket: Couldn't read first message : %v", err)
} else {
2017-11-22 17:20:03 +00:00
underlyingConn.WriteMessage(msgType, msg)
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
go replicate(underlyingConn.UnderlyingConn(), targetConn.UnderlyingConn(), "client", "backend")
<-errc
2017-02-07 21:33:23 +00:00
}
2017-11-22 17:20:03 +00:00
// copyWebsocketRequest makes a copy of the specified request.
func (f *httpForwarder) copyWebSocketRequest(req *http.Request) (outReq *http.Request) {
2017-02-07 21:33:23 +00:00
outReq = new(http.Request)
*outReq = *req // includes shallow copies of maps, but we handle this below
outReq.URL = utils.CopyURL(req.URL)
2017-11-22 17:20:03 +00:00
outReq.URL.Scheme = req.URL.Scheme
2017-11-22 17:20:03 +00:00
// sometimes backends might be registered as HTTP/HTTPS servers so translate URLs to websocket URLs.
switch req.URL.Scheme {
case "https":
outReq.URL.Scheme = "wss"
case "http":
outReq.URL.Scheme = "ws"
}
2017-11-22 17:20:03 +00:00
u := f.getUrlFromRequest(outReq)
outReq.URL.Path = u.Path
outReq.URL.RawPath = u.RawPath
outReq.URL.RawQuery = u.RawQuery
outReq.RequestURI = "" // Outgoing request should not have RequestURI
2017-08-20 17:02:02 +00:00
2017-11-22 17:20:03 +00:00
outReq.URL.Host = req.URL.Host
2017-02-07 21:33:23 +00:00
outReq.Header = make(http.Header)
2017-11-22 17:20:03 +00:00
// gorilla websocket use this header to set the request.Host tested in checkSameOrigin
outReq.Header.Set("Host", outReq.Host)
2017-02-07 21:33:23 +00:00
utils.CopyHeaders(outReq.Header, req.Header)
utils.RemoveHeaders(outReq.Header, WebsocketDialHeaders...)
2017-02-07 21:33:23 +00:00
if f.rewriter != nil {
f.rewriter.Rewrite(outReq)
}
return outReq
}
2017-11-22 17:20:03 +00:00
// serveHTTP forwards HTTP traffic using the configured transport
func (f *httpForwarder) serveHTTP(w http.ResponseWriter, inReq *http.Request, ctx *handlerContext) {
if f.log.Level >= log.DebugLevel {
logEntry := f.log.WithField("Request", utils.DumpHttpRequest(inReq))
logEntry.Debug("vulcand/oxy/forward/http: begin ServeHttp on request")
defer logEntry.Debug("vulcand/oxy/forward/http: completed ServeHttp on request")
}
pw := &utils.ProxyWriter{
W: w,
}
start := time.Now().UTC()
outReq := new(http.Request)
*outReq = *inReq // includes shallow copies of maps, but we handle this in Director
revproxy := httputil.ReverseProxy{
Director: func(req *http.Request) {
f.modifyRequest(req, inReq.URL)
},
Transport: f.roundTripper,
FlushInterval: f.flushInterval,
ModifyResponse: f.modifyResponse,
}
revproxy.ServeHTTP(pw, outReq)
if inReq.TLS != nil {
f.log.Infof("vulcand/oxy/forward/http: Round trip: %v, code: %v, Length: %v, duration: %v tls:version: %x, tls:resume:%t, tls:csuite:%x, tls:server:%v",
inReq.URL, pw.Code, pw.Length, time.Now().UTC().Sub(start),
inReq.TLS.Version,
inReq.TLS.DidResume,
inReq.TLS.CipherSuite,
inReq.TLS.ServerName)
} else {
f.log.Infof("vulcand/oxy/forward/http: Round trip: %v, code: %v, Length: %v, duration: %v",
inReq.URL, pw.Code, pw.Length, time.Now().UTC().Sub(start))
}
}
2017-02-07 21:33:23 +00:00
// isWebsocketRequest determines if the specified HTTP request is a
// websocket handshake request
2017-11-22 17:20:03 +00:00
func IsWebsocketRequest(req *http.Request) bool {
2017-02-07 21:33:23 +00:00
containsHeader := func(name, value string) bool {
items := strings.Split(req.Header.Get(name), ",")
for _, item := range items {
if value == strings.ToLower(strings.TrimSpace(item)) {
return true
}
}
return false
}
return containsHeader(Connection, "upgrade") && containsHeader(Upgrade, "websocket")
}