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")
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user