hivectl: say which of the three socket failures actually happened
`hivectl open forge` on a host where the daemon is fine and the socket is fine printed "could not reach the hive-c0re daemon for URLs — is hive-c0re running?". It was running. The operator was not in `hive-admin` in that shell, and the connect got EACCES. The message was a guess, not a diagnosis, because `query_hive_urls` returned `Option` and threw the cause away with `.ok()`. Three different failures — not in the group, no socket at all, nobody listening — all arrived as the same sentence, and only one of the three is fixed by looking at the daemon. Classify the connect error in `client::request`, which every daemon-assisted verb goes through, and keep the io error as the anyhow cause so the output reads fix-first. EACCES names `hive-admin`, `services.hyperhive.adminUsers`, and — the part that actually bites — the re-login, since secondary group membership is only applied at login, so a shell opened before the grant still cannot connect. ENOENT and ECONNREFUSED point at the units instead. Then stop discarding it: `query_hive_urls` returns `Result<Option<_>>`, `open` and `require_hive_domain` propagate, and `daemon_request` drops its own "connect to daemon socket" context, which only buried the actionable line under a vaguer one. `wg init`'s domain lookup stays best-effort by an explicit `.ok().flatten()` rather than by accident. Same footgun `agent_exists` was already fixed for: a permission error collapsed into a value that reads as a different, wrong story.
This commit is contained in:
parent
053bbb1bb7
commit
f108c72f25
4 changed files with 139 additions and 28 deletions
|
|
@ -1,14 +1,60 @@
|
||||||
|
//! Host admin socket client: one request/response round trip over
|
||||||
|
//! `/run/hyperhive/host.sock`.
|
||||||
|
//!
|
||||||
|
//! Connect failures are classified into an actionable message before they
|
||||||
|
//! reach the operator (see [`connect_hint`]) — the three ways this fails
|
||||||
|
//! (not in `hive-admin`, no socket, nobody listening) need three different
|
||||||
|
//! fixes, and the raw `Permission denied (os error 13)` names none of them.
|
||||||
|
|
||||||
|
use std::io::ErrorKind;
|
||||||
use std::path::Path;
|
use std::path::Path;
|
||||||
|
|
||||||
use anyhow::{Context, Result, bail};
|
use anyhow::{Result, bail};
|
||||||
use hive_host_sock::{HostRequest, HostResponse};
|
use hive_host_sock::{HostRequest, HostResponse};
|
||||||
use tokio::io::{AsyncBufReadExt, AsyncWriteExt, BufReader};
|
use tokio::io::{AsyncBufReadExt, AsyncWriteExt, BufReader};
|
||||||
use tokio::net::UnixStream;
|
use tokio::net::UnixStream;
|
||||||
|
|
||||||
|
/// Turn a socket-connect `io::ErrorKind` into a message that names the fix.
|
||||||
|
///
|
||||||
|
/// The interesting one is `PermissionDenied`: the socket is `0660
|
||||||
|
/// root:hive-admin` behind a `0751` runtime dir, so a non-member gets EACCES
|
||||||
|
/// on connect — and so does a *member* whose shell predates the group being
|
||||||
|
/// granted, because secondary group membership is only applied at login. That
|
||||||
|
/// second case is the one that reads as "the daemon is down" and isn't.
|
||||||
|
fn connect_hint(kind: ErrorKind, socket: &Path) -> String {
|
||||||
|
let path = socket.display();
|
||||||
|
match kind {
|
||||||
|
ErrorKind::PermissionDenied => format!(
|
||||||
|
"permission denied opening the host admin socket {path} — reaching it requires \
|
||||||
|
membership in the `hive-admin` group. Add your user to \
|
||||||
|
`services.hyperhive.adminUsers`, then log out and back in: secondary group \
|
||||||
|
membership is applied at login, so a shell opened before the change still \
|
||||||
|
cannot connect. `id -nG` shows what the running shell actually has; \
|
||||||
|
`newgrp hive-admin` picks the group up without a full re-login"
|
||||||
|
),
|
||||||
|
ErrorKind::NotFound => format!(
|
||||||
|
"no socket at {path} — hive-c0re is not running, or it binds somewhere else \
|
||||||
|
(`--socket`). Check `systemctl status hive-c0re.socket hive-c0re.service`"
|
||||||
|
),
|
||||||
|
ErrorKind::ConnectionRefused => format!(
|
||||||
|
"nothing is listening on {path} — the socket exists but the daemon behind it \
|
||||||
|
is down. Check `systemctl status hive-c0re.service` and \
|
||||||
|
`journalctl -u hive-c0re`"
|
||||||
|
),
|
||||||
|
_ => format!("could not connect to the hive-c0re host admin socket {path}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub async fn request(socket: &Path, req: HostRequest) -> Result<HostResponse> {
|
pub async fn request(socket: &Path, req: HostRequest) -> Result<HostResponse> {
|
||||||
let stream = UnixStream::connect(socket)
|
let stream = match UnixStream::connect(socket).await {
|
||||||
.await
|
Ok(stream) => stream,
|
||||||
.with_context(|| format!("connect to {}", socket.display()))?;
|
// Keep the io error as the cause and put the actionable line on top,
|
||||||
|
// so `Error: <hint>` / `Caused by: <errno>` reads fix-first.
|
||||||
|
Err(e) => {
|
||||||
|
let hint = connect_hint(e.kind(), socket);
|
||||||
|
return Err(anyhow::Error::new(e).context(hint));
|
||||||
|
}
|
||||||
|
};
|
||||||
let (read, mut write) = stream.into_split();
|
let (read, mut write) = stream.into_split();
|
||||||
|
|
||||||
let mut payload = serde_json::to_string(&req)?;
|
let mut payload = serde_json::to_string(&req)?;
|
||||||
|
|
@ -25,3 +71,56 @@ pub async fn request(socket: &Path, req: HostRequest) -> Result<HostResponse> {
|
||||||
let resp: HostResponse = serde_json::from_str(line.trim())?;
|
let resp: HostResponse = serde_json::from_str(line.trim())?;
|
||||||
Ok(resp)
|
Ok(resp)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::{ErrorKind, Path, connect_hint};
|
||||||
|
|
||||||
|
fn hint(kind: ErrorKind) -> String {
|
||||||
|
connect_hint(kind, Path::new("/run/hyperhive/host.sock"))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// EACCES is an operator-side fix, and the non-obvious half is the
|
||||||
|
/// re-login — so both the group and the login requirement must appear,
|
||||||
|
/// and it must not send the operator off checking a daemon that is fine.
|
||||||
|
#[test]
|
||||||
|
fn permission_denied_names_the_group_and_the_relogin() {
|
||||||
|
let h = hint(ErrorKind::PermissionDenied);
|
||||||
|
assert!(h.contains("hive-admin"), "{h}");
|
||||||
|
assert!(h.contains("adminUsers"), "{h}");
|
||||||
|
assert!(h.contains("log out"), "{h}");
|
||||||
|
assert!(
|
||||||
|
!h.contains("not running"),
|
||||||
|
"EACCES must not blame the daemon: {h}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The inverse: a missing socket is a daemon-side problem, so it must not
|
||||||
|
/// send the operator chasing group membership.
|
||||||
|
#[test]
|
||||||
|
fn missing_socket_blames_the_daemon_not_the_operator() {
|
||||||
|
let h = hint(ErrorKind::NotFound);
|
||||||
|
assert!(h.contains("not running"), "{h}");
|
||||||
|
assert!(!h.contains("hive-admin"), "{h}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn refused_socket_points_at_the_service_not_the_group() {
|
||||||
|
let h = hint(ErrorKind::ConnectionRefused);
|
||||||
|
assert!(h.contains("nothing is listening"), "{h}");
|
||||||
|
assert!(!h.contains("hive-admin"), "{h}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn every_hint_names_the_socket_path() {
|
||||||
|
for kind in [
|
||||||
|
ErrorKind::PermissionDenied,
|
||||||
|
ErrorKind::NotFound,
|
||||||
|
ErrorKind::ConnectionRefused,
|
||||||
|
ErrorKind::BrokenPipe,
|
||||||
|
] {
|
||||||
|
let h = hint(kind);
|
||||||
|
assert!(h.contains("/run/hyperhive/host.sock"), "{kind:?}: {h}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ use std::path::Path;
|
||||||
|
|
||||||
use anyhow::{Context as _, Result};
|
use anyhow::{Context as _, Result};
|
||||||
|
|
||||||
use crate::cli::{DEFAULT_HOST_SOCKET, OpenTarget};
|
use crate::cli::OpenTarget;
|
||||||
use crate::util::query_hive_urls;
|
use crate::util::query_hive_urls;
|
||||||
|
|
||||||
/// `open <home|forge|matrix>` — resolve the surface URL from the daemon,
|
/// `open <home|forge|matrix>` — resolve the surface URL from the daemon,
|
||||||
|
|
@ -13,12 +13,12 @@ use crate::util::query_hive_urls;
|
||||||
/// core (headless / SSH hosts where no browser opener exists); the open
|
/// core (headless / SSH hosts where no browser opener exists); the open
|
||||||
/// is convenience on top, so a missing/failed `xdg-open` is not an error.
|
/// is convenience on top, so a missing/failed `xdg-open` is not an error.
|
||||||
pub(crate) async fn open_url(socket: &Path, target: OpenTarget) -> Result<()> {
|
pub(crate) async fn open_url(socket: &Path, target: OpenTarget) -> Result<()> {
|
||||||
let urls = query_hive_urls(socket).await.with_context(|| {
|
// The connect error is already actionable (`client::request` classifies
|
||||||
format!(
|
// it), so propagate it rather than restating a guess about the cause.
|
||||||
"could not reach the hive-c0re daemon for URLs — is hive-c0re running? \
|
let urls = query_hive_urls(socket)
|
||||||
(the socket is at {DEFAULT_HOST_SOCKET})"
|
.await
|
||||||
)
|
.context("could not read this hive's URLs from the daemon")?
|
||||||
})?;
|
.context("the daemon reported no URLs — `services.hyperhive.domain` is unset")?;
|
||||||
let (url, hint) = match target {
|
let (url, hint) = match target {
|
||||||
OpenTarget::Home => (
|
OpenTarget::Home => (
|
||||||
urls.home,
|
urls.home,
|
||||||
|
|
|
||||||
|
|
@ -24,9 +24,10 @@ pub(crate) async fn daemon_request(
|
||||||
req: hive_host_sock::HostRequest,
|
req: hive_host_sock::HostRequest,
|
||||||
label: &str,
|
label: &str,
|
||||||
) -> Result<()> {
|
) -> Result<()> {
|
||||||
let resp = crate::client::request(socket, req)
|
// No extra context on the request: `client::request` already names the
|
||||||
.await
|
// socket and classifies the failure, and wrapping it here would put a
|
||||||
.with_context(|| format!("connect to daemon socket {}", socket.display()))?;
|
// vaguer line on top of the actionable one.
|
||||||
|
let resp = crate::client::request(socket, req).await?;
|
||||||
if !resp.ok {
|
if !resp.ok {
|
||||||
bail!(
|
bail!(
|
||||||
"{label}: {}",
|
"{label}: {}",
|
||||||
|
|
@ -100,13 +101,19 @@ pub(crate) fn render_lifecycle(resp: &hive_host_sock::HostResponse, verb: &str)
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Best-effort query for this hive's domain + browser-facing web URLs
|
/// Query this hive's domain + browser-facing web URLs (`HostRequest::Urls`).
|
||||||
/// (`HostRequest::Urls`). `None` when the daemon is unreachable.
|
///
|
||||||
pub(crate) async fn query_hive_urls(socket: &Path) -> Option<hive_host_sock::HiveUrls> {
|
/// `Ok(None)` = the daemon answered and has nothing to report; `Err` = it was
|
||||||
crate::client::request(socket, hive_host_sock::HostRequest::Urls)
|
/// never reached, and the error carries the actionable connect hint (see
|
||||||
.await
|
/// [`crate::client::request`]). Keep the two apart: collapsing the error into
|
||||||
.ok()
|
/// `None` here is what made a permission problem on the socket read as "is
|
||||||
.and_then(|r| r.urls)
|
/// hive-c0re running?", sending the operator to fix the wrong thing.
|
||||||
|
pub(crate) async fn query_hive_urls(socket: &Path) -> Result<Option<hive_host_sock::HiveUrls>> {
|
||||||
|
Ok(
|
||||||
|
crate::client::request(socket, hive_host_sock::HostRequest::Urls)
|
||||||
|
.await?
|
||||||
|
.urls,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// True when `name` matches an existing hyperhive agent — i.e. it has a
|
/// True when `name` matches an existing hyperhive agent — i.e. it has a
|
||||||
|
|
|
||||||
|
|
@ -24,19 +24,24 @@ const HIVE_TLS_CA_PATH: &str = "/var/lib/hive-tls/ca.pem";
|
||||||
/// Best-effort query for this hive's domain from the running daemon
|
/// Best-effort query for this hive's domain from the running daemon
|
||||||
/// (`HostRequest::Urls`, which reads `HYPERHIVE_HIVE_DOMAIN` from c0re's
|
/// (`HostRequest::Urls`, which reads `HYPERHIVE_HIVE_DOMAIN` from c0re's
|
||||||
/// service env). `None` when the daemon is unreachable or the domain is
|
/// service env). `None` when the daemon is unreachable or the domain is
|
||||||
/// unset — callers decide whether that's fatal.
|
/// unset — for the callers that treat both as "skip the optional block".
|
||||||
|
/// Use [`require_hive_domain`] where the distinction matters: it keeps the
|
||||||
|
/// connect error (and its hint) instead of flattening it away.
|
||||||
async fn query_hive_domain(socket: &Path) -> Option<String> {
|
async fn query_hive_domain(socket: &Path) -> Option<String> {
|
||||||
query_hive_urls(socket).await.and_then(|u| u.domain)
|
query_hive_urls(socket).await.ok().flatten()?.domain
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Require this hive's domain from the daemon for snippet generation.
|
/// Require this hive's domain from the daemon for snippet generation.
|
||||||
/// Errors with a clear hint when it can't be resolved, so `peer-config`
|
/// Errors with a clear hint when it can't be resolved, so `peer-config`
|
||||||
/// never silently emits a wrong key.
|
/// never silently emits a wrong key. An unreachable daemon propagates its
|
||||||
|
/// own (classified) connect error; only a *reachable* daemon with no domain
|
||||||
|
/// gets the config hint.
|
||||||
pub(crate) async fn require_hive_domain(socket: &Path) -> Result<String> {
|
pub(crate) async fn require_hive_domain(socket: &Path) -> Result<String> {
|
||||||
query_hive_domain(socket).await.context(
|
query_hive_urls(socket)
|
||||||
"could not determine this hive's domain from the daemon — is hive-c0re running \
|
.await
|
||||||
and `services.hyperhive.domain` set?",
|
.context("could not determine this hive's domain from the daemon")?
|
||||||
)
|
.and_then(|u| u.domain)
|
||||||
|
.context("the daemon reported no domain — set `services.hyperhive.domain`")
|
||||||
}
|
}
|
||||||
|
|
||||||
/// `wg init` — generate (if absent) the hive's WireGuard key, print its
|
/// `wg init` — generate (if absent) the hive's WireGuard key, print its
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue