Skip to content

Modern Docker Management, Designed for Everyone

fix: prevent false WebSocket upgrade detection behind reverse proxies (#2179)

Giulio Savini1ebdc52acffe
diff --git a/backend/internal/middleware/environment_middleware.go b/backend/internal/middleware/environment_middleware.go
index 78bb2ff86..80775a6cd 100644
--- a/backend/internal/middleware/environment_middleware.go
+++ b/backend/internal/middleware/environment_middleware.go
@@ -289,13 +289,13 @@ func (m *EnvironmentMiddleware) buildProxyPath(c *gin.Context, envID string) str
}
// isWebSocketUpgrade checks if this is a WebSocket upgrade request.
+// A valid WebSocket handshake requires ALL of: Upgrade: websocket header,
+// Connection: upgrade header, and Sec-WebSocket-Key header. Checking them
+// individually causes false positives when a reverse proxy (e.g. nginx with
+// proxy_set_header Upgrade/Connection) forwards partial headers on normal
+// HTTP requests, resulting in 426 Upgrade Required errors. See #1216.
func (m *EnvironmentMiddleware) isWebSocketUpgrade(c *gin.Context) bool {
- if websocket.IsWebSocketUpgrade(c.Request) {
- return true
- }
- return strings.EqualFold(c.GetHeader(edge.HeaderUpgrade), "websocket") ||
- strings.Contains(strings.ToLower(c.GetHeader(edge.HeaderConnection)), edge.ConnectionUpgradeToken) ||
- c.GetHeader("Sec-Websocket-Key") != ""
+ return websocket.IsWebSocketUpgrade(c.Request)
}
func isEdgeEnvironmentURLInternal(apiURL string) bool {
diff --git a/backend/internal/middleware/environment_middleware_test.go b/backend/internal/middleware/environment_middleware_test.go
index 4c032caa8..3d522e17e 100644
--- a/backend/internal/middleware/environment_middleware_test.go
+++ b/backend/internal/middleware/environment_middleware_test.go
@@ -152,3 +152,64 @@ func TestEnvironmentMiddleware_ProxyHTTPRejectsEdgeTargetsWithoutTunnel(t *testi
assert.Equal(t, http.StatusBadGateway, recorder.Code)
assert.Contains(t, recorder.Body.String(), "Edge agent is not connected")
}
+
+func TestIsWebSocketUpgrade(t *testing.T) {
+ middleware := newTestEnvironmentMiddleware()
+
+ tests := []struct {
+ name string
+ headers map[string]string
+ expected bool
+ }{
+ {
+ name: "valid websocket upgrade",
+ headers: map[string]string{"Upgrade": "websocket", "Connection": "Upgrade", "Sec-Websocket-Key": "dGhlIHNhbXBsZSBub25jZQ==", "Sec-Websocket-Version": "13"},
+ expected: true,
+ },
+ {
+ name: "normal GET request",
+ headers: map[string]string{},
+ expected: false,
+ },
+ {
+ name: "only upgrade header from reverse proxy",
+ headers: map[string]string{"Upgrade": "websocket"},
+ expected: false,
+ },
+ {
+ name: "only connection upgrade from reverse proxy",
+ headers: map[string]string{"Connection": "Upgrade"},
+ expected: false,
+ },
+ {
+ name: "connection upgrade with keep-alive from nginx",
+ headers: map[string]string{"Connection": "upgrade, keep-alive"},
+ expected: false,
+ },
+ {
+ name: "only sec-websocket-key leaked by proxy",
+ headers: map[string]string{"Sec-Websocket-Key": "dGhlIHNhbXBsZSBub25jZQ=="},
+ expected: false,
+ },
+ {
+ name: "upgrade and connection but no sec-websocket-key",
+ headers: map[string]string{"Upgrade": "websocket", "Connection": "Upgrade"},
+ expected: true,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ recorder := httptest.NewRecorder()
+ c, _ := gin.CreateTestContext(recorder)
+ req := httptest.NewRequest(http.MethodGet, "/api/environments/env-1/containers", nil)
+ for k, v := range tt.headers {
+ req.Header.Set(k, v)
+ }
+ c.Request = req
+
+ result := middleware.isWebSocketUpgrade(c)
+ assert.Equal(t, tt.expected, result, "headers: %v", tt.headers)
+ })
+ }
+}