Repository navigation
v0.10.261005
qumo now ships its own auth server, so an app can secure a relay without writing one. Live sessions are revalidated with the auth server, which also sees each session's bytes and when it ends. The playground gains a DevTools panel and a viewer that keeps playing through a stalled group.
Important
Breaking for operators: qumo_relay_sessions_expired_total is replaced by qumo_relay_sessions_ended_total{reason}. Dashboards and alerts on the old metric need reason="expired" for the same count.
Highlights
qumo auth: a ready-to-run auth server (#460)
A relay with QUMO_AUTH_URL asks an auth server about every session. Until now you had to write that server yourself. With qumo auth, your app only decides who may publish or watch what, and signs it; qumo handles the key format, signing, verification and path confinement.
qumo auth keygen -prefix acme/app # once: signing key + public key set
QUMO_AUTH_KEYS_FILE=keys.json qumo auth # the auth server, beside the relay
QUMO_AUTH_URL=http://127.0.0.1:4440 qumo relay
qumo auth token -publish acme/app/rooms/42/alice -subscribe acme/app/rooms/42 -ttl 10m
- Verification:
- Tokens are EdDSA JWTs. The server accepts only a trusted key, the exact claim set, and a lifetime of at most one hour with 60 s leeway.
- Every granted path must lie within the key's prefix.
- A missing or invalid token gets 401; a path outside the prefix gets 403.
- Logging: the server logs every admitted, refused and ended session. The token is never logged.
- Signing in Go: your app's backend signs with the standard-library-only package
github.com/qumo-dev/qumo/token:tok, err := token.Sign(key, token.Grant{Publish: "acme/app/rooms/42/alice", Subscribe: "acme/app/rooms/42"}, time.Hour)
See the qumo auth docs.
Sessions are revalidated, with bytes and end reports (#419, #424)
- Revalidate: at the grant's
revalidatecadence, the relay asks the auth server again about each live session. This is how key revocation, suspension and spend limits reach sessions already connected.- A 401 or 403 ends the session (
refused), and an unenforceable grant ends it too (invalid). - If the auth server doesn't answer, the relay retries with backoff until the session's current
expires.
- A 401 or 403 ends the session (
- Bytes: each revalidate carries the session's cumulative
bytes. - End reports: every
connectis followed by anendreport with the final bytes, the duration and a reason:expired,refused,invalid,closed,droppedorupgrade_failed.
Playground: a DevTools panel and a sturdier viewer
- DevTools panel: session bitrate and round-trip time, per-track bitrate, frame rate and group outcomes, and a timeline of the last minute showing how each group arrived and what was rendered.
- Viewer: it reads groups as they arrive and stops waiting on a stalled one, so playback stays at the live edge.
- Audio and video play on a shared delay of at least 100 ms, so video no longer runs ahead of audio.
- A group aborted part-way no longer ends the track.
More
- WebTransport clients see why the relay ended their session. With gomoqt v0.22.1,
moqt.Causereportsexpiredorrefusedover WebTransport, as it already did over native QUIC. A client can reconnect onexpiredand stop onrefused. - The HLS egress can connect as a trusted peer with a client certificate (
RELAY_CERT_FILE,RELAY_KEY_FILE) from the CA the relay trusts. It needs no credential and its session never expires (#432). qumo loadgen --relayandsmoketestacceptmoqt://host:port/path?jwt=…URLs, to test relays that run an auth server.
Fixed
- RTMP and RTSP ingest no longer hands a subscriber an old group instead of the newest one. With one audio frame per group, this was heard as a click about once a minute (#462).
Security
- A relay URL's credential is never logged by
loadgen,smoketestor the HLS egress (#432).
Not yet enforced
Which paths a session can discover through announce interest and TRACK_INFO (#450).
Install
- Linux / macOS:
curl -fsSL https://raw.githubusercontent.com/qumo-dev/qumo/main/install.sh | sh - Windows:
powershell -ExecutionPolicy ByPass -c "irm https://raw.githubusercontent.com/qumo-dev/qumo/main/install.ps1 | iex" - Docker:
ghcr.io/qumo-dev/qumo:0.10.261005 - Upgrading in place:
qumo update
The full list is in CHANGELOG.md.
Changelog
- 3ab0a04 feat(relay): revalidate sessions with the auth server (#451)
- 1666b95 feat(relay): report session bytes on revalidate and end (#453)
- 37226de test(relay): cover SUBSCRIBEs from a peer this relay dialed; deflake admission tests (#452)
- 8077a0c chore(deps): bump gomoqt to v0.22.1; check close reasons over WebTransport (#459)
- f279199 fix(ingest): serve the group asked for, not whatever is in its ring slot (#462)
- dfebfef feat(auth): qumo auth — ready-to-run auth server, key generator and token tool (#461)
- e9a5cbe feat(playground): UI-free viewer, group-aware playback, and a DevTools panel (#455)
- 9f553fa chore(release): cut v0.10.261005 (#457)