Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 0 additions & 5 deletions .changeset/purple-needles-juggle.md

This file was deleted.

7 changes: 0 additions & 7 deletions .changeset/sip-codecs.md

This file was deleted.

8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# github.com/livekit/protocol

## 1.45.8

### Patch Changes

- Allow setting a list of SIP codecs for SDP. - [#1530](https://github.com/livekit/protocol/pull/1530) ([@dennwc](https://github.com/dennwc))

- fix: ensure we don't reject tokens on unknown fields - [#1536](https://github.com/livekit/protocol/pull/1536) ([@davidzhao](https://github.com/davidzhao))

## 1.45.7

### Patch Changes
Expand Down
8 changes: 7 additions & 1 deletion auth/grants.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ var tokenMarshaler = protojson.MarshalOptions{
EmitDefaultValues: false,
}

// tokenUnmarshaler discards unknown fields so that older servers can accept
// tokens issued by newer clients that include fields the server does not yet know about.
var tokenUnmarshaler = protojson.UnmarshalOptions{
DiscardUnknown: true,
}

var ErrSensitiveCredentials = errors.New("room configuration should not contain sensitive credentials")

func (c *RoomConfiguration) Clone() *RoomConfiguration {
Expand All @@ -49,7 +55,7 @@ func (c *RoomConfiguration) MarshalJSON() ([]byte, error) {
}

func (c *RoomConfiguration) UnmarshalJSON(data []byte) error {
return protojson.Unmarshal(data, (*livekit.RoomConfiguration)(c))
return tokenUnmarshaler.Unmarshal(data, (*livekit.RoomConfiguration)(c))
}

// CheckCredentials checks if the room configuration contains sensitive credentials
Expand Down
47 changes: 47 additions & 0 deletions auth/verifier_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ import (
"testing"
"time"

"github.com/go-jose/go-jose/v3"
"github.com/go-jose/go-jose/v3/json"
"github.com/go-jose/go-jose/v3/jwt"
"github.com/stretchr/testify/require"

"github.com/livekit/protocol/auth"
Expand Down Expand Up @@ -95,6 +97,51 @@ func TestVerifier(t *testing.T) {
require.EqualValues(t, attrs, decoded.Attributes)
})

t.Run("unknown fields are ignored for forward compatibility", func(t *testing.T) {
// Simulate a token issued by a newer client whose claims include fields
// this server does not yet know about. The server should still accept the
// token rather than failing with `unknown field`. This guards against
// requiring server upgrades before client upgrades can roll out.
sig, err := jose.NewSigner(
jose.SigningKey{Algorithm: jose.HS256, Key: []byte(secret)},
(&jose.SignerOptions{}).WithType("JWT"),
)
require.NoError(t, err)

claims := map[string]interface{}{
"iss": apiKey,
"sub": "me",
"nbf": jwt.NewNumericDate(time.Now()),
"exp": jwt.NewNumericDate(time.Now().Add(time.Minute)),
// unknown top-level claim grants field
"someFutureGrant": map[string]interface{}{"enabled": true},
"video": map[string]interface{}{
"roomJoin": true,
"room": "myroom",
// unknown field inside a known grant
"someFutureVideoField": "future-value",
},
"roomConfig": map[string]interface{}{
"name": "myroom",
// unknown field inside a protojson-decoded message
"someFutureRoomConfigField": "future-value",
},
}
token, err := jwt.Signed(sig).Claims(claims).CompactSerialize()
require.NoError(t, err)

v, err := auth.ParseAPIToken(token)
require.NoError(t, err)

_, decoded, err := v.Verify(secret)
require.NoError(t, err)
require.NotNil(t, decoded.Video)
require.Equal(t, "myroom", decoded.Video.Room)
require.True(t, decoded.Video.RoomJoin)
require.NotNil(t, decoded.RoomConfig)
require.Equal(t, "myroom", decoded.RoomConfig.Name)
})

t.Run("nil permissions are handled", func(t *testing.T) {
grant := &auth.VideoGrant{
Room: "myroom",
Expand Down
4 changes: 3 additions & 1 deletion observability/gatewayobs/gen_reporter.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions observability/gatewayobs/gen_reporter_noop.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions observability/gatewayobs/gen_source.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "github.com/livekit/protocol",
"private": true,
"version": "1.45.7",
"version": "1.45.8",
"scripts": {
"changeset": "changeset",
"ci:publish": "pnpm --filter @livekit/protocol run build && changeset publish"
Expand Down
8 changes: 8 additions & 0 deletions packages/javascript/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# @livekit/protocol

## 1.45.8

### Patch Changes

- rename agent environment to deployment - [#1532](https://github.com/livekit/protocol/pull/1532) ([@paulwe](https://github.com/paulwe))

- Allow setting a list of SIP codecs for SDP. - [#1530](https://github.com/livekit/protocol/pull/1530) ([@dennwc](https://github.com/dennwc))

## 1.45.7

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/javascript/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@livekit/protocol",
"version": "1.45.7",
"version": "1.45.8",
"description": "",
"type": "module",
"require": "dist/index.cjs",
Expand Down
Loading