badterm 0.1.28

A cross-platform ANSI-BBS telnet client
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

//! Passwords kept in the OS credential store (Keychain on macOS, Credential
//! Manager on Windows, the Secret Service on Linux) instead of the directory
//! file. Where no store is available, passwords stay in the file as before.

use badterm_core::{Directory, Entry};

const SERVICE: &str = "BadTerm BBS client";
/// Where passwords were kept when BadTerm was called Phosphor (to 0.1.16).
const OLD_SERVICE: &str = "Phosphor BBS client";

/// Somewhere to keep passwords; [`Keychain`] in the app, an in-memory map in
/// tests.
pub trait Store {
    fn get(&self, account: &str) -> Result<Option<String>, String>;
    fn set(&self, account: &str, password: &str) -> Result<(), String>;
    fn delete(&self, account: &str) -> Result<(), String>;
}

/// The OS credential store.
pub struct Keychain;

impl Keychain {
    fn entry(account: &str) -> Result<keyring::Entry, String> {
        keyring::Entry::new(SERVICE, account).map_err(|e| e.to_string())
    }
}

impl Store for Keychain {
    fn get(&self, account: &str) -> Result<Option<String>, String> {
        match Self::entry(account)?.get_password() {
            Ok(p) => return Ok(Some(p)),
            Err(keyring::Error::NoEntry) => {}
            Err(e) => return Err(e.to_string()),
        }
        // Not found: it may still be under the old name; move it over.
        let old = keyring::Entry::new(OLD_SERVICE, account).map_err(|e| e.to_string())?;
        match old.get_password() {
            Ok(p) => {
                if self.set(account, &p).is_ok() {
                    let _ = old.delete_credential();
                }
                Ok(Some(p))
            }
            Err(keyring::Error::NoEntry) => Ok(None),
            Err(e) => Err(e.to_string()),
        }
    }

    fn set(&self, account: &str, password: &str) -> Result<(), String> {
        Self::entry(account)?.set_password(password).map_err(|e| e.to_string())
    }

    fn delete(&self, account: &str) -> Result<(), String> {
        if let Ok(old) = keyring::Entry::new(OLD_SERVICE, account) {
            let _ = old.delete_credential();
        }
        match Self::entry(account)?.delete_credential() {
            Ok(()) | Err(keyring::Error::NoEntry) => Ok(()),
            Err(e) => Err(e.to_string()),
        }
    }
}

/// The credential name for an entry, e.g. `guest@ssh://bbs.example.com:22`.
pub fn account(e: &Entry) -> String {
    format!("{}@{}", e.username, e.system_id())
}

/// The entry's password: from the file, or else from the store.
pub fn password(e: &Entry, store: &dyn Store) -> Result<String, String> {
    if !e.password.is_empty() || !e.keychain {
        return Ok(e.password.clone());
    }
    Ok(store.get(&account(e))?.unwrap_or_default())
}

/// Move passwords held in the file into the store. On failure the rest stay
/// in the file, and the store's error is returned.
pub fn migrate(dir: &mut Directory, store: &dyn Store) -> Result<(), String> {
    for e in dir.entries.iter_mut().filter(|e| !e.password.is_empty()) {
        store.set(&account(e), &e.password)?;
        e.password.clear();
        e.keychain = true;
    }
    Ok(())
}

/// Remove an entry's stored password, if it has one.
pub fn forget(e: &Entry, store: &dyn Store) {
    if e.keychain
        && let Err(err) = store.delete(&account(e))
    {
        log::warn!("removing the password for {} from the keychain: {err}", e.name);
    }
}

#[cfg(test)]
pub mod tests {
    use std::cell::RefCell;
    use std::collections::HashMap;

    use super::*;

    /// An in-memory store; `broken` makes every call fail.
    #[derive(Default)]
    pub struct Memory {
        pub map: RefCell<HashMap<String, String>>,
        pub broken: bool,
    }

    impl Store for Memory {
        fn get(&self, account: &str) -> Result<Option<String>, String> {
            if self.broken {
                return Err("no keychain".into());
            }
            Ok(self.map.borrow().get(account).cloned())
        }

        fn set(&self, account: &str, password: &str) -> Result<(), String> {
            if self.broken {
                return Err("no keychain".into());
            }
            self.map.borrow_mut().insert(account.into(), password.into());
            Ok(())
        }

        fn delete(&self, account: &str) -> Result<(), String> {
            if self.broken {
                return Err("no keychain".into());
            }
            self.map.borrow_mut().remove(account);
            Ok(())
        }
    }

    fn ssh(user: &str, password: &str) -> Entry {
        let mut e = Entry::from_address(&format!("ssh://{user}@bbs.example.com")).unwrap();
        e.password = password.into();
        e
    }

    #[test]
    fn passwords_move_into_the_store() {
        let store = Memory::default();
        let mut dir = Directory { entries: vec![ssh("guest", "pw"), ssh("other", "")], ..Directory::default() };
        migrate(&mut dir, &store).unwrap();
        let e = &dir.entries[0];
        assert!(e.password.is_empty() && e.keychain);
        assert_eq!(store.map.borrow()["guest@ssh://bbs.example.com:22"], "pw");
        assert_eq!(password(e, &store).unwrap(), "pw");
        // An entry without a password is left alone.
        assert!(!dir.entries[1].keychain);
        assert_eq!(password(&dir.entries[1], &store).unwrap(), "");

        forget(e, &store);
        assert!(store.map.borrow().is_empty());
    }

    /// Against the real credential store, so ignored by default; CI runs it
    /// on Windows and macOS (`cargo test -p badterm keychain -- --ignored`).
    #[test]
    #[ignore]
    fn keychain_passwords_move_from_phosphor() {
        let account = format!("ci-{}@telnet://upgrade.test:23", std::process::id());
        let old = keyring::Entry::new(OLD_SERVICE, &account)
            .unwrap_or_else(|e| panic!("no credential store ({e}): {:?}", keyring::Entry::store_status()));
        old.set_password("from-phosphor").expect("the OS credential store");
        let store = Keychain;
        assert_eq!(store.get(&account).unwrap().as_deref(), Some("from-phosphor"));
        // Moved: under the new name now, and gone from the old one.
        assert!(matches!(old.get_password(), Err(keyring::Error::NoEntry)));
        assert_eq!(Keychain::entry(&account).unwrap().get_password().unwrap(), "from-phosphor");
        store.delete(&account).unwrap();
        assert_eq!(store.get(&account).unwrap(), None);
    }

    #[test]
    fn without_a_store_passwords_stay_in_the_file() {
        let store = Memory { broken: true, ..Memory::default() };
        let mut dir = Directory { entries: vec![ssh("guest", "pw")], ..Directory::default() };
        assert!(migrate(&mut dir, &store).is_err());
        assert_eq!(dir.entries[0].password, "pw");
        assert!(!dir.entries[0].keychain);
        // Reading never needs the store then.
        assert_eq!(password(&dir.entries[0], &store).unwrap(), "pw");
    }
}