security: pass all 4 checklist items — gateway not public, pairing required, filesystem scoped, tunnel access
Security checklist from @anshnanda / @ledger_eth: ✅ Gateway not public — default bind 127.0.0.1, refuses 0.0.0.0 without tunnel or explicit allow_public_bind=true in config ✅ Pairing required — one-time 6-digit code printed on startup, exchanged for bearer token via POST /pair, enforced on all /webhook requests ✅ Filesystem scoped (no /) — workspace_only=true by default, null byte injection blocked, 14 system dirs + 4 sensitive dotfiles in forbidden list, is_resolved_path_allowed() for symlink escape prevention ✅ Access via Tailscale/SSH tunnel — tunnel system integrated, gateway refuses public bind without active tunnel New files: src/security/pairing.rs — PairingGuard with OTP generation, constant-time code comparison, bearer token issuance, token persistence Changed files: src/config/schema.rs — GatewayConfig (require_pairing, allow_public_bind, paired_tokens), expanded AutonomyConfig forbidden_paths src/config/mod.rs — export GatewayConfig src/gateway/mod.rs — public bind guard, pairing enforcement on /webhook, /pair endpoint, /health no longer leaks version/memory info src/security/policy.rs — null byte blocking, is_resolved_path_allowed(), expanded forbidden_paths (14 system dirs + 4 dotfiles) src/security/mod.rs — export pairing module src/onboard/wizard.rs — wire gateway config 935 tests passing (up from 905), 0 clippy warnings, cargo fmt clean
This commit is contained in:
parent
ce4f36a3ab
commit
b2aff60722
7 changed files with 642 additions and 16 deletions
|
|
@ -1,3 +1,6 @@
|
|||
pub mod pairing;
|
||||
pub mod policy;
|
||||
|
||||
#[allow(unused_imports)]
|
||||
pub use pairing::PairingGuard;
|
||||
pub use policy::{AutonomyLevel, SecurityPolicy};
|
||||
|
|
|
|||
276
src/security/pairing.rs
Normal file
276
src/security/pairing.rs
Normal file
|
|
@ -0,0 +1,276 @@
|
|||
// Gateway pairing mode — first-connect authentication.
|
||||
//
|
||||
// On startup the gateway generates a one-time pairing code printed to the
|
||||
// terminal. The first client must present this code via `X-Pairing-Code`
|
||||
// header on a `POST /pair` request. The server responds with a bearer token
|
||||
// that must be sent on all subsequent requests via `Authorization: Bearer <token>`.
|
||||
//
|
||||
// Already-paired tokens are persisted in config so restarts don't require
|
||||
// re-pairing.
|
||||
|
||||
use std::collections::HashSet;
|
||||
use std::sync::Mutex;
|
||||
|
||||
/// Manages pairing state for the gateway.
|
||||
#[derive(Debug)]
|
||||
pub struct PairingGuard {
|
||||
/// Whether pairing is required at all.
|
||||
require_pairing: bool,
|
||||
/// One-time pairing code (generated on startup, consumed on first pair).
|
||||
pairing_code: Option<String>,
|
||||
/// Set of valid bearer tokens (persisted across restarts).
|
||||
paired_tokens: Mutex<HashSet<String>>,
|
||||
}
|
||||
|
||||
impl PairingGuard {
|
||||
/// Create a new pairing guard.
|
||||
///
|
||||
/// If `require_pairing` is true and no tokens exist yet, a fresh
|
||||
/// pairing code is generated and returned via `pairing_code()`.
|
||||
pub fn new(require_pairing: bool, existing_tokens: &[String]) -> Self {
|
||||
let tokens: HashSet<String> = existing_tokens.iter().cloned().collect();
|
||||
let code = if require_pairing && tokens.is_empty() {
|
||||
Some(generate_code())
|
||||
} else {
|
||||
None
|
||||
};
|
||||
Self {
|
||||
require_pairing,
|
||||
pairing_code: code,
|
||||
paired_tokens: Mutex::new(tokens),
|
||||
}
|
||||
}
|
||||
|
||||
/// The one-time pairing code (only set when no tokens exist yet).
|
||||
pub fn pairing_code(&self) -> Option<&str> {
|
||||
self.pairing_code.as_deref()
|
||||
}
|
||||
|
||||
/// Whether pairing is required at all.
|
||||
pub fn require_pairing(&self) -> bool {
|
||||
self.require_pairing
|
||||
}
|
||||
|
||||
/// Attempt to pair with the given code. Returns a bearer token on success.
|
||||
pub fn try_pair(&self, code: &str) -> Option<String> {
|
||||
if let Some(ref expected) = self.pairing_code {
|
||||
if constant_time_eq(code.trim(), expected.trim()) {
|
||||
let token = generate_token();
|
||||
let mut tokens = self
|
||||
.paired_tokens
|
||||
.lock()
|
||||
.unwrap_or_else(std::sync::PoisonError::into_inner);
|
||||
tokens.insert(token.clone());
|
||||
return Some(token);
|
||||
}
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
/// Check if a bearer token is valid.
|
||||
pub fn is_authenticated(&self, token: &str) -> bool {
|
||||
if !self.require_pairing {
|
||||
return true;
|
||||
}
|
||||
let tokens = self
|
||||
.paired_tokens
|
||||
.lock()
|
||||
.unwrap_or_else(std::sync::PoisonError::into_inner);
|
||||
tokens.contains(token)
|
||||
}
|
||||
|
||||
/// Returns true if the gateway is already paired (has at least one token).
|
||||
pub fn is_paired(&self) -> bool {
|
||||
let tokens = self
|
||||
.paired_tokens
|
||||
.lock()
|
||||
.unwrap_or_else(std::sync::PoisonError::into_inner);
|
||||
!tokens.is_empty()
|
||||
}
|
||||
|
||||
/// Get all paired tokens (for persisting to config).
|
||||
pub fn tokens(&self) -> Vec<String> {
|
||||
let tokens = self
|
||||
.paired_tokens
|
||||
.lock()
|
||||
.unwrap_or_else(std::sync::PoisonError::into_inner);
|
||||
tokens.iter().cloned().collect()
|
||||
}
|
||||
}
|
||||
|
||||
/// Generate a 6-digit numeric pairing code.
|
||||
fn generate_code() -> String {
|
||||
use std::collections::hash_map::DefaultHasher;
|
||||
use std::hash::{Hash, Hasher};
|
||||
use std::time::SystemTime;
|
||||
|
||||
let mut hasher = DefaultHasher::new();
|
||||
SystemTime::now().hash(&mut hasher);
|
||||
std::process::id().hash(&mut hasher);
|
||||
let raw = hasher.finish();
|
||||
format!("{:06}", raw % 1_000_000)
|
||||
}
|
||||
|
||||
/// Generate a cryptographically-adequate bearer token (hex-encoded).
|
||||
fn generate_token() -> String {
|
||||
format!("zc_{}", uuid::Uuid::new_v4().as_simple())
|
||||
}
|
||||
|
||||
/// Constant-time string comparison to prevent timing attacks on pairing code.
|
||||
fn constant_time_eq(a: &str, b: &str) -> bool {
|
||||
if a.len() != b.len() {
|
||||
return false;
|
||||
}
|
||||
a.bytes()
|
||||
.zip(b.bytes())
|
||||
.fold(0u8, |acc, (x, y)| acc | (x ^ y))
|
||||
== 0
|
||||
}
|
||||
|
||||
/// Check if a host string represents a non-localhost bind address.
|
||||
pub fn is_public_bind(host: &str) -> bool {
|
||||
!matches!(
|
||||
host,
|
||||
"127.0.0.1" | "localhost" | "::1" | "[::1]" | "0:0:0:0:0:0:0:1"
|
||||
)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
// ── PairingGuard ─────────────────────────────────────────
|
||||
|
||||
#[test]
|
||||
fn new_guard_generates_code_when_no_tokens() {
|
||||
let guard = PairingGuard::new(true, &[]);
|
||||
assert!(guard.pairing_code().is_some());
|
||||
assert!(!guard.is_paired());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn new_guard_no_code_when_tokens_exist() {
|
||||
let guard = PairingGuard::new(true, &["zc_existing".into()]);
|
||||
assert!(guard.pairing_code().is_none());
|
||||
assert!(guard.is_paired());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn new_guard_no_code_when_pairing_disabled() {
|
||||
let guard = PairingGuard::new(false, &[]);
|
||||
assert!(guard.pairing_code().is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_pair_correct_code() {
|
||||
let guard = PairingGuard::new(true, &[]);
|
||||
let code = guard.pairing_code().unwrap().to_string();
|
||||
let token = guard.try_pair(&code);
|
||||
assert!(token.is_some());
|
||||
assert!(token.unwrap().starts_with("zc_"));
|
||||
assert!(guard.is_paired());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_pair_wrong_code() {
|
||||
let guard = PairingGuard::new(true, &[]);
|
||||
let token = guard.try_pair("000000");
|
||||
// Might succeed if code happens to be 000000, but extremely unlikely
|
||||
// Just check it doesn't panic
|
||||
let _ = token;
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_pair_empty_code() {
|
||||
let guard = PairingGuard::new(true, &[]);
|
||||
assert!(guard.try_pair("").is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn is_authenticated_with_valid_token() {
|
||||
let guard = PairingGuard::new(true, &["zc_valid".into()]);
|
||||
assert!(guard.is_authenticated("zc_valid"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn is_authenticated_with_invalid_token() {
|
||||
let guard = PairingGuard::new(true, &["zc_valid".into()]);
|
||||
assert!(!guard.is_authenticated("zc_invalid"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn is_authenticated_when_pairing_disabled() {
|
||||
let guard = PairingGuard::new(false, &[]);
|
||||
assert!(guard.is_authenticated("anything"));
|
||||
assert!(guard.is_authenticated(""));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tokens_returns_all_paired() {
|
||||
let guard = PairingGuard::new(true, &["a".into(), "b".into()]);
|
||||
let mut tokens = guard.tokens();
|
||||
tokens.sort();
|
||||
assert_eq!(tokens, vec!["a", "b"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pair_then_authenticate() {
|
||||
let guard = PairingGuard::new(true, &[]);
|
||||
let code = guard.pairing_code().unwrap().to_string();
|
||||
let token = guard.try_pair(&code).unwrap();
|
||||
assert!(guard.is_authenticated(&token));
|
||||
assert!(!guard.is_authenticated("wrong"));
|
||||
}
|
||||
|
||||
// ── is_public_bind ───────────────────────────────────────
|
||||
|
||||
#[test]
|
||||
fn localhost_variants_not_public() {
|
||||
assert!(!is_public_bind("127.0.0.1"));
|
||||
assert!(!is_public_bind("localhost"));
|
||||
assert!(!is_public_bind("::1"));
|
||||
assert!(!is_public_bind("[::1]"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn zero_zero_is_public() {
|
||||
assert!(is_public_bind("0.0.0.0"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn real_ip_is_public() {
|
||||
assert!(is_public_bind("192.168.1.100"));
|
||||
assert!(is_public_bind("10.0.0.1"));
|
||||
}
|
||||
|
||||
// ── constant_time_eq ─────────────────────────────────────
|
||||
|
||||
#[test]
|
||||
fn constant_time_eq_same() {
|
||||
assert!(constant_time_eq("abc", "abc"));
|
||||
assert!(constant_time_eq("", ""));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn constant_time_eq_different() {
|
||||
assert!(!constant_time_eq("abc", "abd"));
|
||||
assert!(!constant_time_eq("abc", "ab"));
|
||||
assert!(!constant_time_eq("a", ""));
|
||||
}
|
||||
|
||||
// ── generate helpers ─────────────────────────────────────
|
||||
|
||||
#[test]
|
||||
fn generate_code_is_6_digits() {
|
||||
let code = generate_code();
|
||||
assert_eq!(code.len(), 6);
|
||||
assert!(code.chars().all(|c| c.is_ascii_digit()));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn generate_token_has_prefix() {
|
||||
let token = generate_token();
|
||||
assert!(token.starts_with("zc_"));
|
||||
assert!(token.len() > 10);
|
||||
}
|
||||
}
|
||||
|
|
@ -104,11 +104,26 @@ impl Default for SecurityPolicy {
|
|||
"tail".into(),
|
||||
],
|
||||
forbidden_paths: vec![
|
||||
// System directories (blocked even when workspace_only=false)
|
||||
"/etc".into(),
|
||||
"/root".into(),
|
||||
"/home".into(),
|
||||
"/usr".into(),
|
||||
"/bin".into(),
|
||||
"/sbin".into(),
|
||||
"/lib".into(),
|
||||
"/opt".into(),
|
||||
"/boot".into(),
|
||||
"/dev".into(),
|
||||
"/proc".into(),
|
||||
"/sys".into(),
|
||||
"/var".into(),
|
||||
"/tmp".into(),
|
||||
// Sensitive dotfiles
|
||||
"~/.ssh".into(),
|
||||
"~/.gnupg".into(),
|
||||
"/var/run".into(),
|
||||
"~/.aws".into(),
|
||||
"~/.config".into(),
|
||||
],
|
||||
max_actions_per_hour: 20,
|
||||
max_cost_per_day_cents: 500,
|
||||
|
|
@ -140,6 +155,11 @@ impl SecurityPolicy {
|
|||
|
||||
/// Check if a file path is allowed (no path traversal, within workspace)
|
||||
pub fn is_path_allowed(&self, path: &str) -> bool {
|
||||
// Block null bytes (can truncate paths in C-backed syscalls)
|
||||
if path.contains('\0') {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Block obvious traversal attempts
|
||||
if path.contains("..") {
|
||||
return false;
|
||||
|
|
@ -160,6 +180,13 @@ impl SecurityPolicy {
|
|||
true
|
||||
}
|
||||
|
||||
/// Validate that a resolved path is still inside the workspace.
|
||||
/// Call this AFTER joining `workspace_dir` + relative path and canonicalizing.
|
||||
pub fn is_resolved_path_allowed(&self, resolved: &Path) -> bool {
|
||||
// Must be under workspace_dir (prevents symlink escapes)
|
||||
resolved.starts_with(&self.workspace_dir)
|
||||
}
|
||||
|
||||
/// Check if autonomy level permits any action at all
|
||||
pub fn can_act(&self) -> bool {
|
||||
self.autonomy != AutonomyLevel::ReadOnly
|
||||
|
|
@ -552,9 +579,9 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
fn path_with_null_byte() {
|
||||
fn path_with_null_byte_blocked() {
|
||||
let p = default_policy();
|
||||
assert!(p.is_path_allowed("file\0.txt"));
|
||||
assert!(!p.is_path_allowed("file\0.txt"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
|
@ -668,4 +695,120 @@ mod tests {
|
|||
assert_eq!(policy.tracker.count(), 0);
|
||||
assert!(!policy.is_rate_limited());
|
||||
}
|
||||
|
||||
// ══════════════════════════════════════════════════════════
|
||||
// SECURITY CHECKLIST TESTS
|
||||
// Checklist: gateway not public, pairing required,
|
||||
// filesystem scoped (no /), access via tunnel
|
||||
// ══════════════════════════════════════════════════════════
|
||||
|
||||
// ── Checklist #3: Filesystem scoped (no /) ──────────────
|
||||
|
||||
#[test]
|
||||
fn checklist_root_path_blocked() {
|
||||
let p = default_policy();
|
||||
assert!(!p.is_path_allowed("/"));
|
||||
assert!(!p.is_path_allowed("/anything"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checklist_all_system_dirs_blocked() {
|
||||
let p = SecurityPolicy {
|
||||
workspace_only: false,
|
||||
..SecurityPolicy::default()
|
||||
};
|
||||
for dir in [
|
||||
"/etc", "/root", "/home", "/usr", "/bin", "/sbin", "/lib", "/opt", "/boot", "/dev",
|
||||
"/proc", "/sys", "/var", "/tmp",
|
||||
] {
|
||||
assert!(
|
||||
!p.is_path_allowed(dir),
|
||||
"System dir should be blocked: {dir}"
|
||||
);
|
||||
assert!(
|
||||
!p.is_path_allowed(&format!("{dir}/subpath")),
|
||||
"Subpath of system dir should be blocked: {dir}/subpath"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checklist_sensitive_dotfiles_blocked() {
|
||||
let p = SecurityPolicy {
|
||||
workspace_only: false,
|
||||
..SecurityPolicy::default()
|
||||
};
|
||||
for path in [
|
||||
"~/.ssh/id_rsa",
|
||||
"~/.gnupg/secring.gpg",
|
||||
"~/.aws/credentials",
|
||||
"~/.config/secrets",
|
||||
] {
|
||||
assert!(
|
||||
!p.is_path_allowed(path),
|
||||
"Sensitive dotfile should be blocked: {path}"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checklist_null_byte_injection_blocked() {
|
||||
let p = default_policy();
|
||||
assert!(!p.is_path_allowed("safe\0/../../../etc/passwd"));
|
||||
assert!(!p.is_path_allowed("\0"));
|
||||
assert!(!p.is_path_allowed("file\0"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checklist_workspace_only_blocks_all_absolute() {
|
||||
let p = SecurityPolicy {
|
||||
workspace_only: true,
|
||||
..SecurityPolicy::default()
|
||||
};
|
||||
assert!(!p.is_path_allowed("/any/absolute/path"));
|
||||
assert!(p.is_path_allowed("relative/path.txt"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checklist_resolved_path_must_be_in_workspace() {
|
||||
let p = SecurityPolicy {
|
||||
workspace_dir: PathBuf::from("/home/user/project"),
|
||||
..SecurityPolicy::default()
|
||||
};
|
||||
// Inside workspace — allowed
|
||||
assert!(p.is_resolved_path_allowed(Path::new("/home/user/project/src/main.rs")));
|
||||
// Outside workspace — blocked (symlink escape)
|
||||
assert!(!p.is_resolved_path_allowed(Path::new("/etc/passwd")));
|
||||
assert!(!p.is_resolved_path_allowed(Path::new("/home/user/other_project/file")));
|
||||
// Root — blocked
|
||||
assert!(!p.is_resolved_path_allowed(Path::new("/")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checklist_default_policy_is_workspace_only() {
|
||||
let p = SecurityPolicy::default();
|
||||
assert!(
|
||||
p.workspace_only,
|
||||
"Default policy must be workspace_only=true"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checklist_default_forbidden_paths_comprehensive() {
|
||||
let p = SecurityPolicy::default();
|
||||
// Must contain all critical system dirs
|
||||
for dir in ["/etc", "/root", "/proc", "/sys", "/dev", "/var", "/tmp"] {
|
||||
assert!(
|
||||
p.forbidden_paths.iter().any(|f| f == dir),
|
||||
"Default forbidden_paths must include {dir}"
|
||||
);
|
||||
}
|
||||
// Must contain sensitive dotfiles
|
||||
for dot in ["~/.ssh", "~/.gnupg", "~/.aws"] {
|
||||
assert!(
|
||||
p.forbidden_paths.iter().any(|f| f == dot),
|
||||
"Default forbidden_paths must include {dot}"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue