mirror of
https://github.com/livekit/livekit.git
synced 2026-08-21 18:49:44 +00:00
3c6e56232e
* Add configurable read-message size limit on signalling WebSockets Set a read limit on both the client-facing (/rtc) and agent worker WebSocket connections so an oversized frame is rejected by the transport before being buffered. The limits are operator-tunable via signal_message_size_limit and agent_signal_message_size_limit, both defaulting to 2 MiB (0 disables). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Add tests for signalling WebSocket read-message size limit Cover the configurable signal_message_size_limit added in the prior commit: - config: assert both limits default to 2 MiB and that a YAML override (including 0 to disable) is parsed correctly. - full-path integration: a real client connects to /rtc on a single-node server and an oversized frame is rejected by the transport with a 1009 close; a 0 limit leaves the connection unbounded and signalling proceeds. Adds setupSingleNodeTestWithConfig so a single-node server can be started with config overrides. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Bound decompressed size of signalling WebSocket messages conn.SetReadLimit only accounts for the compressed bytes read off the wire, and the client-facing /rtc upgrader negotiates permessage-deflate, so a small compressed frame could still expand into a much larger buffer once inflated. Enforce the same limit on the decompressed message by reading through NextReader + io.LimitReader in WSSignalConnection instead of the unbounded ReadMessage. The transport-level SetReadLimit is kept as the cheap wire-level guard; the new check is the decompressed-size backstop. Adds NextReader to the WebsocketClient interface (regenerated fake) and a unit test plus permessage-deflate integration tests covering the amplification case. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
75 lines
2.5 KiB
Go
75 lines
2.5 KiB
Go
// Copyright 2026 LiveKit, Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package service_test
|
|
|
|
import (
|
|
"bytes"
|
|
"testing"
|
|
|
|
"github.com/gorilla/websocket"
|
|
"github.com/stretchr/testify/require"
|
|
"google.golang.org/protobuf/proto"
|
|
|
|
"github.com/livekit/protocol/livekit"
|
|
|
|
"github.com/livekit/livekit-server/pkg/rtc/types/typesfakes"
|
|
"github.com/livekit/livekit-server/pkg/service"
|
|
)
|
|
|
|
// TestWSSignalConnectionMessageSizeLimit exercises the decompressed-size bound in
|
|
// WSSignalConnection. NextReader returns the (already decompressed) message
|
|
// stream, so a reader larger than the limit stands in for a small compressed
|
|
// frame that expands past the limit once inflated.
|
|
func TestWSSignalConnectionMessageSizeLimit(t *testing.T) {
|
|
const limit = 1024
|
|
|
|
t.Run("rejects message larger than limit", func(t *testing.T) {
|
|
fake := &typesfakes.FakeWebsocketClient{}
|
|
fake.NextReaderReturns(websocket.BinaryMessage, bytes.NewReader(make([]byte, limit+1)), nil)
|
|
|
|
c := service.NewWSSignalConnection(fake, limit)
|
|
_, _, err := c.ReadRequest()
|
|
require.Error(t, err)
|
|
require.Contains(t, err.Error(), "exceeds size limit")
|
|
})
|
|
|
|
t.Run("accepts message within limit", func(t *testing.T) {
|
|
payload, err := proto.Marshal(&livekit.SignalRequest{})
|
|
require.NoError(t, err)
|
|
require.LessOrEqual(t, len(payload), limit)
|
|
|
|
fake := &typesfakes.FakeWebsocketClient{}
|
|
fake.NextReaderReturns(websocket.BinaryMessage, bytes.NewReader(payload), nil)
|
|
|
|
c := service.NewWSSignalConnection(fake, limit)
|
|
msg, _, err := c.ReadRequest()
|
|
require.NoError(t, err)
|
|
require.NotNil(t, msg)
|
|
})
|
|
|
|
t.Run("limit of zero reads unbounded payload", func(t *testing.T) {
|
|
// a payload well beyond any typical limit is read in full when disabled
|
|
payload, err := proto.Marshal(&livekit.SignalRequest{})
|
|
require.NoError(t, err)
|
|
|
|
fake := &typesfakes.FakeWebsocketClient{}
|
|
fake.NextReaderReturns(websocket.BinaryMessage, bytes.NewReader(payload), nil)
|
|
|
|
c := service.NewWSSignalConnection(fake, 0)
|
|
_, _, err = c.ReadRequest()
|
|
require.NoError(t, err)
|
|
})
|
|
}
|