Skip to content

Implement ICE consent freshness #44

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

Open
wants to merge 4 commits into
base: workflows
Choose a base branch
from
Open

Implement ICE consent freshness #44

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
826b6ac
Implement ICE consent freshness support
murillo128 Jun 5, 2025
8abc931
Remove special chars
murillo128 Jun 10, 2025
a5b3f90
Remove special chars
murillo128 Jun 10, 2025
c0cc525
revert line changes
murillo128 Jun 10, 2025
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
41 changes: 39 additions & 2 deletions libavformat/whip.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,12 @@
#define WHIP_RTCP_PT_START 192
#define WHIP_RTCP_PT_END 223

/**
* Consent-freshness constants
*/
#define WHIP_CONSENT_DEF_INTERVAL 15000 /* ms - RFC 7675 default */
#define WHIP_CONSENT_MAX_FAILURES 3

/**
* In the case of ICE-LITE, these fields are not used; instead, they are defined
* as constant values.
Expand Down Expand Up @@ -303,6 +309,11 @@ typedef struct WHIPContext {
/* The certificate and private key used for DTLS handshake. */
char* cert_file;
char* key_file;

/* Consent-freshness state */
int consent_interval;
int64_t last_consent_tx;
int consent_failures;
} WHIPContext;

/**
Expand Down Expand Up @@ -412,6 +423,12 @@ static av_cold int initialize(AVFormatContext *s)
seed = av_get_random_seed();
av_lfg_init(&whip->rnd, seed);

/* Initialise consent-freshness timers */
if (whip->consent_interval <= 0)
whip->consent_interval = WHIP_CONSENT_DEF_INTERVAL;
whip->last_consent_tx = av_gettime();
whip->consent_failures = 0;

if (whip->pkt_size < ideal_pkt_size)
av_log(whip, AV_LOG_WARNING, "WHIP: pkt_size=%d(<%d) is too small, may cause packet loss\n",
whip->pkt_size, ideal_pkt_size);
Expand Down Expand Up @@ -1775,14 +1792,27 @@ static int whip_write_packet(AVFormatContext *s, AVPacket *pkt)
AVStream *st = s->streams[pkt->stream_index];
AVFormatContext *rtp_ctx = st->priv_data;

/* TODO: Send binding request every 1s as WebRTC heartbeat. */
/* Periodic consent-freshness STUN Binding Request */
int64_t now = av_gettime();
if (now - whip->last_consent_tx >= (int64_t)whip->consent_interval * 1000) {
int req_sz;
if (ice_create_request(s, whip->buf, sizeof(whip->buf), &req_sz) >= 0 && ffurl_write(whip->udp, whip->buf, req_sz) == req_sz) {
whip->consent_failures++;
whip->last_consent_tx = now;
av_log(whip, AV_LOG_VERBOSE, "WHIP: consent-freshness request %d sent\n", whip->consent_failures);
}
}

/**
* Receive packets from the server such as ICE binding requests, DTLS messages,
* and RTCP like PLI requests, then respond to them.
*/
ret = ffurl_read(whip->udp, whip->buf, sizeof(whip->buf));
if (ret > 0) {
if (ice_is_binding_response(whip->buf, ret)) {
whip->consent_failures = 0;
av_log(whip, AV_LOG_VERBOSE, "WHIP: consent-freshness response received, counter reset\n");
}
if (is_dtls_packet(whip->buf, ret)) {
if ((ret = ffurl_write(whip->dtls_uc, whip->buf, ret)) < 0) {
av_log(whip, AV_LOG_ERROR, "WHIP: Failed to handle DTLS message\n");
Expand All @@ -1793,6 +1823,12 @@ static int whip_write_packet(AVFormatContext *s, AVPacket *pkt)
av_log(whip, AV_LOG_ERROR, "WHIP: Failed to read from UDP socket\n");
goto end;
}
/* Check consent freshness consecutive failures */
if (whip->consent_failures >= WHIP_CONSENT_MAX_FAILURES) {
av_log(whip, AV_LOG_ERROR, "WHIP: No consent-freshness response after %d attempts, closing\n", WHIP_CONSENT_MAX_FAILURES);
ret = AVERROR(EHOSTUNREACH);
goto end;
}

if (whip->h264_annexb_insert_sps_pps && st->codecpar->codec_id == AV_CODEC_ID_H264) {
if ((ret = h264_annexb_insert_sps_pps(s, pkt)) < 0) {
Expand Down Expand Up @@ -1891,7 +1927,8 @@ static const AVOption options[] = {
{ "pkt_size", "The maximum size, in bytes, of RTP packets that send out", OFFSET(pkt_size), AV_OPT_TYPE_INT, { .i64 = 1200 }, -1, INT_MAX, DEC },
{ "authorization", "The optional Bearer token for WHIP Authorization", OFFSET(authorization), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, DEC },
{ "cert_file", "The optional certificate file path for DTLS", OFFSET(cert_file), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, DEC },
{ "key_file", "The optional private key file path for DTLS", OFFSET(key_file), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, DEC },
{ "key_file", "The optional private key file path for DTLS", OFFSET(key_file), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, DEC },
{ "consent_interval", "STUN consent refresh interval in ms (RFC 7675)", OFFSET(consent_interval), AV_OPT_TYPE_INT, { .i64 = WHIP_CONSENT_DEF_INTERVAL }, 5000, 30000, DEC },
{ NULL },
};

Expand Down