rash-ssh 0.2.0

Rust Auto SSH — start an ssh session or tunnel, monitor it, and restart it when it dies or stops passing traffic
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

//! The pid file, removed when the guard is dropped.
//!
//! autossh registers an `atexit()` handler for this (autossh.c:1721-1727), which
//! it then has to work around in `xerrlog()` because `_exit()` skips those on
//! most systems. A `Drop` guard needs no such special case.

use std::fs::{self, File, OpenOptions};
use std::io::{self, Write};
use std::path::{Path, PathBuf};
use std::process;
use std::time::SystemTime;

#[derive(Debug)]
pub struct PidFile {
    path: PathBuf,
}

impl PidFile {
    /// Write the current pid. Call this *after* any daemonising fork, so the
    /// file records the daemon's pid rather than that of the process that
    /// forked it.
    pub fn create(path: &Path) -> io::Result<Self> {
        let mut f = File::create(path)?;
        writeln!(f, "{}", std::process::id())?;
        f.flush()?;
        Ok(Self {
            path: path.to_path_buf(),
        })
    }

    /// Bump the modification time so a watchdog can see rash is still alive.
    ///
    /// autossh only does this when built with `-DTOUCH_PIDFILE`, which is off in
    /// the stock build; rash exposes it as `RASH_TOUCH_PIDFILE`.
    pub fn touch(&self) -> io::Result<()> {
        OpenOptions::new()
            .write(true)
            .open(&self.path)?
            .set_modified(SystemTime::now())
    }
}

impl Drop for PidFile {
    /// Remove the file, but only while it is still ours.
    ///
    /// Nothing stops a second rash being pointed at the same path: it truncates
    /// the file and writes its own pid, and without this check the first one to
    /// exit would then delete the *survivor's* pid file, leaving a live
    /// supervisor that no watchdog can find.
    fn drop(&mut self) {
        let ours = fs::read_to_string(&self.path)
            .ok()
            .and_then(|s| s.trim().parse::<u32>().ok())
            .is_some_and(|pid| pid == process::id());
        if ours {
            let _ = fs::remove_file(&self.path);
        }
    }
}