## Why `execpolicy` currently keys `prefix_rule()` matching off the literal first token. That works for rules like `["/usr/bin/git"]`, but it means shared basename rules such as `["git"]` do not help when a caller passes an absolute executable path like `/usr/bin/git`. This PR lays the groundwork for basename-aware matching without changing existing callers yet. It adds typed host-executable metadata and an opt-in resolution path in `codex-execpolicy`, so a follow-up PR can adopt the new behavior in `unix_escalation.rs` and other call sites without having to redesign the policy layer first. ## What Changed - added `host_executable(name = ..., paths = [...])` to the execpolicy parser and validated it with `AbsolutePathBuf` - stored host executable mappings separately from prefix rules inside `Policy` - added `MatchOptions` and opt-in `*_with_options()` APIs that preserve existing behavior by default - implemented exact-first matching with optional basename fallback, gated by `host_executable()` allowlists when present - normalized executable names for cross-platform matching so Windows paths like `git.exe` can satisfy `host_executable(name = "git", ...)` - updated `match` / `not_match` example validation to exercise the host-executable resolution path instead of only raw prefix-rule matching - preserved source locations for deferred example-validation errors so policy load failures still point at the right file and line - surfaced `resolvedProgram` on `RuleMatch` so callers can tell when a basename rule matched an absolute executable path - preserved host executable metadata when requirements policies overlay file-based policies in `core/src/exec_policy.rs` - documented the new rule shape and CLI behavior in `execpolicy/README.md` ## Verification - `cargo test -p codex-execpolicy` - added coverage in `execpolicy/tests/basic.rs` for parsing, precedence, empty allowlists, basename fallback, exact-match precedence, and host-executable-backed `match` / `not_match` examples - added a regression test in `core/src/exec_policy.rs` to verify requirements overlays preserve `host_executable()` metadata - verified `cargo test -p codex-core --lib`, including source-rendering coverage for deferred validation errors
306 lines
8.9 KiB
Rust
306 lines
8.9 KiB
Rust
use crate::decision::Decision;
|
|
use crate::error::Error;
|
|
use crate::error::Result;
|
|
use crate::policy::MatchOptions;
|
|
use crate::policy::Policy;
|
|
use codex_utils_absolute_path::AbsolutePathBuf;
|
|
use serde::Deserialize;
|
|
use serde::Serialize;
|
|
use shlex::try_join;
|
|
use std::any::Any;
|
|
use std::fmt::Debug;
|
|
use std::sync::Arc;
|
|
|
|
/// Matches a single command token, either a fixed string or one of several allowed alternatives.
|
|
#[derive(Clone, Debug, Eq, PartialEq)]
|
|
pub enum PatternToken {
|
|
Single(String),
|
|
Alts(Vec<String>),
|
|
}
|
|
|
|
impl PatternToken {
|
|
fn matches(&self, token: &str) -> bool {
|
|
match self {
|
|
Self::Single(expected) => expected == token,
|
|
Self::Alts(alternatives) => alternatives.iter().any(|alt| alt == token),
|
|
}
|
|
}
|
|
|
|
pub fn alternatives(&self) -> &[String] {
|
|
match self {
|
|
Self::Single(expected) => std::slice::from_ref(expected),
|
|
Self::Alts(alternatives) => alternatives,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Prefix matcher for commands with support for alternative match tokens.
|
|
/// First token is fixed since we key by the first token in policy.
|
|
#[derive(Clone, Debug, Eq, PartialEq)]
|
|
pub struct PrefixPattern {
|
|
pub first: Arc<str>,
|
|
pub rest: Arc<[PatternToken]>,
|
|
}
|
|
|
|
impl PrefixPattern {
|
|
pub fn matches_prefix(&self, cmd: &[String]) -> Option<Vec<String>> {
|
|
let pattern_length = self.rest.len() + 1;
|
|
if cmd.len() < pattern_length || cmd[0] != self.first.as_ref() {
|
|
return None;
|
|
}
|
|
|
|
for (pattern_token, cmd_token) in self.rest.iter().zip(&cmd[1..pattern_length]) {
|
|
if !pattern_token.matches(cmd_token) {
|
|
return None;
|
|
}
|
|
}
|
|
|
|
Some(cmd[..pattern_length].to_vec())
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub enum RuleMatch {
|
|
PrefixRuleMatch {
|
|
#[serde(rename = "matchedPrefix")]
|
|
matched_prefix: Vec<String>,
|
|
decision: Decision,
|
|
#[serde(rename = "resolvedProgram", skip_serializing_if = "Option::is_none")]
|
|
resolved_program: Option<AbsolutePathBuf>,
|
|
/// Optional rationale for why this rule exists.
|
|
///
|
|
/// This can be supplied for any decision and may be surfaced in different contexts
|
|
/// (e.g., prompt reasons or rejection messages).
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
justification: Option<String>,
|
|
},
|
|
HeuristicsRuleMatch {
|
|
command: Vec<String>,
|
|
decision: Decision,
|
|
},
|
|
}
|
|
|
|
impl RuleMatch {
|
|
pub fn decision(&self) -> Decision {
|
|
match self {
|
|
Self::PrefixRuleMatch { decision, .. } => *decision,
|
|
Self::HeuristicsRuleMatch { decision, .. } => *decision,
|
|
}
|
|
}
|
|
|
|
pub fn with_resolved_program(self, resolved_program: &AbsolutePathBuf) -> Self {
|
|
match self {
|
|
Self::PrefixRuleMatch {
|
|
matched_prefix,
|
|
decision,
|
|
justification,
|
|
..
|
|
} => Self::PrefixRuleMatch {
|
|
matched_prefix,
|
|
decision,
|
|
resolved_program: Some(resolved_program.clone()),
|
|
justification,
|
|
},
|
|
other => other,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug, Eq, PartialEq)]
|
|
pub struct PrefixRule {
|
|
pub pattern: PrefixPattern,
|
|
pub decision: Decision,
|
|
pub justification: Option<String>,
|
|
}
|
|
|
|
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
|
pub enum NetworkRuleProtocol {
|
|
Http,
|
|
Https,
|
|
Socks5Tcp,
|
|
Socks5Udp,
|
|
}
|
|
|
|
impl NetworkRuleProtocol {
|
|
pub fn parse(raw: &str) -> Result<Self> {
|
|
match raw {
|
|
"http" => Ok(Self::Http),
|
|
"https" | "https_connect" | "http-connect" => Ok(Self::Https),
|
|
"socks5_tcp" => Ok(Self::Socks5Tcp),
|
|
"socks5_udp" => Ok(Self::Socks5Udp),
|
|
other => Err(Error::InvalidRule(format!(
|
|
"network_rule protocol must be one of http, https, socks5_tcp, socks5_udp (got {other})"
|
|
))),
|
|
}
|
|
}
|
|
|
|
pub fn as_policy_string(self) -> &'static str {
|
|
match self {
|
|
Self::Http => "http",
|
|
Self::Https => "https",
|
|
Self::Socks5Tcp => "socks5_tcp",
|
|
Self::Socks5Udp => "socks5_udp",
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug, Eq, PartialEq)]
|
|
pub struct NetworkRule {
|
|
pub host: String,
|
|
pub protocol: NetworkRuleProtocol,
|
|
pub decision: Decision,
|
|
pub justification: Option<String>,
|
|
}
|
|
|
|
pub(crate) fn normalize_network_rule_host(raw: &str) -> Result<String> {
|
|
let mut host = raw.trim();
|
|
if host.is_empty() {
|
|
return Err(Error::InvalidRule(
|
|
"network_rule host cannot be empty".to_string(),
|
|
));
|
|
}
|
|
if host.contains("://") || host.contains('/') || host.contains('?') || host.contains('#') {
|
|
return Err(Error::InvalidRule(
|
|
"network_rule host must be a hostname or IP literal (without scheme or path)"
|
|
.to_string(),
|
|
));
|
|
}
|
|
|
|
if let Some(stripped) = host.strip_prefix('[') {
|
|
let Some((inside, rest)) = stripped.split_once(']') else {
|
|
return Err(Error::InvalidRule(
|
|
"network_rule host has an invalid bracketed IPv6 literal".to_string(),
|
|
));
|
|
};
|
|
let port_ok = rest
|
|
.strip_prefix(':')
|
|
.is_some_and(|port| !port.is_empty() && port.chars().all(|c| c.is_ascii_digit()));
|
|
if !rest.is_empty() && !port_ok {
|
|
return Err(Error::InvalidRule(format!(
|
|
"network_rule host contains an unsupported suffix: {raw}"
|
|
)));
|
|
}
|
|
host = inside;
|
|
} else if host.matches(':').count() == 1
|
|
&& let Some((candidate, port)) = host.rsplit_once(':')
|
|
&& !candidate.is_empty()
|
|
&& !port.is_empty()
|
|
&& port.chars().all(|c| c.is_ascii_digit())
|
|
{
|
|
host = candidate;
|
|
}
|
|
|
|
let normalized = host.trim_end_matches('.').trim().to_ascii_lowercase();
|
|
if normalized.is_empty() {
|
|
return Err(Error::InvalidRule(
|
|
"network_rule host cannot be empty".to_string(),
|
|
));
|
|
}
|
|
if normalized.contains('*') {
|
|
return Err(Error::InvalidRule(
|
|
"network_rule host must be a specific host; wildcards are not allowed".to_string(),
|
|
));
|
|
}
|
|
if normalized.chars().any(char::is_whitespace) {
|
|
return Err(Error::InvalidRule(
|
|
"network_rule host cannot contain whitespace".to_string(),
|
|
));
|
|
}
|
|
|
|
Ok(normalized)
|
|
}
|
|
|
|
pub trait Rule: Any + Debug + Send + Sync {
|
|
fn program(&self) -> &str;
|
|
|
|
fn matches(&self, cmd: &[String]) -> Option<RuleMatch>;
|
|
|
|
fn as_any(&self) -> &dyn Any;
|
|
}
|
|
|
|
pub type RuleRef = Arc<dyn Rule>;
|
|
|
|
impl Rule for PrefixRule {
|
|
fn program(&self) -> &str {
|
|
self.pattern.first.as_ref()
|
|
}
|
|
|
|
fn matches(&self, cmd: &[String]) -> Option<RuleMatch> {
|
|
self.pattern
|
|
.matches_prefix(cmd)
|
|
.map(|matched_prefix| RuleMatch::PrefixRuleMatch {
|
|
matched_prefix,
|
|
decision: self.decision,
|
|
resolved_program: None,
|
|
justification: self.justification.clone(),
|
|
})
|
|
}
|
|
|
|
fn as_any(&self) -> &dyn Any {
|
|
self
|
|
}
|
|
}
|
|
|
|
/// Count how many rules match each provided example and error if any example is unmatched.
|
|
pub(crate) fn validate_match_examples(
|
|
policy: &Policy,
|
|
rules: &[RuleRef],
|
|
matches: &[Vec<String>],
|
|
) -> Result<()> {
|
|
let mut unmatched_examples = Vec::new();
|
|
let options = MatchOptions {
|
|
resolve_host_executables: true,
|
|
};
|
|
|
|
for example in matches {
|
|
if !policy
|
|
.matches_for_command_with_options(example, None, &options)
|
|
.is_empty()
|
|
{
|
|
continue;
|
|
}
|
|
|
|
unmatched_examples.push(
|
|
try_join(example.iter().map(String::as_str))
|
|
.unwrap_or_else(|_| "unable to render example".to_string()),
|
|
);
|
|
}
|
|
|
|
if unmatched_examples.is_empty() {
|
|
Ok(())
|
|
} else {
|
|
Err(Error::ExampleDidNotMatch {
|
|
rules: rules.iter().map(|rule| format!("{rule:?}")).collect(),
|
|
examples: unmatched_examples,
|
|
location: None,
|
|
})
|
|
}
|
|
}
|
|
|
|
/// Ensure that no rule matches any provided negative example.
|
|
pub(crate) fn validate_not_match_examples(
|
|
policy: &Policy,
|
|
_rules: &[RuleRef],
|
|
not_matches: &[Vec<String>],
|
|
) -> Result<()> {
|
|
let options = MatchOptions {
|
|
resolve_host_executables: true,
|
|
};
|
|
|
|
for example in not_matches {
|
|
if let Some(rule) = policy
|
|
.matches_for_command_with_options(example, None, &options)
|
|
.first()
|
|
{
|
|
return Err(Error::ExampleDidMatch {
|
|
rule: format!("{rule:?}"),
|
|
example: try_join(example.iter().map(String::as_str))
|
|
.unwrap_or_else(|_| "unable to render example".to_string()),
|
|
location: None,
|
|
});
|
|
}
|
|
}
|
|
|
|
Ok(())
|
|
}
|