mirror of
https://github.com/openai/codex.git
synced 2026-05-17 01:32:32 +00:00
8494e5bd7b
## Why We need `PermissionRequest` hook support! Also addresses: - https://github.com/openai/codex/issues/16301 - run a script on Hook to do things like play a sound to draw attention but actually no-op so user can still approve - can omit the `decision` object from output or just have the script exit 0 and print nothing - https://github.com/openai/codex/issues/15311 - let the script approve/deny on its own - external UI what will run on Hook and relay decision back to codex ## Reviewer Note There's a lot of plumbing for the new hook, key files to review are: - New hook added in `codex-rs/hooks/src/events/permission_request.rs` - Wiring for network approvals `codex-rs/core/src/tools/network_approval.rs` - Wiring for tool orchestrator `codex-rs/core/src/tools/orchestrator.rs` - Wiring for execve `codex-rs/core/src/tools/runtimes/shell/unix_escalation.rs` ## What - Wires shell, unified exec, and network approval prompts into the `PermissionRequest` hook flow. - Lets hooks allow or deny approval prompts; quiet or invalid hooks fall back to the normal approval path. - Uses `tool_input.description` for user-facing context when it helps: - shell / `exec_command`: the request justification, when present - network approvals: `network-access <domain>` - Uses `tool_name: Bash` for shell, unified exec, and network approval permission-request hooks. - For network approvals, passes the originating command in `tool_input.command` when there is a single owning call; otherwise falls back to the synthetic `network-access ...` command. <details> <summary>Example `PermissionRequest` hook input for a shell approval</summary> ```json { "session_id": "<session-id>", "turn_id": "<turn-id>", "transcript_path": "/path/to/transcript.jsonl", "cwd": "/path/to/cwd", "hook_event_name": "PermissionRequest", "model": "gpt-5", "permission_mode": "default", "tool_name": "Bash", "tool_input": { "command": "rm -f /tmp/example" } } ``` </details> <details> <summary>Example `PermissionRequest` hook input for an escalated `exec_command` request</summary> ```json { "session_id": "<session-id>", "turn_id": "<turn-id>", "transcript_path": "/path/to/transcript.jsonl", "cwd": "/path/to/cwd", "hook_event_name": "PermissionRequest", "model": "gpt-5", "permission_mode": "default", "tool_name": "Bash", "tool_input": { "command": "cp /tmp/source.json /Users/alice/export/source.json", "description": "Need to copy a generated file outside the workspace" } } ``` </details> <details> <summary>Example `PermissionRequest` hook input for a network approval</summary> ```json { "session_id": "<session-id>", "turn_id": "<turn-id>", "transcript_path": "/path/to/transcript.jsonl", "cwd": "/path/to/cwd", "hook_event_name": "PermissionRequest", "model": "gpt-5", "permission_mode": "default", "tool_name": "Bash", "tool_input": { "command": "curl http://codex-network-test.invalid", "description": "network-access http://codex-network-test.invalid" } } ``` </details> ## Follow-ups - Implement the `PermissionRequest` semantics for `updatedInput`, `updatedPermissions`, `interrupt`, and suggestions / `permission_suggestions` - Add `PermissionRequest` support for the `request_permissions` tool path --------- Co-authored-by: Codex <noreply@openai.com>
38 lines
1.3 KiB
Rust
38 lines
1.3 KiB
Rust
mod engine;
|
|
pub(crate) mod events;
|
|
mod legacy_notify;
|
|
mod registry;
|
|
mod schema;
|
|
mod types;
|
|
|
|
pub use events::permission_request::PermissionRequestDecision;
|
|
pub use events::permission_request::PermissionRequestOutcome;
|
|
pub use events::permission_request::PermissionRequestRequest;
|
|
pub use events::post_tool_use::PostToolUseOutcome;
|
|
pub use events::post_tool_use::PostToolUseRequest;
|
|
pub use events::pre_tool_use::PreToolUseOutcome;
|
|
pub use events::pre_tool_use::PreToolUseRequest;
|
|
pub use events::session_start::SessionStartOutcome;
|
|
pub use events::session_start::SessionStartRequest;
|
|
pub use events::session_start::SessionStartSource;
|
|
pub use events::stop::StopOutcome;
|
|
pub use events::stop::StopRequest;
|
|
pub use events::user_prompt_submit::UserPromptSubmitOutcome;
|
|
pub use events::user_prompt_submit::UserPromptSubmitRequest;
|
|
pub use legacy_notify::legacy_notify_json;
|
|
pub use legacy_notify::notify_hook;
|
|
pub use registry::Hooks;
|
|
pub use registry::HooksConfig;
|
|
pub use registry::command_from_argv;
|
|
pub use schema::write_schema_fixtures;
|
|
pub use types::Hook;
|
|
pub use types::HookEvent;
|
|
pub use types::HookEventAfterAgent;
|
|
pub use types::HookEventAfterToolUse;
|
|
pub use types::HookPayload;
|
|
pub use types::HookResponse;
|
|
pub use types::HookResult;
|
|
pub use types::HookToolInput;
|
|
pub use types::HookToolInputLocalShell;
|
|
pub use types::HookToolKind;
|