docs: SSH stderr audit + socketpair channel design (#2370, #2371)#4339
Merged
Conversation
Adds two docs covering the SSE-1 (#2370) and SSE-2 (#2371) tasks: - `docs/audits/ssh-stderr-handling.md` maps every call site that configures, drains, surfaces, or shuts down the SSH subprocess stderr stream in `crates/rsync_io/src/ssh/`. Covers the dual-backend selection (socketpair on Unix, pipe everywhere else), the 50 ms bounded join policy, the `Drop`-time surface-on-error path, and confirms the async transport currently uses `Stdio::inherit()` with no drain or capture. - `docs/design/socketpair-stderr-channel.md` proposes a tokio-aware `StderrAuxChannel` backend behind a default-off `ssh-socketpair-stderr` feature flag, covers a Windows TCP-loopback shim for the missing `socketpair(2)`, and lays out the five-step rollout keyed to SSE-3..SSE-7. No code changes; the existing dual-backend abstraction in `aux_channel.rs` already supports the proposed trait-level extension.
github-actions
Bot
added
the
documentation
oferchen
added a commit
that referenced
this pull request
May 18, 2026
) Adds two docs covering the SSE-1 (#2370) and SSE-2 (#2371) tasks: - `docs/audits/ssh-stderr-handling.md` maps every call site that configures, drains, surfaces, or shuts down the SSH subprocess stderr stream in `crates/rsync_io/src/ssh/`. Covers the dual-backend selection (socketpair on Unix, pipe everywhere else), the 50 ms bounded join policy, the `Drop`-time surface-on-error path, and confirms the async transport currently uses `Stdio::inherit()` with no drain or capture. - `docs/design/socketpair-stderr-channel.md` proposes a tokio-aware `StderrAuxChannel` backend behind a default-off `ssh-socketpair-stderr` feature flag, covers a Windows TCP-loopback shim for the missing `socketpair(2)`, and lays out the five-step rollout keyed to SSE-3..SSE-7. No code changes; the existing dual-backend abstraction in `aux_channel.rs` already supports the proposed trait-level extension.
oferchen
added a commit
that referenced
this pull request
May 18, 2026
) Adds two docs covering the SSE-1 (#2370) and SSE-2 (#2371) tasks: - `docs/audits/ssh-stderr-handling.md` maps every call site that configures, drains, surfaces, or shuts down the SSH subprocess stderr stream in `crates/rsync_io/src/ssh/`. Covers the dual-backend selection (socketpair on Unix, pipe everywhere else), the 50 ms bounded join policy, the `Drop`-time surface-on-error path, and confirms the async transport currently uses `Stdio::inherit()` with no drain or capture. - `docs/design/socketpair-stderr-channel.md` proposes a tokio-aware `StderrAuxChannel` backend behind a default-off `ssh-socketpair-stderr` feature flag, covers a Windows TCP-loopback shim for the missing `socketpair(2)`, and lays out the five-step rollout keyed to SSE-3..SSE-7. No code changes; the existing dual-backend abstraction in `aux_channel.rs` already supports the proposed trait-level extension.
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-stderr-handling.md(SSE-1, fix: improve metadata platform stubs for cross-platform compilation #2370): per-call-site audit of howcrates/rsync_io/src/ssh/configures, drains, surfaces, and shuts down the SSH subprocess stderr stream, with a sync-vs-async behaviour matrix.docs/design/socketpair-stderr-channel.md(SSE-2, refactor: improve protocol message codes and negotiation #2371): pipe-vs-socketpair trade-off, cross-platform construction (Unixsocketpair(2), Windows TCP-loopback shim),AsyncSshTransportintegration plan, optional warning channel, default-offssh-socketpair-stderrfeature flag, and a five-step rollout keyed to SSE-3..SSE-7.StderrAuxChanneltrait inaux_channel.rsis the seam the new tokio backend slots into.Test plan
cargo fmt --all -- --check