exfiltrate 0.4.0

An embeddable debug tool for Rust.
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

// SPDX-License-Identifier: MIT OR Apache-2.0
//! Implements the native-only command that terminates the debugged process.
#![cfg(not(target_arch = "wasm32"))]
use exfiltrate_internal::command::{Command, Response};

/// The `terminate` command.
///
/// Exits the application with status code 70 (EX_SOFTWARE).
/// Only available on native targets.
pub struct Terminate;

impl Command for Terminate {
    fn name(&self) -> &'static str {
        "terminate"
    }

    fn short_description(&self) -> &'static str {
        "Terminates the program being debugged.  Use this to kill programs that stay resident."
    }

    fn full_description(&self) -> &'static str {
        "Terminates the program being debugged.  Use this to kill programs that stay resident.

A common debugging workflow is:
1.  build/run
2.  examine the program interactively
3.  quit the program

However step 3 may be difficult in a sandbox, or require PID tracking, etc.

This command will remotely exit the program we are debugging, with exit code 70 (EX_SOFTWARE)."
    }

    fn execute(&self, _args: Vec<String>) -> Result<Response, Response> {
        // This is the one path that knows the process is about to end, so it is
        // the one place that can take the instance file down cleanly. Anything
        // else — a crash, a signal — leaves the file behind, which is why
        // `exfiltrate instances` prunes what it cannot reach.
        crate::instances::withdraw();
        std::thread::Builder::new()
            .name("terminate".to_owned())
            .spawn(|| {
                std::thread::sleep(std::time::Duration::from_millis(50));
                std::process::exit(70 /* EX_SOFTWARE */);
            })
            .map_err(|error| {
                Response::String(format!("could not spawn the termination thread: {error}"))
            })?;
        Ok("Termination successful.".into())
    }
}