docs: add security policy and Dependabot configuration - #86
Merged
Conversation
Adds SECURITY.md and .github/dependabot.yml, and links the README's security paragraph to the new policy so the cross-reference works in both directions. SECURITY.md documents where to report (private vulnerability reporting is enabled on this repository), that srtgo is a binding and vendors no copy of libsrt -- so a libsrt CVE cannot be fixed by a change here -- and the recommended libsrt floor of 1.5.6. That number matches the README and is deliberately distinct from the 1.4.2 needed to build. It also notes the build uses a bare `-lsrt` and no pkg-config, so `pkg-config --modversion srt` is not a reliable answer to "what did I link". dependabot.yml enables version updates for gomod and github-actions, and holds golang.org/x/sys at v0.1.x: from v0.31.0 it requires go 1.23.0 and from v0.42.0 go 1.25.0, either of which would raise the toolchain floor for every consumer of a module that declares go 1.12 on purpose. The ignore uses a `versions` range rather than `update-types`, because dependabot-core drops `update-types` on security runs (Config::IgnoreCondition#ignored_versions returns early when security_updates_only is set), so an `update-types` ignore would still let a security PR drag the go directive up. SECURITY.md records the resulting trade-off as an accepted risk for GO-2026-5024 / CVE-2026-39824: Windows-only, never called here, and fixed only in an x/sys release that declares go 1.25.0. 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.
Adds the two files the repo was missing now that CI is in place, and makes the README's security paragraph link to the new policy — the cross-reference was one-way.
SECURITY.md
#cgo LDFLAGS: -lsrtand never invokes pkg-config, sopkg-config --modversion srttells you what pkg-config can see, not what you linked.NewNTUnicodeStringis never called here, and the fix lands only in x/sys v0.44.0, which declaresgo 1.25.0..github/dependabot.yml
Weekly version updates for
gomodandgithub-actions, the latter grouped so a checkout bump and a setup-go bump arrive as one PR rather than triggering two full libsrt-from-source CI runs.The one deliberate ignore holds
golang.org/x/sysat v0.1.x. From v0.31.0 it requiresgo 1.23.0and from v0.42.0go 1.25.0, either of which would raise the toolchain floor for every downstream consumer of a module that declaresgo 1.12on purpose.It uses a
versionsrange rather thanupdate-typesfor a specific reason:update-typesis dropped on security runs — dependabot-core'sConfig::IgnoreCondition#ignored_versionsreturns early whensecurity_updates_onlyis set — so anupdate-typesignore would still allow a security PR to drag thegodirective up. Aversionsrange is honoured on both paths.The knowingly accepted consequence is documented in both files: if an x/sys alert is ever raised, this also suppresses its security-update PR. That is not the case today — the advisory for CVE-2026-39824 is unreviewed and carries no affected-version ranges, so it raises no alert, and the repo currently has none open. The ignore configures updates only; it cannot dismiss or hide an alert.
Docs and config only — no Go code changes.
go vetclean and the suite passes unchanged.🤖 Generated with Claude Code