ssh-mcp-rs 4.1.1

SeSSHion: lightweight SSH MCP server for LLM agents
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
//! Rsync timeout E2E tests
//!
//! These tests verify that:
//! 1. Rsync operations properly timeout when the transfer takes too long
//! 2. No zombie rsync processes remain after timeout
//! 3. Timeout errors are properly propagated to the caller

#![cfg(unix)]

use super::common::*;
use std::path::PathBuf;
use std::time::SystemTime;

/// Test that rsync put operation times out correctly with a large file and short timeout
#[tokio::test]
async fn test_rsync_put_file_timeout() {
    let _ = tracing_subscriber::fmt()
        .with_test_writer()
        .with_env_filter("ssh_mcp=debug,info")
        .try_init();

    if !check_rsync() {
        tracing::warn!("skipping: local 'rsync' unavailable");
        return;
    }

    // Build the custom Debian SSH image if needed
    init_test_env().expect("Failed to build test image");

    // Start SSH container using custom Debian image with key auth
    let container = GenericImage::new("ssh-mcp-debian-sshd", "latest")
        .with_exposed_port(2222u16.into())
        .start()
        .await
        .expect("Failed to start SSH container");

    let host = container
        .get_host()
        .await
        .expect("Failed to get container host");
    let port = container
        .get_host_port_ipv4(2222)
        .await
        .expect("Failed to get mapped SSH port");
    tokio::time::sleep(tokio::time::Duration::from_secs(5)).await;

    // Generate test key
    let (_key_dir, key_path) = setup_test_key();

    let config = Config {
        host: host.to_string(),
        port,
        user: "test".to_string(),
        password: None,
        key: Some(key_path),
        su_password: None,
        sudo_password: None,
        timeout_ms: 30000,
        max_chars: Some(1000),
        max_output_tokens: Some(12000),
        disable_sudo: true,
        keepalive_interval: 30,
        keepalive_max: 3,
        reconnect_retries: 3,
        reconnect_backoff_ms: 250,
        health_probe_timeout_ms: 1500,
        strict_host_key_checking: ssh_mcp::HostKeyCheckMode::No,
        known_hosts: None,
    };

    let server = SshMcpServer::new(config)
        .await
        .expect("Failed to create SshMcpServer");

    // Resolve remote home
    let home_result = server
        .test_execute_command(r#"sh -c 'printf %s "$HOME"'"#)
        .await
        .expect("failed to resolve remote HOME");
    let remote_home = extract_text_from_result(&home_result).trim().to_string();

    // Create a large local file (10MB of random data to prevent compression)
    let unique = format!(
        "{}-{}-rsync-timeout-put",
        std::process::id(),
        SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .map(|d| d.as_nanos())
            .unwrap_or(0)
    );
    let local_base = PathBuf::from("target/tmp").join(format!("rsync-timeout-{unique}"));
    std::fs::create_dir_all(&local_base).expect("create local base");

    let local_file = local_base.join("large_file.bin");

    // Generate 10MB of random data using /dev/urandom to prevent compression
    let output = std::process::Command::new("sh")
        .args([
            "-c",
            &format!(
                "dd if=/dev/urandom of={} bs=1M count=10 2>/dev/null",
                local_file.display()
            ),
        ])
        .output();
    match output {
        Ok(result) if result.status.success() => {}
        Ok(result) => {
            tracing::warn!("dd command failed, using fallback pattern: {:?}", result);
            // Fallback: create a file with non-compressible pattern
            let mut data = Vec::with_capacity(10 * 1024 * 1024);
            for i in 0..(10 * 1024 * 1024) {
                data.push((i % 256) as u8 ^ ((i / 256) % 256) as u8);
            }
            std::fs::write(&local_file, &data).expect("write local file with pattern");
        }
        Err(e) => {
            tracing::warn!("Failed to spawn dd: {}, using fallback pattern", e);
            let mut data = Vec::with_capacity(10 * 1024 * 1024);
            for i in 0..(10 * 1024 * 1024) {
                data.push((i % 256) as u8 ^ ((i / 256) % 256) as u8);
            }
            std::fs::write(&local_file, &data).expect("write local file with pattern");
        }
    }

    let local_path_param = local_file.to_string_lossy().to_string();
    let remote_file = format!("{}/rsync-timeout-test.bin", remote_home);

    // Attempt rsync put with a very short timeout (100ms) - should timeout
    let resp = server
        .test_transfer(TransferParams {
            operation: TransferOperation::Put,
            local_path: local_path_param,
            remote_path: remote_file.clone(),
            transport: TransferTransport::Rsync,
            kind: Some(TransferKind::File),
            overwrite: true,
            timeout_ms: Some(100), // Very short timeout to force timeout
            verbose: false,
            ..Default::default()
        })
        .await;

    // Verify the transfer failed
    assert!(!resp.ok, "rsync file PUT should fail with short timeout");

    // Verify error message indicates timeout
    let error_msg = resp.error.unwrap_or_default();
    assert!(
        error_msg.to_lowercase().contains("timeout"),
        "Error should indicate timeout, got: {}",
        error_msg
    );

    // Verify no rsync processes remain in the container
    // Give a small delay for process cleanup
    tokio::time::sleep(tokio::time::Duration::from_millis(500)).await;

    let check_cmd =
        r#"sh -c 'pgrep -x rsync > /dev/null 2>&1 && echo "rsync_running" || echo "no_rsync"'"#;
    let check_result = server
        .test_execute_command(check_cmd)
        .await
        .expect("Failed to check for rsync processes");
    let check_output = extract_text_from_result(&check_result);

    assert!(
        check_output.contains("no_rsync"),
        "rsync process should not be running after timeout, but got: {}",
        check_output
    );

    server.shutdown().await;
    let _ = std::fs::remove_dir_all(&local_base);
}

/// Test that rsync get operation times out correctly with a large remote file
#[tokio::test]
async fn test_rsync_get_file_timeout() {
    let _ = tracing_subscriber::fmt()
        .with_test_writer()
        .with_env_filter("ssh_mcp=debug,info")
        .try_init();

    if !check_rsync() {
        tracing::warn!("skipping: local 'rsync' unavailable");
        return;
    }

    // Build the custom Debian SSH image if needed
    init_test_env().expect("Failed to build test image");

    // Start SSH container using custom Debian image with key auth
    let container = GenericImage::new("ssh-mcp-debian-sshd", "latest")
        .with_exposed_port(2222u16.into())
        .start()
        .await
        .expect("Failed to start SSH container");

    let host = container
        .get_host()
        .await
        .expect("Failed to get container host");
    let port = container
        .get_host_port_ipv4(2222)
        .await
        .expect("Failed to get mapped SSH port");
    tokio::time::sleep(tokio::time::Duration::from_secs(5)).await;

    // Generate test key
    let (_key_dir, key_path) = setup_test_key();

    let config = Config {
        host: host.to_string(),
        port,
        user: "test".to_string(),
        password: None,
        key: Some(key_path),
        su_password: None,
        sudo_password: None,
        timeout_ms: 30000,
        max_chars: Some(1000),
        max_output_tokens: Some(12000),
        disable_sudo: true,
        keepalive_interval: 30,
        keepalive_max: 3,
        reconnect_retries: 3,
        reconnect_backoff_ms: 250,
        health_probe_timeout_ms: 1500,
        strict_host_key_checking: ssh_mcp::HostKeyCheckMode::No,
        known_hosts: None,
    };

    let server = SshMcpServer::new(config)
        .await
        .expect("Failed to create SshMcpServer");

    // Resolve remote home
    let home_result = server
        .test_execute_command(r#"sh -c 'printf %s "$HOME"'"#)
        .await
        .expect("failed to resolve remote HOME");
    let remote_home = extract_text_from_result(&home_result).trim().to_string();

    // Create a large remote file using dd
    let remote_file = format!("{}/rsync-large-remote.bin", remote_home);
    let create_result = server
        .test_execute_command(&format!(
            "sh -c 'dd if=/dev/urandom of={} bs=1M count=10 2>/dev/null && echo done'",
            ssh_mcp::escape_for_shell(&remote_file)
        ))
        .await
        .expect("failed to create large remote file");
    let create_output = extract_text_from_result(&create_result);
    assert!(
        create_output.contains("done"),
        "Failed to create large remote file"
    );

    // Create local download directory
    let unique = format!(
        "{}-{}-rsync-timeout-get",
        std::process::id(),
        SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .map(|d| d.as_nanos())
            .unwrap_or(0)
    );
    let local_base = PathBuf::from("target/tmp").join(format!("rsync-timeout-{unique}"));
    std::fs::create_dir_all(&local_base).expect("create local base");

    let local_download = local_base.join("downloaded.bin");
    let local_path_param = local_download.to_string_lossy().to_string();

    // Attempt rsync get with a very short timeout (100ms) - should timeout
    let resp = server
        .test_transfer(TransferParams {
            operation: TransferOperation::Get,
            local_path: local_path_param,
            remote_path: remote_file.clone(),
            transport: TransferTransport::Rsync,
            kind: Some(TransferKind::File),
            overwrite: true,
            timeout_ms: Some(100), // Very short timeout to force timeout
            verbose: false,
            ..Default::default()
        })
        .await;

    // Verify the transfer failed
    assert!(!resp.ok, "rsync file GET should fail with short timeout");

    // Verify error message indicates timeout
    let error_msg = resp.error.unwrap_or_default();
    assert!(
        error_msg.to_lowercase().contains("timeout"),
        "Error should indicate timeout, got: {}",
        error_msg
    );

    // Verify no rsync processes remain in the container
    // Give a small delay for process cleanup
    tokio::time::sleep(tokio::time::Duration::from_millis(500)).await;

    let check_cmd =
        r#"sh -c 'pgrep -x rsync > /dev/null 2>&1 && echo "rsync_running" || echo "no_rsync"'"#;
    let check_result = server
        .test_execute_command(check_cmd)
        .await
        .expect("Failed to check for rsync processes");
    let check_output = extract_text_from_result(&check_result);

    assert!(
        check_output.contains("no_rsync"),
        "rsync process should not be running after timeout, but got: {}",
        check_output
    );

    server.shutdown().await;
    let _ = std::fs::remove_dir_all(&local_base);
}

/// Test that rsync directory put operation times out correctly
#[tokio::test]
async fn test_rsync_put_directory_timeout() {
    let _ = tracing_subscriber::fmt()
        .with_test_writer()
        .with_env_filter("ssh_mcp=debug,info")
        .try_init();

    if !check_rsync() {
        tracing::warn!("skipping: local 'rsync' unavailable");
        return;
    }

    // Build the custom Debian SSH image if needed
    init_test_env().expect("Failed to build test image");

    // Start SSH container using custom Debian image with key auth
    let container = GenericImage::new("ssh-mcp-debian-sshd", "latest")
        .with_exposed_port(2222u16.into())
        .start()
        .await
        .expect("Failed to start SSH container");

    let host = container
        .get_host()
        .await
        .expect("Failed to get container host");
    let port = container
        .get_host_port_ipv4(2222)
        .await
        .expect("Failed to get mapped SSH port");
    tokio::time::sleep(tokio::time::Duration::from_secs(5)).await;

    // Generate test key
    let (_key_dir, key_path) = setup_test_key();

    let config = Config {
        host: host.to_string(),
        port,
        user: "test".to_string(),
        password: None,
        key: Some(key_path),
        su_password: None,
        sudo_password: None,
        timeout_ms: 30000,
        max_chars: Some(1000),
        max_output_tokens: Some(12000),
        disable_sudo: true,
        keepalive_interval: 30,
        keepalive_max: 3,
        reconnect_retries: 3,
        reconnect_backoff_ms: 250,
        health_probe_timeout_ms: 1500,
        strict_host_key_checking: ssh_mcp::HostKeyCheckMode::No,
        known_hosts: None,
    };

    let server = SshMcpServer::new(config)
        .await
        .expect("Failed to create SshMcpServer");

    // Resolve remote home
    let home_result = server
        .test_execute_command(r#"sh -c 'printf %s "$HOME"'"#)
        .await
        .expect("failed to resolve remote HOME");
    let remote_home = extract_text_from_result(&home_result).trim().to_string();

    // Create local directory with multiple large files
    let unique = format!(
        "{}-{}-rsync-timeout-dirput",
        std::process::id(),
        SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .map(|d| d.as_nanos())
            .unwrap_or(0)
    );
    let local_base = PathBuf::from("target/tmp").join(format!("rsync-timeout-{unique}"));
    std::fs::create_dir_all(&local_base).expect("create local base");

    let local_dir = local_base.join("upload_dir");
    std::fs::create_dir_all(&local_dir).expect("create local dir");

    // Create several files with random data from /dev/urandom
    for i in 0..5 {
        let file_path = local_dir.join(format!("large_file_{}.bin", i));
        let output = std::process::Command::new("sh")
            .args([
                "-c",
                &format!(
                    "dd if=/dev/urandom of={} bs=1M count=2 2>/dev/null",
                    file_path.display()
                ),
            ])
            .output();
        match output {
            Ok(result) if result.status.success() => {}
            _ => {
                // Fallback: create file with non-compressible pattern
                let mut data = Vec::with_capacity(2 * 1024 * 1024);
                let offset = i * 10000;
                for j in 0..(2 * 1024 * 1024) {
                    data.push(((j + offset) % 256) as u8 ^ (((j + offset) / 256) % 256) as u8);
                }
                std::fs::write(&file_path, &data).expect("write local file with pattern");
            }
        }
    }

    let local_dir_param = local_dir.to_string_lossy().to_string();
    let remote_dir = format!("{}/rsync_timeout_dir", remote_home);

    // Attempt rsync put with a very short timeout (100ms) - should timeout
    let resp = server
        .test_transfer(TransferParams {
            operation: TransferOperation::Put,
            local_path: local_dir_param,
            remote_path: remote_dir.clone(),
            transport: TransferTransport::Rsync,
            kind: Some(TransferKind::Directory),
            overwrite: true,
            timeout_ms: Some(100), // Very short timeout to force timeout
            verbose: false,
            ..Default::default()
        })
        .await;

    // Verify the transfer failed
    assert!(
        !resp.ok,
        "rsync directory PUT should fail with short timeout"
    );

    // Verify error message indicates timeout
    let error_msg = resp.error.unwrap_or_default();
    assert!(
        error_msg.to_lowercase().contains("timeout"),
        "Error should indicate timeout, got: {}",
        error_msg
    );

    // Verify no rsync processes remain in the container
    tokio::time::sleep(tokio::time::Duration::from_millis(500)).await;

    let check_cmd =
        r#"sh -c 'pgrep -x rsync > /dev/null 2>&1 && echo "rsync_running" || echo "no_rsync"'"#;
    let check_result = server
        .test_execute_command(check_cmd)
        .await
        .expect("Failed to check for rsync processes");
    let check_output = extract_text_from_result(&check_result);

    assert!(
        check_output.contains("no_rsync"),
        "rsync process should not be running after timeout, but got: {}",
        check_output
    );

    server.shutdown().await;
    let _ = std::fs::remove_dir_all(&local_base);
}