Files
codex/codex-rs/config/src/host_name.rs
Abhinav ab26554a3a Add remote_sandbox_config to our config requirements (#18763)
## Why

Customers need finer-grained control over allowed sandbox modes based on
the host Codex is running on. For example, they may want stricter
sandbox limits on devboxes while keeping a different default elsewhere.

Our current cloud requirements can target user/account groups, but they
cannot vary sandbox requirements by host. That makes remote development
environments awkward because the same top-level `allowed_sandbox_modes`
has to apply everywhere.

## What

Adds a new `remote_sandbox_config` section to `requirements.toml`:

```toml
allowed_sandbox_modes = ["read-only"]

[[remote_sandbox_config]]
hostname_patterns = ["*.org"]
allowed_sandbox_modes = ["read-only", "workspace-write"]

[[remote_sandbox_config]]
hostname_patterns = ["*.sh", "runner-*.ci"]
allowed_sandbox_modes = ["read-only", "danger-full-access"]
```

During requirements resolution, Codex resolves the local host name once,
preferring the machine FQDN when available and falling back to the
cleaned kernel hostname. This host classification is best effort rather
than authenticated device proof.

Each requirements source applies its first matching
`remote_sandbox_config` entry before it is merged with other sources.
The shared merge helper keeps that `apply_remote_sandbox_config` step
paired with requirements merging so new requirements sources do not have
to remember the extra call.

That preserves source precedence: a lower-precedence requirements file
with a matching `remote_sandbox_config` cannot override a
higher-precedence source that already set `allowed_sandbox_modes`.

This also wires the hostname-aware resolution through app-server,
CLI/TUI config loading, config API reads, and config layer metadata so
they all evaluate remote sandbox requirements consistently.

## Verification

- `cargo test -p codex-config remote_sandbox_config`
- `cargo test -p codex-config host_name`
- `cargo test -p codex-core
load_config_layers_applies_matching_remote_sandbox_config`
- `cargo test -p codex-core
system_remote_sandbox_config_keeps_cloud_sandbox_modes`
- `cargo test -p codex-config`
- `cargo test -p codex-core` unit tests passed; `tests/all.rs`
integration matrix was intentionally stopped after the relevant focused
tests passed
- `just fix -p codex-config`
- `just fix -p codex-core`
- `cargo check -p codex-app-server`
2026-04-21 05:05:02 +00:00

98 lines
3.1 KiB
Rust

#[cfg(unix)]
use dns_lookup::AddrInfoHints;
#[cfg(unix)]
use dns_lookup::getaddrinfo;
use std::sync::LazyLock;
#[cfg(windows)]
use winapi_util::sysinfo::ComputerNameKind;
#[cfg(windows)]
use winapi_util::sysinfo::get_computer_name;
static HOST_NAME: LazyLock<Option<String>> = LazyLock::new(compute_host_name);
pub fn host_name() -> Option<String> {
HOST_NAME.clone()
}
fn compute_host_name() -> Option<String> {
let kernel_hostname = gethostname::gethostname();
let kernel_hostname = normalize_host_name(&kernel_hostname.to_string_lossy())?;
// Remote sandbox requirements are meant to target remote hosts by DNS name,
// so prefer the canonical FQDN when the local resolver can provide one.
// This is best-effort host classification, not authenticated device proof.
if let Some(fqdn) = local_fqdn_for_hostname(&kernel_hostname) {
return Some(fqdn);
}
// Some machines have only a short local hostname or resolver setup that
// does not return AI_CANONNAME. Keep matching behavior best-effort by
// falling back to the cleaned kernel hostname instead of returning None.
Some(kernel_hostname)
}
fn normalize_host_name(hostname: &str) -> Option<String> {
let hostname = hostname.trim().trim_end_matches('.');
(!hostname.is_empty()).then(|| hostname.to_ascii_lowercase())
}
#[cfg(unix)]
fn local_fqdn_for_hostname(hostname: &str) -> Option<String> {
let hints = AddrInfoHints {
flags: libc::AI_CANONNAME,
..AddrInfoHints::default()
};
getaddrinfo(Some(hostname), /*service*/ None, Some(hints))
.ok()?
.filter_map(Result::ok)
.filter_map(|addr| addr.canonname)
// getaddrinfo may return the short hostname as canonname when no FQDN
// is available. Treat only DNS-qualified names as an FQDN result.
.find_map(|hostname| normalize_fqdn_candidate(&hostname))
}
#[cfg(windows)]
fn local_fqdn_for_hostname(_hostname: &str) -> Option<String> {
get_computer_name(ComputerNameKind::PhysicalDnsFullyQualified)
.ok()
.and_then(|hostname| hostname.into_string().ok())
.and_then(|hostname| normalize_fqdn_candidate(&hostname))
}
#[cfg(not(any(unix, windows)))]
fn local_fqdn_for_hostname(_hostname: &str) -> Option<String> {
None
}
fn normalize_fqdn_candidate(hostname: &str) -> Option<String> {
normalize_host_name(hostname).filter(|hostname| hostname.contains('.'))
}
#[cfg(test)]
mod tests {
use super::normalize_fqdn_candidate;
use pretty_assertions::assert_eq;
#[test]
fn normalize_fqdn_candidate_accepts_dns_qualified_name() {
assert_eq!(
normalize_fqdn_candidate("runner-01.ci.example.com"),
Some("runner-01.ci.example.com".to_string())
);
}
#[test]
fn normalize_fqdn_candidate_rejects_short_name() {
assert_eq!(normalize_fqdn_candidate("runner-01"), None);
}
#[test]
fn normalize_fqdn_candidate_trims_trailing_dot_and_normalizes_case() {
assert_eq!(
normalize_fqdn_candidate("RUNNER-01.CI.EXAMPLE.COM."),
Some("runner-01.ci.example.com".to_string())
);
}
}