mirror of
https://github.com/openai/codex.git
synced 2026-05-25 05:24:37 +00:00
# Why Hook trust happens through the TUI in `/hooks` so it can block non-interactive use cases. This flag will allow users that are using codex headlessly to bypass hooks when they want to. # What This adds one invocation-scoped escape hatch. - the CLI flag sets a runtime-only `bypass_hook_trust` override; there is no durable `config.toml` setting - hook discovery still respects normal enablement, so explicitly disabled hooks remain disabled - we show a `--dangerously-bypass-hook-trust is enabled. Enabled hooks may run without review for this invocation.` message on startup so accidental use is visible in both interactive and exec flows This keeps “enabled” and “trusted” as separate concepts in the normal path, while giving CI/E2E callers a stable way to opt into the exceptional path when they already control the hook set.
234 lines
7.0 KiB
Rust
234 lines
7.0 KiB
Rust
use codex_config::ConfigLayerStack;
|
|
use codex_plugin::PluginHookSource;
|
|
use tokio::process::Command;
|
|
|
|
use crate::engine::ClaudeHooksEngine;
|
|
use crate::engine::CommandShell;
|
|
use crate::engine::HookListEntry;
|
|
use crate::events::compact::PostCompactRequest;
|
|
use crate::events::compact::PreCompactOutcome;
|
|
use crate::events::compact::PreCompactRequest;
|
|
use crate::events::compact::StatelessHookOutcome;
|
|
use crate::events::permission_request::PermissionRequestOutcome;
|
|
use crate::events::permission_request::PermissionRequestRequest;
|
|
use crate::events::post_tool_use::PostToolUseOutcome;
|
|
use crate::events::post_tool_use::PostToolUseRequest;
|
|
use crate::events::pre_tool_use::PreToolUseOutcome;
|
|
use crate::events::pre_tool_use::PreToolUseRequest;
|
|
use crate::events::session_start::SessionStartOutcome;
|
|
use crate::events::session_start::SessionStartRequest;
|
|
use crate::events::stop::StopOutcome;
|
|
use crate::events::stop::StopRequest;
|
|
use crate::events::user_prompt_submit::UserPromptSubmitOutcome;
|
|
use crate::events::user_prompt_submit::UserPromptSubmitRequest;
|
|
use crate::types::Hook;
|
|
use crate::types::HookEvent;
|
|
use crate::types::HookPayload;
|
|
use crate::types::HookResponse;
|
|
|
|
#[derive(Default, Clone)]
|
|
pub struct HooksConfig {
|
|
pub legacy_notify_argv: Option<Vec<String>>,
|
|
pub feature_enabled: bool,
|
|
pub bypass_hook_trust: bool,
|
|
pub config_layer_stack: Option<ConfigLayerStack>,
|
|
pub plugin_hook_sources: Vec<PluginHookSource>,
|
|
pub plugin_hook_load_warnings: Vec<String>,
|
|
pub shell_program: Option<String>,
|
|
pub shell_args: Vec<String>,
|
|
}
|
|
|
|
#[derive(Debug, Clone, Default, PartialEq, Eq)]
|
|
pub struct HookListOutcome {
|
|
pub hooks: Vec<HookListEntry>,
|
|
pub warnings: Vec<String>,
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
pub struct Hooks {
|
|
after_agent: Vec<Hook>,
|
|
engine: ClaudeHooksEngine,
|
|
}
|
|
|
|
impl Default for Hooks {
|
|
fn default() -> Self {
|
|
Self::new(HooksConfig::default())
|
|
}
|
|
}
|
|
|
|
impl Hooks {
|
|
pub fn new(config: HooksConfig) -> Self {
|
|
let after_agent = config
|
|
.legacy_notify_argv
|
|
.filter(|argv| !argv.is_empty() && !argv[0].is_empty())
|
|
.map(crate::notify_hook)
|
|
.into_iter()
|
|
.collect();
|
|
let engine = ClaudeHooksEngine::new(
|
|
config.feature_enabled,
|
|
config.bypass_hook_trust,
|
|
config.config_layer_stack.as_ref(),
|
|
config.plugin_hook_sources,
|
|
config.plugin_hook_load_warnings,
|
|
CommandShell {
|
|
program: config.shell_program.unwrap_or_default(),
|
|
args: config.shell_args,
|
|
},
|
|
);
|
|
Self {
|
|
after_agent,
|
|
engine,
|
|
}
|
|
}
|
|
|
|
pub fn startup_warnings(&self) -> &[String] {
|
|
self.engine.warnings()
|
|
}
|
|
|
|
fn hooks_for_event(&self, hook_event: &HookEvent) -> &[Hook] {
|
|
match hook_event {
|
|
HookEvent::AfterAgent { .. } => &self.after_agent,
|
|
}
|
|
}
|
|
|
|
pub async fn dispatch(&self, hook_payload: HookPayload) -> Vec<HookResponse> {
|
|
let hooks = self.hooks_for_event(&hook_payload.hook_event);
|
|
let mut outcomes = Vec::with_capacity(hooks.len());
|
|
for hook in hooks {
|
|
let outcome = hook.execute(&hook_payload).await;
|
|
let should_abort_operation = outcome.result.should_abort_operation();
|
|
outcomes.push(outcome);
|
|
if should_abort_operation {
|
|
break;
|
|
}
|
|
}
|
|
|
|
outcomes
|
|
}
|
|
|
|
pub fn preview_session_start(
|
|
&self,
|
|
request: &SessionStartRequest,
|
|
) -> Vec<codex_protocol::protocol::HookRunSummary> {
|
|
self.engine.preview_session_start(request)
|
|
}
|
|
|
|
pub fn preview_pre_tool_use(
|
|
&self,
|
|
request: &PreToolUseRequest,
|
|
) -> Vec<codex_protocol::protocol::HookRunSummary> {
|
|
self.engine.preview_pre_tool_use(request)
|
|
}
|
|
|
|
pub fn preview_permission_request(
|
|
&self,
|
|
request: &PermissionRequestRequest,
|
|
) -> Vec<codex_protocol::protocol::HookRunSummary> {
|
|
self.engine.preview_permission_request(request)
|
|
}
|
|
|
|
pub fn preview_post_tool_use(
|
|
&self,
|
|
request: &PostToolUseRequest,
|
|
) -> Vec<codex_protocol::protocol::HookRunSummary> {
|
|
self.engine.preview_post_tool_use(request)
|
|
}
|
|
|
|
pub async fn run_session_start(
|
|
&self,
|
|
request: SessionStartRequest,
|
|
turn_id: Option<String>,
|
|
) -> SessionStartOutcome {
|
|
self.engine.run_session_start(request, turn_id).await
|
|
}
|
|
|
|
pub async fn run_pre_tool_use(&self, request: PreToolUseRequest) -> PreToolUseOutcome {
|
|
self.engine.run_pre_tool_use(request).await
|
|
}
|
|
|
|
pub async fn run_permission_request(
|
|
&self,
|
|
request: PermissionRequestRequest,
|
|
) -> PermissionRequestOutcome {
|
|
self.engine.run_permission_request(request).await
|
|
}
|
|
|
|
pub async fn run_post_tool_use(&self, request: PostToolUseRequest) -> PostToolUseOutcome {
|
|
self.engine.run_post_tool_use(request).await
|
|
}
|
|
|
|
pub fn preview_pre_compact(
|
|
&self,
|
|
request: &PreCompactRequest,
|
|
) -> Vec<codex_protocol::protocol::HookRunSummary> {
|
|
self.engine.preview_pre_compact(request)
|
|
}
|
|
|
|
pub async fn run_pre_compact(&self, request: PreCompactRequest) -> PreCompactOutcome {
|
|
self.engine.run_pre_compact(request).await
|
|
}
|
|
|
|
pub fn preview_post_compact(
|
|
&self,
|
|
request: &PostCompactRequest,
|
|
) -> Vec<codex_protocol::protocol::HookRunSummary> {
|
|
self.engine.preview_post_compact(request)
|
|
}
|
|
|
|
pub async fn run_post_compact(&self, request: PostCompactRequest) -> StatelessHookOutcome {
|
|
self.engine.run_post_compact(request).await
|
|
}
|
|
|
|
pub fn preview_user_prompt_submit(
|
|
&self,
|
|
request: &UserPromptSubmitRequest,
|
|
) -> Vec<codex_protocol::protocol::HookRunSummary> {
|
|
self.engine.preview_user_prompt_submit(request)
|
|
}
|
|
|
|
pub async fn run_user_prompt_submit(
|
|
&self,
|
|
request: UserPromptSubmitRequest,
|
|
) -> UserPromptSubmitOutcome {
|
|
self.engine.run_user_prompt_submit(request).await
|
|
}
|
|
|
|
pub fn preview_stop(
|
|
&self,
|
|
request: &StopRequest,
|
|
) -> Vec<codex_protocol::protocol::HookRunSummary> {
|
|
self.engine.preview_stop(request)
|
|
}
|
|
|
|
pub async fn run_stop(&self, request: StopRequest) -> StopOutcome {
|
|
self.engine.run_stop(request).await
|
|
}
|
|
}
|
|
|
|
pub fn list_hooks(config: HooksConfig) -> HookListOutcome {
|
|
if !config.feature_enabled {
|
|
return HookListOutcome::default();
|
|
}
|
|
|
|
let discovered = crate::engine::discovery::discover_handlers(
|
|
config.config_layer_stack.as_ref(),
|
|
config.plugin_hook_sources,
|
|
config.plugin_hook_load_warnings,
|
|
config.bypass_hook_trust,
|
|
);
|
|
HookListOutcome {
|
|
hooks: discovered.hook_entries,
|
|
warnings: discovered.warnings,
|
|
}
|
|
}
|
|
|
|
pub fn command_from_argv(argv: &[String]) -> Option<Command> {
|
|
let (program, args) = argv.split_first()?;
|
|
if program.is_empty() {
|
|
return None;
|
|
}
|
|
let mut command = Command::new(program);
|
|
command.args(args);
|
|
Some(command)
|
|
}
|