Compare commits

...
11 Commits
Author SHA1 Message Date
DuProcess 24180c5092 Release v1.0.0-rc46
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
2026-07-17 20:54:02 -04:00
DuProcess 0fdfc0ee22 Keep terminal backpressure test MTU safe
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 20:48:50 -04:00
DuProcess 5dceb2792d Decouple terminal rendering from transport
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 20:47:42 -04:00
DuProcess 58ac974fe2 Harden Windows terminal byte handling
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 20:33:44 -04:00
DuProcess 0cdcaaaec1 Release v1.0.0-rc45
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
2026-07-17 20:13:08 -04:00
DuProcess 9245c666af Bound reliable stream bursts for terminal fairness
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 20:08:39 -04:00
DuProcess af11ab889e Keep large file regression test fast
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 20:03:05 -04:00
DuProcess 43a7a69b9b Keep reliable stream packets below path MTU
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 20:01:12 -04:00
DuProcess 86a1942aa0 Trace terminal loop failures
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 19:55:16 -04:00
DuProcess 7a9ad38657 Surface service forwarder failures
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 19:52:19 -04:00
DuProcess 9cec63aeb5 Trace forwarded stream lifecycles
ci / test (push) Canceled after 0s
ci / fuzz-smoke (push) Canceled after 0s
ci / macos-client (macos-aarch64, macos-14) (push) Canceled after 0s
ci / macos-client (macos-x86_64, macos-13) (push) Canceled after 0s
ci / windows-client (push) Canceled after 0s
ci / package-release (linux-x86_64, ubuntu-latest, , , ) (push) Canceled after 0s
ci / package-release (macos-aarch64, macos-14, , , ) (push) Canceled after 0s
ci / package-release (macos-x86_64, macos-13, , , ) (push) Canceled after 0s
ci / package-release (windows-aarch64, windows-latest, aarch64, windows, aarch64-pc-windows-msvc) (push) Canceled after 0s
ci / package-release (windows-x86_64, windows-latest, , , ) (push) Canceled after 0s
ci / remote-bench (push) Canceled after 0s
ci / publish-gitea-release (push) Canceled after 0s
2026-07-17 19:50:49 -04:00
7 changed files with 988 additions and 111 deletions
Generated
+1 -1
View File
@@ -436,7 +436,7 @@ dependencies = [
[[package]] [[package]]
name = "dosh" name = "dosh"
version = "1.0.0-rc44" version = "1.0.0-rc46"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"base64", "base64",
+1 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "dosh" name = "dosh"
version = "1.0.0-rc44" version = "1.0.0-rc46"
edition = "2024" edition = "2024"
license = "MIT" license = "MIT"
+324 -106
View File
@@ -67,7 +67,7 @@ use tokio::net::windows::named_pipe::{ClientOptions, NamedPipeClient};
use tokio::net::{TcpListener, TcpStream, UdpSocket}; use tokio::net::{TcpListener, TcpStream, UdpSocket};
use tokio::sync::mpsc; use tokio::sync::mpsc;
const STREAM_INITIAL_WINDOW: usize = 1024 * 1024; const STREAM_INITIAL_WINDOW: usize = dosh::transport::DEFAULT_INITIAL_WINDOW;
const STREAM_RETIRED_TOMBSTONES: usize = 16 * 1024; const STREAM_RETIRED_TOMBSTONES: usize = 16 * 1024;
const STREAM_CONTROL_RETRANSMIT_MAX_ATTEMPTS: u32 = 8; const STREAM_CONTROL_RETRANSMIT_MAX_ATTEMPTS: u32 = 8;
const MAX_PENDING_USER_INPUT_BYTES: usize = 1024 * 1024; const MAX_PENDING_USER_INPUT_BYTES: usize = 1024 * 1024;
@@ -486,22 +486,24 @@ async fn main() -> Result<()> {
detach_once(&socket, &cred, 2).await?; detach_once(&socket, &cred, 2).await?;
return Ok(()); return Ok(());
} }
return run_terminal( return trace_terminal_result(
socket, run_terminal(
cred, socket,
Some(target_udp_addr), cred,
Some(frame), Some(target_udp_addr),
predict, Some(frame),
predict_mode, predict,
escape_key, predict_mode,
startup_command, escape_key,
config.reconnect_timeout_secs, startup_command,
Vec::new(), config.reconnect_timeout_secs,
Vec::new(), Vec::new(),
false, Vec::new(),
None, false,
) None,
.await; )
.await,
);
} }
Err(err) => { Err(err) => {
log_debug( log_debug(
@@ -525,22 +527,24 @@ async fn main() -> Result<()> {
detach_once(&socket, &cred, 2).await?; detach_once(&socket, &cred, 2).await?;
return Ok(()); return Ok(());
} }
return run_terminal( return trace_terminal_result(
socket, run_terminal(
cred, socket,
Some(target_udp_addr), cred,
Some(frame), Some(target_udp_addr),
predict, Some(frame),
predict_mode, predict,
escape_key, predict_mode,
startup_command, escape_key,
config.reconnect_timeout_secs, startup_command,
Vec::new(), config.reconnect_timeout_secs,
Vec::new(), Vec::new(),
false, Vec::new(),
None, false,
) None,
.await; )
.await,
);
} }
Err(err) => { Err(err) => {
log_debug( log_debug(
@@ -601,22 +605,24 @@ async fn main() -> Result<()> {
detach_once(&socket, &cred, 2).await?; detach_once(&socket, &cred, 2).await?;
return Ok(()); return Ok(());
} }
return run_terminal( return trace_terminal_result(
socket, run_terminal(
cred, socket,
Some(addr), cred,
Some(frame), Some(addr),
predict, Some(frame),
predict_mode, predict,
escape_key, predict_mode,
startup_command, escape_key,
config.reconnect_timeout_secs, startup_command,
local_forwards, config.reconnect_timeout_secs,
dynamic_forwards, local_forwards,
args.forward_only, dynamic_forwards,
agent_sock, args.forward_only,
) agent_sock,
.await; )
.await,
);
} }
Err(err) if !forwarding_requested && auth_allows(&auth_preference, "ssh") => { Err(err) if !forwarding_requested && auth_allows(&auth_preference, "ssh") => {
log_debug( log_debug(
@@ -680,22 +686,24 @@ async fn main() -> Result<()> {
detach_once(&socket, &cred, 2).await?; detach_once(&socket, &cred, 2).await?;
return Ok(()); return Ok(());
} }
run_terminal( trace_terminal_result(
socket, run_terminal(
cred, socket,
Some(target_udp_addr), cred,
Some(first), Some(target_udp_addr),
predict, Some(first),
predict_mode, predict,
escape_key, predict_mode,
startup_command, escape_key,
config.reconnect_timeout_secs, startup_command,
Vec::new(), config.reconnect_timeout_secs,
Vec::new(), Vec::new(),
false, Vec::new(),
None, false,
None,
)
.await,
) )
.await
} }
fn run_trust_command(config: &dosh::config::ClientConfig, args: &Args) -> Result<()> { fn run_trust_command(config: &dosh::config::ClientConfig, args: &Args) -> Result<()> {
@@ -2380,8 +2388,21 @@ struct FileForwarder {
impl Drop for FileForwarder { impl Drop for FileForwarder {
fn drop(&mut self) { fn drop(&mut self) {
let _ = self.child.kill(); let exited = self.child.try_wait().ok().flatten();
let _ = self.child.wait(); if exited.is_none() {
let _ = self.child.kill();
let _ = self.child.wait();
return;
}
if exited.is_some_and(|status| !status.success()) {
let mut stderr = String::new();
if let Some(mut pipe) = self.child.stderr.take() {
let _ = pipe.read_to_string(&mut stderr);
}
if !stderr.trim().is_empty() {
eprintln!("Dosh service forwarder failed:\n{}", stderr.trim_end());
}
}
} }
} }
@@ -6482,6 +6503,13 @@ fn terminal_input_channel() -> (mpsc::Sender<Vec<u8>>, mpsc::Receiver<Vec<u8>>)
mpsc::channel(STDIN_QUEUE_CAPACITY) mpsc::channel(STDIN_QUEUE_CAPACITY)
} }
fn trace_terminal_result(result: Result<()>) -> Result<()> {
if let Err(err) = &result {
dosh::trace::event("client.terminal_error", &[("error", format!("{err:#}"))]);
}
result
}
#[allow(clippy::too_many_arguments)] #[allow(clippy::too_many_arguments)]
async fn run_terminal( async fn run_terminal(
socket: UdpSocket, socket: UdpSocket,
@@ -6532,6 +6560,7 @@ async fn run_terminal(
let mut winch = let mut winch =
tokio::signal::unix::signal(tokio::signal::unix::SignalKind::window_change()).ok(); tokio::signal::unix::signal(tokio::signal::unix::SignalKind::window_change()).ok();
let mut frame_buffer = FrameBuffer::default(); let mut frame_buffer = FrameBuffer::default();
let mut accepted_output_seq = cred.last_rendered_seq;
// Resolve the prediction display policy (off / experimental / always). An // Resolve the prediction display policy (off / experimental / always). An
// env var wins for ad-hoc tuning; otherwise the client config's // env var wins for ad-hoc tuning; otherwise the client config's
// `predict_mode` provides the persistent default. Predictions only run in a // `predict_mode` provides the persistent default. Predictions only run in a
@@ -6540,6 +6569,7 @@ async fn run_terminal(
predict && cred.mode != "view-only" && !forward_only, predict && cred.mode != "view-only" && !forward_only,
predict_mode, predict_mode,
); );
let mut frame_renderer = TerminalFrameRenderer::new()?;
// Non-destructive disconnect status line. Off in forward-only mode (no TTY to // Non-destructive disconnect status line. Off in forward-only mode (no TTY to
// draw on) and respecting the client config (default on, env override). // draw on) and respecting the client config (default on, env override).
let mut disconnect_status = DisconnectStatus::new(resolve_disconnect_status() && !forward_only); let mut disconnect_status = DisconnectStatus::new(resolve_disconnect_status() && !forward_only);
@@ -6645,10 +6675,28 @@ async fn run_terminal(
let mut recv_buf = vec![0u8; 65535]; let mut recv_buf = vec![0u8; 65535];
let mut detach_requested = false; let mut detach_requested = false;
loop { loop {
accepted_output_seq = accepted_output_seq.max(cred.last_rendered_seq);
predictor.set_output_backpressured(frame_renderer.has_pending());
if detach_requested { if detach_requested {
break; break;
} }
tokio::select! { tokio::select! {
rendered = frame_renderer.recv(), if frame_renderer.has_pending() => {
let frame = rendered?;
predictor.set_output_backpressured(frame_renderer.has_pending());
cred.last_rendered_seq = cred.last_rendered_seq.max(frame.output_seq);
note_snapshot_rendered(
&frame,
&mut disconnect_status,
&mut status_restore_pending,
);
last_terminal_frame_at = Instant::now();
wake_repaint_retry_until = None;
send_ack(&socket, addr, &cred, &mut send_seq).await?;
if frame.closed {
return Ok(());
}
}
stdin_msg = stdin_rx.recv() => { stdin_msg = stdin_rx.recv() => {
match stdin_msg { match stdin_msg {
Some(mut bytes) => { Some(mut bytes) => {
@@ -6672,7 +6720,8 @@ async fn run_terminal(
forward_only, forward_only,
input_status_tick_gap, input_status_tick_gap,
last_packet_at.elapsed(), last_packet_at.elapsed(),
) { ) && !frame_renderer.has_pending()
{
let reconnect_started_at = Instant::now(); let reconnect_started_at = Instant::now();
if let Some(deadline) = if let Some(deadline) =
wake_repaint_retry_deadline(reconnect_started_at, input_status_tick_gap) wake_repaint_retry_deadline(reconnect_started_at, input_status_tick_gap)
@@ -6736,6 +6785,7 @@ async fn run_terminal(
let saw_focus_in = input_contains_focus_in(&bytes); let saw_focus_in = input_contains_focus_in(&bytes);
if !forward_only if !forward_only
&& !refreshed_before_input && !refreshed_before_input
&& !frame_renderer.has_pending()
&& saw_focus_in && saw_focus_in
&& last_focus_repaint_at.elapsed() >= FOCUS_REPAINT_COOLDOWN && last_focus_repaint_at.elapsed() >= FOCUS_REPAINT_COOLDOWN
{ {
@@ -6969,7 +7019,8 @@ async fn run_terminal(
&mut pending_user_input_bytes, &mut pending_user_input_bytes,
bytes, bytes,
)?; )?;
if let Some(frame) = reconnect( if !frame_renderer.has_pending()
&& let Some(frame) = reconnect(
&socket, &socket,
&mut cred, &mut cred,
&mut send_seq, &mut send_seq,
@@ -7047,7 +7098,8 @@ async fn run_terminal(
maybe_send_resize(&socket, addr, &cred, &mut send_seq, &mut last_size).await?; maybe_send_resize(&socket, addr, &cred, &mut send_seq, &mut last_size).await?;
} }
_ = frame_gap_tick.tick() => { _ = frame_gap_tick.tick() => {
if frame_buffer.resync_due() if !frame_renderer.has_pending()
&& frame_buffer.resync_due()
&& let Some(frame) = reconnect( && let Some(frame) = reconnect(
&socket, &socket,
&mut cred, &mut cred,
@@ -7110,6 +7162,9 @@ async fn run_terminal(
} }
}); });
let Ok(plain) = decrypted else { let Ok(plain) = decrypted else {
if frame_renderer.has_pending() {
continue;
}
if let Some(frame) = reconnect( if let Some(frame) = reconnect(
&socket, &socket,
&mut cred, &mut cred,
@@ -7157,19 +7212,15 @@ async fn run_terminal(
continue; continue;
}; };
last_packet_at = Instant::now(); last_packet_at = Instant::now();
let frames = frame_buffer.accept(frame, &mut cred.last_rendered_seq); let frames = frame_buffer.accept(frame, &mut accepted_output_seq);
for frame in frames { for frame in frames {
predictor.clear_pending()?; predictor.clear_pending()?;
if !forward_only { if !forward_only {
render_frame(&frame)?;
note_snapshot_rendered(
&frame,
&mut disconnect_status,
&mut status_restore_pending,
);
predictor.observe_output(&frame.bytes); predictor.observe_output(&frame.bytes);
last_terminal_frame_at = Instant::now(); last_terminal_frame_at = Instant::now();
wake_repaint_retry_until = None; wake_repaint_retry_until = None;
frame_renderer.enqueue(frame)?;
predictor.set_output_backpressured(true);
flush_startup_input_if_ready( flush_startup_input_if_ready(
&socket, &socket,
addr, addr,
@@ -7181,12 +7232,15 @@ async fn run_terminal(
) )
.await?; .await?;
} }
if frame.closed { else if frame.closed {
send_ack(&socket, addr, &cred, &mut send_seq).await?; send_ack(&socket, addr, &cred, &mut send_seq).await?;
return Ok(()); return Ok(());
} }
} }
send_ack(&socket, addr, &cred, &mut send_seq).await?; if forward_only {
cred.last_rendered_seq = accepted_output_seq;
send_ack(&socket, addr, &cred, &mut send_seq).await?;
}
} }
PacketKind::Pong => { PacketKind::Pong => {
if protocol::decrypt_body( if protocol::decrypt_body(
@@ -7274,7 +7328,7 @@ async fn run_terminal(
} }
PacketKind::AttachReject => { PacketKind::AttachReject => {
let reject: AttachReject = protocol::from_body(&packet.body)?; let reject: AttachReject = protocol::from_body(&packet.body)?;
if reject.reason == "unknown client" { if reject.reason == "unknown client" && !frame_renderer.has_pending() {
if let Some(frame) = reconnect( if let Some(frame) = reconnect(
&socket, &socket,
&mut cred, &mut cred,
@@ -7500,6 +7554,10 @@ async fn run_terminal(
let Ok(ok) = protocol::from_body::<StreamOpenOk>(&plain) else { let Ok(ok) = protocol::from_body::<StreamOpenOk>(&plain) else {
continue; continue;
}; };
dosh::trace::event(
"client.stream_open_ok",
&[("stream", ok.stream_id.to_string())],
);
last_packet_at = Instant::now(); last_packet_at = Instant::now();
let Some(pending_open) = stream_pending_opens.remove(&ok.stream_id) else { let Some(pending_open) = stream_pending_opens.remove(&ok.stream_id) else {
continue; continue;
@@ -7549,6 +7607,13 @@ async fn run_terminal(
let Ok(reject) = protocol::from_body::<StreamOpenReject>(&plain) else { let Ok(reject) = protocol::from_body::<StreamOpenReject>(&plain) else {
continue; continue;
}; };
dosh::trace::event(
"client.stream_open_reject",
&[
("stream", reject.stream_id.to_string()),
("reason", reject.reason.clone()),
],
);
last_packet_at = Instant::now(); last_packet_at = Instant::now();
stream_pending_opens.remove(&reject.stream_id); stream_pending_opens.remove(&reject.stream_id);
if pending_socks_replies.remove(&reject.stream_id) if pending_socks_replies.remove(&reject.stream_id)
@@ -7658,6 +7723,10 @@ async fn run_terminal(
let Ok(eof) = protocol::from_body::<StreamEof>(&plain) else { let Ok(eof) = protocol::from_body::<StreamEof>(&plain) else {
continue; continue;
}; };
dosh::trace::event(
"client.stream_eof_received",
&[("stream", eof.stream_id.to_string())],
);
last_packet_at = Instant::now(); last_packet_at = Instant::now();
if !opened_streams.contains(&eof.stream_id) { if !opened_streams.contains(&eof.stream_id) {
continue; continue;
@@ -7703,6 +7772,10 @@ async fn run_terminal(
let Ok(close) = protocol::from_body::<StreamClose>(&plain) else { let Ok(close) = protocol::from_body::<StreamClose>(&plain) else {
continue; continue;
}; };
dosh::trace::event(
"client.stream_close_received",
&[("stream", close.stream_id.to_string())],
);
last_packet_at = Instant::now(); last_packet_at = Instant::now();
pending_socks_replies.remove(&close.stream_id); pending_socks_replies.remove(&close.stream_id);
stream_close_retransmit.remove(&close.stream_id); stream_close_retransmit.remove(&close.stream_id);
@@ -7732,6 +7805,13 @@ async fn run_terminal(
forward_event = forward_rx.recv() => { forward_event = forward_rx.recv() => {
match forward_event { match forward_event {
Some(ForwardEvent::Open { stream_id, target_host, target_port, writer, socks5_reply }) => { Some(ForwardEvent::Open { stream_id, target_host, target_port, writer, socks5_reply }) => {
dosh::trace::event(
"client.forward_open",
&[
("stream", stream_id.to_string()),
("target", format!("{target_host}:{target_port}")),
],
);
stream_writers.insert(stream_id, writer); stream_writers.insert(stream_id, writer);
stream_send_credit.insert(stream_id, STREAM_INITIAL_WINDOW); stream_send_credit.insert(stream_id, STREAM_INITIAL_WINDOW);
stream_next_send_offset.entry(stream_id).or_insert(0); stream_next_send_offset.entry(stream_id).or_insert(0);
@@ -7772,6 +7852,10 @@ async fn run_terminal(
).await?; ).await?;
} }
Some(ForwardEvent::Eof { stream_id }) => { Some(ForwardEvent::Eof { stream_id }) => {
dosh::trace::event(
"client.forward_eof",
&[("stream", stream_id.to_string())],
);
stream_local_eof_sent.insert(stream_id); stream_local_eof_sent.insert(stream_id);
if opened_streams.contains(&stream_id) { if opened_streams.contains(&stream_id) {
send_stream_eof(&socket, addr, &cred, &mut send_seq, stream_id).await?; send_stream_eof(&socket, addr, &cred, &mut send_seq, stream_id).await?;
@@ -7811,6 +7895,10 @@ async fn run_terminal(
} }
} }
Some(ForwardEvent::Close { stream_id }) => { Some(ForwardEvent::Close { stream_id }) => {
dosh::trace::event(
"client.forward_close",
&[("stream", stream_id.to_string())],
);
pending_socks_replies.remove(&stream_id); pending_socks_replies.remove(&stream_id);
retire_stream_state( retire_stream_state(
stream_id, stream_id,
@@ -7856,8 +7944,9 @@ async fn run_terminal(
} }
let mut repainted_this_tick = false; let mut repainted_this_tick = false;
let stale = last_packet_at.elapsed(); let stale = last_packet_at.elapsed();
if status_restore_pending if !frame_renderer.has_pending()
|| stale >= Duration::from_secs(reconnect_timeout_secs.max(1)) && (status_restore_pending
|| stale >= Duration::from_secs(reconnect_timeout_secs.max(1)))
{ {
if let Some(frame) = reconnect( if let Some(frame) = reconnect(
&socket, &socket,
@@ -7915,7 +8004,9 @@ async fn run_terminal(
// a latency spike (or recovery) flips speculation on/off promptly // a latency spike (or recovery) flips speculation on/off promptly
// without waiting for the next keystroke to drive `redraw`. // without waiting for the next keystroke to drive `redraw`.
if !forward_only { if !forward_only {
predictor.refresh_policy()?; if !frame_renderer.has_pending() {
predictor.refresh_policy()?;
}
flush_startup_input_if_ready( flush_startup_input_if_ready(
&socket, &socket,
addr, addr,
@@ -7927,7 +8018,7 @@ async fn run_terminal(
) )
.await?; .await?;
let now = Instant::now(); let now = Instant::now();
if !repainted_this_tick && should_repaint_idle_terminal( if !repainted_this_tick && !frame_renderer.has_pending() && should_repaint_idle_terminal(
predictor.alternate_screen, predictor.alternate_screen,
last_terminal_frame_at, last_terminal_frame_at,
last_idle_repaint_attempt_at, last_idle_repaint_attempt_at,
@@ -7985,7 +8076,7 @@ async fn run_terminal(
// on how long the link has been silent (recomputed after any // on how long the link has been silent (recomputed after any
// reconnect attempt above may have reset `last_packet_at`). // reconnect attempt above may have reset `last_packet_at`).
if !forward_only { if !forward_only {
let action = if predictor.alternate_screen { let action = if predictor.alternate_screen || frame_renderer.has_pending() {
disconnect_status.on_suppressed() disconnect_status.on_suppressed()
} else { } else {
disconnect_status.on_tick(last_packet_at.elapsed()) disconnect_status.on_tick(last_packet_at.elapsed())
@@ -9685,6 +9776,9 @@ struct PredictedCell {
struct Predictor { struct Predictor {
mode: PredictMode, mode: PredictMode,
enabled: bool, enabled: bool,
/// Suppress local display writes while authoritative output is waiting on a
/// slow terminal renderer. Input prediction state is still maintained.
output_backpressured: bool,
/// True while the server is in the alternate screen (a full-screen TUI such /// True while the server is in the alternate screen (a full-screen TUI such
/// as vim/htop); we never speculate there because we cannot model arbitrary /// as vim/htop); we never speculate there because we cannot model arbitrary
/// cursor addressing safely. /// cursor addressing safely.
@@ -9741,6 +9835,7 @@ impl Predictor {
Self { Self {
mode, mode,
enabled: enabled && mode != PredictMode::Off, enabled: enabled && mode != PredictMode::Off,
output_backpressured: false,
alternate_screen: false, alternate_screen: false,
mouse_tracking: TerminalMouseMode::None, mouse_tracking: TerminalMouseMode::None,
output_parse_tail: Vec::new(), output_parse_tail: Vec::new(),
@@ -10005,6 +10100,9 @@ impl Predictor {
/// Whether we should *display* predictions right now under the active policy. /// Whether we should *display* predictions right now under the active policy.
fn should_display(&self) -> bool { fn should_display(&self) -> bool {
if self.output_backpressured {
return false;
}
match self.mode { match self.mode {
PredictMode::Off => false, PredictMode::Off => false,
PredictMode::Always => true, PredictMode::Always => true,
@@ -10023,6 +10121,10 @@ impl Predictor {
} }
} }
fn set_output_backpressured(&mut self, value: bool) {
self.output_backpressured = value;
}
/// Update the SRTT/flag hysteresis latches from the current estimate. /// Update the SRTT/flag hysteresis latches from the current estimate.
fn update_triggers(&mut self) { fn update_triggers(&mut self) {
let srtt = self.srtt_ms.unwrap_or(0.0); let srtt = self.srtt_ms.unwrap_or(0.0);
@@ -10438,6 +10540,80 @@ async fn detach_once(socket: &UdpSocket, cred: &CachedCredential, seq: u64) -> R
Ok(()) Ok(())
} }
const TERMINAL_RENDER_QUEUE_CAPACITY: usize = 256;
/// Keeps potentially slow console writes off the UDP event loop. Frame ACKs are
/// emitted only after `recv` reports completion, so the server never retires
/// output that has merely been queued locally rather than displayed.
struct TerminalFrameRenderer {
jobs: Option<mpsc::Sender<Frame>>,
completed: mpsc::UnboundedReceiver<Result<Frame, String>>,
pending: usize,
thread: Option<std::thread::JoinHandle<()>>,
}
impl TerminalFrameRenderer {
fn new() -> Result<Self> {
let (job_tx, mut job_rx) = mpsc::channel::<Frame>(TERMINAL_RENDER_QUEUE_CAPACITY);
let (completed_tx, completed_rx) = mpsc::unbounded_channel();
let thread = std::thread::Builder::new()
.name("dosh-terminal-render".to_string())
.spawn(move || {
while let Some(frame) = job_rx.blocking_recv() {
let result = render_frame(&frame)
.map(|()| frame)
.map_err(|err| format!("render terminal frame: {err:#}"));
if completed_tx.send(result).is_err() {
break;
}
}
})?;
Ok(Self {
jobs: Some(job_tx),
completed: completed_rx,
pending: 0,
thread: Some(thread),
})
}
fn enqueue(&mut self, frame: Frame) -> Result<()> {
let Some(jobs) = self.jobs.as_ref() else {
return Err(anyhow!("terminal renderer is closed"));
};
jobs.try_send(frame).map_err(|err| match err {
mpsc::error::TrySendError::Full(_) => anyhow!(
"terminal renderer exceeded its bounded {}-frame queue",
TERMINAL_RENDER_QUEUE_CAPACITY
),
mpsc::error::TrySendError::Closed(_) => anyhow!("terminal renderer stopped"),
})?;
self.pending += 1;
Ok(())
}
fn has_pending(&self) -> bool {
self.pending > 0
}
async fn recv(&mut self) -> Result<Frame> {
let result =
self.completed.recv().await.ok_or_else(|| {
anyhow!("terminal renderer stopped before completing queued output")
})?;
self.pending = self.pending.saturating_sub(1);
result.map_err(anyhow::Error::msg)
}
}
impl Drop for TerminalFrameRenderer {
fn drop(&mut self) {
self.jobs.take();
if let Some(thread) = self.thread.take() {
let _ = thread.join();
}
}
}
fn render_frame(frame: &Frame) -> Result<()> { fn render_frame(frame: &Frame) -> Result<()> {
let mut stdout = std::io::stdout(); let mut stdout = std::io::stdout();
stdout.write_all(&render_frame_bytes(frame))?; stdout.write_all(&render_frame_bytes(frame))?;
@@ -10783,6 +10959,8 @@ fn windows_vt_input_mode(mode: u32) -> u32 {
struct WindowsConsoleModeGuard { struct WindowsConsoleModeGuard {
input: Option<(windows_sys::Win32::Foundation::HANDLE, u32)>, input: Option<(windows_sys::Win32::Foundation::HANDLE, u32)>,
output: Option<(windows_sys::Win32::Foundation::HANDLE, u32)>, output: Option<(windows_sys::Win32::Foundation::HANDLE, u32)>,
input_code_page: Option<u32>,
output_code_page: Option<u32>,
} }
#[cfg(windows)] #[cfg(windows)]
@@ -10791,51 +10969,91 @@ impl WindowsConsoleModeGuard {
unsafe { unsafe {
use windows_sys::Win32::Foundation::INVALID_HANDLE_VALUE; use windows_sys::Win32::Foundation::INVALID_HANDLE_VALUE;
use windows_sys::Win32::System::Console::{ use windows_sys::Win32::System::Console::{
GetConsoleMode, GetStdHandle, STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, SetConsoleMode, GetConsoleCP, GetConsoleMode, GetConsoleOutputCP, GetStdHandle, STD_INPUT_HANDLE,
STD_OUTPUT_HANDLE, SetConsoleCP, SetConsoleMode, SetConsoleOutputCP,
};
const CP_UTF8: u32 = 65001;
let mut guard = Self {
input: None,
output: None,
input_code_page: None,
output_code_page: None,
}; };
let input_handle = GetStdHandle(STD_INPUT_HANDLE); let input_handle = GetStdHandle(STD_INPUT_HANDLE);
let input = if input_handle.is_null() || input_handle == INVALID_HANDLE_VALUE { if !input_handle.is_null() && input_handle != INVALID_HANDLE_VALUE {
None
} else {
let mut original = 0u32; let mut original = 0u32;
if GetConsoleMode(input_handle, &mut original) == 0 { if GetConsoleMode(input_handle, &mut original) != 0 {
None
} else {
let desired = windows_vt_input_mode(original); let desired = windows_vt_input_mode(original);
if desired != original && SetConsoleMode(input_handle, desired) == 0 { if desired != original && SetConsoleMode(input_handle, desired) == 0 {
return Err(std::io::Error::last_os_error()) return Err(std::io::Error::last_os_error())
.context("enable Windows virtual-terminal input mode"); .context("enable Windows virtual-terminal input mode");
} }
Some((input_handle, original)) guard.input = Some((input_handle, original));
let original_code_page = GetConsoleCP();
if original_code_page == 0 {
let err = std::io::Error::last_os_error();
guard.restore();
return Err(err).context("read Windows console input code page");
}
guard.input_code_page = Some(original_code_page);
if original_code_page != CP_UTF8 && SetConsoleCP(CP_UTF8) == 0 {
let err = std::io::Error::last_os_error();
guard.restore();
return Err(err).context("set Windows console input to UTF-8");
}
} }
}; }
let output_handle = GetStdHandle(STD_OUTPUT_HANDLE); let output_handle = GetStdHandle(STD_OUTPUT_HANDLE);
let output = if output_handle.is_null() || output_handle == INVALID_HANDLE_VALUE { if !output_handle.is_null() && output_handle != INVALID_HANDLE_VALUE {
None
} else {
let mut original = 0u32; let mut original = 0u32;
if GetConsoleMode(output_handle, &mut original) == 0 { if GetConsoleMode(output_handle, &mut original) != 0 {
None
} else {
let desired = windows_vt_output_mode(original); let desired = windows_vt_output_mode(original);
if desired != original && SetConsoleMode(output_handle, desired) == 0 { if desired != original && SetConsoleMode(output_handle, desired) == 0 {
let err = std::io::Error::last_os_error(); let err = std::io::Error::last_os_error();
if let Some((handle, mode)) = input { guard.restore();
let _ = SetConsoleMode(handle, mode);
}
return Err(err).context("enable Windows virtual-terminal output mode"); return Err(err).context("enable Windows virtual-terminal output mode");
} }
Some((output_handle, original)) guard.output = Some((output_handle, original));
}
};
Ok(Self { input, output }) let original_code_page = GetConsoleOutputCP();
if original_code_page == 0 {
let err = std::io::Error::last_os_error();
guard.restore();
return Err(err).context("read Windows console output code page");
}
guard.output_code_page = Some(original_code_page);
if original_code_page != CP_UTF8 && SetConsoleOutputCP(CP_UTF8) == 0 {
let err = std::io::Error::last_os_error();
guard.restore();
return Err(err).context("set Windows console output to UTF-8");
}
}
}
Ok(guard)
} }
} }
fn restore(&self) { fn restore(&self) {
if let Some(code_page) = self.output_code_page {
unsafe {
use windows_sys::Win32::System::Console::SetConsoleOutputCP;
let _ = SetConsoleOutputCP(code_page);
}
}
if let Some(code_page) = self.input_code_page {
unsafe {
use windows_sys::Win32::System::Console::SetConsoleCP;
let _ = SetConsoleCP(code_page);
}
}
if let Some((handle, mode)) = self.input { if let Some((handle, mode)) = self.input {
unsafe { unsafe {
use windows_sys::Win32::System::Console::SetConsoleMode; use windows_sys::Win32::System::Console::SetConsoleMode;
+38 -1
View File
@@ -48,7 +48,7 @@ use tokio::net::{TcpListener, TcpStream, UdpSocket, UnixListener};
use tokio::process::Command as TokioCommand; use tokio::process::Command as TokioCommand;
use tokio::sync::mpsc; use tokio::sync::mpsc;
const STREAM_INITIAL_WINDOW: usize = 1024 * 1024; const STREAM_INITIAL_WINDOW: usize = dosh::transport::DEFAULT_INITIAL_WINDOW;
const STREAM_RETIRED_TOMBSTONES: usize = 16 * 1024; const STREAM_RETIRED_TOMBSTONES: usize = 16 * 1024;
const STREAM_CONTROL_RETRANSMIT_MAX_ATTEMPTS: u32 = 8; const STREAM_CONTROL_RETRANSMIT_MAX_ATTEMPTS: u32 = 8;
@@ -2089,6 +2089,14 @@ async fn handle_stream_open(
} }
if open.target_host == FILE_STREAM_SENTINEL { if open.target_host == FILE_STREAM_SENTINEL {
dosh::trace::event(
"server.file_stream_open",
&[
("session", session_name.clone()),
("stream", open.stream_id.to_string()),
("peer", peer.to_string()),
],
);
let (writer_tx, writer_rx) = mpsc::channel::<Vec<u8>>(1024); let (writer_tx, writer_rx) = mpsc::channel::<Vec<u8>>(1024);
register_opened_stream( register_opened_stream(
state, state,
@@ -2113,6 +2121,7 @@ async fn handle_stream_open(
) )
.await .await
{ {
eprintln!("file service stream {stream_id} failed: {err:#}");
let _ = send_file_response_to_client( let _ = send_file_response_to_client(
&state, &state,
&socket, &socket,
@@ -2464,6 +2473,14 @@ async fn handle_stream_eof(
let (key, session_name) = find_client_decrypt_key(state, &packet.header)?; let (key, session_name) = find_client_decrypt_key(state, &packet.header)?;
let body = protocol::decrypt_body(packet, &key, CLIENT_TO_SERVER)?; let body = protocol::decrypt_body(packet, &key, CLIENT_TO_SERVER)?;
let eof: StreamEof = protocol::from_body(&body)?; let eof: StreamEof = protocol::from_body(&body)?;
dosh::trace::event(
"server.stream_eof_received",
&[
("session", session_name.clone()),
("stream", eof.stream_id.to_string()),
("peer", peer.to_string()),
],
);
let mut locked = state.lock().expect("server state poisoned"); let mut locked = state.lock().expect("server state poisoned");
let Some(session) = locked.sessions.get_mut(&session_name) else { let Some(session) = locked.sessions.get_mut(&session_name) else {
return Ok(()); return Ok(());
@@ -2495,6 +2512,14 @@ async fn handle_stream_close(
let (key, session_name) = find_client_decrypt_key(state, &packet.header)?; let (key, session_name) = find_client_decrypt_key(state, &packet.header)?;
let body = protocol::decrypt_body(packet, &key, CLIENT_TO_SERVER)?; let body = protocol::decrypt_body(packet, &key, CLIENT_TO_SERVER)?;
let close: StreamClose = protocol::from_body(&body)?; let close: StreamClose = protocol::from_body(&body)?;
dosh::trace::event(
"server.stream_close_received",
&[
("session", session_name.clone()),
("stream", close.stream_id.to_string()),
("peer", peer.to_string()),
],
);
let mut locked = state.lock().expect("server state poisoned"); let mut locked = state.lock().expect("server state poisoned");
let Some(session) = locked.sessions.get_mut(&session_name) else { let Some(session) = locked.sessions.get_mut(&session_name) else {
return Ok(()); return Ok(());
@@ -2887,6 +2912,7 @@ async fn run_file_stream_service(
) )
.await .await
{ {
eprintln!("file service request on stream {stream_id} failed: {err:#}");
send_file_response_to_client( send_file_response_to_client(
&state, &state,
&socket, &socket,
@@ -2900,6 +2926,10 @@ async fn run_file_stream_service(
} }
} }
} }
dosh::trace::event(
"server.file_stream_input_closed",
&[("stream", stream_id.to_string())],
);
Ok(()) Ok(())
} }
@@ -3817,6 +3847,13 @@ async fn send_stream_close_to_client(
client_id: [u8; 16], client_id: [u8; 16],
stream_id: u64, stream_id: u64,
) -> Result<()> { ) -> Result<()> {
dosh::trace::event(
"server.stream_close_sent",
&[
("stream", stream_id.to_string()),
("client", hex_id(client_id)),
],
);
{ {
let mut locked = state.lock().expect("server state poisoned"); let mut locked = state.lock().expect("server state poisoned");
if let Some(client) = locked.client_mut(&client_id) { if let Some(client) = locked.client_mut(&client_id) {
+33 -2
View File
@@ -31,7 +31,10 @@ use std::sync::Arc;
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use tokio::net::UdpSocket; use tokio::net::UdpSocket;
pub const DEFAULT_INITIAL_WINDOW: usize = 1024 * 1024; /// Per-stream bytes allowed in flight before window credit returns. This bounds
/// each sender burst to 64 MTU-safe packets so bulk streams cannot starve the
/// terminal while retaining useful bandwidth on high-latency links.
pub const DEFAULT_INITIAL_WINDOW: usize = 64 * 1024;
pub const DEFAULT_RETRANSMIT_AFTER: Duration = Duration::from_millis(200); pub const DEFAULT_RETRANSMIT_AFTER: Duration = Duration::from_millis(200);
pub const ADAPTIVE_RETRANSMIT_PAD: Duration = Duration::from_millis(10); pub const ADAPTIVE_RETRANSMIT_PAD: Duration = Duration::from_millis(10);
pub const ADAPTIVE_RETRANSMIT_MIN: Duration = Duration::from_millis(10); pub const ADAPTIVE_RETRANSMIT_MIN: Duration = Duration::from_millis(10);
@@ -39,7 +42,10 @@ pub const DEFAULT_KEEPALIVE_AFTER: Duration = Duration::from_secs(2);
pub const DEFAULT_RETIRED_STREAM_TOMBSTONES: usize = 16 * 1024; pub const DEFAULT_RETIRED_STREAM_TOMBSTONES: usize = 16 * 1024;
pub const STREAM_CONTROL_RETRANSMIT_MAX_ATTEMPTS: u32 = 8; pub const STREAM_CONTROL_RETRANSMIT_MAX_ATTEMPTS: u32 = 8;
pub const SERVICE_TARGET_PREFIX: &str = "@dosh-"; pub const SERVICE_TARGET_PREFIX: &str = "@dosh-";
pub const MAX_STREAM_DATA_BYTES: usize = 60 * 1024; /// Maximum application bytes in one encrypted UDP stream packet. Keeping this
/// aligned with terminal output framing avoids IP fragmentation and stays
/// below macOS route MTUs after Dosh, AEAD, UDP, and IP overhead.
pub const MAX_STREAM_DATA_BYTES: usize = 1024;
#[derive(Debug, Clone, PartialEq, Eq)] #[derive(Debug, Clone, PartialEq, Eq)]
pub struct TransportConfig { pub struct TransportConfig {
@@ -1675,6 +1681,31 @@ mod tests {
assert_eq!(third.bytes.len(), 13); assert_eq!(third.bytes.len(), 13);
} }
#[test]
fn maximum_stream_chunk_fits_a_safe_udp_datagram() {
let body = protocol::to_body(&StreamData {
stream_id: u64::MAX,
offset: u64::MAX,
bytes: vec![0xff; MAX_STREAM_DATA_BYTES],
})
.unwrap();
let packet = protocol::encode_encrypted(
PacketKind::StreamData,
[0xff; 16],
u64::MAX,
u64::MAX,
&[0xff; 32],
CLIENT_TO_SERVER,
&body,
)
.unwrap();
assert!(
packet.len() <= 1200,
"encrypted stream datagram is {} bytes",
packet.len()
);
}
#[test] #[test]
fn queued_large_write_flushes_in_window_sized_chunks_after_open() { fn queued_large_write_flushes_in_window_sized_chunks_after_open() {
let mut mux = StreamMux::new(TransportConfig { let mut mux = StreamMux::new(TransportConfig {
+585
View File
@@ -0,0 +1,585 @@
use dosh::config::ClientConfig;
use dosh::protocol::{self, CLIENT_TO_SERVER, Frame, Input, PacketKind, Resize, SERVER_TO_CLIENT};
use portable_pty::{CommandBuilder, NativePtySystem, PtySize, PtySystem};
use serde::Serialize;
use std::fs;
use std::io::{Read, Write};
use std::net::UdpSocket;
use std::path::Path;
use std::sync::{Arc, Mutex, mpsc};
use std::thread;
use std::time::{Duration, Instant};
const SESSION: &str = "terminal-parity";
const CLIENT_ID: [u8; 16] = [0x45; 16];
const SESSION_KEY: [u8; 32] = [0x91; 32];
const INPUT_BYTES: &[u8] = concat!(
"\x1b[A",
"\x1b[B",
"\x1b[200~",
"paste-λ-界",
"\x1b[201~",
"\x1b[<0;12;7M",
"\x1b[<0;12;7m"
)
.as_bytes();
const OUTPUT_CHUNKS: &[&[u8]] = &[
b"\x1b[3;4H\x1b[38;2;12;200;90mDOSH_GRAPH_\xe2",
b"\xa3\xbf\xe2\xa3",
b"\xb7\xe2\xa3\xa4_\xce",
b"\xbb_\xe7",
b"\x95\x8c\x1b[0m",
];
#[derive(Serialize)]
struct CachedCredentialWire {
server: String,
session: String,
mode: String,
udp_host: String,
udp_port: u16,
client_id: [u8; 16],
session_key: [u8; 32],
session_key_id: [u8; 16],
attach_ticket: Vec<u8>,
attach_ticket_psk: [u8; 32],
last_rendered_seq: u64,
}
#[derive(Debug)]
enum ServerObservation {
BulkSent,
Input(Vec<u8>),
Resize(u16, u16),
}
#[test]
fn native_client_terminal_round_trip_is_platform_complete() {
let dir = tempfile::tempdir().unwrap();
let home = dir.path().join("home");
let cache = dir.path().join("credentials");
fs::create_dir_all(home.join(".config/dosh")).unwrap();
fs::create_dir_all(&cache).unwrap();
let socket = UdpSocket::bind("127.0.0.1:0").unwrap();
socket
.set_read_timeout(Some(Duration::from_secs(8)))
.unwrap();
let port = socket.local_addr().unwrap().port();
write_client_fixture(&home, &cache, port);
let (observation_tx, observation_rx) = mpsc::channel();
let server = thread::spawn(move || run_fake_terminal_server(socket, observation_tx));
let pty = NativePtySystem::default();
let pair = pty
.openpty(PtySize {
rows: 24,
cols: 80,
pixel_width: 0,
pixel_height: 0,
})
.unwrap();
let mut reader = pair.master.try_clone_reader().unwrap();
let mut writer = pair.master.take_writer().unwrap();
let mut command = client_command(dir.path(), port);
command.env("HOME", home.to_string_lossy().to_string());
command.env("USERPROFILE", home.to_string_lossy().to_string());
command.env("APPDATA", home.to_string_lossy().to_string());
command.env("LOCALAPPDATA", home.to_string_lossy().to_string());
command.env("TERM", "xterm-256color");
command.env("COLORTERM", "truecolor");
let mut child = pair.slave.spawn_command(command).unwrap();
drop(pair.slave);
let output = Arc::new(Mutex::new(Vec::new()));
let reader_output = Arc::clone(&output);
let reader_thread = thread::spawn(move || {
let mut buf = [0u8; 4096];
loop {
match reader.read(&mut buf) {
Ok(0) | Err(_) => break,
Ok(n) => reader_output.lock().unwrap().extend_from_slice(&buf[..n]),
}
}
});
wait_for_output(&output, b"DOSH_PARITY_READY", Duration::from_secs(5));
wait_for_output(
&output,
"DOSH_GRAPH_⣿⣷⣤_λ_界".as_bytes(),
Duration::from_secs(5),
);
pair.master
.resize(PtySize {
rows: 31,
cols: 100,
pixel_width: 0,
pixel_height: 0,
})
.unwrap();
wait_for_resize(&observation_rx, (100, 31), Duration::from_secs(3));
writer.write_all(INPUT_BYTES).unwrap();
writer.flush().unwrap();
wait_for_input(&observation_rx, INPUT_BYTES, Duration::from_secs(3));
wait_for_output(&output, b"DOSH_PARITY_DONE", Duration::from_secs(5));
let status = child.wait().unwrap();
drop(writer);
drop(pair.master);
reader_thread.join().unwrap();
server.join().unwrap();
assert!(status.success(), "Dosh client exited with {status:?}");
let output = output.lock().unwrap();
assert!(
contains(&output, b"\x1b[38;2;12;200;90m"),
"true-color control sequence was not preserved: {output:?}"
);
assert!(
contains(&output, b"\x1b[?1049h"),
"alternate-screen mode was not preserved: {output:?}"
);
assert!(
contains(&output, b"\x1b[?1006h"),
"SGR mouse mode was not preserved: {output:?}"
);
assert!(
contains(&output, b"\x1b[?25h"),
"terminal cleanup did not restore the cursor: {output:?}"
);
#[cfg(windows)]
{
let code_page = fs::read(dir.path().join("restored-code-page.txt")).unwrap();
assert!(
contains(&code_page, b"437"),
"Dosh did not restore the original Windows console code page: {code_page:?}"
);
}
}
#[test]
fn terminal_output_backpressure_does_not_block_input_transport() {
const PROBE: &[u8] = b"DOSH_BACKPRESSURE_INPUT\r";
let dir = tempfile::tempdir().unwrap();
let home = dir.path().join("home");
let cache = dir.path().join("credentials");
fs::create_dir_all(home.join(".config/dosh")).unwrap();
fs::create_dir_all(&cache).unwrap();
let socket = UdpSocket::bind("127.0.0.1:0").unwrap();
socket
.set_read_timeout(Some(Duration::from_secs(8)))
.unwrap();
let port = socket.local_addr().unwrap().port();
write_client_fixture(&home, &cache, port);
let (observation_tx, observation_rx) = mpsc::channel();
let server = thread::spawn(move || run_backpressure_server(socket, observation_tx, PROBE));
let pty = NativePtySystem::default();
let pair = pty
.openpty(PtySize {
rows: 24,
cols: 80,
pixel_width: 0,
pixel_height: 0,
})
.unwrap();
let mut reader = pair.master.try_clone_reader().unwrap();
let mut writer = pair.master.take_writer().unwrap();
let mut command = client_command(dir.path(), port);
command.env("HOME", home.to_string_lossy().to_string());
command.env("USERPROFILE", home.to_string_lossy().to_string());
command.env("APPDATA", home.to_string_lossy().to_string());
command.env("LOCALAPPDATA", home.to_string_lossy().to_string());
command.env("TERM", "xterm-256color");
let mut child = pair.slave.spawn_command(command).unwrap();
drop(pair.slave);
wait_for_observation(&observation_rx, Duration::from_secs(5), |observation| {
matches!(observation, ServerObservation::BulkSent)
});
thread::sleep(Duration::from_millis(100));
writer.write_all(PROBE).unwrap();
writer.flush().unwrap();
wait_for_input(&observation_rx, PROBE, Duration::from_secs(2));
let reader_thread = thread::spawn(move || {
let mut buf = [0u8; 16 * 1024];
while let Ok(n) = reader.read(&mut buf) {
if n == 0 {
break;
}
}
});
let status = child.wait().unwrap();
drop(writer);
drop(pair.master);
reader_thread.join().unwrap();
server.join().unwrap();
assert!(status.success(), "Dosh client exited with {status:?}");
}
fn write_client_fixture(home: &Path, cache: &Path, port: u16) {
let config = ClientConfig {
server: "local".to_string(),
dosh_host: Some("127.0.0.1".to_string()),
dosh_port: port,
cache_attach_tickets: false,
credential_cache: cache.to_string_lossy().to_string(),
auth_preference: "ssh".to_string(),
predict: false,
predict_mode: "off".to_string(),
disconnect_status: false,
..ClientConfig::default()
};
fs::write(
home.join(".config/dosh/client.toml"),
toml::to_string(&config).unwrap(),
)
.unwrap();
let credential = CachedCredentialWire {
server: "local".to_string(),
session: SESSION.to_string(),
mode: "read-write".to_string(),
udp_host: "127.0.0.1".to_string(),
udp_port: port,
client_id: CLIENT_ID,
session_key: SESSION_KEY,
session_key_id: protocol::session_key_id(&SESSION_KEY),
attach_ticket: Vec::new(),
attach_ticket_psk: [0x33; 32],
last_rendered_seq: 9,
};
fs::write(
cache.join("local_terminal_parity_read_write.bin"),
bincode::serialize(&credential).unwrap(),
)
.unwrap();
}
fn client_command(_dir: &Path, port: u16) -> CommandBuilder {
let client = env!("CARGO_BIN_EXE_dosh-client");
let args = [
"--local-auth",
"--predict-never",
"--session",
SESSION,
"--dosh-host",
"127.0.0.1",
"--dosh-port",
&port.to_string(),
"local",
];
#[cfg(windows)]
{
let script = _dir.join("run-client.cmd");
let quoted_args = args
.iter()
.map(|arg| format!("\"{}\"", arg.replace('"', "\"\"")))
.collect::<Vec<_>>()
.join(" ");
fs::write(
&script,
format!(
"@echo off\r\nchcp 437 >nul\r\n\"{}\" {quoted_args}\r\nchcp > \"{}\"\r\n",
client.replace('"', "\"\""),
_dir.join("restored-code-page.txt").display()
),
)
.unwrap();
let mut command = CommandBuilder::new("cmd.exe");
command.args(["/d", "/c", &script.to_string_lossy()]);
command
}
#[cfg(not(windows))]
{
let mut command = CommandBuilder::new(client);
command.args(args);
command
}
}
fn run_fake_terminal_server(socket: UdpSocket, observations: mpsc::Sender<ServerObservation>) {
let mut peer = None;
let mut next_output_chunk = 0usize;
let mut received_input = Vec::new();
let mut buf = [0u8; 65535];
loop {
let (n, source) = socket.recv_from(&mut buf).unwrap();
let packet = protocol::decode(&buf[..n]).unwrap();
match packet.header.kind {
PacketKind::ResumeRequest => {
let plain =
protocol::decrypt_body(&packet, &SESSION_KEY, CLIENT_TO_SERVER).unwrap();
let request: protocol::ResumeRequest = protocol::from_body(&plain).unwrap();
assert_eq!(request.session, SESSION);
peer = Some(source);
send_frame(
&socket,
source,
PacketKind::ResumeOk,
1,
10,
concat!(
"\x1b[?1049h",
"\x1b[?1003h",
"\x1b[?1006h",
"\x1b[?2004h",
"\x1b[2J\x1b[H",
"DOSH_PARITY_READY"
)
.as_bytes(),
true,
false,
);
}
PacketKind::Ack if next_output_chunk < OUTPUT_CHUNKS.len() => {
let source = peer.unwrap_or(source);
send_frame(
&socket,
source,
PacketKind::Frame,
2 + next_output_chunk as u64,
11 + next_output_chunk as u64,
OUTPUT_CHUNKS[next_output_chunk],
false,
false,
);
next_output_chunk += 1;
}
PacketKind::Input => {
let plain =
protocol::decrypt_body(&packet, &SESSION_KEY, CLIENT_TO_SERVER).unwrap();
let input: Input = protocol::from_body(&plain).unwrap();
received_input.extend_from_slice(&input.bytes);
observations
.send(ServerObservation::Input(input.bytes))
.unwrap();
if contains(&received_input, INPUT_BYTES) {
send_frame(
&socket,
peer.unwrap_or(source),
PacketKind::Frame,
20,
16,
b"\x1b[?1003l\x1b[?1006l\x1b[?1049lDOSH_PARITY_DONE",
false,
true,
);
}
}
PacketKind::Resize => {
let plain =
protocol::decrypt_body(&packet, &SESSION_KEY, CLIENT_TO_SERVER).unwrap();
let resize: Resize = protocol::from_body(&plain).unwrap();
observations
.send(ServerObservation::Resize(resize.cols, resize.rows))
.unwrap();
}
PacketKind::Ping => {
let pong = protocol::encode_encrypted(
PacketKind::Pong,
CLIENT_ID,
4,
11,
&SESSION_KEY,
SERVER_TO_CLIENT,
b"",
)
.unwrap();
socket.send_to(&pong, source).unwrap();
}
PacketKind::Detach => break,
_ => {}
}
if received_input
.windows(INPUT_BYTES.len())
.any(|bytes| bytes == INPUT_BYTES)
{
break;
}
}
}
fn run_backpressure_server(
socket: UdpSocket,
observations: mpsc::Sender<ServerObservation>,
expected_input: &[u8],
) {
let mut peer = None;
let mut bulk_sent = false;
let mut received_input = Vec::new();
let mut buf = [0u8; 65535];
loop {
let (n, source) = socket.recv_from(&mut buf).unwrap();
let packet = protocol::decode(&buf[..n]).unwrap();
match packet.header.kind {
PacketKind::ResumeRequest => {
peer = Some(source);
send_frame(
&socket,
source,
PacketKind::ResumeOk,
1,
10,
b"DOSH_BACKPRESSURE_READY",
true,
false,
);
}
PacketKind::Ack if !bulk_sent => {
let bulk = [b'x'; 1024];
for index in 0..64u64 {
send_frame(
&socket,
peer.unwrap_or(source),
PacketKind::Frame,
2 + index,
11 + index,
&bulk,
false,
false,
);
}
send_frame(
&socket,
peer.unwrap_or(source),
PacketKind::Frame,
66,
75,
b"DOSH_BACKPRESSURE_DONE",
false,
true,
);
bulk_sent = true;
observations.send(ServerObservation::BulkSent).unwrap();
}
PacketKind::Input => {
let plain =
protocol::decrypt_body(&packet, &SESSION_KEY, CLIENT_TO_SERVER).unwrap();
let input: Input = protocol::from_body(&plain).unwrap();
received_input.extend_from_slice(&input.bytes);
observations
.send(ServerObservation::Input(input.bytes))
.unwrap();
if contains(&received_input, expected_input) {
break;
}
}
_ => {}
}
}
}
#[allow(clippy::too_many_arguments)]
fn send_frame(
socket: &UdpSocket,
peer: std::net::SocketAddr,
kind: PacketKind,
packet_seq: u64,
output_seq: u64,
bytes: &[u8],
snapshot: bool,
closed: bool,
) {
let frame = Frame {
session: SESSION.to_string(),
output_seq,
bytes: bytes.to_vec(),
snapshot,
closed,
};
let body = protocol::to_body(&frame).unwrap();
let packet = protocol::encode_encrypted(
kind,
CLIENT_ID,
packet_seq,
output_seq.saturating_sub(1),
&SESSION_KEY,
SERVER_TO_CLIENT,
&body,
)
.unwrap();
socket.send_to(&packet, peer).unwrap();
}
fn wait_for_output(output: &Arc<Mutex<Vec<u8>>>, needle: &[u8], timeout: Duration) {
let deadline = Instant::now() + timeout;
while Instant::now() < deadline {
if contains(&output.lock().unwrap(), needle) {
return;
}
thread::sleep(Duration::from_millis(10));
}
panic!(
"terminal output did not contain {:?}: {:?}",
String::from_utf8_lossy(needle),
output.lock().unwrap()
);
}
fn wait_for_resize(
observations: &mpsc::Receiver<ServerObservation>,
expected: (u16, u16),
timeout: Duration,
) {
let deadline = Instant::now() + timeout;
while let Some(remaining) = deadline.checked_duration_since(Instant::now()) {
match observations.recv_timeout(remaining) {
Ok(ServerObservation::Resize(cols, rows)) if (cols, rows) == expected => return,
Ok(_) => {}
Err(err) => panic!("terminal resize {expected:?} was not delivered: {err}"),
}
}
panic!("terminal resize {expected:?} was not delivered");
}
fn wait_for_input(
observations: &mpsc::Receiver<ServerObservation>,
expected: &[u8],
timeout: Duration,
) {
let deadline = Instant::now() + timeout;
let mut input = Vec::new();
while let Some(remaining) = deadline.checked_duration_since(Instant::now()) {
match observations.recv_timeout(remaining) {
Ok(ServerObservation::Input(bytes)) => {
input.extend_from_slice(&bytes);
if contains(&input, expected) {
return;
}
}
Ok(_) => {}
Err(err) => panic!("terminal input was not delivered: {err}; got {input:?}"),
}
}
panic!("terminal input was not delivered; got {input:?}");
}
fn wait_for_observation(
observations: &mpsc::Receiver<ServerObservation>,
timeout: Duration,
matches: impl Fn(&ServerObservation) -> bool,
) {
let deadline = Instant::now() + timeout;
while let Some(remaining) = deadline.checked_duration_since(Instant::now()) {
match observations.recv_timeout(remaining) {
Ok(observation) if matches(&observation) => return,
Ok(_) => {}
Err(err) => panic!("expected server observation was not received: {err}"),
}
}
panic!("expected server observation was not received");
}
fn contains(haystack: &[u8], needle: &[u8]) -> bool {
!needle.is_empty() && haystack.windows(needle.len()).any(|bytes| bytes == needle)
}
+6
View File
@@ -1027,6 +1027,8 @@ fn native_file_copy_recursive_round_trip() {
fs::create_dir_all(src.join("nested")).unwrap(); fs::create_dir_all(src.join("nested")).unwrap();
fs::write(src.join("root.txt"), b"root file\n").unwrap(); fs::write(src.join("root.txt"), b"root file\n").unwrap();
fs::write(src.join("nested/child.txt"), b"child file\n").unwrap(); fs::write(src.join("nested/child.txt"), b"child file\n").unwrap();
let large_payload: Vec<u8> = (0..128 * 1024).map(|index| (index % 251) as u8).collect();
fs::write(src.join("large.bin"), &large_payload).unwrap();
std::os::unix::fs::symlink("root.txt", src.join("root-link")).unwrap(); std::os::unix::fs::symlink("root.txt", src.join("root-link")).unwrap();
std::os::unix::fs::symlink("nested/child.txt", src.join("child-link")).unwrap(); std::os::unix::fs::symlink("nested/child.txt", src.join("child-link")).unwrap();
@@ -1134,6 +1136,10 @@ fn native_file_copy_recursive_round_trip() {
fs::read_to_string(downloaded.join("nested/child.txt")).unwrap(), fs::read_to_string(downloaded.join("nested/child.txt")).unwrap(),
"child file\n" "child file\n"
); );
assert_eq!(
fs::read(downloaded.join("large.bin")).unwrap(),
large_payload
);
assert_eq!( assert_eq!(
fs::read_link(downloaded.join("root-link")).unwrap(), fs::read_link(downloaded.join("root-link")).unwrap(),
PathBuf::from("root.txt") PathBuf::from("root.txt")