From 7bc719c87370e854ec8e77b34542cc6f0dbed71c Mon Sep 17 00:00:00 2001 From: Benjamin Boudreau Date: Tue, 6 Feb 2018 16:23:20 -0500 Subject: [PATCH 01/11] fixing packet loss --- websocketproxy.go | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/websocketproxy.go b/websocketproxy.go index e6fc4b0..5a47b3b 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -2,7 +2,6 @@ package websocketproxy import ( - "io" "log" "net" "net/http" @@ -162,13 +161,28 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { defer connPub.Close() errc := make(chan error, 2) - cp := func(dst io.Writer, src io.Reader) { - _, err := io.Copy(dst, src) + + replicateWebsocketConn := func(dst, src *websocket.Conn, dstName, srcName string) { + var err error + for { + msgType, msg, err := src.ReadMessage() + if err != nil { + log.Printf("websocketproxy: error when copying from %s to %s using ReadMessage: %v", srcName, dstName, err) + break + } + err = dst.WriteMessage(msgType, msg) + if err != nil { + log.Printf("websocketproxy: error when copying from %s to %s using WriteMessage: %v", srcName, dstName, err) + break + } else { + log.Printf("websocketproxy: copying from %s to %s completed without error.", srcName, dstName) + } + } errc <- err } - // Start our proxy now, everything is ready... - go cp(connBackend.UnderlyingConn(), connPub.UnderlyingConn()) - go cp(connPub.UnderlyingConn(), connBackend.UnderlyingConn()) + go replicateWebsocketConn(connPub, connBackend, "client", "backend") + go replicateWebsocketConn(connBackend, connPub, "backend", "client") + <-errc } From ab0a2866914de153c929102baea2cb71087d3ade Mon Sep 17 00:00:00 2001 From: Tong Jia Date: Tue, 20 Feb 2018 09:42:14 -0500 Subject: [PATCH 02/11] improved error handling --- websocketproxy.go | 38 ++++++++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/websocketproxy.go b/websocketproxy.go index 5a47b3b..88d17e1 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -2,6 +2,7 @@ package websocketproxy import ( + "fmt" "log" "net" "net/http" @@ -160,29 +161,42 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { } defer connPub.Close() - errc := make(chan error, 2) - - replicateWebsocketConn := func(dst, src *websocket.Conn, dstName, srcName string) { - var err error + errClient := make(chan error, 1) + errBackend := make(chan error, 1) + replicateWebsocketConn := func(dst, src *websocket.Conn, errc chan error) { for { msgType, msg, err := src.ReadMessage() if err != nil { - log.Printf("websocketproxy: error when copying from %s to %s using ReadMessage: %v", srcName, dstName, err) + m := websocket.FormatCloseMessage(websocket.CloseNormalClosure, fmt.Sprintf("%v", err)) + if e, ok := err.(*websocket.CloseError); ok { + if e.Code != websocket.CloseNoStatusReceived { + m = websocket.FormatCloseMessage(e.Code, e.Text) + } + } + errc <- err + dst.WriteMessage(websocket.CloseMessage, m) break } err = dst.WriteMessage(msgType, msg) if err != nil { - log.Printf("websocketproxy: error when copying from %s to %s using WriteMessage: %v", srcName, dstName, err) + errc <- err break - } else { - log.Printf("websocketproxy: copying from %s to %s completed without error.", srcName, dstName) } } - errc <- err } - go replicateWebsocketConn(connPub, connBackend, "client", "backend") - go replicateWebsocketConn(connBackend, connPub, "backend", "client") + go replicateWebsocketConn(connPub, connBackend, errClient) + go replicateWebsocketConn(connBackend, connPub, errBackend) + + var message string + select { + case err = <-errClient: + message = "websocketproxy: Error when copying from backend to client: %v" + case err = <-errBackend: + message = "websocketproxy: Error when copying from client to backend: %v" - <-errc + } + if e, ok := err.(*websocket.CloseError); !ok || e.Code == websocket.CloseAbnormalClosure { + log.Printf(message, err) + } } From e5d128f2186e3c393ff03b87e542e0a387a0f4be Mon Sep 17 00:00:00 2001 From: shengxiang Date: Wed, 28 Mar 2018 15:12:43 +0800 Subject: [PATCH 03/11] remove useless log --- websocketproxy.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/websocketproxy.go b/websocketproxy.go index 5a47b3b..df7b40d 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -174,8 +174,6 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { if err != nil { log.Printf("websocketproxy: error when copying from %s to %s using WriteMessage: %v", srcName, dstName, err) break - } else { - log.Printf("websocketproxy: copying from %s to %s completed without error.", srcName, dstName) } } errc <- err From 9a590806a0d0f3ede564aeca4963520744edae6f Mon Sep 17 00:00:00 2001 From: meghna Date: Fri, 22 Jun 2018 15:47:58 +0530 Subject: [PATCH 04/11] change code in README file Signed-off-by: meghna --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 71a144a..526bb43 100644 --- a/README.md +++ b/README.md @@ -32,12 +32,12 @@ var ( func main() { u, err := url.Parse(*flagBackend) if err != nil { - log.Fataln(err) + log.Fatalln(err) } - err := http.ListenAndServe(":80", websocketproxy.NewProxy(u)) + err = http.ListenAndServe(":80", websocketproxy.NewProxy(u)) if err != nil { - log.Fataln(err) + log.Fatalln(err) } } ``` From e3ee67fa94b525147e9fc7c47ea1f43bf67fcaf1 Mon Sep 17 00:00:00 2001 From: Josh Hawn Date: Thu, 17 May 2018 16:34:21 -0700 Subject: [PATCH 05/11] Copy response to client on failed handshake Docker-DCO-1.1-Signed-off-by: Josh Hawn (github: jlhawn) --- websocketproxy.go | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/websocketproxy.go b/websocketproxy.go index 88d17e1..29f5bda 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -3,6 +3,7 @@ package websocketproxy import ( "fmt" + "io" "log" "net" "net/http" @@ -133,7 +134,17 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { // http://tools.ietf.org/html/draft-ietf-hybi-websocket-multiplexing-01 connBackend, resp, err := dialer.Dial(backendURL.String(), requestHeader) if err != nil { - log.Printf("websocketproxy: couldn't dial to remote backend url %s\n", err) + log.Printf("websocketproxy: couldn't dial to remote backend url %s", err) + if resp != nil { + // If the WebSocket handshake fails, ErrBadHandshake is returned + // along with a non-nil *http.Response so that callers can handle + // redirects, authentication, etcetera. + if err := copyResponse(rw, resp); err != nil { + log.Printf("websocketproxy: couldn't write response after failed remote backend handshake: %s", err) + } + } else { + http.Error(rw, http.StatusText(http.StatusServiceUnavailable), http.StatusServiceUnavailable) + } return } defer connBackend.Close() @@ -156,7 +167,7 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { // Also pass the header that we gathered from the Dial handshake. connPub, err := upgrader.Upgrade(rw, req, upgradeHeader) if err != nil { - log.Printf("websocketproxy: couldn't upgrade %s\n", err) + log.Printf("websocketproxy: couldn't upgrade %s", err) return } defer connPub.Close() @@ -200,3 +211,20 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { log.Printf(message, err) } } + +func copyHeader(dst, src http.Header) { + for k, vv := range src { + for _, v := range vv { + dst.Add(k, v) + } + } +} + +func copyResponse(rw http.ResponseWriter, resp *http.Response) error { + copyHeader(rw.Header(), resp.Header) + rw.WriteHeader(resp.StatusCode) + defer resp.Body.Close() + + _, err := io.Copy(rw, resp.Body) + return err +} From 77f7dd9cfa72058b872a17ae44db693131de3739 Mon Sep 17 00:00:00 2001 From: will butler Date: Wed, 19 Dec 2018 13:24:06 -0800 Subject: [PATCH 06/11] Preserve host header --- websocketproxy.go | 3 +++ websocketproxy_test.go | 6 ++++++ 2 files changed, 9 insertions(+) diff --git a/websocketproxy.go b/websocketproxy.go index 29f5bda..7e4c7dc 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -97,6 +97,9 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { for _, cookie := range req.Header[http.CanonicalHeaderKey("Cookie")] { requestHeader.Add("Cookie", cookie) } + if host := req.Host; host != "" { + requestHeader.Set("Host", host) + } // Pass X-Forwarded-For headers too, code below is a part of // httputil.ReverseProxy. See http://en.wikipedia.org/wiki/X-Forwarded-For diff --git a/websocketproxy_test.go b/websocketproxy_test.go index 63f7861..defe389 100644 --- a/websocketproxy_test.go +++ b/websocketproxy_test.go @@ -45,6 +45,12 @@ func TestProxy(t *testing.T) { go func() { mux2 := http.NewServeMux() mux2.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { + // Don't upgrade if original host header isnt preserved + if r.Host != "127.0.0.1:7777" { + log.Printf("Host header set incorrectly. Expecting 127.0.0.1:7777 got %s", r.Host) + return + } + conn, err := upgrader.Upgrade(w, r, nil) if err != nil { log.Println(err) From 95a1a910758e8b9b21419b4cf0ab17c26d816466 Mon Sep 17 00:00:00 2001 From: will butler Date: Thu, 20 Dec 2018 13:27:04 -0800 Subject: [PATCH 07/11] making requested PR changes --- websocketproxy.go | 4 ++-- websocketproxy_test.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/websocketproxy.go b/websocketproxy.go index 7e4c7dc..63d39ba 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -97,8 +97,8 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { for _, cookie := range req.Header[http.CanonicalHeaderKey("Cookie")] { requestHeader.Add("Cookie", cookie) } - if host := req.Host; host != "" { - requestHeader.Set("Host", host) + if req.Host != "" { + requestHeader.Set("Host", req.Host) } // Pass X-Forwarded-For headers too, code below is a part of diff --git a/websocketproxy_test.go b/websocketproxy_test.go index defe389..b90e02b 100644 --- a/websocketproxy_test.go +++ b/websocketproxy_test.go @@ -45,7 +45,7 @@ func TestProxy(t *testing.T) { go func() { mux2 := http.NewServeMux() mux2.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { - // Don't upgrade if original host header isnt preserved + // Don't upgrade if original host header isn't preserved if r.Host != "127.0.0.1:7777" { log.Printf("Host header set incorrectly. Expecting 127.0.0.1:7777 got %s", r.Host) return From 28560a65ed538bf25fcc3d281f8dc6a45a7d0297 Mon Sep 17 00:00:00 2001 From: sudiptadeb Date: Mon, 30 Mar 2020 16:36:02 +0530 Subject: [PATCH 08/11] Added On-demand websocket proxy close. Useful when implementing authenticated proxy. Signed-off-by: sudipta.deb --- websocketproxy.go | 56 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 39 insertions(+), 17 deletions(-) diff --git a/websocketproxy.go b/websocketproxy.go index 63d39ba..b0f0f8a 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -45,6 +45,10 @@ type WebsocketProxy struct { // Dialer contains options for connecting to the backend WebSocket server. // If nil, DefaultDialer is used. Dialer *websocket.Dialer + + // Stop channels to close the websocket on demand + stopClientChan chan struct{} + stopBackendChan chan struct{} } // ProxyHandler returns a new http.Handler interface that reverse proxies the @@ -65,6 +69,12 @@ func NewProxy(target *url.URL) *WebsocketProxy { return &WebsocketProxy{Backend: backend} } +// Stop websocket proxy on demand +func (w *WebsocketProxy) CloseProxy() { + close(w.stopBackendChan) + close(w.stopClientChan) +} + // ServeHTTP implements the http.Handler that proxies WebSocket connections. func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { if w.Backend == nil { @@ -177,30 +187,42 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { errClient := make(chan error, 1) errBackend := make(chan error, 1) - replicateWebsocketConn := func(dst, src *websocket.Conn, errc chan error) { + replicateWebsocketConn := func(dst, src *websocket.Conn, errc chan error, stopChan chan struct{}) { for { - msgType, msg, err := src.ReadMessage() - if err != nil { - m := websocket.FormatCloseMessage(websocket.CloseNormalClosure, fmt.Sprintf("%v", err)) - if e, ok := err.(*websocket.CloseError); ok { - if e.Code != websocket.CloseNoStatusReceived { - m = websocket.FormatCloseMessage(e.Code, e.Text) + // do until stopChan gets any message + select { + default: + msgType, msg, err := src.ReadMessage() + if err != nil { + m := websocket.FormatCloseMessage(websocket.CloseNormalClosure, fmt.Sprintf("%v", err)) + if e, ok := err.(*websocket.CloseError); ok { + if e.Code != websocket.CloseNoStatusReceived { + m = websocket.FormatCloseMessage(e.Code, e.Text) + } } + errc <- err + dst.WriteMessage(websocket.CloseMessage, m) + break } - errc <- err - dst.WriteMessage(websocket.CloseMessage, m) - break - } - err = dst.WriteMessage(msgType, msg) - if err != nil { - errc <- err - break + err = dst.WriteMessage(msgType, msg) + if err != nil { + errc <- err + break + } + case <-stopChan: + dst.WriteMessage(websocket.CloseMessage, []byte("Closed by proxy")) + return } + } } - go replicateWebsocketConn(connPub, connBackend, errClient) - go replicateWebsocketConn(connBackend, connPub, errBackend) + // initiate the stop channels + w.stopClientChan = make(chan struct{}) + w.stopBackendChan = make(chan struct{}) + + go replicateWebsocketConn(connPub, connBackend, errClient, w.stopClientChan) + go replicateWebsocketConn(connBackend, connPub, errBackend, w.stopBackendChan) var message string select { From ddd4166d4b61702c8fc3d657261dca357e1e02ff Mon Sep 17 00:00:00 2001 From: Sudipta Deb Date: Mon, 30 Mar 2020 16:51:01 +0530 Subject: [PATCH 09/11] Renaming links in readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 526bb43..83cf081 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# WebsocketProxy [![GoDoc](https://godoc.org/github.com/koding/websocketproxy?status.svg)](https://godoc.org/github.com/koding/websocketproxy) [![Build Status](https://travis-ci.org/koding/websocketproxy.svg)](https://travis-ci.org/koding/websocketproxy) +# WebsocketProxy [![GoDoc](https://godoc.org/github.com/sudiptadeb/websocketproxy?status.svg)](https://godoc.org/github.com/sudiptadeb/websocketproxy) [![Build Status](https://travis-ci.org/sudiptadeb/websocketproxy.svg)](https://travis-ci.org/sudiptadeb/websocketproxy) WebsocketProxy is an http.Handler interface build on top of [gorilla/websocket](https://github.com/gorilla/websocket) that you can plug @@ -7,7 +7,7 @@ into your existing Go webserver to provide WebSocket reverse proxy. ## Install ```bash -go get github.com/koding/websocketproxy +go get github.com/sudiptadeb/websocketproxy ``` ## Example @@ -22,7 +22,7 @@ import ( "net/http" "net/url" - "github.com/koding/websocketproxy" + "github.com/sudiptadeb/websocketproxy" ) var ( From 4a0099951af593fce19d2514ba74f1cd84f23287 Mon Sep 17 00:00:00 2001 From: sudiptadeb Date: Fri, 15 May 2020 19:24:33 +0530 Subject: [PATCH 10/11] Forwarding headers --- websocketproxy.go | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/websocketproxy.go b/websocketproxy.go index b0f0f8a..0677ab3 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -167,14 +167,14 @@ func (w *WebsocketProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) { upgrader = DefaultUpgrader } - // Only pass those headers to the upgrader. + // passing all headers except those which can become duplicate upgradeHeader := http.Header{} - if hdr := resp.Header.Get("Sec-Websocket-Protocol"); hdr != "" { - upgradeHeader.Set("Sec-Websocket-Protocol", hdr) - } - if hdr := resp.Header.Get("Set-Cookie"); hdr != "" { - upgradeHeader.Set("Set-Cookie", hdr) - } + copyHeader(upgradeHeader, resp.Header) + + // These are extra header which the upgrader actually sets itself so need to remove these to avoid duplicate headers + upgradeHeader.Del("Connection") + upgradeHeader.Del("Upgrade") + upgradeHeader.Del("Sec-WebSocket-Accept") // Now upgrade the existing incoming request to a WebSocket connection. // Also pass the header that we gathered from the Dial handshake. From 2ae2f8662cc6ffab65771f6430d838028ea7428a Mon Sep 17 00:00:00 2001 From: "goutham.r" Date: Wed, 16 Aug 2023 12:39:09 +0530 Subject: [PATCH 11/11] [FIX] Handle nil channel when closing WebSocketProxy --- websocketproxy.go | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/websocketproxy.go b/websocketproxy.go index 0677ab3..28cf7c3 100644 --- a/websocketproxy.go +++ b/websocketproxy.go @@ -2,6 +2,7 @@ package websocketproxy import ( + "errors" "fmt" "io" "log" @@ -23,6 +24,8 @@ var ( // DefaultDialer is a dialer with all fields set to the default zero values. DefaultDialer = websocket.DefaultDialer + + errNilChannelClose = errors.New("trying to close nil channel") ) // WebsocketProxy is an HTTP Handler that takes an incoming WebSocket @@ -70,9 +73,19 @@ func NewProxy(target *url.URL) *WebsocketProxy { } // Stop websocket proxy on demand -func (w *WebsocketProxy) CloseProxy() { - close(w.stopBackendChan) - close(w.stopClientChan) +func (w *WebsocketProxy) CloseProxy() (err error) { + err = nil + if w.stopBackendChan != nil { + close(w.stopBackendChan) + } else { + err = errNilChannelClose + } + if w.stopClientChan != nil { + close(w.stopClientChan) + } else { + err = errNilChannelClose + } + return err } // ServeHTTP implements the http.Handler that proxies WebSocket connections.