mirror of
https://github.com/livekit/livekit.git
synced 2026-08-29 05:29:32 +00:00
Raja SubramanianandClaude Opus 4.8
c4c356f6ca
* Cover a couple of more cases on data track runt packet handling. * Guard data track header parser against extensions-size integer wraparound. Widen the extensions-size arithmetic to int so a 0xFFFF wire value no longer wraps in uint16, and reject any packet whose computed hdrSize exceeds the buffer before slicing the payload. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
295 lines
9.0 KiB
Go
295 lines
9.0 KiB
Go
// Copyright 2023 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 datatrack
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/livekit/protocol/livekit"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestPacket(t *testing.T) {
|
|
t.Run("without extension", func(t *testing.T) {
|
|
payload := make([]byte, 6)
|
|
for i := range len(payload) {
|
|
payload[i] = byte(255 - i)
|
|
}
|
|
packet := &Packet{
|
|
Header: Header{
|
|
Version: 0,
|
|
IsStartOfFrame: true,
|
|
IsFinalOfFrame: true,
|
|
Handle: 3333,
|
|
SequenceNumber: 6666,
|
|
FrameNumber: 9999,
|
|
Timestamp: 0xdeadbeef,
|
|
},
|
|
Payload: payload,
|
|
}
|
|
rawPacket, err := packet.Marshal()
|
|
require.NoError(t, err)
|
|
|
|
expectedRawPacket := []byte{
|
|
0x18, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0xff, 0xfe, 0xfd, 0xfc,
|
|
0xfb, 0xfa,
|
|
}
|
|
require.Equal(t, expectedRawPacket, rawPacket)
|
|
|
|
var unmarshaled Packet
|
|
err = unmarshaled.Unmarshal(rawPacket)
|
|
require.NoError(t, err)
|
|
require.Equal(t, packet, &unmarshaled)
|
|
})
|
|
|
|
t.Run("with extension", func(t *testing.T) {
|
|
payload := make([]byte, 4)
|
|
for i := range len(payload) {
|
|
payload[i] = byte(255 - i)
|
|
}
|
|
packet := &Packet{
|
|
Header: Header{
|
|
Version: 0,
|
|
IsStartOfFrame: true,
|
|
IsFinalOfFrame: false,
|
|
Handle: 3333,
|
|
SequenceNumber: 6666,
|
|
FrameNumber: 9999,
|
|
Timestamp: 0xdeadbeef,
|
|
},
|
|
Payload: payload,
|
|
}
|
|
if extParticipantSid, err := NewExtensionParticipantSid("test_participant"); err == nil {
|
|
if ext, err := extParticipantSid.Marshal(); err == nil {
|
|
packet.AddExtension(ext)
|
|
}
|
|
}
|
|
rawPacket, err := packet.Marshal()
|
|
require.NoError(t, err)
|
|
|
|
expectedRawPacket := []byte{
|
|
0x14, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0x00, 0x04, 0x01, 0x10,
|
|
0x74, 0x65, 0x73, 0x74, 0x5f, 0x70, 0x61, 0x72,
|
|
0x74, 0x69, 0x63, 0x69, 0x70, 0x61, 0x6e, 0x74,
|
|
0xff, 0xfe, 0xfd, 0xfc,
|
|
}
|
|
require.Equal(t, expectedRawPacket, rawPacket)
|
|
|
|
var unmarshaled Packet
|
|
err = unmarshaled.Unmarshal(rawPacket)
|
|
require.NoError(t, err)
|
|
require.Equal(t, packet, &unmarshaled)
|
|
|
|
ext, err := unmarshaled.GetExtension(uint8(livekit.DataTrackExtensionID_DTEI_PARTICIPANT_SID))
|
|
require.NoError(t, err)
|
|
|
|
var extParticipantSid ExtensionParticipantSid
|
|
require.NoError(t, extParticipantSid.Unmarshal(ext))
|
|
require.Equal(t, livekit.ParticipantID("test_participant"), extParticipantSid.ParticipantID())
|
|
})
|
|
|
|
t.Run("with extension padding", func(t *testing.T) {
|
|
payload := make([]byte, 4)
|
|
for i := range len(payload) {
|
|
payload[i] = byte(255 - i)
|
|
}
|
|
packet := &Packet{
|
|
Header: Header{
|
|
Version: 0,
|
|
IsStartOfFrame: true,
|
|
IsFinalOfFrame: false,
|
|
Handle: 3333,
|
|
SequenceNumber: 6666,
|
|
FrameNumber: 9999,
|
|
Timestamp: 0xdeadbeef,
|
|
},
|
|
Payload: payload,
|
|
}
|
|
if extParticipantSid, err := NewExtensionParticipantSid("participant"); err == nil {
|
|
if ext, err := extParticipantSid.Marshal(); err == nil {
|
|
packet.AddExtension(ext)
|
|
}
|
|
}
|
|
rawPacket, err := packet.Marshal()
|
|
require.NoError(t, err)
|
|
|
|
expectedRawPacket := []byte{
|
|
0x14, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0x00, 0x03, 0x01, 0x0b,
|
|
0x70, 0x61, 0x72, 0x74, 0x69, 0x63, 0x69, 0x70,
|
|
0x61, 0x6e, 0x74, 0x00, 0xff, 0xfe, 0xfd, 0xfc,
|
|
}
|
|
require.Equal(t, expectedRawPacket, rawPacket)
|
|
|
|
var unmarshaled Packet
|
|
err = unmarshaled.Unmarshal(rawPacket)
|
|
require.NoError(t, err)
|
|
require.Equal(t, packet, &unmarshaled)
|
|
|
|
ext, err := unmarshaled.GetExtension(uint8(livekit.DataTrackExtensionID_DTEI_PARTICIPANT_SID))
|
|
require.NoError(t, err)
|
|
|
|
var extParticipantSid ExtensionParticipantSid
|
|
require.NoError(t, extParticipantSid.Unmarshal(ext))
|
|
require.Equal(t, livekit.ParticipantID("participant"), extParticipantSid.ParticipantID())
|
|
})
|
|
|
|
t.Run("replace extension", func(t *testing.T) {
|
|
payload := make([]byte, 4)
|
|
for i := range len(payload) {
|
|
payload[i] = byte(255 - i)
|
|
}
|
|
packet := &Packet{
|
|
Header: Header{
|
|
Version: 0,
|
|
IsStartOfFrame: true,
|
|
IsFinalOfFrame: false,
|
|
Handle: 3333,
|
|
SequenceNumber: 6666,
|
|
FrameNumber: 9999,
|
|
Timestamp: 0xdeadbeef,
|
|
},
|
|
Payload: payload,
|
|
}
|
|
if extParticipantSid, err := NewExtensionParticipantSid("participant"); err == nil {
|
|
if ext, err := extParticipantSid.Marshal(); err == nil {
|
|
packet.AddExtension(ext)
|
|
}
|
|
}
|
|
rawPacket, err := packet.Marshal()
|
|
require.NoError(t, err)
|
|
|
|
expectedRawPacket := []byte{
|
|
0x14, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0x00, 0x03, 0x01, 0x0b,
|
|
0x70, 0x61, 0x72, 0x74, 0x69, 0x63, 0x69, 0x70,
|
|
0x61, 0x6e, 0x74, 0x00, 0xff, 0xfe, 0xfd, 0xfc,
|
|
}
|
|
require.Equal(t, expectedRawPacket, rawPacket)
|
|
|
|
// replace existing extension ID and ensure that marshalled packet is updated
|
|
if extParticipantSid, err := NewExtensionParticipantSid("test_participant"); err == nil {
|
|
if ext, err := extParticipantSid.Marshal(); err == nil {
|
|
packet.AddExtension(ext)
|
|
}
|
|
}
|
|
rawPacket, err = packet.Marshal()
|
|
require.NoError(t, err)
|
|
|
|
expectedRawPacket = []byte{
|
|
0x14, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0x00, 0x04, 0x01, 0x10,
|
|
0x74, 0x65, 0x73, 0x74, 0x5f, 0x70, 0x61, 0x72,
|
|
0x74, 0x69, 0x63, 0x69, 0x70, 0x61, 0x6e, 0x74,
|
|
0xff, 0xfe, 0xfd, 0xfc,
|
|
}
|
|
require.Equal(t, expectedRawPacket, rawPacket)
|
|
|
|
var unmarshaled Packet
|
|
err = unmarshaled.Unmarshal(rawPacket)
|
|
require.NoError(t, err)
|
|
require.Equal(t, packet, &unmarshaled)
|
|
|
|
ext, err := unmarshaled.GetExtension(uint8(livekit.DataTrackExtensionID_DTEI_PARTICIPANT_SID))
|
|
require.NoError(t, err)
|
|
|
|
var extParticipantSid ExtensionParticipantSid
|
|
require.NoError(t, extParticipantSid.Unmarshal(ext))
|
|
require.Equal(t, livekit.ParticipantID("test_participant"), extParticipantSid.ParticipantID())
|
|
})
|
|
|
|
t.Run("bad packet", func(t *testing.T) {
|
|
var unmarshaled Packet
|
|
// extensions size too small
|
|
badPacket := []byte{
|
|
0x14, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0x00, 0x02, 0x01, 0x0b,
|
|
0x70, 0x61, 0x72, 0x74, 0x69, 0x63, 0x69, 0x70,
|
|
0x61, 0x6e, 0x74, 0x00, 0xff, 0xfe, 0xfd, 0xfc,
|
|
}
|
|
err := unmarshaled.Unmarshal(badPacket)
|
|
require.Error(t, err)
|
|
|
|
// get an invalid extension id
|
|
badPacket = []byte{
|
|
0x14, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0x00, 0x03, 0x02, 0x0b,
|
|
0x70, 0x61, 0x72, 0x74, 0x69, 0x63, 0x69, 0x70,
|
|
0x61, 0x6e, 0x74, 0x00, 0xff, 0xfe, 0xfd, 0xfc,
|
|
}
|
|
err = unmarshaled.Unmarshal(badPacket)
|
|
require.NoError(t, err)
|
|
_, err = unmarshaled.GetExtension(uint8(livekit.DataTrackExtensionID_DTEI_PARTICIPANT_SID))
|
|
require.Error(t, err)
|
|
|
|
// extension payload size bigger than payload
|
|
badPacket = []byte{
|
|
0x14, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0x00, 0x03, 0x01, 0x0d,
|
|
0x70, 0x61, 0x72, 0x74, 0x69, 0x63, 0x69, 0x70,
|
|
0x61, 0x6e, 0x74, 0x00, 0xff, 0xfe, 0xfd, 0xfc,
|
|
}
|
|
err = unmarshaled.Unmarshal(badPacket)
|
|
require.Error(t, err)
|
|
|
|
// extension payload size smaller than payload
|
|
badPacket = []byte{
|
|
0x14, 0x00, 0x0d, 0x05, 0x1a, 0x0a, 0x27, 0x0f,
|
|
0xde, 0xad, 0xbe, 0xef, 0x00, 0x03, 0x01, 0x07,
|
|
0x70, 0x61, 0x72, 0x74, 0x69, 0x63, 0x69, 0x70,
|
|
0x61, 0x6e, 0x74, 0x00, 0xff, 0xfe, 0xfd, 0xfc,
|
|
}
|
|
err = unmarshaled.Unmarshal(badPacket)
|
|
require.Error(t, err)
|
|
})
|
|
|
|
t.Run("oversized extension padding does not panic", func(t *testing.T) {
|
|
var unmarshaled Packet
|
|
// HasExtensions set, extensionsSize describes more bytes than present,
|
|
// terminated by a 0x00 padding id -> hdrSize would exceed len(buf)
|
|
badPacket := []byte{
|
|
0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
}
|
|
err := unmarshaled.Unmarshal(badPacket)
|
|
require.Error(t, err)
|
|
})
|
|
|
|
t.Run("extensions size wraparound does not panic", func(t *testing.T) {
|
|
var unmarshaled Packet
|
|
// 0xFFFF extensions-size field wraps (raw+1)*4 uint16 arithmetic to a huge
|
|
// remainingSize; the 0x00 padding id must not push hdrSize past len(buf)
|
|
badPacket := []byte{
|
|
0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00,
|
|
}
|
|
err := unmarshaled.Unmarshal(badPacket)
|
|
require.Error(t, err)
|
|
})
|
|
|
|
t.Run("truncated extensions size field does not panic", func(t *testing.T) {
|
|
var unmarshaled Packet
|
|
// HasExtensions set but buffer too short to hold the extensionsSize field
|
|
badPacket := []byte{
|
|
0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00,
|
|
}
|
|
err := unmarshaled.Unmarshal(badPacket)
|
|
require.Error(t, err)
|
|
})
|
|
}
|