fm-tui 0.2.3

FM : a file manager inspired by ranger and dired{n}{n}Config files ~/.config/fm/{n}Documentation https://github.com/qkzk/fm{n}
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

/// Different kind of password
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum PasswordKind {
    SUDO,
    CRYPTSETUP,
}

impl std::fmt::Display for PasswordKind {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        let asker = match self {
            Self::SUDO => "sudo   ",
            Self::CRYPTSETUP => "device ",
        };
        write!(f, "{asker}")
    }
}

/// What will this password be used for ?
/// ATM only 3 usages are supported:
/// * mounting an ISO file,
/// * opening an mounting an encrypted device.
/// * running a sudo command
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum PasswordUsage {
    ISO,
    CRYPTSETUP(PasswordKind),
    SUDOCOMMAND,
    DEVICE,
}

type Password = String;

/// Holds passwords allowing to mount or unmount an encrypted drive.
#[derive(Default, Clone)]
pub struct PasswordHolder {
    sudo: Option<Password>,
    cryptsetup: Option<Password>,
}

/// Custom debug format to prevent leaking passwords in logs.
impl std::fmt::Debug for PasswordHolder {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("PasswordHodler")
            .field("sudo", &self.hide_option(PasswordKind::SUDO))
            .field("cryptsetup", &self.hide_option(PasswordKind::CRYPTSETUP))
            .finish()
    }
}

impl PasswordHolder {
    const fn hide_option(&self, password_kind: PasswordKind) -> &str {
        match password_kind {
            PasswordKind::SUDO => Self::hide(self.has_sudo()),
            PasswordKind::CRYPTSETUP => Self::hide(self.has_cryptsetup()),
        }
    }

    const fn hide(is_set: bool) -> &'static str {
        if is_set {
            "Some(****)"
        } else {
            "None"
        }
    }

    /// Set the sudo password.
    pub fn set_sudo(&mut self, password: Password) {
        self.sudo = Some(password);
    }

    /// Set the encrypted device passphrase
    pub fn set_cryptsetup(&mut self, passphrase: Password) {
        self.cryptsetup = Some(passphrase);
    }

    /// Reads the cryptsetup password
    #[must_use]
    pub fn cryptsetup(&mut self) -> Option<Password> {
        std::mem::take(&mut self.cryptsetup)
    }

    /// Reads the sudo password
    #[must_use]
    pub fn sudo(&mut self) -> Option<Password> {
        std::mem::take(&mut self.sudo)
    }

    /// True if the sudo password was set
    #[must_use]
    pub const fn has_sudo(&self) -> bool {
        self.sudo.is_some()
    }

    /// True if the encrypted device passphrase was set
    #[must_use]
    pub const fn has_cryptsetup(&self) -> bool {
        self.cryptsetup.is_some()
    }

    /// Reset every known password, dropping them.
    /// It should be called ASAP.
    pub fn reset(&mut self) {
        std::mem::take(&mut self.sudo);
        std::mem::take(&mut self.cryptsetup);
        self.sudo = None;
        self.cryptsetup = None;
    }
}