Skip to content

Few fixes for Header.Unmarshal #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sirzooro merged 1 commit into from
Oct 5, 2025
Merged

Few fixes for Header.Unmarshal #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions packet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ const (
extensionShift = 4
extensionMask = 0x1
extensionIDReserved = 0xF
extensionIDPadding = 0x0
ccMask = 0xF
markerShift = 7
markerMask = 0x1
Expand Down Expand Up @@ -138,6 +139,7 @@ func (h *Header) Unmarshal(buf []byte) (n int, err error) { //nolint:gocognit,cy
return n, fmt.Errorf("size %d < %d: %w", len(buf), n,
errHeaderSizeInsufficient)
}
headerLength := n

h.Marker = (buf[1] >> markerShift & markerMask) > 0
h.PayloadType = buf[1] & ptMask
Expand Down Expand Up @@ -168,6 +170,7 @@ func (h *Header) Unmarshal(buf []byte) (n int, err error) { //nolint:gocognit,cy
extensionLength := int(binary.BigEndian.Uint16(buf[n:])) * 4
n += 2
extensionEnd := n + extensionLength
headerLength = extensionEnd

if len(buf) < extensionEnd {
return n, fmt.Errorf("size %d < %d: %w", len(buf), extensionEnd, errHeaderSizeInsufficientForExtension)
Expand All @@ -180,7 +183,7 @@ func (h *Header) Unmarshal(buf []byte) (n int, err error) { //nolint:gocognit,cy
)

for n < extensionEnd {
if buf[n] == 0x00 { // padding
if buf[n] == extensionIDPadding { // padding
n++

continue
Expand All @@ -191,23 +194,24 @@ func (h *Header) Unmarshal(buf []byte) (n int, err error) { //nolint:gocognit,cy
payloadLen = int(buf[n]&^0xF0 + 1)
n++

if extid == extensionIDReserved {
// Stop parsing extensions if we reach the reserved ID or padding with non-zero length
if extid == extensionIDReserved || extid == extensionIDPadding {
break
}
} else {
extid = buf[n]
n++

if len(buf) <= n {
return n, fmt.Errorf("size %d < %d: %w", len(buf), n, errHeaderSizeInsufficientForExtension)
if extensionEnd <= n {
return n, fmt.Errorf("size %d < %d: %w", extensionEnd, n, errHeaderSizeInsufficientForExtension)
}

payloadLen = int(buf[n])
n++
}

if extensionPayloadEnd := n + payloadLen; len(buf) < extensionPayloadEnd {
return n, fmt.Errorf("size %d < %d: %w", len(buf), extensionPayloadEnd, errHeaderSizeInsufficientForExtension)
if extensionPayloadEnd := n + payloadLen; extensionEnd < extensionPayloadEnd {
return n, fmt.Errorf("size %d < %d: %w", extensionEnd, extensionPayloadEnd, errHeaderSizeInsufficientForExtension)
}

extension := Extension{id: extid, payload: buf[n : n+payloadLen]}
Expand All @@ -218,11 +222,10 @@ func (h *Header) Unmarshal(buf []byte) (n int, err error) { //nolint:gocognit,cy
// RFC3550 Extension
extension := Extension{id: 0, payload: buf[n:extensionEnd]}
h.Extensions = append(h.Extensions, extension)
n += len(h.Extensions[0].payload)
}
}

return n, nil
return headerLength, nil
}

// Unmarshal parses the passed byte slice and stores the result in the Packet.
Expand Down
111 changes: 102 additions & 9 deletions packet_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,6 +573,29 @@ func TestRFC8285TwoByteMultipleExtensionsWithPadding(t *testing.T) {
ext3 := packet.GetExtension(3)
ext3Expect := []byte{0xCC, 0xCC, 0xCC, 0xCC}
assert.Equal(t, ext3Expect, ext3, "Extension has incorrect data")

rawPktReMarshal := []byte{
0x90, 0xe0, 0x69, 0x8f, 0xd9, 0xc2, 0x93, 0xda, 0x1c, 0x64,
0x27, 0x82, 0x10, 0x00, 0x00, 0x03, 0x01, 0x00, 0x02, 0x01,
0xBB, 0x03, 0x04, 0xCC, 0xCC, 0xCC, 0xCC, 0x00, // padding is moved to the end by re-marshaling
// Payload
0x98, 0x36, 0xbe, 0x88, 0x9e,
}
dstBuf := map[string][]byte{
"CleanBuffer": make([]byte, 1000),
"DirtyBuffer": make([]byte, 1000),
}
for i := range dstBuf["DirtyBuffer"] {
dstBuf["DirtyBuffer"][i] = 0xFF
}
for name, buf := range dstBuf {
buf := buf
t.Run(name, func(t *testing.T) {
n, err := packet.MarshalTo(buf)
assert.NoError(t, err)
assert.Equal(t, rawPktReMarshal, buf[:n])
})
}
}

func TestRFC8285TwoByteMultipleExtensionsWithLargeExtension(t *testing.T) {
Expand Down Expand Up @@ -884,7 +907,7 @@ func TestRFC8285OneByteSetExtensionShouldErrorWhenInvalidIDProvided(t *testing.T
)
}

func TestRFC8285OneByteExtensionTermianteProcessingWhenReservedIDEncountered(t *testing.T) {
func TestRFC8285OneByteExtensionTerminateProcessingWhenReservedIDEncountered(t *testing.T) {
packet := &Packet{}

reservedIDPkt := []byte{
Expand All @@ -897,7 +920,24 @@ func TestRFC8285OneByteExtensionTermianteProcessingWhenReservedIDEncountered(t *
)
assert.Len(t, packet.Extensions, 0, "Extensions should be empty for invalid id")

payload := reservedIDPkt[17:]
payload := reservedIDPkt[20:]
assert.Equal(t, payload, packet.Payload)
}

func TestRFC8285OneByteExtensionTerminateProcessingWhenPaddingWithSizeEncountered(t *testing.T) {
packet := &Packet{}

reservedIDPkt := []byte{
0x90, 0xe0, 0x69, 0x8f, 0xd9, 0xc2, 0x93, 0xda, 0x1c, 0x64,
0x27, 0x82, 0xBE, 0xDE, 0x00, 0x01, 0x01, 0xAA, 0x98, 0x36, 0xbe, 0x88, 0x9e,
}
assert.NoError(
t, packet.Unmarshal(reservedIDPkt),
"Unmarshal error on packet with non-zero padding size",
)
assert.Len(t, packet.Extensions, 0, "Extensions should be empty for non-zero padding size")

payload := reservedIDPkt[20:]
assert.Equal(t, payload, packet.Payload)
}

Expand Down Expand Up @@ -1059,26 +1099,26 @@ func TestRFC8285TwoByteSetExtensionShouldErrorWhenPayloadTooLarge(t *testing.T)
func TestRFC8285Padding(t *testing.T) {
header := &Header{}

for _, payload := range [][]byte{
for n, payload := range [][]byte{
{
0b00010000, // header.Extension = true
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // SequenceNumber, Timestamp, SSRC
0xBE, 0xDE, // header.ExtensionProfile = extensionProfileOneByte
0, 1, // extensionLength
0, 0, 0, // padding
1, // extid
0x10, // extid and length
},
{
0b00010000, // header.Extension = true
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // SequenceNumber, Timestamp, SSRC
0x10, 0x00, // header.ExtensionProfile = extensionProfileOneByte
0x10, 0x00, // header.ExtensionProfile = extensionProfileTwoByte
0, 1, // extensionLength
0, 0, 0, // padding
1, // extid
0, 0, // padding
0x01, 0x01, // extid and length
},
} {
_, err := header.Unmarshal(payload)
assert.ErrorIs(t, err, errHeaderSizeInsufficientForExtension)
assert.ErrorIs(t, err, errHeaderSizeInsufficientForExtension, "case %d", n)
}
}

Expand Down Expand Up @@ -1198,7 +1238,7 @@ func TestUnmarshal_ErrorHandling(t *testing.T) {
}

// https://github.com/pion/rtp/issues/275
func TestUnmarshal_ExtensionWithoutRTPPayload(t *testing.T) {
func TestUnmarshal_OneByteExtensionWithoutRTPPayload(t *testing.T) {
rawPkt := []byte{
0x10, 0x64, 0x57, 0x49, 0x00, 0x00, 0x01, 0x90, 0x12, 0x34, 0xAB, 0xCD,
0xBE, 0xDE, 0x00, 0x01, // One-Byte extension header, 4 bytes
Expand All @@ -1210,6 +1250,59 @@ func TestUnmarshal_ExtensionWithoutRTPPayload(t *testing.T) {
assert.NoError(t, p.Unmarshal(rawPkt))
}

func TestUnmarshal_TwoByteExtensionWithoutRTPPayload(t *testing.T) {
rawPkt := []byte{
0x10, 0x64, 0x57, 0x49, 0x00, 0x00, 0x01, 0x90, 0x12, 0x34, 0xAB, 0xCD,
0x10, 0x00, 0x00, 0x01, // Two-Byte extension header, 4 bytes
0x02, 0x02, // ID=0, Len=2 (2 bytes data)
0x02, 0x03, // Extension data
}

p := &Packet{}
assert.NoError(t, p.Unmarshal(rawPkt))
}

func TestUnmarshal_NonStandardExtensionWithoutRTPPayload(t *testing.T) {
rawPkt := []byte{
0x10, 0x64, 0x57, 0x49, 0x00, 0x00, 0x01, 0x90, 0x12, 0x34, 0xAB, 0xCD,
0xAA, 0xAA, 0x00, 0x01, // Non-standard header extension 0xAAAA, 4 bytes
0x01, 0x02, 0x03, 0x04, // Extension data
}

p := &Packet{}
assert.NoError(t, p.Unmarshal(rawPkt))
}

func TestUnmarshal_EmptyOneByteExtensionWithoutRTPPayload(t *testing.T) {
rawPkt := []byte{
0x10, 0x64, 0x57, 0x49, 0x00, 0x00, 0x01, 0x90, 0x12, 0x34, 0xAB, 0xCD,
0xBE, 0xDE, 0x00, 0x00, // One-Byte extension header, 0 bytes
}

p := &Packet{}
assert.NoError(t, p.Unmarshal(rawPkt))
}

func TestUnmarshal_EmptyTwoByteExtensionWithoutRTPPayload(t *testing.T) {
rawPkt := []byte{
0x10, 0x64, 0x57, 0x49, 0x00, 0x00, 0x01, 0x90, 0x12, 0x34, 0xAB, 0xCD,
0x10, 0x00, 0x00, 0x00, // Two-Byte extension header, 0 bytes
}

p := &Packet{}
assert.NoError(t, p.Unmarshal(rawPkt))
}

func TestUnmarshal_EmptyNonStandardExtensionWithoutRTPPayload(t *testing.T) {
rawPkt := []byte{
0x10, 0x64, 0x57, 0x49, 0x00, 0x00, 0x01, 0x90, 0x12, 0x34, 0xAB, 0xCD,
0xAA, 0xAA, 0x00, 0x00, // Non-standard header extension 0xAAAA, 0 bytes
}

p := &Packet{}
assert.NoError(t, p.Unmarshal(rawPkt))
}

func TestRoundtrip(t *testing.T) {
rawPkt := []byte{
0x00, 0x10, 0x23, 0x45, 0x12, 0x34, 0x45, 0x67, 0xCC, 0xDD, 0xEE, 0xFF,
Expand Down
Loading