docs: add deployment assumptions, security model, and build troubleshooting steps - #54
Open
roshan-ku wants to merge 7 commits into
Open
docs: add deployment assumptions, security model, and build troubleshooting steps#54roshan-ku wants to merge 7 commits into
roshan-ku wants to merge 7 commits into
Conversation
Document the dedicated-switch trust boundary raised in the SDLE review: - New docs/assumptions.md covering the TX host / dedicated L2 switch / receiver topology inside the locked cabinet, the deployment assumptions the security model depends on, the security properties the toolkit does not provide (security follows MTL and ST 2110, offloaded to physical and L2 isolation), and the residual risk with mitigations. - Link the new document from the README overview and from Security.md, which now also states the in-scope and out-of-scope components.
roshan-ku
changed the title
dmkarthi
reviewed
Aug 20, 2026
Replace the ffmpeg-plugin-extra-pixel-format tag with commit 7bee24231c864d12da6db2c2ffbfd3986717af5a in the clone instructions and in all MTL documentation links, so the build steps reference a fixed commit rather than a movable tag. Addresses PR review feedback.
- environment-check: rename the mtl-version input to mtl-commit and default it to 7bee24231c864d12da6db2c2ffbfd3986717af5a, matching the commit the README now documents. The env cache key picks up the new value automatically, so runners rebuild instead of restoring a stale MTL. - daily_build: raise the libFuzzer run from 300s to 7200s per sanitizer mode and extend the job timeout to 300 minutes to cover both modes plus the builds.
…otes - daily_build: libFuzzer runs 3600s per sanitizer mode (~2h total) with a 138 minute job timeout. - README: 12-bit pix_fmts require MTL and FFmpeg to both be built from the pinned commit, since the plugin sources are compiled into libavdevice. - README: drop the stale instruction to hand-patch mtl_common.h for p2_port..p7_port; those AVOptions are present at the pinned commit, so 8 NICs work with the default FFmpeg TX path unpatched.
dmkarthi
reviewed
Aug 21, 2026
| uses: ./.github/actions/analysis/libfuzzer | ||
| with: | ||
| max-seconds: '300' | ||
| max-seconds: '3600' |
Collaborator
There was a problem hiding this comment.
check if this runs for 2 hrs or 1 hr in your fork
dmkarthi
reviewed
Aug 21, 2026
- afl-fuzz job: max-seconds 300 -> 7200 (single AFL run, so 2h total) and timeout-minutes 25 -> 138 to leave headroom for install and build. - Corpus seeds were written against an older schema: fps/fmt were placed in the video object but the parser reads them from tx_video, so the tx_video branch was never exercised. Moved them and added scale_width/scale_height. - Added nic_index to interfaces[] and tx_sessions[]. - New seeds for parameters with no coverage: ptp_config.json (ptp enable/pi/ unicast booleans), screen_capture.json (input_mode/screen_input) and multi_nic.json (multiple interfaces, 12-bit fmt, session-to-NIC mapping).
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
2 participants
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.
Description
Checklist
Code Quality
Testing
Review Readiness
Documentation
Security
PR Type
What kind of change does this PR introduce?