Skip to content

docs: v0.6 known limitations and security hardening notes#3475

Merged
oferchen merged 1 commit into
masterfrom
docs/v060-limitations-hardening
Apr 30, 2026
Merged

docs: v0.6 known limitations and security hardening notes#3475
oferchen merged 1 commit into
masterfrom
docs/v060-limitations-hardening

Conversation

@oferchen
Copy link
Copy Markdown
Owner

Summary

  • README.md: new "Known Limitations / Architectural Trade-offs" section documenting PBUF_RING 5.19+, io_uring buffer pool ceiling, SSH double-compression interaction, single-thread delta computation, daemon TLS gap, Windows IOCP wiring status, .rsync-filter inheritance audit gap.
  • SECURITY.md: bumped supported-versions table to 0.6.x; new "Hardening Notes" section covering recycle_buffer release-mode bounds-check gap, bgid u16 namespace exhaustion, SSH double-compression amplification surface, daemon TLS-in-front guidance, daemon module hardening defaults.

These trade-offs are tracked individually as decomposed tasks (#2042-#2052) for follow-up implementation work.

Test plan

  • CI green (docs-only change, no behaviour impact)
  • Render preview on GitHub looks correct
  • Cross-links between README ↔ SECURITY resolve

Adds a "Known Limitations / Architectural Trade-offs" section to README.md
covering PBUF_RING 5.19+ requirement, io_uring buffer pool ceiling, SSH
double-compression interaction, single-thread delta computation, daemon TLS
gap, and Windows IOCP wiring status (#1868).

Updates SECURITY.md supported-versions table to 0.6.x and adds a "Hardening
Notes" section covering recycle_buffer release-mode bounds-check gap, bgid
u16 namespace exhaustion, SSH double-compression amplification surface,
daemon TLS-in-front guidance (stunnel / SSH tunnel / reverse proxy), and
daemon module hardening defaults.

Cross-links the two documents so operators planning a deployment have a
single source of truth for the documented trade-offs.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 30, 2026
@oferchen oferchen merged commit 918a303 into master Apr 30, 2026
11 checks passed
@oferchen oferchen deleted the docs/v060-limitations-hardening branch April 30, 2026 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant