mirror of
https://github.com/openai/codex.git
synced 2026-03-05 21:45:28 +03:00
codex-execpolicy
Overview
- Policy engine and CLI built around
prefix_rule(pattern=[...], decision?, match?, not_match?). - This release covers the prefix-rule subset of the execpolicy language; a richer language will follow.
- Tokens are matched in order; any
patternelement may be a list to denote alternatives.decisiondefaults toallow; valid values:allow,prompt,forbidden. match/not_matchsupply example invocations that are validated at load time (think of them as unit tests); examples can be token arrays or strings (strings are tokenized withshlex).- The CLI always prints the JSON serialization of the evaluation result.
- The legacy rule matcher lives in
codex-execpolicy-legacy.
Policy shapes
- Prefix rules use Starlark syntax:
prefix_rule(
pattern = ["cmd", ["alt1", "alt2"]], # ordered tokens; list entries denote alternatives
decision = "prompt", # allow | prompt | forbidden; defaults to allow
match = [["cmd", "alt1"], "cmd alt2"], # examples that must match this rule
not_match = [["cmd", "oops"], "cmd alt3"], # examples that must not match this rule
)
CLI
- Provide one or more policy files (for example
src/default.codexpolicy) to check a command:
cargo run -p codex-execpolicy -- check --policy path/to/policy.codexpolicy git status
- Pass multiple
--policyflags to merge rules, evaluated in the order provided:
cargo run -p codex-execpolicy -- check --policy base.codexpolicy --policy overrides.codexpolicy git status
- Output is JSON by default; pass
--prettyfor pretty-printed JSON - Example outcomes:
- Match:
{"match": { ... "decision": "allow" ... }} - No match:
"noMatch"
- Match:
Response shapes
- Match:
{
"match": {
"decision": "allow|prompt|forbidden",
"matchedRules": [
{
"prefixRuleMatch": {
"matchedPrefix": ["<token>", "..."],
"decision": "allow|prompt|forbidden"
}
}
]
}
}
- No match:
"noMatch"
matchedRuleslists every rule whose prefix matched the command;matchedPrefixis the exact prefix that matched.- The effective
decisionis the strictest severity across all matches (forbidden>prompt>allow).