sshbind 0.1.0

SSHBind is a Rust library that securely binds remote services behind multiple SSH jump hosts to a local socket, enabling seamless access with encrypted credential management, TOTP-based two-factor authentication, and automatic reconnection.
Documentation
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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
use env_logger::Builder;
use log::info;
use log::LevelFilter;
use russh::server::Server;
use sshbind::{bind, unbind};
use sshbind::{Creds, YamlCreds};
use std::collections::HashMap;
use std::io::Write;
use std::sync::{Arc, LazyLock};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::{TcpListener, TcpStream};
use tokio::task;

mod helpers;

#[cfg(windows)]
const FAST_RSA_KEY_SIZE: usize = 1024;

// Ensure the logger is initialized only once
static LOGGER: LazyLock<()> = LazyLock::new(|| {
    Builder::new()
        .filter(None, LevelFilter::Info) // Adjust log level as needed
        .format(|buf, record| writeln!(buf, "[{}] - {}", record.level(), record.args()))
        .init();
});

#[test]
fn fail_not_path() {
    #[allow(clippy::let_unit_value)]
    let _ = *LOGGER; // Ensure logger is initialized
    let bind_addr = "127.0.0.1:8000";
    let jump_hosts = vec!["127.0.0.1:20".to_string()];
    let service_addr = Some("127.0.0.1:8080".to_string());

    bind(bind_addr, jump_hosts, service_addr, "aq^fasdfs*$%", None);
    unbind(bind_addr);
}

#[tokio::test]
async fn test_correct_configuration() -> Result<(), Box<dyn std::error::Error>> {
    #[allow(clippy::let_unit_value)]
    let _ = *LOGGER; // Ensure logger is initialized

    // Test ID 1: 2 jump hosts, uses ports 10000, 10001-10002 (jump hosts), 10003 (service)
    let ports = helpers::TestPorts::new(1, 2);

    let mut testcreds = YamlCreds::new();
    testcreds.insert(
        ports.jump_host(0),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: None,
        },
    );
    testcreds.insert(
        ports.jump_host(1),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: None,
        },
    );
    testcreds.insert(
        "httpforever.com".to_string(),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: "ABCAD37A".to_string().into(),
        },
    );
    let tmp_dir = helpers::setup_sopsfile(testcreds.clone());
    let sopsfile_path = tmp_dir.path().join("secrets.yaml");
    let mut config = russh::server::Config::default();
    // Use OsRng from rand for randomness.
    use russh::keys::ssh_key::rand_core::OsRng;
    let mut rng = OsRng;

    #[cfg(unix)]
    {
        use russh::keys::Algorithm;
        let pk = russh::keys::PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
        config.keys.push(pk);
    }
    #[cfg(windows)]
    {
        use russh::keys::ssh_key::private::{KeypairData, RsaKeypair};
        let keypair = KeypairData::from(RsaKeypair::random(&mut rng, FAST_RSA_KEY_SIZE).unwrap());
        let pk = russh::keys::PrivateKey::new(keypair, "").unwrap();
        config.keys.push(pk);
    }
    let config = Arc::new(config);
    use helpers::Credentials;
    let mut hosts_users: HashMap<String, HashMap<String, Credentials>> = HashMap::new();
    testcreds.iter().for_each(|(k, v)| {
        let mut map: HashMap<String, Credentials> = HashMap::new();
        map.insert(v.username.clone(), Credentials::from(v.clone()));
        hosts_users.insert(k.to_string(), map);
    });
    info!("Prepared SSH server configuration");

    let bind_addr = ports.bind_addr();
    let jump_hosts = ports.jump_hosts();
    let service_addr_consume = ports.service_addr();
    let service_addr = Some(service_addr_consume.clone());

    // Set up cleanup handler to ensure cleanup happens even on test failure
    let mut cleanup = helpers::TestCleanup::new(bind_addr.clone());

    let ssh_tasks: Vec<_> = jump_hosts
        .clone()
        .into_iter()
        .map(|ssh_addr| {
            let cloned_config = config.clone();
            let users = hosts_users.get(&ssh_addr).cloned().unwrap_or_default();
            let mut server = helpers::SSHServer::new(Some(users));

            task::spawn(async move {
                let _ = server.run_on_address(cloned_config, &ssh_addr).await;
            })
        })
        .collect();

    // Register SSH tasks with cleanup handler
    for task in &ssh_tasks {
        cleanup.add_ssh_task(task);
    }

    // Give SSH servers more time to start up on Windows
    #[cfg(windows)]
    tokio::time::sleep(std::time::Duration::from_millis(1000)).await;
    #[cfg(not(windows))]
    tokio::time::sleep(std::time::Duration::from_millis(500)).await;
    info!("SSH servers started");
    let service_handle = task::spawn(async move {
        let serv = TcpListener::bind(service_addr_consume).await.unwrap();
        loop {
            let (mut socket, _) = serv.accept().await.unwrap();
            socket.write_all(b"hello world!").await.unwrap();
        }
    });

    // Register service handle with cleanup handler
    cleanup.set_service_handle(&service_handle);
    info!("Service started");

    bind(
        &bind_addr,
        jump_hosts,
        service_addr,
        sopsfile_path.to_str().unwrap(),
        None,
    );

    info!("Bind started");
    let mut conn = TcpStream::connect(&bind_addr).await.unwrap();
    let mut buf = vec![0; 1024];
    let n = conn.read(&mut buf).await?;
    let response = String::from_utf8_lossy(&buf[..n]).to_string();
    println!("Received: {}", response);
    assert_eq!(response, "hello world!");

    // Cleanup will be handled automatically by the Drop implementation
    // but we can also call it explicitly if desired
    cleanup.cleanup();
    Ok(())
}

#[tokio::test]
async fn test_correct_configuration_multiple() -> Result<(), Box<dyn std::error::Error>> {
    #[allow(clippy::let_unit_value)]
    let _ = *LOGGER; // Ensure logger is initialized

    // Test ID 2: 2 jump hosts, uses ports 10010, 10011-10012 (jump hosts), 10013 (service)
    let ports = helpers::TestPorts::new(2, 2);

    let mut testcreds = YamlCreds::new();
    testcreds.insert(
        ports.jump_host(0),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: None,
        },
    );
    testcreds.insert(
        ports.jump_host(1),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: None,
        },
    );
    testcreds.insert(
        "httpforever.com".to_string(),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: "ABCAD37A".to_string().into(),
        },
    );
    let tmp_dir = helpers::setup_sopsfile(testcreds.clone());
    let sopsfile_path = tmp_dir.path().join("secrets.yaml");
    let mut config = russh::server::Config::default();
    // Use OsRng from rand for randomness.
    use russh::keys::ssh_key::rand_core::OsRng;
    let mut rng = OsRng;

    #[cfg(unix)]
    {
        use russh::keys::Algorithm;
        let pk = russh::keys::PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
        config.keys.push(pk);
    }
    #[cfg(windows)]
    {
        use russh::keys::ssh_key::private::{KeypairData, RsaKeypair};
        let keypair = KeypairData::from(RsaKeypair::random(&mut rng, FAST_RSA_KEY_SIZE).unwrap());
        let pk = russh::keys::PrivateKey::new(keypair, "").unwrap();
        config.keys.push(pk);
    }
    let config = Arc::new(config);
    use helpers::Credentials;
    let mut hosts_users: HashMap<String, HashMap<String, Credentials>> = HashMap::new();
    testcreds.iter().for_each(|(k, v)| {
        let mut map: HashMap<String, Credentials> = HashMap::new();
        map.insert(v.username.clone(), Credentials::from(v.clone()));
        hosts_users.insert(k.to_string(), map);
    });

    let bind_addr = ports.bind_addr();
    let jump_hosts = ports.jump_hosts();
    let service_addr_consume = ports.service_addr();
    let service_addr = Some(service_addr_consume.clone());

    // Set up cleanup handler to ensure cleanup happens even on test failure
    let mut cleanup = helpers::TestCleanup::new(bind_addr.clone());

    let ssh_tasks: Vec<_> = jump_hosts
        .clone()
        .into_iter()
        .map(|ssh_addr| {
            let cloned_config = config.clone();
            let users = hosts_users.get(&ssh_addr).cloned().unwrap_or_default();
            let mut server = helpers::SSHServer::new(Some(users));

            task::spawn(async move {
                let _ = server.run_on_address(cloned_config, &ssh_addr).await;
            })
        })
        .collect();

    // Register SSH tasks with cleanup handler
    for task in &ssh_tasks {
        cleanup.add_ssh_task(task);
    }

    // Give SSH servers more time to start up on Windows
    #[cfg(windows)]
    tokio::time::sleep(std::time::Duration::from_millis(1000)).await;

    #[cfg(not(windows))]
    tokio::time::sleep(std::time::Duration::from_millis(500)).await;

    let service_handle = task::spawn(async move {
        let serv = TcpListener::bind(service_addr_consume).await.unwrap();
        loop {
            let (mut socket, _) = serv.accept().await.unwrap();
            socket.write_all(b"hello world!").await.unwrap();
        }
    });

    // Register service handle with cleanup handler
    cleanup.set_service_handle(&service_handle);

    bind(
        &bind_addr,
        jump_hosts,
        service_addr,
        sopsfile_path.to_str().unwrap(),
        None,
    );

    let mut conn = TcpStream::connect(&bind_addr).await.unwrap();
    let mut buf = vec![0; 1024];
    let n = conn.read(&mut buf).await?;
    let response = String::from_utf8_lossy(&buf[..n]).to_string();
    println!("Received: {}", response);
    assert_eq!(response, "hello world!");

    let mut conn = TcpStream::connect(&bind_addr).await.unwrap();
    let mut buf = vec![0; 1024];
    let n = conn.read(&mut buf).await?;
    let response = String::from_utf8_lossy(&buf[..n]).to_string();
    println!("Received: {}", response);
    assert_eq!(response, "hello world!");

    // Cleanup will be handled automatically by the Drop implementation
    // but we can also call it explicitly if desired
    cleanup.cleanup();
    Ok(())
}

#[tokio::test]
async fn test_second_server_wrong_credentials() -> Result<(), Box<dyn std::error::Error>> {
    #[allow(clippy::let_unit_value)]
    let _ = *LOGGER; // Ensure logger is initialized

    // Test ID 3: 2 jump hosts, uses ports 10020, 10021-10022 (jump hosts), 10023 (service)
    let ports = helpers::TestPorts::new(3, 2);

    let mut testcreds = YamlCreds::new();
    testcreds.insert(
        ports.jump_host(0),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: None,
        },
    );
    testcreds.insert(
        ports.jump_host(1),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: None,
        },
    );
    testcreds.insert(
        "httpforever.com".to_string(),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: "ABCAD37A".to_string().into(),
        },
    );
    let tmp_dir = helpers::setup_sopsfile(testcreds.clone());
    let sopsfile_path = tmp_dir.path().join("secrets.yaml");
    let mut config = russh::server::Config::default();
    // Use OsRng from rand for randomness.
    use russh::keys::ssh_key::rand_core::OsRng;
    let mut rng = OsRng;

    #[cfg(unix)]
    {
        use russh::keys::Algorithm;
        let pk = russh::keys::PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
        config.keys.push(pk);
    }
    #[cfg(windows)]
    {
        use russh::keys::ssh_key::private::{KeypairData, RsaKeypair};
        let keypair = KeypairData::from(RsaKeypair::random(&mut rng, FAST_RSA_KEY_SIZE).unwrap());
        let pk = russh::keys::PrivateKey::new(keypair, "").unwrap();
        config.keys.push(pk);
    }
    let config = Arc::new(config);
    use helpers::Credentials;
    let mut hosts_users: HashMap<String, HashMap<String, Credentials>> = HashMap::new();
    testcreds.iter().for_each(|(k, v)| {
        let mut map: HashMap<String, Credentials> = HashMap::new();
        map.insert(v.username.clone(), Credentials::from(v.clone()));
        hosts_users.insert(k.to_string(), map);
    });

    let bind_addr = ports.bind_addr();
    let jump_hosts = ports.jump_hosts();
    let service_addr_consume = ports.service_addr();
    let service_addr = Some(service_addr_consume.clone());

    // Set up cleanup handler to ensure cleanup happens even on test failure
    let mut cleanup = helpers::TestCleanup::new(bind_addr.clone());

    let ssh_tasks: Vec<_> = jump_hosts
        .clone()
        .into_iter()
        .enumerate()
        .map(|(idx, ssh_addr)| {
            let cloned_config = config.clone();
            // Second server should have no valid users (to test wrong credentials)
            let users = if idx == 1 {
                HashMap::new() // No valid users for second server
            } else {
                hosts_users.get(&ssh_addr).cloned().unwrap_or_default()
            };
            let mut server = helpers::SSHServer::new(Some(users));

            task::spawn(async move {
                let _ = server.run_on_address(cloned_config, &ssh_addr).await;
            })
        })
        .collect();

    // Register SSH tasks with cleanup handler
    for task in &ssh_tasks {
        cleanup.add_ssh_task(task);
    }

    // Give SSH servers more time to start up on Windows
    #[cfg(windows)]
    tokio::time::sleep(std::time::Duration::from_millis(1000)).await;
    #[cfg(not(windows))]
    tokio::time::sleep(std::time::Duration::from_millis(500)).await;
    let service_handle = task::spawn(async move {
        let serv = TcpListener::bind(service_addr_consume).await.unwrap();
        loop {
            let (mut socket, _) = serv.accept().await.unwrap();
            socket.write_all(b"hello world!").await.unwrap();
        }
    });

    cleanup.set_service_handle(&service_handle);

    bind(
        &bind_addr,
        jump_hosts,
        service_addr,
        sopsfile_path.to_str().unwrap(),
        None,
    );

    // Give time for the bind to attempt connection through SSH chain
    tokio::time::sleep(std::time::Duration::from_millis(1000)).await;

    // Try to connect - this should succeed but the connection through SSH will have failed
    let result = TcpStream::connect(&bind_addr).await;
    if let Ok(mut conn) = result {
        let mut buf = vec![0; 1024];
        // The read should either fail or return empty since SSH auth failed
        match conn.read(&mut buf).await {
            Ok(0) => {
                // Connection closed immediately - auth failed as expected
            }
            Ok(n) => {
                let response = String::from_utf8_lossy(&buf[..n]).to_string();
                println!("Received: {}", response);
                assert_eq!(response, "");
            }
            Err(_) => {
                // Connection error - auth failed as expected
            }
        }
    }

    // Cleanup will be handled automatically by the Drop implementation
    cleanup.cleanup();
    Ok(())
}

#[tokio::test]
async fn test_correct_configuration_2fa() -> Result<(), Box<dyn std::error::Error>> {
    #[allow(clippy::let_unit_value)]
    let _ = *LOGGER; // Ensure logger is initialized

    // Test ID 4: 1 jump host, uses ports 10030, 10031 (jump host), 10032 (service)
    let ports = helpers::TestPorts::new(4, 1);

    let mut testcreds = YamlCreds::new();
    testcreds.insert(
        ports.jump_host(0),
        Creds {
            username: "pi".to_string(),
            password: "max".to_string(),
            totp_key: "GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ".to_string().into(),
        },
    );
    let tmp_dir = helpers::setup_sopsfile(testcreds.clone());
    let sopsfile_path = tmp_dir.path().join("secrets.yaml");
    let mut config = russh::server::Config::default();
    // Use OsRng from rand for randomness.
    use russh::keys::ssh_key::rand_core::OsRng;
    let mut rng = OsRng;

    #[cfg(unix)]
    {
        use russh::keys::Algorithm;
        let pk = russh::keys::PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
        config.keys.push(pk);
    }
    #[cfg(windows)]
    {
        use russh::keys::ssh_key::private::{KeypairData, RsaKeypair};
        let keypair = KeypairData::from(RsaKeypair::random(&mut rng, FAST_RSA_KEY_SIZE).unwrap());
        let pk = russh::keys::PrivateKey::new(keypair, "").unwrap();
        config.keys.push(pk);
    }
    let config = Arc::new(config);
    use helpers::Credentials;
    let mut hosts_users: HashMap<String, HashMap<String, Credentials>> = HashMap::new();
    testcreds.iter().for_each(|(k, v)| {
        let mut map: HashMap<String, Credentials> = HashMap::new();
        map.insert(v.username.clone(), v.clone().into());
        hosts_users.insert(k.to_string(), map);
    });

    println!("hosts_users: {:?}", hosts_users);

    let bind_addr = ports.bind_addr();
    let jump_hosts = ports.jump_hosts();
    let service_addr_consume = ports.service_addr();
    let service_addr = Some(service_addr_consume.clone());

    // Set up cleanup handler to ensure cleanup happens even on test failure
    let mut cleanup = helpers::TestCleanup::new(bind_addr.clone());

    let ssh_tasks: Vec<_> = jump_hosts
        .clone()
        .into_iter()
        .map(|ssh_addr| {
            let cloned_config = config.clone();
            let users = hosts_users.get(&ssh_addr).cloned().unwrap_or_default();
            let mut server = helpers::SSHServer::new(Some(users));

            task::spawn(async move {
                let _ = server.run_on_address(cloned_config, &ssh_addr).await;
            })
        })
        .collect();

    // Register SSH tasks with cleanup handler
    for task in &ssh_tasks {
        cleanup.add_ssh_task(task);
    }

    // Give SSH servers more time to start up on Windows
    #[cfg(windows)]
    tokio::time::sleep(std::time::Duration::from_millis(1000)).await;
    #[cfg(not(windows))]
    tokio::time::sleep(std::time::Duration::from_millis(500)).await;
    let service_handle = task::spawn(async move {
        let serv = TcpListener::bind(service_addr_consume).await.unwrap();
        loop {
            let (mut socket, _) = serv.accept().await.unwrap();
            socket.write_all(b"hello world!").await.unwrap();
        }
    });

    // Register service handle with cleanup handler
    cleanup.set_service_handle(&service_handle);

    bind(
        &bind_addr,
        jump_hosts,
        service_addr,
        sopsfile_path.to_str().unwrap(),
        None,
    );

    let mut conn = TcpStream::connect(&bind_addr).await.unwrap();
    let mut buf = vec![0; 1024];
    let n = conn.read(&mut buf).await?;
    let response = String::from_utf8_lossy(&buf[..n]).to_string();
    println!("Received: {}", response);
    assert_eq!(response, "hello world!");

    // Cleanup will be handled automatically by the Drop implementation
    cleanup.cleanup();
    Ok(())
}

// #[tokio::test]
// async fn serial_integration_test_correct_configuration_2fa_aug(
// ) -> Result<(), Box<dyn std::error::Error>> {
//     #[allow(clippy::let_unit_value)]
//     let _ = *LOGGER; // Ensure logger is initialized
//     let bind_addr = "127.0.0.1:7000";
//     let jump_hosts = vec![
//         "gate.mpcdf.mpg.de:22".to_string(),
//         "toki01.bc.rzg.mpg.de:22".to_string(),
//     ];
//     let service_addr = "httpforever.com:80";
//
//     bind(
//         &bind_addr,
//         jump_hosts,
//         service_addr,
//         "../tokadata-python-template/tests/creds/aug.yaml",
//     );
//
//     let mut conn = TcpStream::connect(&bind_addr).await.unwrap();
//     let mut buf = vec![0; 1024];
//     let n = conn.read(&mut buf).await?;
//     let response = String::from_utf8_lossy(&buf[..n]).to_string();
//     println!("Received: {}", response);
//     assert_eq!(response, "hello world!");
//
//     unbind(&bind_addr);
//     Ok(())
// }