docs: add CI badge and correct the libsrt version requirements - #85
Merged
Conversation
The stated libsrt versions were wrong in both directions. "successfully tested in srt 1.3.4 and above" understates the real build floor: srtgo references srt_connect_callback, srt_setrejectreason and the SRT_EPOLLEMPTY/SRT_ESCLOSED/SRT_ESYSOBJ error codes, none of which exist in the v1.4.1 headers and all of which appear in v1.4.2. Building against 1.3.4 or 1.4.1 cannot work. It also points users at versions with known critical vulnerabilities: everything up to and including 1.5.5 is affected by CVE-2026-55869 (buffer overflow in KMREQ/KMRSP handling) and CVE-2026-55868 (encryption state machine downgrade), both fixed in 1.5.6. The build floor and the security recommendation are stated separately because they are different numbers. The feature list said "SRT transport options up to SRT 1.4.1" without saying what that means for later releases; noted that newer options are not exposed yet. Also adds a CI status badge now that the workflow exists. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two fixes to README, plus the CI badge now that a workflow exists.
The stated libsrt versions were wrong in both directions
Too low to build. "successfully tested in srt 1.3.4 and above" cannot be true. srtgo references
srt_connect_callback,srt_setrejectreason, and theSRT_EPOLLEMPTY/SRT_ESCLOSED/SRT_ESYSOBJerror codes. Checked against upstream headers:SRT_EPOLLEMPTYsrt_connect_callbackSRT_ESCLOSED/SRT_ESYSOBJSo the real build floor is 1.4.2.
Too low to be safe. Every release up to and including 1.5.5 is affected by CVE-2026-55869 (buffer overflow in KMREQ/KMRSP handling) and CVE-2026-55868 (encryption state machine downgrade), both fixed in 1.5.6. Pointing users at 1.3.4 aims them at a version with known critical vulnerabilities.
The two numbers are stated separately and labelled, because they are genuinely different: 1.4.2 is what compiles, 1.5.6 is what you should run.
Badge
pinned tomaster, linking to the workflow's run list, placed beside the existing PkgGoDev badge. The endpoint returns200 image/svg+xml.Note srtgo does not vendor libsrt — it links whatever the consumer installs — so these are requirements on the user's environment, not something this repo can enforce beyond CI.
🤖 Generated with Claude Code