fix: human-readable advisories for TLS data_dir + port-53 EACCES (#48)
* fix: human-readable advisory when TLS data_dir is not writable When numa runs as non-root on a system with a privileged default data_dir (e.g. /usr/local/var/numa on macOS), TLS CA setup fails with a raw "Permission denied (os error 13)" and HTTPS proxy is silently disabled. The user sees a cryptic warning with no path forward. Detect std::io::ErrorKind::PermissionDenied on the tls error, print a diagnostic naming the data_dir and offering two fixes (install as system resolver, or point data_dir at a writable path), and keep the graceful-degradation behavior — DNS resolution and plain-HTTP proxy continue to work without HTTPS. All other TLS setup errors fall through to the existing log::warn!. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: port-53 advisory also handles EACCES (non-root privileged bind) The original port-53 match arm only caught EADDRINUSE, so a fresh non-root user on macOS/Linux hitting EACCES when trying to bind a privileged port saw the raw OS error instead of the advisory. Collapse the scoping helper and the advisory into a single `try_port53_advisory(bind_addr, &io::Error) -> Option<String>` that returns the formatted diagnostic when both the port is 53 and the error kind is one we can speak to (AddrInUse or PermissionDenied), and `None` otherwise. The two failure modes share one body with a cause-sentence variant — no duplicated fix text. Caller becomes a plain if-let: no match guard, no separate is_port_53 helper exposed on the public API. is_port_53 goes back to private. Unit tests cover all branches: AddrInUse, PermissionDenied, non-53 bind_addr, unrelated ErrorKind, and malformed bind_addr. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor: move TLS error classification into tls module main.rs no longer downcasts a boxed error to figure out whether it's a permission-denied case. tls::try_data_dir_advisory(&err, &dir) encapsulates the downcast + kind match and returns Some(advisory) or None, mirroring system_dns::try_port53_advisory. main.rs becomes a plain if-let, symmetric with the port-53 path. Trim the docstrings on both advisory functions: they were narrating the implementation (errno mapping) instead of stating the contract. Add unit tests for try_data_dir_advisory covering PermissionDenied, other io::ErrorKind, and non-io errors. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit was merged in pull request #48.
This commit is contained in:
@@ -46,28 +46,32 @@ pub fn discover_system_dns() -> SystemDnsInfo {
|
||||
}
|
||||
}
|
||||
|
||||
/// True if `bind_addr` targets DNS port 53. Used to scope the port-53
|
||||
/// conflict advisory — we only want to print the systemd-resolved /
|
||||
/// Dnscache hint when the user is actually trying to bind the DNS port.
|
||||
pub fn is_port_53(bind_addr: &str) -> bool {
|
||||
bind_addr
|
||||
.parse::<SocketAddr>()
|
||||
.map(|s| s.port() == 53)
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
/// Human-readable diagnostic for port-53 bind conflicts. Offers two
|
||||
/// concrete fixes: install Numa as the system resolver, or bind to a
|
||||
/// non-privileged port.
|
||||
pub fn port53_conflict_advisory(bind_addr: &str) -> String {
|
||||
/// Advisory for port-53 bind failures (EADDRINUSE or EACCES); `None`
|
||||
/// if not applicable so the caller can fall back to the raw error.
|
||||
pub fn try_port53_advisory(bind_addr: &str, err: &std::io::Error) -> Option<String> {
|
||||
if !is_port_53(bind_addr) {
|
||||
return None;
|
||||
}
|
||||
let (title, cause) = match err.kind() {
|
||||
std::io::ErrorKind::AddrInUse => (
|
||||
"port 53 is already in use",
|
||||
"Another process is already bound to port 53. On Linux this is\n \
|
||||
typically systemd-resolved; on Windows, the DNS Client service.",
|
||||
),
|
||||
std::io::ErrorKind::PermissionDenied => (
|
||||
"permission denied",
|
||||
"Port 53 is privileged — binding it requires root on Linux/macOS\n \
|
||||
or Administrator on Windows.",
|
||||
),
|
||||
_ => return None,
|
||||
};
|
||||
let o = "\x1b[1;38;2;192;98;58m"; // bold orange
|
||||
let r = "\x1b[0m";
|
||||
format!(
|
||||
Some(format!(
|
||||
"
|
||||
{o}Numa{r} — cannot bind to {bind_addr}: port 53 is already in use.
|
||||
{o}Numa{r} — cannot bind to {bind_addr}: {title}.
|
||||
|
||||
Another process is already bound to port 53. On Linux this is
|
||||
typically systemd-resolved; on Windows, the DNS Client service.
|
||||
{cause}
|
||||
|
||||
Fix — pick one:
|
||||
|
||||
@@ -86,7 +90,14 @@ pub fn port53_conflict_advisory(bind_addr: &str) -> String {
|
||||
Test with: dig @127.0.0.1 -p 5354 example.com
|
||||
|
||||
"
|
||||
)
|
||||
))
|
||||
}
|
||||
|
||||
fn is_port_53(bind_addr: &str) -> bool {
|
||||
bind_addr
|
||||
.parse::<SocketAddr>()
|
||||
.map(|s| s.port() == 53)
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
#[cfg(target_os = "macos")]
|
||||
@@ -1796,4 +1807,43 @@ Wireless LAN adapter Wi-Fi:
|
||||
assert_eq!(result.len(), 1);
|
||||
assert!(result.contains_key("Wi-Fi"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_port53_advisory_addr_in_use() {
|
||||
let err = std::io::Error::from(std::io::ErrorKind::AddrInUse);
|
||||
let msg = try_port53_advisory("0.0.0.0:53", &err).expect("should advise on port 53");
|
||||
assert!(msg.contains("cannot bind to"));
|
||||
assert!(msg.contains("already in use"));
|
||||
assert!(msg.contains("numa install"));
|
||||
assert!(msg.contains("bind_addr"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_port53_advisory_permission_denied() {
|
||||
let err = std::io::Error::from(std::io::ErrorKind::PermissionDenied);
|
||||
let msg = try_port53_advisory("0.0.0.0:53", &err).expect("should advise on port 53");
|
||||
assert!(msg.contains("cannot bind to"));
|
||||
assert!(msg.contains("permission denied"));
|
||||
assert!(msg.contains("numa install"));
|
||||
assert!(msg.contains("bind_addr"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_port53_advisory_skips_non_53_ports() {
|
||||
let err = std::io::Error::from(std::io::ErrorKind::AddrInUse);
|
||||
assert!(try_port53_advisory("127.0.0.1:5354", &err).is_none());
|
||||
assert!(try_port53_advisory("[::]:853", &err).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_port53_advisory_skips_unrelated_error_kinds() {
|
||||
let err = std::io::Error::from(std::io::ErrorKind::NotFound);
|
||||
assert!(try_port53_advisory("0.0.0.0:53", &err).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_port53_advisory_skips_malformed_bind_addr() {
|
||||
let err = std::io::Error::from(std::io::ErrorKind::AddrInUse);
|
||||
assert!(try_port53_advisory("not-an-address", &err).is_none());
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user