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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
use std::io;
use std::path::PathBuf;
use super::attach::{find_installed_remote_herdr, RemoteSsh, SshStdioBridge};
pub(crate) struct SavedSshBridge {
_bridge: SshStdioBridge,
}
pub(crate) struct SavedSshStream {
pub(crate) stream: crate::ipc::LocalStream,
pub(crate) bridge: SavedSshBridge,
}
pub(crate) fn connect_saved_ssh(
profile_id: &str,
target: &str,
session: &str,
) -> io::Result<SavedSshStream> {
let ssh = validated_saved_ssh(profile_id, target, session)?;
let remote_herdr = find_installed_remote_herdr(&ssh)?;
let metadata = remote_herdr.machine_metadata();
let path = saved_bridge_path(profile_id);
let bridge = SshStdioBridge::start(
target.to_owned(),
remote_herdr,
path.clone(),
session.to_owned(),
ssh.options(),
true,
)?;
let stream = crate::ipc::connect_local_stream(&path)?;
if let Some(metadata) = metadata {
crate::client::endpoint::SshMetadataCache::new(profile_id, target, session)?
.store(&metadata);
}
Ok(SavedSshStream {
stream,
bridge: SavedSshBridge { _bridge: bridge },
})
}
pub(crate) struct SavedSshApiBridge {
path: PathBuf,
bridge: SshStdioBridge,
metadata_cache: crate::client::endpoint::SshMetadataCache,
pub(crate) used_cached_metadata: bool,
}
impl SavedSshApiBridge {
pub(crate) fn start(
profile_id: &str,
target: &str,
session: &str,
use_cached_metadata: bool,
) -> io::Result<Self> {
let ssh = validated_saved_ssh(profile_id, target, session)?;
let metadata_cache =
crate::client::endpoint::SshMetadataCache::new(profile_id, target, session)?;
let cached = use_cached_metadata.then(|| metadata_cache.load()).flatten();
let used_cached_metadata = cached.is_some();
let metadata = match cached {
Some(metadata) => metadata,
None => {
let metadata = super::attach::discover_remote_api_metadata(&ssh, session)?;
metadata_cache.store(&metadata);
metadata
}
};
let command = super::attach::cached_remote_api_command(&metadata, session);
let path = crate::platform::remote_bridge_endpoint_path(
&format!("herdr-api-ssh-{}-{profile_id}.sock", std::process::id()),
&format!(
"herdr-api-{}-{}.sock",
std::process::id(),
&profile_id[..16]
),
);
let bridge = SshStdioBridge::start_command(
target.to_owned(),
command,
path.clone(),
ssh.options(),
true,
)?;
Ok(Self {
path,
bridge,
metadata_cache,
used_cached_metadata,
})
}
pub(crate) fn socket_path(&self) -> &std::path::Path {
&self.path
}
pub(crate) fn reported_failure(&self) -> Option<io::Error> {
self.bridge.reported_failure()
}
pub(crate) fn invalidate_metadata(&self) {
self.metadata_cache.invalidate();
}
pub(crate) fn stale_metadata_failure(error: &io::Error) -> bool {
error
.to_string()
.contains(super::attach::STALE_API_METADATA)
}
}
pub(crate) fn saved_ssh_bootstrap_command(target: &str, session: &str) -> String {
format!(
"herdr --remote {} --session {}",
super::shell_quote(target),
super::shell_quote(session)
)
}
pub(crate) fn saved_ssh_failure_needs_attention(error: &io::Error) -> bool {
if matches!(
error.kind(),
io::ErrorKind::InvalidInput
| io::ErrorKind::InvalidData
| io::ErrorKind::NotFound
| io::ErrorKind::PermissionDenied
| io::ErrorKind::Unsupported
) {
return true;
}
let message = error.to_string().to_ascii_lowercase();
[
"permission denied",
"host key verification failed",
"remote host identification has changed",
"no matching host key",
"unsupported remote platform",
"not ready",
"install or update",
"protocol",
"handshake",
]
.iter()
.any(|needle| message.contains(needle))
}
fn saved_bridge_path(profile_id: &str) -> PathBuf {
let pid = std::process::id();
let readable = format!("herdr-ssh-{pid}-{profile_id}.sock");
let short = format!("herdr-s-{pid}-{}.sock", &profile_id[..16]);
crate::platform::remote_bridge_endpoint_path(&readable, &short)
}
fn validated_saved_ssh(profile_id: &str, target: &str, session: &str) -> io::Result<RemoteSsh> {
validate_profile_path_id(profile_id)?;
crate::session::validate_name(session)
.map_err(|error| io::Error::new(io::ErrorKind::InvalidInput, error))?;
Ok(RemoteSsh::new_noninteractive(target.to_owned()))
}
fn validate_profile_path_id(profile_id: &str) -> io::Result<()> {
if profile_id.len() == 32
&& profile_id
.bytes()
.all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
{
Ok(())
} else {
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"invalid SSH endpoint profile id",
))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn bridge_paths_use_profile_identity_not_target_or_session() {
let first = saved_bridge_path("0123456789abcdef0123456789abcdef");
let second = saved_bridge_path("fedcba9876543210fedcba9876543210");
assert_ne!(first, second);
assert!(!first.to_string_lossy().contains("example.com"));
assert!(!first.to_string_lossy().contains("default"));
}
#[test]
fn bootstrap_command_preserves_the_explicit_remote_session() {
assert_eq!(
saved_ssh_bootstrap_command("build host", "agent work"),
"herdr --remote 'build host' --session 'agent work'"
);
}
#[test]
fn prompt_and_compatibility_failures_require_attention() {
for message in [
"Permission denied (publickey)",
"Host key verification failed",
"matching Herdr is not ready; install or update",
"handshake rejected",
] {
assert!(saved_ssh_failure_needs_attention(&io::Error::other(
message
)));
}
assert!(!saved_ssh_failure_needs_attention(&io::Error::new(
io::ErrorKind::TimedOut,
"network timed out"
)));
}
}
|
