Skip to content

Ogg, xtask: check packet ranges against the source first; stats skips directory links - #1796

Merged
aiongg merged 1 commit into
mainfrom
fix/sec-ogg-xtask-stats
Nov 4, 2026
Merged

aiongg merged 1 commit into
mainfrom
fix/sec-ogg-xtask-stats

Conversation

@dylanmtaylor

@dylanmtaylor dylanmtaylor commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

What was wrong: the public OggFile::read_packet sized and zero-filled its buffer from the stored packet ranges before checking they exist in the source it was handed (ranges recorded from a scan of a different or shorter source). The xtask stats walker followed directory symlinks with no visited set, so a small branching link tree is walked exponentially.

Changed: read_parts validates every range against src.len() first and returns Error::Invalid; the stats walker uses DirEntry::file_type (which does not follow links) and skips symlinks.

Blast radius: crates/ogg read_parts (only caller path is read_packet) and xtask/src/stats.rs (a dev tool). Behavior change: read_packet on a mismatched source now errors up front instead of failing partway; symlinked directories are no longer counted by xtask stats.

Checks run: cargo fmt --check, clippy -p deckcraft-ogg -p xtask --all-targets -D warnings, cargo test -p deckcraft-ogg (new test with a truncated source). Not run: workspace tests, xtask run.

Summary by CodeRabbit

  • Bug Fixes
    • Invalid packet ranges, including ranges that overflow or extend beyond the source, are now rejected instead of being read.
    • Statistics scans now skip symbolic links and recurse only into directories.

@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Walkthrough

Packet reads now reject ranges that overflow or extend beyond the source. Stats traversal skips symlinks and recurses only into directories.

Changes: Ogg packet bounds

Layer / File(s) Summary
Validate packet ranges
crates/ogg/src/lib.rs, crates/ogg/src/tests.rs
read_parts returns Error::Invalid for overflowing or out-of-source packet ranges. A test checks this result when the source is truncated.

Stats directory traversal

Layer / File(s) Summary
Skip symlinks during traversal
xtask/src/stats.rs
walk skips entries whose file type cannot be read and skips symlinks. It recurses only into entries reported as directories.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: echelon

Merge Risk: Minimal · up to b3ceb

No actionable merge-blocking risk is established in the reviewed changes. The reported CI failures are infrastructure/authentication failures rather than PR defects.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names both changes in the PR: the Ogg read_parts change that checks packet ranges against the source before allocating, and the xtask stats change that skips directory symlinks. It is long…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names both changes in the PR: the Ogg read_parts change that checks packet ranges against the source before allocating, and the xtask stats change that skips directory symlinks. It is long and uses a semicolon to join two unrelated changes, but it describes real, on-topic changes and does not mislead.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 2 functions across 3 files.

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches
Generate docstrings
  • Commit to this branch
  • Create a new PR
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share
Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 19dceff and b3cebb9.

Files selected for processing: 3
  • crates/ogg/src/lib.rs
  • crates/ogg/src/tests.rs
  • xtask/src/stats.rs

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 5 remain after this review.

@dylanmtaylor

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Rate Limit Exceeded

@dylanmtaylor have exceeded the limit for the number of chat messages per hour. Please wait 42 minutes and 2 seconds before sending another message.

@dylanmtaylor

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor
Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@aiongg aiongg added bugfix Fixes something that is broken: wrong result, crash, data loss security labels Nov 4, 2026
@aiongg aiongg self-assigned this Nov 4, 2026
@aiongg
aiongg merged commit 51d19ba into main Nov 4, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix Fixes something that is broken: wrong result, crash, data loss security

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants