fix: validate Quick Connect and ~/.ssh/config imports; unknown enum values no longer reset a profile's config
- Quick Connect runs the same validation as saved profiles, so an SSH connection without a username fails up front with a clear message (F5). - ~/.ssh/config imports fill a missing User (and jump-host user) with the local user name, as ssh does, and skip blocks that still don't validate, reporting how many (F6). - An unrecognised hostKeyPolicy/lineEnding/parity/flowControl/direction in a stored config falls back to that field's default instead of failing the whole JSON column and silently resetting every other setting; parse failures that remain are logged (F7).
This commit is contained in:
@@ -37,6 +37,12 @@ fn nd<'de, D: Deserializer<'de>, T: Default + Deserialize<'de>>(d: D) -> Result<
|
||||
Ok(Option::<T>::deserialize(d)?.unwrap_or_default())
|
||||
}
|
||||
|
||||
/// For enum fields: an unknown value (e.g. written by a newer build) falls back to the default
|
||||
/// for that field instead of failing the whole config, which would reset every other setting.
|
||||
fn lenient<'de, D: Deserializer<'de>, T: Default + serde::de::DeserializeOwned>(d: D) -> Result<T, D::Error> {
|
||||
Ok(Option::<serde_json::Value>::deserialize(d)?.and_then(|v| T::deserialize(v).ok()).unwrap_or_default())
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
|
||||
#[serde(rename_all = "lowercase")]
|
||||
pub enum Protocol {
|
||||
@@ -244,6 +250,7 @@ pub struct SshConfig {
|
||||
pub secret_mode: SecretMode,
|
||||
pub private_key_path: String,
|
||||
pub key_secret_mode: SecretMode,
|
||||
#[serde(deserialize_with = "lenient")]
|
||||
pub host_key_policy: HostKeyPolicy,
|
||||
pub terminal_type: String,
|
||||
pub keepalive_interval: i64,
|
||||
@@ -303,6 +310,7 @@ pub enum ForwardDirection {
|
||||
#[serde(rename_all = "camelCase", default)]
|
||||
pub struct PortForward {
|
||||
pub id: String,
|
||||
#[serde(deserialize_with = "lenient")]
|
||||
pub direction: ForwardDirection,
|
||||
pub bind_host: String,
|
||||
pub bind_port: i64,
|
||||
@@ -316,6 +324,7 @@ pub struct PortForward {
|
||||
#[serde(rename_all = "camelCase", default)]
|
||||
pub struct TelnetConfig {
|
||||
pub local_echo: bool,
|
||||
#[serde(deserialize_with = "lenient")]
|
||||
pub line_ending: LineEnding,
|
||||
pub terminal_type: String,
|
||||
pub encoding: String,
|
||||
@@ -331,6 +340,7 @@ pub struct TelnetConfig {
|
||||
#[serde(rename_all = "camelCase", default)]
|
||||
pub struct RawConfig {
|
||||
pub auto_reconnect: bool,
|
||||
#[serde(deserialize_with = "lenient")]
|
||||
pub line_ending: LineEnding,
|
||||
pub encoding: String,
|
||||
pub show_timestamps: bool,
|
||||
@@ -431,9 +441,12 @@ pub enum FlowControl {
|
||||
pub struct SerialConfig {
|
||||
pub baud_rate: u32,
|
||||
pub data_bits: u8,
|
||||
#[serde(deserialize_with = "lenient")]
|
||||
pub parity: Parity,
|
||||
pub stop_bits: u8,
|
||||
#[serde(deserialize_with = "lenient")]
|
||||
pub flow_control: FlowControl,
|
||||
#[serde(deserialize_with = "lenient")]
|
||||
pub line_ending: LineEnding,
|
||||
pub local_echo: bool,
|
||||
pub dtr_on_connect: bool,
|
||||
@@ -919,3 +932,18 @@ impl IrcConfig {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn unknown_enum_values_fall_back_per_field() {
|
||||
let c: SshConfig = serde_json::from_str(r#"{"hostKeyPolicy":"from-the-future","keepaliveInterval":42,"agentForwarding":true}"#).unwrap();
|
||||
assert_eq!((c.host_key_policy, c.keepalive_interval, c.agent_forwarding), (HostKeyPolicy::Ask, 42, true));
|
||||
let c: SshConfig = serde_json::from_str(r#"{"hostKeyPolicy":"strict"}"#).unwrap();
|
||||
assert_eq!(c.host_key_policy, HostKeyPolicy::Strict);
|
||||
let t: TelnetConfig = serde_json::from_str(r#"{"lineEnding":"weird","localEcho":true}"#).unwrap();
|
||||
assert_eq!((t.line_ending, t.local_echo), (LineEnding::default(), true));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -109,12 +109,17 @@ impl Service {
|
||||
}
|
||||
|
||||
/// Opens an unsaved profile (Quick Connect).
|
||||
pub fn connect_quick(&self, mut p: Profile) -> String {
|
||||
/// Validates like a saved profile (so e.g. an empty SSH username fails here, not at auth).
|
||||
pub fn connect_quick(&self, mut p: Profile) -> Result<String> {
|
||||
if p.id.is_empty() {
|
||||
p.id = new_id();
|
||||
}
|
||||
if p.display_name.trim().is_empty() {
|
||||
p.display_name = p.host.clone();
|
||||
}
|
||||
p.normalize();
|
||||
self.sessions.connect(p)
|
||||
validation::validate_profile(&p).map_err(|e| e.to_string())?;
|
||||
Ok(self.sessions.connect(p))
|
||||
}
|
||||
|
||||
pub fn connect_local(&self) -> String {
|
||||
@@ -277,15 +282,30 @@ impl Service {
|
||||
self.import(ps, strategy)
|
||||
}
|
||||
|
||||
pub fn import_ssh_config(&self, path: Option<&Path>, folder: &str) -> Result<usize> {
|
||||
/// Imports Host blocks as profiles; returns (imported, skipped). A block without `User` gets
|
||||
/// the local user name, as `ssh` itself would; blocks that still don't validate are skipped.
|
||||
pub fn import_ssh_config(&self, path: Option<&Path>, folder: &str) -> Result<(usize, usize)> {
|
||||
let path = path.map(Path::to_path_buf).or_else(sshconfig::default_config_path).ok_or("no ~/.ssh/config found")?;
|
||||
let blocks = sshconfig::parse_file(&path)?;
|
||||
let mut n = 0;
|
||||
for p in sshconfig::to_profiles(&blocks, folder) {
|
||||
n += self.store.create_profile(&p).is_ok() as usize;
|
||||
let local_user = std::env::var("USER").or_else(|_| std::env::var("USERNAME")).unwrap_or_default();
|
||||
let (mut n, mut skipped) = (0, 0);
|
||||
for mut p in sshconfig::to_profiles(&blocks, folder) {
|
||||
if p.username.is_empty() {
|
||||
p.username = local_user.clone();
|
||||
}
|
||||
for jh in p.ssh.iter_mut().flat_map(|s| s.jump_hosts.iter_mut()) {
|
||||
if jh.username.is_empty() {
|
||||
jh.username = local_user.clone();
|
||||
}
|
||||
}
|
||||
if validation::validate_profile(&p).is_ok() && self.store.create_profile(&p).is_ok() {
|
||||
n += 1;
|
||||
} else {
|
||||
skipped += 1;
|
||||
}
|
||||
}
|
||||
self.store.add_audit("import", "", "", &format!("Imported {n} profile(s)"));
|
||||
Ok(n)
|
||||
self.store.add_audit("import", "", "", &format!("Imported {n} profile(s) from SSH config, skipped {skipped}"));
|
||||
Ok((n, skipped))
|
||||
}
|
||||
|
||||
// --- SSH keys -----------------------------------------------------------------------
|
||||
|
||||
@@ -46,7 +46,8 @@ fn json_col<T: serde::Serialize>(v: &Option<T>) -> Option<String> {
|
||||
}
|
||||
|
||||
fn parse_col<T: serde::de::DeserializeOwned>(s: Option<String>) -> Option<T> {
|
||||
s.filter(|s| !s.is_empty() && s != "null").and_then(|s| serde_json::from_str(&s).ok())
|
||||
let s = s.filter(|s| !s.is_empty() && s != "null")?;
|
||||
serde_json::from_str(&s).inspect_err(|e| eprintln!("storage: ignoring unreadable profile config: {e}")).ok()
|
||||
}
|
||||
|
||||
fn scan_profile(r: &Row) -> rusqlite::Result<Profile> {
|
||||
|
||||
Reference in New Issue
Block a user