shell-tunnel 0.5.0

Ultra-lightweight remote shell gateway with a REST/WebSocket API
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
//! Input validation and command sanitization.

use std::time::Duration;

/// Validation configuration.
#[derive(Debug, Clone)]
pub struct ValidationConfig {
    /// Maximum command length in characters.
    pub max_command_length: usize,
    /// Maximum output size in bytes.
    pub max_output_size: usize,
    /// Maximum timeout in seconds.
    pub max_timeout_secs: u64,
    /// Minimum timeout in seconds.
    pub min_timeout_secs: u64,
    /// Whether to block dangerous commands.
    pub block_dangerous: bool,
    /// Custom blocked patterns (regex-like simple patterns).
    pub blocked_patterns: Vec<String>,
}

impl Default for ValidationConfig {
    fn default() -> Self {
        Self {
            max_command_length: 4096,
            max_output_size: 10 * 1024 * 1024, // 10MB
            max_timeout_secs: 300,             // 5 minutes
            min_timeout_secs: 1,
            block_dangerous: true,
            blocked_patterns: Vec::new(),
        }
    }
}

impl ValidationConfig {
    /// Create a permissive config (for trusted environments).
    pub fn permissive() -> Self {
        Self {
            max_command_length: 65536,
            max_output_size: 100 * 1024 * 1024, // 100MB
            max_timeout_secs: 3600,             // 1 hour
            min_timeout_secs: 1,
            block_dangerous: false,
            blocked_patterns: Vec::new(),
        }
    }

    /// Create a strict config (for untrusted environments).
    pub fn strict() -> Self {
        Self {
            max_command_length: 1024,
            max_output_size: 1024 * 1024, // 1MB
            max_timeout_secs: 60,
            min_timeout_secs: 1,
            block_dangerous: true,
            blocked_patterns: vec![
                "rm -rf".to_string(),
                "mkfs".to_string(),
                "dd if=".to_string(),
                ":(){".to_string(), // Fork bomb
                ">(w)".to_string(),
            ],
        }
    }
}

/// Command validator.
#[derive(Debug)]
pub struct CommandValidator {
    config: ValidationConfig,
}

impl CommandValidator {
    /// Create a new validator with the given config.
    pub fn new(config: ValidationConfig) -> Self {
        Self { config }
    }

    /// Validate a command string.
    pub fn validate_command(&self, command: &str) -> Result<(), ValidationError> {
        // Check length
        if command.len() > self.config.max_command_length {
            return Err(ValidationError::CommandTooLong {
                length: command.len(),
                max: self.config.max_command_length,
            });
        }

        // Check for empty command
        if command.trim().is_empty() {
            return Err(ValidationError::EmptyCommand);
        }

        // Check for dangerous patterns
        if self.config.block_dangerous {
            if let Some(pattern) = self.check_dangerous_patterns(command) {
                return Err(ValidationError::DangerousCommand {
                    pattern: pattern.to_string(),
                });
            }
        }

        // Check custom blocked patterns
        for pattern in &self.config.blocked_patterns {
            if command.contains(pattern) {
                return Err(ValidationError::BlockedPattern {
                    pattern: pattern.clone(),
                });
            }
        }

        // Check for null bytes
        if command.contains('\0') {
            return Err(ValidationError::InvalidCharacter('\0'));
        }

        Ok(())
    }

    /// Validate a timeout value.
    pub fn validate_timeout(&self, timeout_secs: u64) -> Result<Duration, ValidationError> {
        if timeout_secs < self.config.min_timeout_secs {
            return Err(ValidationError::TimeoutTooShort {
                value: timeout_secs,
                min: self.config.min_timeout_secs,
            });
        }

        if timeout_secs > self.config.max_timeout_secs {
            return Err(ValidationError::TimeoutTooLong {
                value: timeout_secs,
                max: self.config.max_timeout_secs,
            });
        }

        Ok(Duration::from_secs(timeout_secs))
    }

    /// Validate working directory path.
    pub fn validate_working_dir(&self, path: &str) -> Result<(), ValidationError> {
        // Check for path traversal attempts
        if path.contains("..") {
            return Err(ValidationError::PathTraversal);
        }

        // Check for null bytes
        if path.contains('\0') {
            return Err(ValidationError::InvalidCharacter('\0'));
        }

        // Basic length check
        if path.len() > 4096 {
            return Err(ValidationError::PathTooLong {
                length: path.len(),
                max: 4096,
            });
        }

        Ok(())
    }

    /// Check for common dangerous command patterns.
    fn check_dangerous_patterns(&self, command: &str) -> Option<&'static str> {
        let lower = command.to_lowercase();

        // Dangerous file operations
        if lower.contains("rm -rf /") || lower.contains("rm -fr /") {
            return Some("rm -rf /");
        }

        // Format/partition commands
        if lower.contains("mkfs") || lower.contains("fdisk") || lower.contains("parted") {
            return Some("disk formatting");
        }

        // Raw disk access
        if lower.contains("dd if=/dev") && lower.contains("of=/dev") {
            return Some("raw disk write");
        }

        // Fork bomb patterns
        if lower.contains(":(){") || lower.contains(":(){ :|:& };:") {
            return Some("fork bomb");
        }

        // Shutdown/reboot
        if lower.contains("shutdown") || lower.contains("reboot") || lower.contains("init 0") {
            return Some("system shutdown");
        }

        // Dangerous redirections
        if lower.contains("> /dev/sd") || lower.contains("> /dev/nvme") {
            return Some("device overwrite");
        }

        None
    }

    /// Get the max output size.
    pub fn max_output_size(&self) -> usize {
        self.config.max_output_size
    }
}

impl Default for CommandValidator {
    fn default() -> Self {
        Self::new(ValidationConfig::default())
    }
}

/// Validation errors.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ValidationError {
    /// Command exceeds maximum length.
    CommandTooLong { length: usize, max: usize },
    /// Command is empty.
    EmptyCommand,
    /// Command contains dangerous pattern.
    DangerousCommand { pattern: String },
    /// Command matches blocked pattern.
    BlockedPattern { pattern: String },
    /// Command contains invalid character.
    InvalidCharacter(char),
    /// Timeout is too short.
    TimeoutTooShort { value: u64, min: u64 },
    /// Timeout is too long.
    TimeoutTooLong { value: u64, max: u64 },
    /// Path contains traversal attempt.
    PathTraversal,
    /// Path is too long.
    PathTooLong { length: usize, max: usize },
}

impl std::fmt::Display for ValidationError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::CommandTooLong { length, max } => {
                write!(f, "Command too long: {} chars (max: {})", length, max)
            }
            Self::EmptyCommand => write!(f, "Command cannot be empty"),
            Self::DangerousCommand { pattern } => {
                write!(f, "Dangerous command pattern detected: {}", pattern)
            }
            Self::BlockedPattern { pattern } => {
                write!(f, "Command contains blocked pattern: {}", pattern)
            }
            Self::InvalidCharacter(c) => {
                write!(f, "Command contains invalid character: {:?}", c)
            }
            Self::TimeoutTooShort { value, min } => {
                write!(f, "Timeout too short: {}s (min: {}s)", value, min)
            }
            Self::TimeoutTooLong { value, max } => {
                write!(f, "Timeout too long: {}s (max: {}s)", value, max)
            }
            Self::PathTraversal => write!(f, "Path traversal detected"),
            Self::PathTooLong { length, max } => {
                write!(f, "Path too long: {} chars (max: {})", length, max)
            }
        }
    }
}

impl std::error::Error for ValidationError {}

/// Sanitize a command string.
///
/// This removes potentially dangerous characters without blocking the command.
/// Use this for logging or display purposes.
pub fn sanitize_for_display(command: &str) -> String {
    command
        .chars()
        .filter(|c| !c.is_control() || *c == '\n' || *c == '\t')
        .take(1000) // Limit display length
        .collect()
}

/// Check if a string looks like a shell injection attempt.
pub fn looks_like_injection(input: &str) -> bool {
    let suspicious_patterns = [
        "$(", "`", "${", "&&", "||", ";", "|", ">", "<", "\\n", "\\r",
    ];

    suspicious_patterns.iter().any(|p| input.contains(p))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_validation_config_default() {
        let config = ValidationConfig::default();
        assert_eq!(config.max_command_length, 4096);
        assert!(config.block_dangerous);
    }

    #[test]
    fn test_validation_config_strict() {
        let config = ValidationConfig::strict();
        assert_eq!(config.max_command_length, 1024);
        assert!(config.block_dangerous);
        assert!(!config.blocked_patterns.is_empty());
    }

    #[test]
    fn test_validate_command_ok() {
        let validator = CommandValidator::default();

        assert!(validator.validate_command("ls -la").is_ok());
        assert!(validator.validate_command("echo hello world").is_ok());
        assert!(validator.validate_command("cat /etc/passwd").is_ok());
    }

    #[test]
    fn test_validate_command_empty() {
        let validator = CommandValidator::default();

        assert!(matches!(
            validator.validate_command(""),
            Err(ValidationError::EmptyCommand)
        ));
        assert!(matches!(
            validator.validate_command("   "),
            Err(ValidationError::EmptyCommand)
        ));
    }

    #[test]
    fn test_validate_command_too_long() {
        let validator = CommandValidator::new(ValidationConfig {
            max_command_length: 10,
            ..Default::default()
        });

        let result = validator.validate_command("this is a very long command");
        assert!(matches!(
            result,
            Err(ValidationError::CommandTooLong { .. })
        ));
    }

    #[test]
    fn test_validate_dangerous_rm() {
        let validator = CommandValidator::default();

        assert!(matches!(
            validator.validate_command("rm -rf /"),
            Err(ValidationError::DangerousCommand { .. })
        ));
        assert!(matches!(
            validator.validate_command("sudo rm -rf /home"),
            Err(ValidationError::DangerousCommand { .. })
        ));
    }

    #[test]
    fn test_validate_dangerous_fork_bomb() {
        let validator = CommandValidator::default();

        assert!(matches!(
            validator.validate_command(":(){ :|:& };:"),
            Err(ValidationError::DangerousCommand { .. })
        ));
    }

    #[test]
    fn test_validate_dangerous_shutdown() {
        let validator = CommandValidator::default();

        assert!(matches!(
            validator.validate_command("shutdown -h now"),
            Err(ValidationError::DangerousCommand { .. })
        ));
        assert!(matches!(
            validator.validate_command("reboot"),
            Err(ValidationError::DangerousCommand { .. })
        ));
    }

    #[test]
    fn test_validate_null_byte() {
        let validator = CommandValidator::default();

        assert!(matches!(
            validator.validate_command("ls\0 -la"),
            Err(ValidationError::InvalidCharacter('\0'))
        ));
    }

    #[test]
    fn test_validate_timeout() {
        let validator = CommandValidator::default();

        assert!(validator.validate_timeout(30).is_ok());
        assert!(validator.validate_timeout(1).is_ok());
        assert!(validator.validate_timeout(300).is_ok());

        assert!(matches!(
            validator.validate_timeout(0),
            Err(ValidationError::TimeoutTooShort { .. })
        ));
        assert!(matches!(
            validator.validate_timeout(1000),
            Err(ValidationError::TimeoutTooLong { .. })
        ));
    }

    #[test]
    fn test_validate_working_dir() {
        let validator = CommandValidator::default();

        assert!(validator.validate_working_dir("/home/user").is_ok());
        assert!(validator.validate_working_dir("/tmp").is_ok());

        assert!(matches!(
            validator.validate_working_dir("/home/../etc"),
            Err(ValidationError::PathTraversal)
        ));
    }

    #[test]
    fn test_blocked_patterns() {
        let validator = CommandValidator::new(ValidationConfig::strict());

        // "mkfs" is in strict blocked patterns but also dangerous
        // Use a pattern that's only in blocked_patterns
        assert!(matches!(
            validator.validate_command("dd if=/dev/zero"),
            Err(ValidationError::BlockedPattern { .. })
        ));
    }

    #[test]
    fn test_permissive_allows_dangerous() {
        let validator = CommandValidator::new(ValidationConfig::permissive());

        // Permissive mode doesn't block dangerous commands
        assert!(validator.validate_command("rm -rf /").is_ok());
    }

    #[test]
    fn test_sanitize_for_display() {
        assert_eq!(sanitize_for_display("hello"), "hello");
        assert_eq!(sanitize_for_display("hello\nworld"), "hello\nworld");
        assert_eq!(sanitize_for_display("hello\x00world"), "helloworld");

        // Long string is truncated
        let long = "a".repeat(2000);
        assert_eq!(sanitize_for_display(&long).len(), 1000);
    }

    #[test]
    fn test_looks_like_injection() {
        assert!(looks_like_injection("echo $(whoami)"));
        assert!(looks_like_injection("echo `id`"));
        assert!(looks_like_injection("cmd1 && cmd2"));
        assert!(looks_like_injection("cmd1 | cmd2"));

        assert!(!looks_like_injection("echo hello"));
        assert!(!looks_like_injection("ls -la"));
    }
}