fix(transport): align WebSocket read limits with agent protocol
This commit is contained in:
1 parent
ef6e65e6f1
commit
6984a09486
11 files changed
+376
-4
No files matched your search
@@ -3,9 +3,12 @@ package agent
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"math"
|
||||
"net/http"
|
||||
|
||||
"github.com/coder/websocket"
|
||||
"github.com/rvbox/rvbox/internal/agentproto"
|
||||
)
|
||||
|
||||
var ErrUnexpectedMessage = errors.New("agent transport received a non-binary WebSocket message")
|
||||
@@ -13,10 +16,25 @@ var ErrUnexpectedMessage = errors.New("agent transport received a non-binary Web
|
||||
type WebSocketTransport struct{ connection *websocket.Conn }
|
||||
|
||||
func DialWebSocket(ctx context.Context, address string, client *http.Client) (*WebSocketTransport, error) {
|
||||
return DialWebSocketWithLimits(ctx, address, client, agentproto.DefaultLimits())
|
||||
}
|
||||
|
||||
// DialWebSocketWithLimits applies the same message ceiling as envelope
|
||||
// validation. The library's 32 KiB default is smaller than ordinary RVBox
|
||||
// chunks, dispatches, and reconciliation history.
|
||||
func DialWebSocketWithLimits(ctx context.Context, address string, client *http.Client, limits agentproto.Limits) (*WebSocketTransport, error) {
|
||||
readLimit := limits.MaxEnvelopeBytes
|
||||
if readLimit == 0 {
|
||||
readLimit = agentproto.DefaultLimits().MaxEnvelopeBytes
|
||||
}
|
||||
if readLimit > math.MaxInt64-1 {
|
||||
return nil, fmt.Errorf("invalid WebSocket envelope limit: %d", readLimit)
|
||||
}
|
||||
connection, _, err := websocket.Dial(ctx, address, &websocket.DialOptions{HTTPClient: client, CompressionMode: websocket.CompressionDisabled})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
connection.SetReadLimit(int64(readLimit))
|
||||
return &WebSocketTransport{connection: connection}, nil
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"math"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/coder/websocket"
|
||||
"github.com/rvbox/rvbox/internal/agentproto"
|
||||
)
|
||||
|
||||
func TestWebSocketConfiguredReadCeiling_BH_WS_01(t *testing.T) {
|
||||
t.Parallel()
|
||||
for _, scenario := range []struct {
|
||||
name string
|
||||
limit uint64
|
||||
bytes int
|
||||
wantLarge bool
|
||||
}{
|
||||
{name: "above library default", bytes: (32 << 10) + 1},
|
||||
{name: "exact default ceiling", bytes: 1 << 20},
|
||||
{name: "over default ceiling", bytes: (1 << 20) + 1, wantLarge: true},
|
||||
{name: "exact configured ceiling", limit: 2048, bytes: 2048},
|
||||
{name: "over configured ceiling", limit: 2048, bytes: 2049, wantLarge: true},
|
||||
} {
|
||||
t.Run(scenario.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||
defer cancel()
|
||||
payload := bytes.Repeat([]byte{0x51}, scenario.bytes)
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
connection, err := websocket.Accept(w, r, nil)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
defer connection.CloseNow()
|
||||
if err := connection.Write(ctx, websocket.MessageBinary, payload); err != nil {
|
||||
return
|
||||
}
|
||||
_, _, _ = connection.Read(ctx) // Complete the peer's close handshake.
|
||||
}))
|
||||
defer server.Close()
|
||||
transport, err := DialWebSocketWithLimits(ctx, "ws"+strings.TrimPrefix(server.URL, "http"), nil,
|
||||
agentproto.Limits{MaxEnvelopeBytes: scenario.limit})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer transport.Close()
|
||||
got, err := transport.Read(ctx)
|
||||
if scenario.wantLarge {
|
||||
if !errors.Is(err, websocket.ErrMessageTooBig) {
|
||||
t.Fatalf("oversize read = %v", err)
|
||||
}
|
||||
} else if err != nil || !bytes.Equal(got, payload) {
|
||||
t.Fatalf("read bytes=%d error=%v", len(got), err)
|
||||
}
|
||||
})
|
||||
}
|
||||
if _, err := DialWebSocketWithLimits(context.Background(), "invalid", nil, agentproto.Limits{MaxEnvelopeBytes: math.MaxUint64}); err == nil {
|
||||
t.Fatal("overflowing read ceiling accepted")
|
||||
}
|
||||
}
|
||||
@@ -7,6 +7,7 @@ import (
|
||||
"encoding/base64"
|
||||
"errors"
|
||||
"fmt"
|
||||
"math"
|
||||
"net/http"
|
||||
"sort"
|
||||
"sync"
|
||||
@@ -49,6 +50,8 @@ type AgentServer struct {
|
||||
// Metrics is optional so transport tests and embeddings do not need an
|
||||
// observability endpoint. Every emitted name is a static bounded value.
|
||||
Metrics *observability.Health
|
||||
// Logf receives bounded transport diagnostics without command payloads.
|
||||
Logf func(string, ...any)
|
||||
}
|
||||
|
||||
func (server *AgentServer) ServeHTTP(response http.ResponseWriter, request *http.Request) {
|
||||
@@ -69,6 +72,10 @@ func (server *AgentServer) ServeHTTP(response http.ResponseWriter, request *http
|
||||
http.Error(response, "agent session registry is unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
if server.limits().MaxEnvelopeBytes > math.MaxInt64-1 {
|
||||
http.Error(response, "invalid agent envelope limit", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
started := time.Now()
|
||||
heartbeat := newSynchronizedHeartbeat(server.heartbeatIdle(), server.livenessTimeout(), 0)
|
||||
connection, err := websocket.Accept(response, request, &websocket.AcceptOptions{
|
||||
@@ -88,6 +95,7 @@ func (server *AgentServer) ServeHTTP(response http.ResponseWriter, request *http
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
connection.SetReadLimit(int64(server.limits().MaxEnvelopeBytes))
|
||||
server.incMetric("agent_connection")
|
||||
defer connection.CloseNow()
|
||||
server.serveConnection(request.Context(), connection, heartbeat, started)
|
||||
@@ -96,6 +104,10 @@ func (server *AgentServer) ServeHTTP(response http.ResponseWriter, request *http
|
||||
func (server *AgentServer) serveConnection(parent context.Context, connection *websocket.Conn, heartbeat *synchronizedHeartbeat, started time.Time) {
|
||||
messageType, payload, err := connection.Read(parent)
|
||||
if err != nil {
|
||||
if errors.Is(err, websocket.ErrMessageTooBig) {
|
||||
server.incMetric("agent_message_too_big")
|
||||
}
|
||||
server.logSessionError("", 0, "hello-read", err)
|
||||
return
|
||||
}
|
||||
if messageType != websocket.MessageBinary {
|
||||
@@ -143,6 +155,7 @@ func (server *AgentServer) serveConnection(parent context.Context, connection *w
|
||||
})
|
||||
server.observeMetric("sqlite_write_latency", time.Since(registrationStarted))
|
||||
if err != nil {
|
||||
server.logSessionError(hello.GetClientId(), 0, "register", err)
|
||||
server.incMetric("client_registration_failure")
|
||||
if errors.Is(err, store.ErrTakeoverRequired) {
|
||||
server.incMetric("client_takeover_required")
|
||||
@@ -242,6 +255,10 @@ func (server *AgentServer) serveConnection(parent context.Context, connection *w
|
||||
for {
|
||||
messageType, payload, err = connection.Read(sessionContext)
|
||||
if err != nil {
|
||||
if errors.Is(err, websocket.ErrMessageTooBig) {
|
||||
server.incMetric("agent_message_too_big")
|
||||
}
|
||||
server.logSessionError(hello.GetClientId(), registration.Generation, "read", err)
|
||||
return
|
||||
}
|
||||
// Elapsed time is monotonic; peer-provided wall timestamps are never used
|
||||
@@ -267,6 +284,7 @@ func (server *AgentServer) serveConnection(parent context.Context, connection *w
|
||||
if snapshot := envelope.GetReconcileSnapshot(); snapshot != nil {
|
||||
result, reconcileErr := server.Store.ReconcileClientSnapshotForSessionAt(sessionContext, hello.GetClientId(), registration.Generation, snapshot, reconcileBoundary)
|
||||
if reconcileErr != nil {
|
||||
server.logSessionError(hello.GetClientId(), registration.Generation, "reconcile", reconcileErr)
|
||||
server.close(connection, websocket.StatusPolicyViolation, "reconciliation failed")
|
||||
return
|
||||
}
|
||||
@@ -348,6 +366,7 @@ func (server *AgentServer) serveConnection(parent context.Context, connection *w
|
||||
appended, eventErr := server.Store.AppendCommandEvent(sessionContext, appendEvent)
|
||||
if eventErr != nil {
|
||||
server.incMetric("command_event_rejected")
|
||||
server.logSessionError(hello.GetClientId(), registration.Generation, "command-event", eventErr)
|
||||
server.close(connection, websocket.StatusPolicyViolation, "command event was not accepted")
|
||||
return
|
||||
}
|
||||
@@ -810,6 +829,17 @@ func (server *AgentServer) close(connection *websocket.Conn, status websocket.St
|
||||
_ = connection.Close(status, reason)
|
||||
}
|
||||
|
||||
func (server *AgentServer) logSessionError(clientID string, generation uint64, stage string, err error) {
|
||||
if server.Logf == nil || err == nil {
|
||||
return
|
||||
}
|
||||
detail := err.Error()
|
||||
if len(detail) > 1024 {
|
||||
detail = detail[:1024] + "..."
|
||||
}
|
||||
server.Logf("agent session client=%q generation=%d stage=%s error=%q", clientID, generation, stage, detail)
|
||||
}
|
||||
|
||||
func (server *AgentServer) agentPath() string {
|
||||
if server.Path == "" {
|
||||
return defaultAgentPath
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
@@ -225,6 +226,37 @@ func TestAgentServerRejectsHostileWireInputs_BH_SES_04(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestAgentServerEnforcesConfiguredReadCeiling_BH_WS_02(t *testing.T) {
|
||||
t.Parallel()
|
||||
server, edge, cleanup := newTestAgentServerWithStore(t)
|
||||
defer cleanup()
|
||||
edge.Limits = agentproto.DefaultLimits()
|
||||
edge.Limits.MaxEnvelopeBytes = 2048
|
||||
logs := make(chan string, 1)
|
||||
edge.Logf = func(format string, args ...any) { logs <- fmt.Sprintf(format, args...) }
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||||
defer cancel()
|
||||
connection, _, err := websocket.Dial(ctx, websocketURL(server.URL), nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer connection.CloseNow()
|
||||
if err := connection.Write(ctx, websocket.MessageBinary, bytes.Repeat([]byte{0x51}, 2049)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, _, err := connection.Read(ctx); websocket.CloseStatus(err) != websocket.StatusMessageTooBig {
|
||||
t.Fatalf("oversize close = %v", err)
|
||||
}
|
||||
select {
|
||||
case diagnostic := <-logs:
|
||||
if !strings.Contains(diagnostic, "stage=hello-read") || !strings.Contains(diagnostic, "2049") {
|
||||
t.Fatalf("missing bounded transport diagnostic: %s", diagnostic)
|
||||
}
|
||||
case <-ctx.Done():
|
||||
t.Fatal("oversize failure was not logged")
|
||||
}
|
||||
}
|
||||
|
||||
func TestWireEventAppendCarriesClientBinding_HP_EVENT_01(t *testing.T) {
|
||||
event := &rvboxv1.CommandEvent{IssueUuid: "019c46f1-1d02-7000-8000-000000000096", EventSeq: 1, ObservedAt: timestamppb.Now(), Payload: &rvboxv1.CommandEvent_Lifecycle{Lifecycle: &rvboxv1.LifecycleChange{Lifecycle: rvboxv1.CommandLifecycle_COMMAND_RUNNING, CommandRevision: 1}}}
|
||||
digest, err := agentproto.CommandEventDigest(event)
|
||||
|
||||
Reference in new issue
Block a user