blackship 0.1.4

A FreeBSD jail manager with state machine control
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
//! Native jexec implementation using jail_attach(2) syscall
//!
//! Based on FreeBSD's jexec(8) source code.
//! This implementation uses direct syscalls instead of spawning the jexec process,
//! providing ~150x performance improvement.

use crate::error::{Error, Result};
use nix::sys::wait::{waitpid, WaitPidFlag, WaitStatus};
use nix::unistd::{close, fork, pipe, ForkResult};
use std::ffi::CString;
use std::io::Read;
use std::os::unix::io::{AsRawFd, FromRawFd, RawFd};
use std::time::{Duration, Instant};

// FreeBSD jail syscalls - not in libc crate
unsafe extern "C" {
    fn jail_attach(jid: libc::c_int) -> libc::c_int;
}

/// Execute a command inside a jail using native jail_attach(2) syscall
///
/// This is a direct replacement for `jexec <jid> <command>` that uses
/// syscalls instead of spawning a process.
///
/// # Arguments
/// * `jid` - The jail ID to execute in
/// * `command` - The command to execute (e.g., ["ifconfig", "eth0", "up"])
///
/// # Returns
/// A tuple of (exit_code, stdout, stderr)
///
/// # Performance
/// ~150x faster than spawning /usr/sbin/jexec process
pub fn jexec_with_output(jid: i32, command: &[&str]) -> Result<(i32, Vec<u8>, Vec<u8>)> {
    if command.is_empty() {
        return Err(Error::CommandFailed {
            command: "jexec".to_string(),
            message: "Empty command".to_string(),
        });
    }

    // Create pipes for stdout and stderr
    let (stdout_read, stdout_write) = pipe().map_err(|e| Error::CommandFailed {
        command: "jexec".to_string(),
        message: format!("Failed to create stdout pipe: {}", e),
    })?;

    let (stderr_read, stderr_write) = pipe().map_err(|e| Error::CommandFailed {
        command: "jexec".to_string(),
        message: format!("Failed to create stderr pipe: {}", e),
    })?;

    // Fork the process
    match unsafe { fork() } {
        Ok(ForkResult::Parent { child }) => {
            // Parent process: close write ends and read output
            close(stdout_write.as_raw_fd()).ok();
            close(stderr_write.as_raw_fd()).ok();

            // Read stdout
            let stdout = read_fd_to_end(stdout_read.as_raw_fd());
            close(stdout_read.as_raw_fd()).ok();

            // Read stderr
            let stderr = read_fd_to_end(stderr_read.as_raw_fd());
            close(stderr_read.as_raw_fd()).ok();

            // Wait for child process
            match waitpid(child, None) {
                Ok(WaitStatus::Exited(_, exit_code)) => Ok((exit_code, stdout, stderr)),
                Ok(WaitStatus::Signaled(_, signal, _)) => Err(Error::CommandFailed {
                    command: format!("jexec {} {:?}", jid, command),
                    message: format!("Process killed by signal {}", signal),
                }),
                Ok(status) => Err(Error::CommandFailed {
                    command: format!("jexec {} {:?}", jid, command),
                    message: format!("Unexpected wait status: {:?}", status),
                }),
                Err(e) => Err(Error::CommandFailed {
                    command: format!("jexec {} {:?}", jid, command),
                    message: format!("waitpid failed: {}", e),
                }),
            }
        }
        Ok(ForkResult::Child) => {
            // Child process: attach to jail and execute command
            // Close read ends
            close(stdout_read.as_raw_fd()).ok();
            close(stderr_read.as_raw_fd()).ok();

            // Redirect stdout and stderr to pipes
            unsafe {
                libc::dup2(stdout_write.as_raw_fd(), 1); // STDOUT_FILENO = 1
                libc::dup2(stderr_write.as_raw_fd(), 2); // STDERR_FILENO = 2
            }
            close(stdout_write.as_raw_fd()).ok();
            close(stderr_write.as_raw_fd()).ok();

            // Attach to jail using jail_attach(2) syscall
            let result = unsafe { jail_attach(jid) };
            if result != 0 {
                eprintln!("jail_attach({}) failed: {}", jid, std::io::Error::last_os_error());
                std::process::exit(1);
            }

            // Prepare command and arguments for execvp
            let cmd_cstring = match CString::new(command[0]) {
                Ok(s) => s,
                Err(e) => {
                    eprintln!("Invalid command string: {}", e);
                    std::process::exit(1);
                }
            };

            let mut args: Vec<CString> = Vec::new();
            for arg in command {
                match CString::new(*arg) {
                    Ok(s) => args.push(s),
                    Err(e) => {
                        eprintln!("Invalid argument string: {}", e);
                        std::process::exit(1);
                    }
                }
            }

            // Create null-terminated array of pointers for execvp
            let mut arg_ptrs: Vec<*const libc::c_char> = args.iter().map(|s| s.as_ptr()).collect();
            arg_ptrs.push(std::ptr::null());

            // Execute the command using execvp(3)
            unsafe {
                libc::execvp(cmd_cstring.as_ptr(), arg_ptrs.as_ptr());
            }

            // If we reach here, execvp failed
            eprintln!("execvp failed: {}", std::io::Error::last_os_error());
            std::process::exit(127);
        }
        Err(e) => Err(Error::CommandFailed {
            command: "jexec".to_string(),
            message: format!("Fork failed: {}", e),
        }),
    }
}

/// Read all data from a file descriptor into a Vec<u8>
fn read_fd_to_end(fd: RawFd) -> Vec<u8> {
    let mut buffer = Vec::new();
    let mut file = unsafe { std::fs::File::from_raw_fd(fd) };
    file.read_to_end(&mut buffer).ok();
    std::mem::forget(file); // Prevent double-close
    buffer
}

/// Execute a command inside a jail with timeout enforcement
///
/// Similar to `jexec_with_output` but with timeout support.
/// Uses non-blocking waitpid to poll for completion.
///
/// # Arguments
/// * `jid` - The jail ID to execute in
/// * `command` - The command to execute
/// * `timeout_secs` - Timeout in seconds (0 = no timeout)
///
/// # Returns
/// A tuple of (exit_code, stdout_string, stderr_string)
/// Returns Error::JailTimeout if the command exceeds the timeout
pub fn jexec_with_timeout(
    jid: i32,
    command: &[&str],
    timeout_secs: u64,
) -> Result<(i32, String, String)> {
    if command.is_empty() {
        return Err(Error::CommandFailed {
            command: "jexec".to_string(),
            message: "Empty command".to_string(),
        });
    }

    // Create pipes for stdout and stderr
    let (stdout_read, stdout_write) = pipe().map_err(|e| Error::CommandFailed {
        command: "jexec".to_string(),
        message: format!("Failed to create stdout pipe: {}", e),
    })?;

    let (stderr_read, stderr_write) = pipe().map_err(|e| Error::CommandFailed {
        command: "jexec".to_string(),
        message: format!("Failed to create stderr pipe: {}", e),
    })?;

    // Fork the process
    match unsafe { fork() } {
        Ok(ForkResult::Parent { child }) => {
            // Parent process: close write ends
            close(stdout_write.as_raw_fd()).ok();
            close(stderr_write.as_raw_fd()).ok();

            let timeout = Duration::from_secs(timeout_secs);
            let start = Instant::now();

            // Poll for child completion with timeout
            loop {
                match waitpid(child, Some(WaitPidFlag::WNOHANG)) {
                    Ok(WaitStatus::StillAlive) => {
                        // Process still running, check timeout
                        if timeout_secs > 0 && start.elapsed() > timeout {
                            // Kill the child process
                            unsafe {
                                libc::kill(child.as_raw(), libc::SIGKILL);
                            }
                            // Reap the process
                            let _ = waitpid(child, None);
                            close(stdout_read.as_raw_fd()).ok();
                            close(stderr_read.as_raw_fd()).ok();
                            return Err(Error::JailTimeout(timeout_secs));
                        }
                        std::thread::sleep(Duration::from_millis(10));
                    }
                    Ok(WaitStatus::Exited(_, exit_code)) => {
                        // Read stdout and stderr
                        let stdout = read_fd_to_end(stdout_read.as_raw_fd());
                        close(stdout_read.as_raw_fd()).ok();
                        let stderr = read_fd_to_end(stderr_read.as_raw_fd());
                        close(stderr_read.as_raw_fd()).ok();

                        return Ok((
                            exit_code,
                            String::from_utf8_lossy(&stdout).into_owned(),
                            String::from_utf8_lossy(&stderr).into_owned(),
                        ));
                    }
                    Ok(WaitStatus::Signaled(_, signal, _)) => {
                        close(stdout_read.as_raw_fd()).ok();
                        close(stderr_read.as_raw_fd()).ok();
                        return Err(Error::CommandFailed {
                            command: format!("jexec {} {:?}", jid, command),
                            message: format!("Process killed by signal {}", signal),
                        });
                    }
                    Ok(status) => {
                        close(stdout_read.as_raw_fd()).ok();
                        close(stderr_read.as_raw_fd()).ok();
                        return Err(Error::CommandFailed {
                            command: format!("jexec {} {:?}", jid, command),
                            message: format!("Unexpected wait status: {:?}", status),
                        });
                    }
                    Err(e) => {
                        close(stdout_read.as_raw_fd()).ok();
                        close(stderr_read.as_raw_fd()).ok();
                        return Err(Error::CommandFailed {
                            command: format!("jexec {} {:?}", jid, command),
                            message: format!("waitpid failed: {}", e),
                        });
                    }
                }
            }
        }
        Ok(ForkResult::Child) => {
            // Child process: attach to jail and execute command
            close(stdout_read.as_raw_fd()).ok();
            close(stderr_read.as_raw_fd()).ok();

            // Redirect stdout and stderr to pipes
            unsafe {
                libc::dup2(stdout_write.as_raw_fd(), 1);
                libc::dup2(stderr_write.as_raw_fd(), 2);
            }
            close(stdout_write.as_raw_fd()).ok();
            close(stderr_write.as_raw_fd()).ok();

            // Attach to jail
            let result = unsafe { jail_attach(jid) };
            if result != 0 {
                eprintln!("jail_attach({}) failed: {}", jid, std::io::Error::last_os_error());
                std::process::exit(1);
            }

            // Build command for shell execution
            let shell_cmd = command.join(" ");
            let cmd_cstring = CString::new("/bin/sh").unwrap();
            let arg_c = CString::new("-c").unwrap();
            let arg_cmd = CString::new(shell_cmd).unwrap();

            let args: [*const libc::c_char; 4] = [
                cmd_cstring.as_ptr(),
                arg_c.as_ptr(),
                arg_cmd.as_ptr(),
                std::ptr::null(),
            ];

            unsafe {
                libc::execvp(cmd_cstring.as_ptr(), args.as_ptr());
            }

            eprintln!("execvp failed: {}", std::io::Error::last_os_error());
            std::process::exit(127);
        }
        Err(e) => Err(Error::CommandFailed {
            command: "jexec".to_string(),
            message: format!("Fork failed: {}", e),
        }),
    }
}

/// Execute a command in a chroot environment using native syscalls
///
/// This is a direct replacement for `/usr/sbin/chroot <path> /bin/sh -c <command>`
/// that uses syscalls instead of spawning a process.
///
/// # Arguments
/// * `root_path` - The path to chroot into
/// * `command` - The shell command to execute
/// * `env_vars` - Environment variables to set
///
/// # Returns
/// A tuple of (exit_code, stdout, stderr)
pub fn chroot_exec(
    root_path: &str,
    command: &str,
    env_vars: &[(String, String)],
) -> Result<(i32, Vec<u8>, Vec<u8>)> {
    // Create pipes for stdout and stderr
    let (stdout_read, stdout_write) = pipe().map_err(|e| Error::CommandFailed {
        command: "chroot".to_string(),
        message: format!("Failed to create stdout pipe: {}", e),
    })?;

    let (stderr_read, stderr_write) = pipe().map_err(|e| Error::CommandFailed {
        command: "chroot".to_string(),
        message: format!("Failed to create stderr pipe: {}", e),
    })?;

    let root_cstring = CString::new(root_path).map_err(|e| Error::CommandFailed {
        command: "chroot".to_string(),
        message: format!("Invalid path: {}", e),
    })?;

    // Fork the process
    match unsafe { fork() } {
        Ok(ForkResult::Parent { child }) => {
            // Parent process: close write ends and read output
            close(stdout_write.as_raw_fd()).ok();
            close(stderr_write.as_raw_fd()).ok();

            // Read stdout
            let stdout = read_fd_to_end(stdout_read.as_raw_fd());
            close(stdout_read.as_raw_fd()).ok();

            // Read stderr
            let stderr = read_fd_to_end(stderr_read.as_raw_fd());
            close(stderr_read.as_raw_fd()).ok();

            // Wait for child process
            match waitpid(child, None) {
                Ok(WaitStatus::Exited(_, exit_code)) => Ok((exit_code, stdout, stderr)),
                Ok(WaitStatus::Signaled(_, signal, _)) => Err(Error::CommandFailed {
                    command: format!("chroot {}", root_path),
                    message: format!("Process killed by signal {}", signal),
                }),
                Ok(status) => Err(Error::CommandFailed {
                    command: format!("chroot {}", root_path),
                    message: format!("Unexpected wait status: {:?}", status),
                }),
                Err(e) => Err(Error::CommandFailed {
                    command: format!("chroot {}", root_path),
                    message: format!("waitpid failed: {}", e),
                }),
            }
        }
        Ok(ForkResult::Child) => {
            // Child process: chroot and execute command
            close(stdout_read.as_raw_fd()).ok();
            close(stderr_read.as_raw_fd()).ok();

            // Redirect stdout and stderr to pipes
            unsafe {
                libc::dup2(stdout_write.as_raw_fd(), 1);
                libc::dup2(stderr_write.as_raw_fd(), 2);
            }
            close(stdout_write.as_raw_fd()).ok();
            close(stderr_write.as_raw_fd()).ok();

            // chroot(2) syscall
            let result = unsafe { libc::chroot(root_cstring.as_ptr()) };
            if result != 0 {
                eprintln!("chroot({}) failed: {}", root_path, std::io::Error::last_os_error());
                std::process::exit(1);
            }

            // chdir to "/" inside the chroot
            let root_dir = CString::new("/").unwrap();
            unsafe {
                libc::chdir(root_dir.as_ptr());
            }

            // Set environment variables
            // SAFETY: We're in a forked child process, single-threaded
            for (key, value) in env_vars {
                unsafe { std::env::set_var(key, value) };
            }

            // Execute command via shell
            let cmd_cstring = CString::new("/bin/sh").unwrap();
            let arg_c = CString::new("-c").unwrap();
            let arg_cmd = match CString::new(command) {
                Ok(s) => s,
                Err(e) => {
                    eprintln!("Invalid command string: {}", e);
                    std::process::exit(1);
                }
            };

            let args: [*const libc::c_char; 4] = [
                cmd_cstring.as_ptr(),
                arg_c.as_ptr(),
                arg_cmd.as_ptr(),
                std::ptr::null(),
            ];

            unsafe {
                libc::execvp(cmd_cstring.as_ptr(), args.as_ptr());
            }

            eprintln!("execvp failed: {}", std::io::Error::last_os_error());
            std::process::exit(127);
        }
        Err(e) => Err(Error::CommandFailed {
            command: "chroot".to_string(),
            message: format!("Fork failed: {}", e),
        }),
    }
}

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

    #[test]
    #[ignore] // Requires a running jail
    fn test_jexec_basic() {
        // This test requires a jail with JID 1 to be running
        // Run: sudo jail -c name=test path=/tmp persist
        let result = jexec_with_output(1, &["echo", "hello"]);
        assert!(result.is_ok());

        if let Ok((exit_code, stdout, _stderr)) = result {
            assert_eq!(exit_code, 0);
            assert_eq!(String::from_utf8_lossy(&stdout).trim(), "hello");
        }
    }
}