docs(rsync_io): audit SSH cipher-level compression detection (#2046)#3506
Merged
Conversation
Phase-1 audit only. Surveys the existing SSH transport surface in crates/rsync_io/src/ssh and the --compress CLI plumbing, catalogs the detection signals available at command-build time (argv -C / -o Compression=yes, ssh -G HOST output, cipher-implied compression), and proposes a phased plan for emitting a stderr warning when SSH and rsync would double-compress the same byte stream. No code or Cargo.toml changes; the recommended Phase 2 wiring point is build_ssh_connection in crates/core/src/client/remote/ssh_transfer.rs.
github-actions
Bot
added
the
documentation
oferchen
added a commit
that referenced
this pull request
May 5, 2026
…3506) Phase-1 audit only. Surveys the existing SSH transport surface in crates/rsync_io/src/ssh and the --compress CLI plumbing, catalogs the detection signals available at command-build time (argv -C / -o Compression=yes, ssh -G HOST output, cipher-implied compression), and proposes a phased plan for emitting a stderr warning when SSH and rsync would double-compress the same byte stream. No code or Cargo.toml changes; the recommended Phase 2 wiring point is build_ssh_connection in crates/core/src/client/remote/ssh_transfer.rs.
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.
Summary
docs/audits/ssh-cipher-compression.md. No Rust, no Cargo.toml, no flag wiring.crates/rsync_io/src/ssh/and the--compressCLI plumbing incrates/cli/...connection_and_logging_options.rs, then catalogs three detection signals available at command-build time:-C/-oCompression=yesin argv,ssh -G HOSTresolved config, and cipher-implied compression (none in modern OpenSSH).--compress-warn-double(default on) wired intobuild_ssh_connectionincrates/core/src/client/remote/ssh_transfer.rs. Phase 3 (opt-in--compress-on-double=auto|force|off) deferred until benchmarks justify changing transfer semantics.Test plan
todo!/FIXME.