sshfwd 0.4.0

TUI-based SSH port forwarding manager with automatic port discovery
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
pub mod persistence;

use std::collections::{HashMap, HashSet};
use std::sync::Arc;

use serde::{Deserialize, Serialize};
use tokio::net::TcpListener;
use tokio::sync::mpsc;
use tokio::task::JoinSet;

use crate::ssh::session::{IncomingForward, Session};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
pub enum ForwardKind {
    #[default]
    Local,
    Reverse,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct ForwardKey {
    pub kind: ForwardKind,
    pub remote_port: u16,
}

impl ForwardKey {
    pub fn local(remote_port: u16) -> Self {
        Self {
            kind: ForwardKind::Local,
            remote_port,
        }
    }

    pub fn reverse(remote_port: u16) -> Self {
        Self {
            kind: ForwardKind::Reverse,
            remote_port,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ForwardStatus {
    Active,
    Paused,
    Starting,
}

#[derive(Debug, Clone)]
pub struct ForwardEntry {
    pub local_port: u16,
    pub status: ForwardStatus,
    pub active_connections: u32,
}

pub enum ForwardCommand {
    Start {
        kind: ForwardKind,
        remote_port: u16,
        local_port: u16,
        remote_host: String,
    },
    Stop {
        kind: ForwardKind,
        remote_port: u16,
    },
    Reactivate {
        kind: ForwardKind,
        remote_port: u16,
        local_port: u16,
        remote_host: String,
    },
    Pause {
        kind: ForwardKind,
        remote_port: u16,
    },
    UploadImage {
        path: String,
        bytes: Vec<u8>,
    },
    CleanupPasteUploads {
        paths: Vec<String>,
        done: crossbeam_channel::Sender<()>,
    },
}

#[derive(Debug)]
pub enum ForwardEvent {
    Started {
        kind: ForwardKind,
        remote_port: u16,
        local_port: u16,
    },
    Stopped {
        kind: ForwardKind,
        remote_port: u16,
    },
    Paused {
        kind: ForwardKind,
        remote_port: u16,
    },
    BindError {
        kind: ForwardKind,
        remote_port: u16,
        message: String,
    },
    ConnectionCountChanged {
        kind: ForwardKind,
        remote_port: u16,
        count: u32,
    },
    ImageUploaded {
        path: String,
    },
    ImageUploadFailed {
        error: String,
    },
}

struct ListenerHandle {
    local_port: u16,
    remote_host: String,
    abort_handle: tokio::task::AbortHandle,
}

pub struct ForwardManager {
    session: Session,
    event_tx: crossbeam_channel::Sender<crate::app::Message>,
    listeners: HashMap<ForwardKey, ListenerHandle>,
    /// Maps remote_port → local_port for active reverse forwards.
    reverse_map: HashMap<u16, u16>,
}

impl ForwardManager {
    pub fn new(session: Session, event_tx: crossbeam_channel::Sender<crate::app::Message>) -> Self {
        Self {
            session,
            event_tx,
            listeners: HashMap::new(),
            reverse_map: HashMap::new(),
        }
    }

    /// Drive the forward manager for one session lifetime.
    ///
    /// `cmd_rx` and `forwarded_rx` are borrowed so the sidecar can reuse them
    /// across reconnect cycles without recreating the command channel.
    /// `shutdown_rx` fires when the sidecar wants a graceful teardown (e.g.
    /// the discovery stream ended).  On shutdown all local listener tasks are
    /// aborted so their ports are released before the next session binds them.
    pub async fn run(
        mut self,
        cmd_rx: &mut mpsc::UnboundedReceiver<ForwardCommand>,
        forwarded_rx: &mut mpsc::UnboundedReceiver<IncomingForward>,
        mut shutdown_rx: tokio::sync::oneshot::Receiver<()>,
    ) {
        loop {
            tokio::select! {
                biased;
                _ = &mut shutdown_rx => {
                    // Abort all local listeners so ports are released for the next session.
                    for (_, handle) in self.listeners.drain() {
                        handle.abort_handle.abort();
                    }
                    break;
                }
                cmd_opt = cmd_rx.recv() => {
                    match cmd_opt {
                        Some(cmd) => self.handle_command(cmd).await,
                        None => break,
                    }
                }
                inc_opt = forwarded_rx.recv() => {
                    if let Some(inc) = inc_opt {
                        self.handle_incoming(inc);
                    }
                }
            }
        }
    }

    async fn handle_command(&mut self, cmd: ForwardCommand) {
        match cmd {
            ForwardCommand::Start {
                kind,
                remote_port,
                local_port,
                remote_host,
            } => {
                let key = ForwardKey { kind, remote_port };
                match kind {
                    ForwardKind::Local => self.handle_start_local(key, local_port, remote_host),
                    ForwardKind::Reverse => self.handle_start_reverse(key, local_port).await,
                }
            }
            ForwardCommand::Stop { kind, remote_port } => {
                let key = ForwardKey { kind, remote_port };
                match kind {
                    ForwardKind::Local => self.handle_stop_local(key),
                    ForwardKind::Reverse => self.handle_stop_reverse(key).await,
                }
            }
            ForwardCommand::Reactivate {
                kind,
                remote_port,
                local_port,
                remote_host,
            } => {
                let key = ForwardKey { kind, remote_port };
                match kind {
                    ForwardKind::Local => {
                        let port = self
                            .listeners
                            .get(&key)
                            .map_or(local_port, |h| h.local_port);
                        self.handle_start_local(key, port, remote_host);
                    }
                    ForwardKind::Reverse => self.handle_start_reverse(key, local_port).await,
                }
            }
            ForwardCommand::Pause { kind, remote_port } => {
                let key = ForwardKey { kind, remote_port };
                match kind {
                    ForwardKind::Local => self.handle_pause_local(key),
                    ForwardKind::Reverse => {
                        unreachable!("reconcile_forwards never pauses Reverse forwards")
                    }
                }
            }
            ForwardCommand::UploadImage { path, bytes } => {
                self.handle_upload_image(path, bytes);
            }
            ForwardCommand::CleanupPasteUploads { paths, done } => {
                self.handle_cleanup_paste_uploads(paths, done);
            }
        }
    }

    fn handle_cleanup_paste_uploads(
        &self,
        paths: Vec<String>,
        done: crossbeam_channel::Sender<()>,
    ) {
        let session = self.session.clone();
        tokio::spawn(async move {
            if !paths.is_empty() {
                // Paths come from paste::spawn_paste (fixed prefix + unix-ms digits), so
                // single-quote wrapping is sufficient. Same invariant as handle_upload_image.
                let quoted: Vec<String> = paths.iter().map(|p| format!("'{p}'")).collect();
                let cmd = format!("rm -f {}", quoted.join(" "));
                let _ = session.exec(&cmd).await;
            }
            let _ = done.send(());
        });
    }

    fn handle_upload_image(&self, path: String, bytes: Vec<u8>) {
        let session = self.session.clone();
        let event_tx = self.event_tx.clone();
        tokio::spawn(async move {
            // Path is constructed from a fixed prefix + unix-ms digits, so single-quote
            // wrapping is sufficient to keep it shell-safe.
            let cmd = format!("cat > '{path}' && chmod 600 '{path}'");
            let event = match session.exec_with_stdin(&cmd, &bytes).await {
                Ok(out) if out.success => ForwardEvent::ImageUploaded { path },
                Ok(out) => {
                    let stderr = String::from_utf8_lossy(&out.stderr).trim().to_string();
                    let error = if stderr.is_empty() {
                        "remote command failed".to_string()
                    } else {
                        stderr
                    };
                    ForwardEvent::ImageUploadFailed { error }
                }
                Err(e) => ForwardEvent::ImageUploadFailed {
                    error: e.to_string(),
                },
            };
            let _ = event_tx.send(crate::app::Message::ForwardEvent(event));
        });
    }

    fn handle_start_local(&mut self, key: ForwardKey, local_port: u16, remote_host: String) {
        if let Some(handle) = self.listeners.remove(&key) {
            handle.abort_handle.abort();
        }

        let remote_port = key.remote_port;
        let kind = key.kind;
        let session = self.session.clone();
        let event_tx = self.event_tx.clone();
        let host = remote_host.clone();

        let join_handle = tokio::spawn(async move {
            let listener = match TcpListener::bind(("127.0.0.1", local_port)).await {
                Ok(l) => l,
                Err(e) => {
                    let _ =
                        event_tx.send(crate::app::Message::ForwardEvent(ForwardEvent::BindError {
                            kind,
                            remote_port,
                            message: e.to_string(),
                        }));
                    return;
                }
            };

            let actual_port = listener.local_addr().map(|a| a.port()).unwrap_or(0);
            let _ = event_tx.send(crate::app::Message::ForwardEvent(ForwardEvent::Started {
                kind,
                remote_port,
                local_port: actual_port,
            }));

            let conn_count = Arc::new(std::sync::atomic::AtomicU32::new(0));
            let mut connections = JoinSet::new();

            loop {
                tokio::select! {
                    accept_result = listener.accept() => {
                        match accept_result {
                            Ok((local_stream, _)) => {
                                let session = session.clone();
                                let host = host.clone();
                                let event_tx = event_tx.clone();
                                let conn_count = conn_count.clone();

                                let count = conn_count.fetch_add(1, std::sync::atomic::Ordering::Relaxed) + 1;
                                let _ = event_tx.send(crate::app::Message::ForwardEvent(
                                    ForwardEvent::ConnectionCountChanged {
                                        kind,
                                        remote_port,
                                        count,
                                    },
                                ));

                                connections.spawn(async move {
                                    let result = tunnel_connection(
                                        local_stream,
                                        &session,
                                        &host,
                                        remote_port,
                                    )
                                    .await;

                                    let count = conn_count.fetch_sub(1, std::sync::atomic::Ordering::Relaxed) - 1;
                                    let _ = event_tx.send(crate::app::Message::ForwardEvent(
                                        ForwardEvent::ConnectionCountChanged {
                                            kind,
                                            remote_port,
                                            count,
                                        },
                                    ));

                                    result
                                });
                            }
                            Err(_) => break,
                        }
                    }
                    Some(_) = connections.join_next() => {
                        // Connection finished, count already updated in task
                    }
                }
            }
        });

        let abort_handle = join_handle.abort_handle();
        self.listeners.insert(
            key,
            ListenerHandle {
                local_port,
                remote_host,
                abort_handle,
            },
        );
    }

    fn handle_stop_local(&mut self, key: ForwardKey) {
        if let Some(handle) = self.listeners.remove(&key) {
            handle.abort_handle.abort();
        }
        let _ = self
            .event_tx
            .send(crate::app::Message::ForwardEvent(ForwardEvent::Stopped {
                kind: key.kind,
                remote_port: key.remote_port,
            }));
    }

    fn handle_pause_local(&mut self, key: ForwardKey) {
        if let Some(handle) = self.listeners.remove(&key) {
            handle.abort_handle.abort();
            // Re-insert to preserve local_port/remote_host for the Reactivate path.
            // abort_handle is already aborted (abort() on it is a no-op); it is kept
            // only because ListenerHandle requires one — handle_start_local will abort
            // it again harmlessly when reactivating.
            self.listeners.insert(
                key,
                ListenerHandle {
                    local_port: handle.local_port,
                    remote_host: handle.remote_host,
                    abort_handle: handle.abort_handle,
                },
            );
        }
        let _ = self
            .event_tx
            .send(crate::app::Message::ForwardEvent(ForwardEvent::Paused {
                kind: key.kind,
                remote_port: key.remote_port,
            }));
    }

    async fn handle_start_reverse(&mut self, key: ForwardKey, local_port: u16) {
        let remote_port = key.remote_port;

        match self.session.tcpip_forward(remote_port).await {
            Ok(bound_port) => {
                // bound_port may differ from remote_port if remote_port was 0
                self.reverse_map.insert(bound_port, local_port);
                let _ =
                    self.event_tx
                        .send(crate::app::Message::ForwardEvent(ForwardEvent::Started {
                            kind: ForwardKind::Reverse,
                            remote_port: bound_port,
                            local_port,
                        }));
            }
            Err(e) => {
                let _ = self.event_tx.send(crate::app::Message::ForwardEvent(
                    ForwardEvent::BindError {
                        kind: ForwardKind::Reverse,
                        remote_port,
                        message: e.to_string(),
                    },
                ));
            }
        }
    }

    async fn handle_stop_reverse(&mut self, key: ForwardKey) {
        let remote_port = key.remote_port;
        self.reverse_map.remove(&remote_port);
        // Best-effort cancel — don't fail the stop if the session is dead
        let _ = self.session.cancel_tcpip_forward(remote_port).await;
        let _ = self
            .event_tx
            .send(crate::app::Message::ForwardEvent(ForwardEvent::Stopped {
                kind: ForwardKind::Reverse,
                remote_port,
            }));
    }

    fn handle_incoming(&self, inc: IncomingForward) {
        let Some(&local_port) = self.reverse_map.get(&inc.remote_port) else {
            return; // Unknown port — ignore
        };

        tokio::spawn(async move {
            let local_stream = match tokio::net::TcpStream::connect(("127.0.0.1", local_port)).await
            {
                Ok(s) => s,
                Err(_) => return,
            };

            let channel_stream = inc.channel.into_stream();
            let (mut ssh_r, mut ssh_w) = tokio::io::split(channel_stream);
            let (mut local_r, mut local_w) = tokio::io::split(local_stream);
            tokio::select! {
                _ = tokio::io::copy(&mut local_r, &mut ssh_w) => {}
                _ = tokio::io::copy(&mut ssh_r, &mut local_w) => {}
            }
        });
    }
}

/// Compare current scan ports against tracked forwards and produce
/// Pause/Reactivate commands. Also updates entry statuses in-place.
pub fn reconcile_forwards(
    forwards: &mut HashMap<ForwardKey, ForwardEntry>,
    current_remote_ports: &HashSet<u16>,
    remote_host: &str,
) -> Vec<ForwardCommand> {
    let mut commands = Vec::new();

    for (key, entry) in forwards.iter() {
        if key.kind != ForwardKind::Local {
            continue;
        }
        let remote_port = key.remote_port;
        match entry.status {
            ForwardStatus::Active | ForwardStatus::Starting => {
                if !current_remote_ports.contains(&remote_port) {
                    commands.push(ForwardCommand::Pause {
                        kind: key.kind,
                        remote_port,
                    });
                }
            }
            ForwardStatus::Paused => {
                if current_remote_ports.contains(&remote_port) {
                    commands.push(ForwardCommand::Reactivate {
                        kind: key.kind,
                        remote_port,
                        local_port: entry.local_port,
                        remote_host: remote_host.to_string(),
                    });
                }
            }
        }
    }

    // Update statuses for the commands we just produced
    for cmd in &commands {
        match cmd {
            ForwardCommand::Pause { kind, remote_port } => {
                if let Some(entry) = forwards.get_mut(&ForwardKey {
                    kind: *kind,
                    remote_port: *remote_port,
                }) {
                    entry.status = ForwardStatus::Paused;
                }
            }
            ForwardCommand::Reactivate {
                kind, remote_port, ..
            } => {
                if let Some(entry) = forwards.get_mut(&ForwardKey {
                    kind: *kind,
                    remote_port: *remote_port,
                }) {
                    entry.status = ForwardStatus::Starting;
                }
            }
            _ => {}
        }
    }

    commands
}

async fn tunnel_connection(
    local_stream: tokio::net::TcpStream,
    session: &Session,
    remote_host: &str,
    remote_port: u16,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let channel_stream = session.open_direct_tcpip(remote_host, remote_port).await?;

    let (mut ssh_reader, mut ssh_writer) = tokio::io::split(channel_stream);
    let (mut local_reader, mut local_writer) = tokio::io::split(local_stream);

    tokio::select! {
        r = tokio::io::copy(&mut local_reader, &mut ssh_writer) => { r?; }
        r = tokio::io::copy(&mut ssh_reader, &mut local_writer) => { r?; }
    }

    Ok(())
}