mirror of
https://github.com/lWolvesl/claw-code.git
synced 2026-04-03 05:41:53 +08:00
wip: hook-pipeline progress
This commit is contained in:
@@ -316,6 +316,11 @@ impl RuntimeConfig {
|
|||||||
self.feature_config.permission_mode
|
self.feature_config.permission_mode
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_rules(&self) -> &RuntimePermissionRuleConfig {
|
||||||
|
&self.feature_config.permission_rules
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn sandbox(&self) -> &SandboxConfig {
|
pub fn sandbox(&self) -> &SandboxConfig {
|
||||||
&self.feature_config.sandbox
|
&self.feature_config.sandbox
|
||||||
@@ -916,7 +921,7 @@ mod tests {
|
|||||||
.expect("write user compat config");
|
.expect("write user compat config");
|
||||||
fs::write(
|
fs::write(
|
||||||
home.join("settings.json"),
|
home.join("settings.json"),
|
||||||
r#"{"model":"sonnet","env":{"A2":"1"},"hooks":{"PreToolUse":["base"]},"permissions":{"defaultMode":"plan"}}"#,
|
r#"{"model":"sonnet","env":{"A2":"1"},"hooks":{"PreToolUse":["base"]},"permissions":{"defaultMode":"plan","allow":["Read"],"deny":["Bash(rm -rf)"]}}"#,
|
||||||
)
|
)
|
||||||
.expect("write user settings");
|
.expect("write user settings");
|
||||||
fs::write(
|
fs::write(
|
||||||
@@ -926,7 +931,7 @@ mod tests {
|
|||||||
.expect("write project compat config");
|
.expect("write project compat config");
|
||||||
fs::write(
|
fs::write(
|
||||||
cwd.join(".claude").join("settings.json"),
|
cwd.join(".claude").join("settings.json"),
|
||||||
r#"{"env":{"C":"3"},"hooks":{"PostToolUse":["project"]},"mcpServers":{"project":{"command":"uvx","args":["project"]}}}"#,
|
r#"{"env":{"C":"3"},"hooks":{"PostToolUse":["project"],"PostToolUseFailure":["project-failure"]},"permissions":{"ask":["Edit"]},"mcpServers":{"project":{"command":"uvx","args":["project"]}}}"#,
|
||||||
)
|
)
|
||||||
.expect("write project settings");
|
.expect("write project settings");
|
||||||
fs::write(
|
fs::write(
|
||||||
@@ -971,6 +976,16 @@ mod tests {
|
|||||||
.contains_key("PostToolUse"));
|
.contains_key("PostToolUse"));
|
||||||
assert_eq!(loaded.hooks().pre_tool_use(), &["base".to_string()]);
|
assert_eq!(loaded.hooks().pre_tool_use(), &["base".to_string()]);
|
||||||
assert_eq!(loaded.hooks().post_tool_use(), &["project".to_string()]);
|
assert_eq!(loaded.hooks().post_tool_use(), &["project".to_string()]);
|
||||||
|
assert_eq!(
|
||||||
|
loaded.hooks().post_tool_use_failure(),
|
||||||
|
&["project-failure".to_string()]
|
||||||
|
);
|
||||||
|
assert_eq!(loaded.permission_rules().allow(), &["Read".to_string()]);
|
||||||
|
assert_eq!(
|
||||||
|
loaded.permission_rules().deny(),
|
||||||
|
&["Bash(rm -rf)".to_string()]
|
||||||
|
);
|
||||||
|
assert_eq!(loaded.permission_rules().ask(), &["Edit".to_string()]);
|
||||||
assert!(loaded.mcp().get("home").is_some());
|
assert!(loaded.mcp().get("home").is_some());
|
||||||
assert!(loaded.mcp().get("project").is_some());
|
assert!(loaded.mcp().get("project").is_some());
|
||||||
|
|
||||||
|
|||||||
@@ -5,8 +5,10 @@ use crate::compact::{
|
|||||||
compact_session, estimate_session_tokens, CompactionConfig, CompactionResult,
|
compact_session, estimate_session_tokens, CompactionConfig, CompactionResult,
|
||||||
};
|
};
|
||||||
use crate::config::RuntimeFeatureConfig;
|
use crate::config::RuntimeFeatureConfig;
|
||||||
use crate::hooks::{HookRunResult, HookRunner};
|
use crate::hooks::{HookAbortSignal, HookProgressReporter, HookRunResult, HookRunner};
|
||||||
use crate::permissions::{PermissionOutcome, PermissionPolicy, PermissionPrompter};
|
use crate::permissions::{
|
||||||
|
PermissionContext, PermissionOutcome, PermissionPolicy, PermissionPrompter,
|
||||||
|
};
|
||||||
use crate::session::{ContentBlock, ConversationMessage, Session};
|
use crate::session::{ContentBlock, ConversationMessage, Session};
|
||||||
use crate::usage::{TokenUsage, UsageTracker};
|
use crate::usage::{TokenUsage, UsageTracker};
|
||||||
|
|
||||||
@@ -97,6 +99,8 @@ pub struct ConversationRuntime<C, T> {
|
|||||||
max_iterations: usize,
|
max_iterations: usize,
|
||||||
usage_tracker: UsageTracker,
|
usage_tracker: UsageTracker,
|
||||||
hook_runner: HookRunner,
|
hook_runner: HookRunner,
|
||||||
|
hook_abort_signal: HookAbortSignal,
|
||||||
|
hook_progress_reporter: Option<Box<dyn HookProgressReporter>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<C, T> ConversationRuntime<C, T>
|
impl<C, T> ConversationRuntime<C, T>
|
||||||
@@ -118,7 +122,7 @@ where
|
|||||||
tool_executor,
|
tool_executor,
|
||||||
permission_policy,
|
permission_policy,
|
||||||
system_prompt,
|
system_prompt,
|
||||||
RuntimeFeatureConfig::default(),
|
&RuntimeFeatureConfig::default(),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -129,7 +133,7 @@ where
|
|||||||
tool_executor: T,
|
tool_executor: T,
|
||||||
permission_policy: PermissionPolicy,
|
permission_policy: PermissionPolicy,
|
||||||
system_prompt: Vec<String>,
|
system_prompt: Vec<String>,
|
||||||
feature_config: RuntimeFeatureConfig,
|
feature_config: &RuntimeFeatureConfig,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
let usage_tracker = UsageTracker::from_session(&session);
|
let usage_tracker = UsageTracker::from_session(&session);
|
||||||
Self {
|
Self {
|
||||||
@@ -140,7 +144,8 @@ where
|
|||||||
system_prompt,
|
system_prompt,
|
||||||
max_iterations: usize::MAX,
|
max_iterations: usize::MAX,
|
||||||
usage_tracker,
|
usage_tracker,
|
||||||
hook_runner: HookRunner::from_feature_config(&feature_config),
|
hook_runner: HookRunner::from_feature_config(feature_config),
|
||||||
|
hook_abort_signal: HookAbortSignal::default(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -150,6 +155,22 @@ where
|
|||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn with_hook_abort_signal(mut self, hook_abort_signal: HookAbortSignal) -> Self {
|
||||||
|
self.hook_abort_signal = hook_abort_signal;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn with_hook_progress_reporter(
|
||||||
|
mut self,
|
||||||
|
hook_progress_reporter: Box<dyn HookProgressReporter>,
|
||||||
|
) -> Self {
|
||||||
|
self.hook_progress_reporter = Some(hook_progress_reporter);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_lines)]
|
||||||
pub fn run_turn(
|
pub fn run_turn(
|
||||||
&mut self,
|
&mut self,
|
||||||
user_input: impl Into<String>,
|
user_input: impl Into<String>,
|
||||||
@@ -199,55 +220,94 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
for (tool_use_id, tool_name, input) in pending_tool_uses {
|
for (tool_use_id, tool_name, input) in pending_tool_uses {
|
||||||
let permission_outcome = if let Some(prompt) = prompter.as_mut() {
|
let pre_hook_result = self.hook_runner.run_pre_tool_use_with_context(
|
||||||
self.permission_policy
|
&tool_name,
|
||||||
.authorize(&tool_name, &input, Some(*prompt))
|
&input,
|
||||||
|
Some(&self.hook_abort_signal),
|
||||||
|
self.hook_progress_reporter.as_deref_mut(),
|
||||||
|
);
|
||||||
|
let effective_input = pre_hook_result
|
||||||
|
.updated_input_json()
|
||||||
|
.map_or_else(|| input.clone(), ToOwned::to_owned);
|
||||||
|
let permission_context = PermissionContext::new(
|
||||||
|
pre_hook_result.permission_decision(),
|
||||||
|
pre_hook_result.permission_reason().map(ToOwned::to_owned),
|
||||||
|
);
|
||||||
|
|
||||||
|
let permission_outcome = if pre_hook_result.is_cancelled() {
|
||||||
|
PermissionOutcome::Deny {
|
||||||
|
reason: format_hook_message(
|
||||||
|
&pre_hook_result,
|
||||||
|
&format!("PreToolUse hook cancelled tool `{tool_name}`"),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
} else if pre_hook_result.is_denied() {
|
||||||
|
PermissionOutcome::Deny {
|
||||||
|
reason: format_hook_message(
|
||||||
|
&pre_hook_result,
|
||||||
|
&format!("PreToolUse hook denied tool `{tool_name}`"),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
} else if let Some(prompt) = prompter.as_mut() {
|
||||||
|
self.permission_policy.authorize_with_context(
|
||||||
|
&tool_name,
|
||||||
|
&effective_input,
|
||||||
|
&permission_context,
|
||||||
|
Some(*prompt),
|
||||||
|
)
|
||||||
} else {
|
} else {
|
||||||
self.permission_policy.authorize(&tool_name, &input, None)
|
self.permission_policy.authorize_with_context(
|
||||||
|
&tool_name,
|
||||||
|
&effective_input,
|
||||||
|
&permission_context,
|
||||||
|
None,
|
||||||
|
)
|
||||||
};
|
};
|
||||||
|
|
||||||
let result_message = match permission_outcome {
|
let result_message = match permission_outcome {
|
||||||
PermissionOutcome::Allow => {
|
PermissionOutcome::Allow => {
|
||||||
let pre_hook_result = self.hook_runner.run_pre_tool_use(&tool_name, &input);
|
let (mut output, mut is_error) =
|
||||||
if pre_hook_result.is_denied() {
|
match self.tool_executor.execute(&tool_name, &effective_input) {
|
||||||
let deny_message = format!("PreToolUse hook denied tool `{tool_name}`");
|
Ok(output) => (output, false),
|
||||||
ConversationMessage::tool_result(
|
Err(error) => (error.to_string(), true),
|
||||||
tool_use_id,
|
};
|
||||||
tool_name,
|
output = merge_hook_feedback(pre_hook_result.messages(), output, false);
|
||||||
format_hook_message(&pre_hook_result, &deny_message),
|
|
||||||
true,
|
let post_hook_result = if is_error {
|
||||||
|
self.hook_runner.run_post_tool_use_failure_with_context(
|
||||||
|
&tool_name,
|
||||||
|
&effective_input,
|
||||||
|
&output,
|
||||||
|
Some(&self.hook_abort_signal),
|
||||||
|
self.hook_progress_reporter.as_deref_mut(),
|
||||||
)
|
)
|
||||||
} else {
|
} else {
|
||||||
let (mut output, mut is_error) =
|
self.hook_runner.run_post_tool_use_with_context(
|
||||||
match self.tool_executor.execute(&tool_name, &input) {
|
&tool_name,
|
||||||
Ok(output) => (output, false),
|
&effective_input,
|
||||||
Err(error) => (error.to_string(), true),
|
&output,
|
||||||
};
|
false,
|
||||||
output = merge_hook_feedback(pre_hook_result.messages(), output, false);
|
Some(&self.hook_abort_signal),
|
||||||
|
self.hook_progress_reporter.as_deref_mut(),
|
||||||
let post_hook_result = self
|
|
||||||
.hook_runner
|
|
||||||
.run_post_tool_use(&tool_name, &input, &output, is_error);
|
|
||||||
if post_hook_result.is_denied() {
|
|
||||||
is_error = true;
|
|
||||||
}
|
|
||||||
output = merge_hook_feedback(
|
|
||||||
post_hook_result.messages(),
|
|
||||||
output,
|
|
||||||
post_hook_result.is_denied(),
|
|
||||||
);
|
|
||||||
|
|
||||||
ConversationMessage::tool_result(
|
|
||||||
tool_use_id,
|
|
||||||
tool_name,
|
|
||||||
output,
|
|
||||||
is_error,
|
|
||||||
)
|
)
|
||||||
|
};
|
||||||
|
if post_hook_result.is_denied() || post_hook_result.is_cancelled() {
|
||||||
|
is_error = true;
|
||||||
}
|
}
|
||||||
|
output = merge_hook_feedback(
|
||||||
|
post_hook_result.messages(),
|
||||||
|
output,
|
||||||
|
post_hook_result.is_denied() || post_hook_result.is_cancelled(),
|
||||||
|
);
|
||||||
|
|
||||||
|
ConversationMessage::tool_result(tool_use_id, tool_name, output, is_error)
|
||||||
}
|
}
|
||||||
PermissionOutcome::Deny { reason } => {
|
PermissionOutcome::Deny { reason } => ConversationMessage::tool_result(
|
||||||
ConversationMessage::tool_result(tool_use_id, tool_name, reason, true)
|
tool_use_id,
|
||||||
}
|
tool_name,
|
||||||
|
merge_hook_feedback(pre_hook_result.messages(), reason, true),
|
||||||
|
true,
|
||||||
|
),
|
||||||
};
|
};
|
||||||
self.session.messages.push(result_message.clone());
|
self.session.messages.push(result_message.clone());
|
||||||
tool_results.push(result_message);
|
tool_results.push(result_message);
|
||||||
@@ -609,9 +669,10 @@ mod tests {
|
|||||||
}),
|
}),
|
||||||
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
vec!["system".to_string()],
|
vec!["system".to_string()],
|
||||||
RuntimeFeatureConfig::default().with_hooks(RuntimeHookConfig::new(
|
&RuntimeFeatureConfig::default().with_hooks(RuntimeHookConfig::new(
|
||||||
vec![shell_snippet("printf 'blocked by hook'; exit 2")],
|
vec![shell_snippet("printf 'blocked by hook'; exit 2")],
|
||||||
Vec::new(),
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
)),
|
)),
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -675,9 +736,10 @@ mod tests {
|
|||||||
StaticToolExecutor::new().register("add", |_input| Ok("4".to_string())),
|
StaticToolExecutor::new().register("add", |_input| Ok("4".to_string())),
|
||||||
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
vec!["system".to_string()],
|
vec!["system".to_string()],
|
||||||
RuntimeFeatureConfig::default().with_hooks(RuntimeHookConfig::new(
|
&RuntimeFeatureConfig::default().with_hooks(RuntimeHookConfig::new(
|
||||||
vec![shell_snippet("printf 'pre hook ran'")],
|
vec![shell_snippet("printf 'pre hook ran'")],
|
||||||
vec![shell_snippet("printf 'post hook ran'")],
|
vec![shell_snippet("printf 'post hook ran'")],
|
||||||
|
Vec::new(),
|
||||||
)),
|
)),
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -697,7 +759,7 @@ mod tests {
|
|||||||
"post hook should preserve non-error result: {output:?}"
|
"post hook should preserve non-error result: {output:?}"
|
||||||
);
|
);
|
||||||
assert!(
|
assert!(
|
||||||
output.contains("4"),
|
output.contains('4'),
|
||||||
"tool output missing value: {output:?}"
|
"tool output missing value: {output:?}"
|
||||||
);
|
);
|
||||||
assert!(
|
assert!(
|
||||||
|
|||||||
@@ -1,29 +1,92 @@
|
|||||||
use std::ffi::OsStr;
|
use std::ffi::OsStr;
|
||||||
use std::process::Command;
|
use std::process::{Command, Stdio};
|
||||||
|
use std::sync::{
|
||||||
|
atomic::{AtomicBool, Ordering},
|
||||||
|
Arc,
|
||||||
|
};
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
use serde_json::json;
|
use serde_json::{json, Value};
|
||||||
|
use tokio::io::AsyncWriteExt;
|
||||||
|
use tokio::process::Command as TokioCommand;
|
||||||
|
use tokio::runtime::Builder;
|
||||||
|
use tokio::time::sleep;
|
||||||
|
|
||||||
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
||||||
|
use crate::permissions::PermissionOverride;
|
||||||
|
|
||||||
|
pub type HookPermissionDecision = PermissionOverride;
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
pub enum HookEvent {
|
pub enum HookEvent {
|
||||||
PreToolUse,
|
PreToolUse,
|
||||||
PostToolUse,
|
PostToolUse,
|
||||||
|
PostToolUseFailure,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl HookEvent {
|
impl HookEvent {
|
||||||
fn as_str(self) -> &'static str {
|
#[must_use]
|
||||||
|
pub fn as_str(self) -> &'static str {
|
||||||
match self {
|
match self {
|
||||||
Self::PreToolUse => "PreToolUse",
|
Self::PreToolUse => "PreToolUse",
|
||||||
Self::PostToolUse => "PostToolUse",
|
Self::PostToolUse => "PostToolUse",
|
||||||
|
Self::PostToolUseFailure => "PostToolUseFailure",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub enum HookProgressEvent {
|
||||||
|
Started {
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: String,
|
||||||
|
command: String,
|
||||||
|
},
|
||||||
|
Completed {
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: String,
|
||||||
|
command: String,
|
||||||
|
},
|
||||||
|
Cancelled {
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: String,
|
||||||
|
command: String,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
pub trait HookProgressReporter {
|
||||||
|
fn on_event(&mut self, event: &HookProgressEvent);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Default)]
|
||||||
|
pub struct HookAbortSignal {
|
||||||
|
aborted: Arc<AtomicBool>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookAbortSignal {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self::default()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn abort(&self) {
|
||||||
|
self.aborted.store(true, Ordering::SeqCst);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn is_aborted(&self) -> bool {
|
||||||
|
self.aborted.load(Ordering::SeqCst)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
pub struct HookRunResult {
|
pub struct HookRunResult {
|
||||||
denied: bool,
|
denied: bool,
|
||||||
|
cancelled: bool,
|
||||||
messages: Vec<String>,
|
messages: Vec<String>,
|
||||||
|
permission_override: Option<PermissionOverride>,
|
||||||
|
permission_reason: Option<String>,
|
||||||
|
updated_input: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl HookRunResult {
|
impl HookRunResult {
|
||||||
@@ -31,7 +94,11 @@ impl HookRunResult {
|
|||||||
pub fn allow(messages: Vec<String>) -> Self {
|
pub fn allow(messages: Vec<String>) -> Self {
|
||||||
Self {
|
Self {
|
||||||
denied: false,
|
denied: false,
|
||||||
|
cancelled: false,
|
||||||
messages,
|
messages,
|
||||||
|
permission_override: None,
|
||||||
|
permission_reason: None,
|
||||||
|
updated_input: None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -40,10 +107,40 @@ impl HookRunResult {
|
|||||||
self.denied
|
self.denied
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn is_cancelled(&self) -> bool {
|
||||||
|
self.cancelled
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn messages(&self) -> &[String] {
|
pub fn messages(&self) -> &[String] {
|
||||||
&self.messages
|
&self.messages
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_override(&self) -> Option<PermissionOverride> {
|
||||||
|
self.permission_override
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_decision(&self) -> Option<HookPermissionDecision> {
|
||||||
|
self.permission_override
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_reason(&self) -> Option<&str> {
|
||||||
|
self.permission_reason.as_deref()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn updated_input(&self) -> Option<&str> {
|
||||||
|
self.updated_input.as_deref()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn updated_input_json(&self) -> Option<&str> {
|
||||||
|
self.updated_input()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
@@ -64,6 +161,17 @@ impl HookRunner {
|
|||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn run_pre_tool_use(&self, tool_name: &str, tool_input: &str) -> HookRunResult {
|
pub fn run_pre_tool_use(&self, tool_name: &str, tool_input: &str) -> HookRunResult {
|
||||||
|
self.run_pre_tool_use_with_context(tool_name, tool_input, None, None)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_pre_tool_use_with_context(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
reporter: Option<&mut dyn HookProgressReporter>,
|
||||||
|
) -> HookRunResult {
|
||||||
self.run_commands(
|
self.run_commands(
|
||||||
HookEvent::PreToolUse,
|
HookEvent::PreToolUse,
|
||||||
self.config.pre_tool_use(),
|
self.config.pre_tool_use(),
|
||||||
@@ -71,9 +179,21 @@ impl HookRunner {
|
|||||||
tool_input,
|
tool_input,
|
||||||
None,
|
None,
|
||||||
false,
|
false,
|
||||||
|
abort_signal,
|
||||||
|
reporter,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_pre_tool_use_with_signal(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_pre_tool_use_with_context(tool_name, tool_input, abort_signal, None)
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn run_post_tool_use(
|
pub fn run_post_tool_use(
|
||||||
&self,
|
&self,
|
||||||
@@ -81,6 +201,26 @@ impl HookRunner {
|
|||||||
tool_input: &str,
|
tool_input: &str,
|
||||||
tool_output: &str,
|
tool_output: &str,
|
||||||
is_error: bool,
|
is_error: bool,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_post_tool_use_with_context(
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
tool_output,
|
||||||
|
is_error,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_with_context(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: &str,
|
||||||
|
is_error: bool,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
reporter: Option<&mut dyn HookProgressReporter>,
|
||||||
) -> HookRunResult {
|
) -> HookRunResult {
|
||||||
self.run_commands(
|
self.run_commands(
|
||||||
HookEvent::PostToolUse,
|
HookEvent::PostToolUse,
|
||||||
@@ -89,9 +229,79 @@ impl HookRunner {
|
|||||||
tool_input,
|
tool_input,
|
||||||
Some(tool_output),
|
Some(tool_output),
|
||||||
is_error,
|
is_error,
|
||||||
|
abort_signal,
|
||||||
|
reporter,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_with_signal(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: &str,
|
||||||
|
is_error: bool,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_post_tool_use_with_context(
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
tool_output,
|
||||||
|
is_error,
|
||||||
|
abort_signal,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_failure(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_error: &str,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_post_tool_use_failure_with_context(tool_name, tool_input, tool_error, None, None)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_failure_with_context(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_error: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
reporter: Option<&mut dyn HookProgressReporter>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_commands(
|
||||||
|
HookEvent::PostToolUseFailure,
|
||||||
|
self.config.post_tool_use_failure(),
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
Some(tool_error),
|
||||||
|
true,
|
||||||
|
abort_signal,
|
||||||
|
reporter,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_failure_with_signal(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_error: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_post_tool_use_failure_with_context(
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
tool_error,
|
||||||
|
abort_signal,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_arguments)]
|
||||||
fn run_commands(
|
fn run_commands(
|
||||||
&self,
|
&self,
|
||||||
event: HookEvent,
|
event: HookEvent,
|
||||||
@@ -100,25 +310,40 @@ impl HookRunner {
|
|||||||
tool_input: &str,
|
tool_input: &str,
|
||||||
tool_output: Option<&str>,
|
tool_output: Option<&str>,
|
||||||
is_error: bool,
|
is_error: bool,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
mut reporter: Option<&mut dyn HookProgressReporter>,
|
||||||
) -> HookRunResult {
|
) -> HookRunResult {
|
||||||
if commands.is_empty() {
|
if commands.is_empty() {
|
||||||
return HookRunResult::allow(Vec::new());
|
return HookRunResult::allow(Vec::new());
|
||||||
}
|
}
|
||||||
|
|
||||||
let payload = json!({
|
if abort_signal.is_some_and(HookAbortSignal::is_aborted) {
|
||||||
"hook_event_name": event.as_str(),
|
return HookRunResult {
|
||||||
"tool_name": tool_name,
|
denied: false,
|
||||||
"tool_input": parse_tool_input(tool_input),
|
cancelled: true,
|
||||||
"tool_input_json": tool_input,
|
messages: vec![format!(
|
||||||
"tool_output": tool_output,
|
"{} hook cancelled before execution",
|
||||||
"tool_result_is_error": is_error,
|
event.as_str()
|
||||||
})
|
)],
|
||||||
.to_string();
|
permission_override: None,
|
||||||
|
permission_reason: None,
|
||||||
|
updated_input: None,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
let mut messages = Vec::new();
|
let payload = hook_payload(event, tool_name, tool_input, tool_output, is_error).to_string();
|
||||||
|
let mut result = HookRunResult::allow(Vec::new());
|
||||||
|
|
||||||
for command in commands {
|
for command in commands {
|
||||||
match self.run_command(
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
|
reporter.on_event(&HookProgressEvent::Started {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
match Self::run_command(
|
||||||
command,
|
command,
|
||||||
event,
|
event,
|
||||||
tool_name,
|
tool_name,
|
||||||
@@ -126,31 +351,60 @@ impl HookRunner {
|
|||||||
tool_output,
|
tool_output,
|
||||||
is_error,
|
is_error,
|
||||||
&payload,
|
&payload,
|
||||||
|
abort_signal,
|
||||||
) {
|
) {
|
||||||
HookCommandOutcome::Allow { message } => {
|
HookCommandOutcome::Allow { parsed } => {
|
||||||
if let Some(message) = message {
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
messages.push(message);
|
reporter.on_event(&HookProgressEvent::Completed {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
merge_parsed_hook_output(&mut result, parsed);
|
||||||
}
|
}
|
||||||
HookCommandOutcome::Deny { message } => {
|
HookCommandOutcome::Deny { parsed } => {
|
||||||
let message = message.unwrap_or_else(|| {
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
format!("{} hook denied tool `{tool_name}`", event.as_str())
|
reporter.on_event(&HookProgressEvent::Completed {
|
||||||
});
|
event,
|
||||||
messages.push(message);
|
tool_name: tool_name.to_string(),
|
||||||
return HookRunResult {
|
command: command.clone(),
|
||||||
denied: true,
|
});
|
||||||
messages,
|
}
|
||||||
};
|
merge_parsed_hook_output(&mut result, parsed);
|
||||||
|
result.denied = true;
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
HookCommandOutcome::Warn { message } => {
|
||||||
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
|
reporter.on_event(&HookProgressEvent::Completed {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
result.messages.push(message);
|
||||||
|
}
|
||||||
|
HookCommandOutcome::Cancelled { message } => {
|
||||||
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
|
reporter.on_event(&HookProgressEvent::Cancelled {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
result.cancelled = true;
|
||||||
|
result.messages.push(message);
|
||||||
|
return result;
|
||||||
}
|
}
|
||||||
HookCommandOutcome::Warn { message } => messages.push(message),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
HookRunResult::allow(messages)
|
result
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_arguments)]
|
||||||
fn run_command(
|
fn run_command(
|
||||||
&self,
|
|
||||||
command: &str,
|
command: &str,
|
||||||
event: HookEvent,
|
event: HookEvent,
|
||||||
tool_name: &str,
|
tool_name: &str,
|
||||||
@@ -158,11 +412,12 @@ impl HookRunner {
|
|||||||
tool_output: Option<&str>,
|
tool_output: Option<&str>,
|
||||||
is_error: bool,
|
is_error: bool,
|
||||||
payload: &str,
|
payload: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
) -> HookCommandOutcome {
|
) -> HookCommandOutcome {
|
||||||
let mut child = shell_command(command);
|
let mut child = shell_command(command);
|
||||||
child.stdin(std::process::Stdio::piped());
|
child.stdin(Stdio::piped());
|
||||||
child.stdout(std::process::Stdio::piped());
|
child.stdout(Stdio::piped());
|
||||||
child.stderr(std::process::Stdio::piped());
|
child.stderr(Stdio::piped());
|
||||||
child.env("HOOK_EVENT", event.as_str());
|
child.env("HOOK_EVENT", event.as_str());
|
||||||
child.env("HOOK_TOOL_NAME", tool_name);
|
child.env("HOOK_TOOL_NAME", tool_name);
|
||||||
child.env("HOOK_TOOL_INPUT", tool_input);
|
child.env("HOOK_TOOL_INPUT", tool_input);
|
||||||
@@ -171,19 +426,30 @@ impl HookRunner {
|
|||||||
child.env("HOOK_TOOL_OUTPUT", tool_output);
|
child.env("HOOK_TOOL_OUTPUT", tool_output);
|
||||||
}
|
}
|
||||||
|
|
||||||
match child.output_with_stdin(payload.as_bytes()) {
|
match child.output_with_stdin(payload.as_bytes(), abort_signal) {
|
||||||
Ok(output) => {
|
Ok(CommandExecution::Finished(output)) => {
|
||||||
let stdout = String::from_utf8_lossy(&output.stdout).trim().to_string();
|
let stdout = String::from_utf8_lossy(&output.stdout).trim().to_string();
|
||||||
let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
|
let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
|
||||||
let message = (!stdout.is_empty()).then_some(stdout);
|
let parsed = parse_hook_output(&stdout);
|
||||||
match output.status.code() {
|
match output.status.code() {
|
||||||
Some(0) => HookCommandOutcome::Allow { message },
|
Some(0) => {
|
||||||
Some(2) => HookCommandOutcome::Deny { message },
|
if parsed.deny {
|
||||||
|
HookCommandOutcome::Deny { parsed }
|
||||||
|
} else {
|
||||||
|
HookCommandOutcome::Allow { parsed }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Some(2) => HookCommandOutcome::Deny {
|
||||||
|
parsed: parsed.with_fallback_message(format!(
|
||||||
|
"{} hook denied tool `{tool_name}`",
|
||||||
|
event.as_str()
|
||||||
|
)),
|
||||||
|
},
|
||||||
Some(code) => HookCommandOutcome::Warn {
|
Some(code) => HookCommandOutcome::Warn {
|
||||||
message: format_hook_warning(
|
message: format_hook_warning(
|
||||||
command,
|
command,
|
||||||
code,
|
code,
|
||||||
message.as_deref(),
|
parsed.primary_message(),
|
||||||
stderr.as_str(),
|
stderr.as_str(),
|
||||||
),
|
),
|
||||||
},
|
},
|
||||||
@@ -195,6 +461,12 @@ impl HookRunner {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Ok(CommandExecution::Cancelled) => HookCommandOutcome::Cancelled {
|
||||||
|
message: format!(
|
||||||
|
"{} hook `{command}` cancelled while handling `{tool_name}`",
|
||||||
|
event.as_str()
|
||||||
|
),
|
||||||
|
},
|
||||||
Err(error) => HookCommandOutcome::Warn {
|
Err(error) => HookCommandOutcome::Warn {
|
||||||
message: format!(
|
message: format!(
|
||||||
"{} hook `{command}` failed to start for `{tool_name}`: {error}",
|
"{} hook `{command}` failed to start for `{tool_name}`: {error}",
|
||||||
@@ -206,12 +478,131 @@ impl HookRunner {
|
|||||||
}
|
}
|
||||||
|
|
||||||
enum HookCommandOutcome {
|
enum HookCommandOutcome {
|
||||||
Allow { message: Option<String> },
|
Allow { parsed: ParsedHookOutput },
|
||||||
Deny { message: Option<String> },
|
Deny { parsed: ParsedHookOutput },
|
||||||
Warn { message: String },
|
Warn { message: String },
|
||||||
|
Cancelled { message: String },
|
||||||
}
|
}
|
||||||
|
|
||||||
fn parse_tool_input(tool_input: &str) -> serde_json::Value {
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
struct ParsedHookOutput {
|
||||||
|
messages: Vec<String>,
|
||||||
|
deny: bool,
|
||||||
|
permission_override: Option<PermissionOverride>,
|
||||||
|
permission_reason: Option<String>,
|
||||||
|
updated_input: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ParsedHookOutput {
|
||||||
|
fn with_fallback_message(mut self, fallback: String) -> Self {
|
||||||
|
if self.messages.is_empty() {
|
||||||
|
self.messages.push(fallback);
|
||||||
|
}
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn primary_message(&self) -> Option<&str> {
|
||||||
|
self.messages.first().map(String::as_str)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn merge_parsed_hook_output(target: &mut HookRunResult, parsed: ParsedHookOutput) {
|
||||||
|
target.messages.extend(parsed.messages);
|
||||||
|
if parsed.permission_override.is_some() {
|
||||||
|
target.permission_override = parsed.permission_override;
|
||||||
|
}
|
||||||
|
if parsed.permission_reason.is_some() {
|
||||||
|
target.permission_reason = parsed.permission_reason;
|
||||||
|
}
|
||||||
|
if parsed.updated_input.is_some() {
|
||||||
|
target.updated_input = parsed.updated_input;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_hook_output(stdout: &str) -> ParsedHookOutput {
|
||||||
|
if stdout.is_empty() {
|
||||||
|
return ParsedHookOutput::default();
|
||||||
|
}
|
||||||
|
|
||||||
|
let Ok(Value::Object(root)) = serde_json::from_str::<Value>(stdout) else {
|
||||||
|
return ParsedHookOutput {
|
||||||
|
messages: vec![stdout.to_string()],
|
||||||
|
..ParsedHookOutput::default()
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut parsed = ParsedHookOutput::default();
|
||||||
|
|
||||||
|
if let Some(message) = root.get("systemMessage").and_then(Value::as_str) {
|
||||||
|
parsed.messages.push(message.to_string());
|
||||||
|
}
|
||||||
|
if let Some(message) = root.get("reason").and_then(Value::as_str) {
|
||||||
|
parsed.messages.push(message.to_string());
|
||||||
|
}
|
||||||
|
if root.get("continue").and_then(Value::as_bool) == Some(false)
|
||||||
|
|| root.get("decision").and_then(Value::as_str) == Some("block")
|
||||||
|
{
|
||||||
|
parsed.deny = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(Value::Object(specific)) = root.get("hookSpecificOutput") {
|
||||||
|
if let Some(Value::String(additional_context)) = specific.get("additionalContext") {
|
||||||
|
parsed.messages.push(additional_context.clone());
|
||||||
|
}
|
||||||
|
if let Some(decision) = specific.get("permissionDecision").and_then(Value::as_str) {
|
||||||
|
parsed.permission_override = match decision {
|
||||||
|
"allow" => Some(PermissionOverride::Allow),
|
||||||
|
"deny" => Some(PermissionOverride::Deny),
|
||||||
|
"ask" => Some(PermissionOverride::Ask),
|
||||||
|
_ => None,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if let Some(reason) = specific
|
||||||
|
.get("permissionDecisionReason")
|
||||||
|
.and_then(Value::as_str)
|
||||||
|
{
|
||||||
|
parsed.permission_reason = Some(reason.to_string());
|
||||||
|
}
|
||||||
|
if let Some(updated_input) = specific.get("updatedInput") {
|
||||||
|
parsed.updated_input = serde_json::to_string(updated_input).ok();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if parsed.messages.is_empty() {
|
||||||
|
parsed.messages.push(stdout.to_string());
|
||||||
|
}
|
||||||
|
|
||||||
|
parsed
|
||||||
|
}
|
||||||
|
|
||||||
|
fn hook_payload(
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: Option<&str>,
|
||||||
|
is_error: bool,
|
||||||
|
) -> Value {
|
||||||
|
match event {
|
||||||
|
HookEvent::PostToolUseFailure => json!({
|
||||||
|
"hook_event_name": event.as_str(),
|
||||||
|
"tool_name": tool_name,
|
||||||
|
"tool_input": parse_tool_input(tool_input),
|
||||||
|
"tool_input_json": tool_input,
|
||||||
|
"tool_error": tool_output,
|
||||||
|
"tool_result_is_error": true,
|
||||||
|
}),
|
||||||
|
_ => json!({
|
||||||
|
"hook_event_name": event.as_str(),
|
||||||
|
"tool_name": tool_name,
|
||||||
|
"tool_input": parse_tool_input(tool_input),
|
||||||
|
"tool_input_json": tool_input,
|
||||||
|
"tool_output": tool_output,
|
||||||
|
"tool_result_is_error": is_error,
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_tool_input(tool_input: &str) -> Value {
|
||||||
serde_json::from_str(tool_input).unwrap_or_else(|_| json!({ "raw": tool_input }))
|
serde_json::from_str(tool_input).unwrap_or_else(|_| json!({ "raw": tool_input }))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -255,17 +646,17 @@ impl CommandWithStdin {
|
|||||||
Self { command }
|
Self { command }
|
||||||
}
|
}
|
||||||
|
|
||||||
fn stdin(&mut self, cfg: std::process::Stdio) -> &mut Self {
|
fn stdin(&mut self, cfg: Stdio) -> &mut Self {
|
||||||
self.command.stdin(cfg);
|
self.command.stdin(cfg);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
fn stdout(&mut self, cfg: std::process::Stdio) -> &mut Self {
|
fn stdout(&mut self, cfg: Stdio) -> &mut Self {
|
||||||
self.command.stdout(cfg);
|
self.command.stdout(cfg);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
fn stderr(&mut self, cfg: std::process::Stdio) -> &mut Self {
|
fn stderr(&mut self, cfg: Stdio) -> &mut Self {
|
||||||
self.command.stderr(cfg);
|
self.command.stderr(cfg);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
@@ -279,26 +670,77 @@ impl CommandWithStdin {
|
|||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
fn output_with_stdin(&mut self, stdin: &[u8]) -> std::io::Result<std::process::Output> {
|
fn output_with_stdin(
|
||||||
let mut child = self.command.spawn()?;
|
&mut self,
|
||||||
if let Some(mut child_stdin) = child.stdin.take() {
|
stdin: &[u8],
|
||||||
use std::io::Write;
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
child_stdin.write_all(stdin)?;
|
) -> std::io::Result<CommandExecution> {
|
||||||
}
|
let runtime = Builder::new_current_thread().enable_all().build()?;
|
||||||
child.wait_with_output()
|
let mut command =
|
||||||
|
TokioCommand::from(std::mem::replace(&mut self.command, Command::new("true")));
|
||||||
|
let stdin = stdin.to_vec();
|
||||||
|
let abort_signal = abort_signal.cloned();
|
||||||
|
runtime.block_on(async move {
|
||||||
|
let mut child = command.spawn()?;
|
||||||
|
if let Some(mut child_stdin) = child.stdin.take() {
|
||||||
|
child_stdin.write_all(&stdin).await?;
|
||||||
|
}
|
||||||
|
|
||||||
|
loop {
|
||||||
|
if abort_signal
|
||||||
|
.as_ref()
|
||||||
|
.is_some_and(HookAbortSignal::is_aborted)
|
||||||
|
{
|
||||||
|
let _ = child.start_kill();
|
||||||
|
let _ = child.wait().await;
|
||||||
|
return Ok(CommandExecution::Cancelled);
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(status) = child.try_wait()? {
|
||||||
|
let output = child.wait_with_output().await?;
|
||||||
|
debug_assert_eq!(output.status.code(), status.code());
|
||||||
|
return Ok(CommandExecution::Finished(output));
|
||||||
|
}
|
||||||
|
|
||||||
|
sleep(Duration::from_millis(20)).await;
|
||||||
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
enum CommandExecution {
|
||||||
|
Finished(std::process::Output),
|
||||||
|
Cancelled,
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::{HookRunResult, HookRunner};
|
use std::thread;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use super::{
|
||||||
|
HookAbortSignal, HookEvent, HookProgressEvent, HookProgressReporter, HookRunResult,
|
||||||
|
HookRunner,
|
||||||
|
};
|
||||||
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
||||||
|
use crate::permissions::PermissionOverride;
|
||||||
|
|
||||||
|
struct RecordingReporter {
|
||||||
|
events: Vec<HookProgressEvent>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookProgressReporter for RecordingReporter {
|
||||||
|
fn on_event(&mut self, event: &HookProgressEvent) {
|
||||||
|
self.events.push(event.clone());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn allows_exit_code_zero_and_captures_stdout() {
|
fn allows_exit_code_zero_and_captures_stdout() {
|
||||||
let runner = HookRunner::new(RuntimeHookConfig::new(
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
vec![shell_snippet("printf 'pre ok'")],
|
vec![shell_snippet("printf 'pre ok'")],
|
||||||
Vec::new(),
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
));
|
));
|
||||||
|
|
||||||
let result = runner.run_pre_tool_use("Read", r#"{"path":"README.md"}"#);
|
let result = runner.run_pre_tool_use("Read", r#"{"path":"README.md"}"#);
|
||||||
@@ -311,6 +753,7 @@ mod tests {
|
|||||||
let runner = HookRunner::new(RuntimeHookConfig::new(
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
vec![shell_snippet("printf 'blocked by hook'; exit 2")],
|
vec![shell_snippet("printf 'blocked by hook'; exit 2")],
|
||||||
Vec::new(),
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
));
|
));
|
||||||
|
|
||||||
let result = runner.run_pre_tool_use("Bash", r#"{"command":"pwd"}"#);
|
let result = runner.run_pre_tool_use("Bash", r#"{"command":"pwd"}"#);
|
||||||
@@ -325,6 +768,7 @@ mod tests {
|
|||||||
RuntimeHookConfig::new(
|
RuntimeHookConfig::new(
|
||||||
vec![shell_snippet("printf 'warning hook'; exit 1")],
|
vec![shell_snippet("printf 'warning hook'; exit 1")],
|
||||||
Vec::new(),
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
),
|
),
|
||||||
));
|
));
|
||||||
|
|
||||||
@@ -337,6 +781,82 @@ mod tests {
|
|||||||
.any(|message| message.contains("allowing tool execution to continue")));
|
.any(|message| message.contains("allowing tool execution to continue")));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parses_pre_hook_permission_override_and_updated_input() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet(
|
||||||
|
r#"printf '%s' '{"systemMessage":"updated","hookSpecificOutput":{"permissionDecision":"allow","permissionDecisionReason":"hook ok","updatedInput":{"command":"git status"}}}'"#,
|
||||||
|
)],
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
));
|
||||||
|
|
||||||
|
let result = runner.run_pre_tool_use("bash", r#"{"command":"pwd"}"#);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
result.permission_override(),
|
||||||
|
Some(PermissionOverride::Allow)
|
||||||
|
);
|
||||||
|
assert_eq!(result.permission_reason(), Some("hook ok"));
|
||||||
|
assert_eq!(result.updated_input(), Some(r#"{"command":"git status"}"#));
|
||||||
|
assert!(result.messages().iter().any(|message| message == "updated"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn runs_post_tool_use_failure_hooks() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
vec![shell_snippet("printf 'failure hook ran'")],
|
||||||
|
));
|
||||||
|
|
||||||
|
let result =
|
||||||
|
runner.run_post_tool_use_failure("bash", r#"{"command":"false"}"#, "command failed");
|
||||||
|
|
||||||
|
assert!(!result.is_denied());
|
||||||
|
assert_eq!(result.messages(), &["failure hook ran".to_string()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn abort_signal_cancels_long_running_hook_and_reports_progress() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet("sleep 5")],
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
));
|
||||||
|
let abort_signal = HookAbortSignal::new();
|
||||||
|
let abort_signal_for_thread = abort_signal.clone();
|
||||||
|
let mut reporter = RecordingReporter { events: Vec::new() };
|
||||||
|
|
||||||
|
thread::spawn(move || {
|
||||||
|
thread::sleep(Duration::from_millis(100));
|
||||||
|
abort_signal_for_thread.abort();
|
||||||
|
});
|
||||||
|
|
||||||
|
let result = runner.run_pre_tool_use_with_context(
|
||||||
|
"bash",
|
||||||
|
r#"{"command":"sleep 5"}"#,
|
||||||
|
Some(&abort_signal),
|
||||||
|
Some(&mut reporter),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert!(result.is_cancelled());
|
||||||
|
assert!(reporter.events.iter().any(|event| matches!(
|
||||||
|
event,
|
||||||
|
HookProgressEvent::Started {
|
||||||
|
event: HookEvent::PreToolUse,
|
||||||
|
..
|
||||||
|
}
|
||||||
|
)));
|
||||||
|
assert!(reporter.events.iter().any(|event| matches!(
|
||||||
|
event,
|
||||||
|
HookProgressEvent::Cancelled {
|
||||||
|
event: HookEvent::PreToolUse,
|
||||||
|
..
|
||||||
|
}
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(windows)]
|
#[cfg(windows)]
|
||||||
fn shell_snippet(script: &str) -> String {
|
fn shell_snippet(script: &str) -> String {
|
||||||
script.replace('\'', "\"")
|
script.replace('\'', "\"")
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ pub use config::{
|
|||||||
McpConfigCollection, McpOAuthConfig, McpRemoteServerConfig, McpSdkServerConfig,
|
McpConfigCollection, McpOAuthConfig, McpRemoteServerConfig, McpSdkServerConfig,
|
||||||
McpServerConfig, McpStdioServerConfig, McpTransport, McpWebSocketServerConfig, OAuthConfig,
|
McpServerConfig, McpStdioServerConfig, McpTransport, McpWebSocketServerConfig, OAuthConfig,
|
||||||
ResolvedPermissionMode, RuntimeConfig, RuntimeFeatureConfig, RuntimeHookConfig,
|
ResolvedPermissionMode, RuntimeConfig, RuntimeFeatureConfig, RuntimeHookConfig,
|
||||||
ScopedMcpServerConfig, CLAUDE_CODE_SETTINGS_SCHEMA_NAME,
|
RuntimePermissionRuleConfig, ScopedMcpServerConfig, CLAUDE_CODE_SETTINGS_SCHEMA_NAME,
|
||||||
};
|
};
|
||||||
pub use conversation::{
|
pub use conversation::{
|
||||||
ApiClient, ApiRequest, AssistantEvent, ConversationRuntime, RuntimeError, StaticToolExecutor,
|
ApiClient, ApiRequest, AssistantEvent, ConversationRuntime, RuntimeError, StaticToolExecutor,
|
||||||
@@ -39,7 +39,9 @@ pub use file_ops::{
|
|||||||
GrepSearchInput, GrepSearchOutput, ReadFileOutput, StructuredPatchHunk, TextFilePayload,
|
GrepSearchInput, GrepSearchOutput, ReadFileOutput, StructuredPatchHunk, TextFilePayload,
|
||||||
WriteFileOutput,
|
WriteFileOutput,
|
||||||
};
|
};
|
||||||
pub use hooks::{HookEvent, HookRunResult, HookRunner};
|
pub use hooks::{
|
||||||
|
HookAbortSignal, HookEvent, HookProgressEvent, HookProgressReporter, HookRunResult, HookRunner,
|
||||||
|
};
|
||||||
pub use mcp::{
|
pub use mcp::{
|
||||||
mcp_server_signature, mcp_tool_name, mcp_tool_prefix, normalize_name_for_mcp,
|
mcp_server_signature, mcp_tool_name, mcp_tool_prefix, normalize_name_for_mcp,
|
||||||
scoped_mcp_config_hash, unwrap_ccr_proxy_url,
|
scoped_mcp_config_hash, unwrap_ccr_proxy_url,
|
||||||
@@ -64,8 +66,8 @@ pub use oauth::{
|
|||||||
PkceChallengeMethod, PkceCodePair,
|
PkceChallengeMethod, PkceCodePair,
|
||||||
};
|
};
|
||||||
pub use permissions::{
|
pub use permissions::{
|
||||||
PermissionMode, PermissionOutcome, PermissionPolicy, PermissionPromptDecision,
|
PermissionContext, PermissionMode, PermissionOutcome, PermissionOverride, PermissionPolicy,
|
||||||
PermissionPrompter, PermissionRequest,
|
PermissionPromptDecision, PermissionPrompter, PermissionRequest,
|
||||||
};
|
};
|
||||||
pub use prompt::{
|
pub use prompt::{
|
||||||
load_system_prompt, prepend_bullets, ContextFile, ProjectContext, PromptBuildError,
|
load_system_prompt, prepend_bullets, ContextFile, ProjectContext, PromptBuildError,
|
||||||
|
|||||||
@@ -1,5 +1,9 @@
|
|||||||
use std::collections::BTreeMap;
|
use std::collections::BTreeMap;
|
||||||
|
|
||||||
|
use serde_json::Value;
|
||||||
|
|
||||||
|
use crate::config::RuntimePermissionRuleConfig;
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
|
||||||
pub enum PermissionMode {
|
pub enum PermissionMode {
|
||||||
ReadOnly,
|
ReadOnly,
|
||||||
@@ -22,12 +26,49 @@ impl PermissionMode {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
pub enum PermissionOverride {
|
||||||
|
Allow,
|
||||||
|
Deny,
|
||||||
|
Ask,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
pub struct PermissionContext {
|
||||||
|
override_decision: Option<PermissionOverride>,
|
||||||
|
override_reason: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl PermissionContext {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new(
|
||||||
|
override_decision: Option<PermissionOverride>,
|
||||||
|
override_reason: Option<String>,
|
||||||
|
) -> Self {
|
||||||
|
Self {
|
||||||
|
override_decision,
|
||||||
|
override_reason,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn override_decision(&self) -> Option<PermissionOverride> {
|
||||||
|
self.override_decision
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn override_reason(&self) -> Option<&str> {
|
||||||
|
self.override_reason.as_deref()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
pub struct PermissionRequest {
|
pub struct PermissionRequest {
|
||||||
pub tool_name: String,
|
pub tool_name: String,
|
||||||
pub input: String,
|
pub input: String,
|
||||||
pub current_mode: PermissionMode,
|
pub current_mode: PermissionMode,
|
||||||
pub required_mode: PermissionMode,
|
pub required_mode: PermissionMode,
|
||||||
|
pub reason: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
@@ -50,6 +91,9 @@ pub enum PermissionOutcome {
|
|||||||
pub struct PermissionPolicy {
|
pub struct PermissionPolicy {
|
||||||
active_mode: PermissionMode,
|
active_mode: PermissionMode,
|
||||||
tool_requirements: BTreeMap<String, PermissionMode>,
|
tool_requirements: BTreeMap<String, PermissionMode>,
|
||||||
|
allow_rules: Vec<PermissionRule>,
|
||||||
|
deny_rules: Vec<PermissionRule>,
|
||||||
|
ask_rules: Vec<PermissionRule>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PermissionPolicy {
|
impl PermissionPolicy {
|
||||||
@@ -58,6 +102,9 @@ impl PermissionPolicy {
|
|||||||
Self {
|
Self {
|
||||||
active_mode,
|
active_mode,
|
||||||
tool_requirements: BTreeMap::new(),
|
tool_requirements: BTreeMap::new(),
|
||||||
|
allow_rules: Vec::new(),
|
||||||
|
deny_rules: Vec::new(),
|
||||||
|
ask_rules: Vec::new(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -72,6 +119,26 @@ impl PermissionPolicy {
|
|||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn with_permission_rules(mut self, config: &RuntimePermissionRuleConfig) -> Self {
|
||||||
|
self.allow_rules = config
|
||||||
|
.allow()
|
||||||
|
.iter()
|
||||||
|
.map(|rule| PermissionRule::parse(rule))
|
||||||
|
.collect();
|
||||||
|
self.deny_rules = config
|
||||||
|
.deny()
|
||||||
|
.iter()
|
||||||
|
.map(|rule| PermissionRule::parse(rule))
|
||||||
|
.collect();
|
||||||
|
self.ask_rules = config
|
||||||
|
.ask()
|
||||||
|
.iter()
|
||||||
|
.map(|rule| PermissionRule::parse(rule))
|
||||||
|
.collect();
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn active_mode(&self) -> PermissionMode {
|
pub fn active_mode(&self) -> PermissionMode {
|
||||||
self.active_mode
|
self.active_mode
|
||||||
@@ -90,38 +157,121 @@ impl PermissionPolicy {
|
|||||||
&self,
|
&self,
|
||||||
tool_name: &str,
|
tool_name: &str,
|
||||||
input: &str,
|
input: &str,
|
||||||
mut prompter: Option<&mut dyn PermissionPrompter>,
|
prompter: Option<&mut dyn PermissionPrompter>,
|
||||||
) -> PermissionOutcome {
|
) -> PermissionOutcome {
|
||||||
let current_mode = self.active_mode();
|
self.authorize_with_context(tool_name, input, &PermissionContext::default(), prompter)
|
||||||
let required_mode = self.required_mode_for(tool_name);
|
}
|
||||||
if current_mode == PermissionMode::Allow || current_mode >= required_mode {
|
|
||||||
return PermissionOutcome::Allow;
|
#[must_use]
|
||||||
|
#[allow(clippy::too_many_lines)]
|
||||||
|
pub fn authorize_with_context(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
input: &str,
|
||||||
|
context: &PermissionContext,
|
||||||
|
prompter: Option<&mut dyn PermissionPrompter>,
|
||||||
|
) -> PermissionOutcome {
|
||||||
|
if let Some(rule) = Self::find_matching_rule(&self.deny_rules, tool_name, input) {
|
||||||
|
return PermissionOutcome::Deny {
|
||||||
|
reason: format!(
|
||||||
|
"Permission to use {tool_name} has been denied by rule '{}'",
|
||||||
|
rule.raw
|
||||||
|
),
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
let request = PermissionRequest {
|
let current_mode = self.active_mode();
|
||||||
tool_name: tool_name.to_string(),
|
let required_mode = self.required_mode_for(tool_name);
|
||||||
input: input.to_string(),
|
let ask_rule = Self::find_matching_rule(&self.ask_rules, tool_name, input);
|
||||||
current_mode,
|
let allow_rule = Self::find_matching_rule(&self.allow_rules, tool_name, input);
|
||||||
required_mode,
|
|
||||||
};
|
match context.override_decision() {
|
||||||
|
Some(PermissionOverride::Deny) => {
|
||||||
|
return PermissionOutcome::Deny {
|
||||||
|
reason: context.override_reason().map_or_else(
|
||||||
|
|| format!("tool '{tool_name}' denied by hook"),
|
||||||
|
ToOwned::to_owned,
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
Some(PermissionOverride::Ask) => {
|
||||||
|
let reason = context.override_reason().map_or_else(
|
||||||
|
|| format!("tool '{tool_name}' requires approval due to hook guidance"),
|
||||||
|
ToOwned::to_owned,
|
||||||
|
);
|
||||||
|
return Self::prompt_or_deny(
|
||||||
|
tool_name,
|
||||||
|
input,
|
||||||
|
current_mode,
|
||||||
|
required_mode,
|
||||||
|
Some(reason),
|
||||||
|
prompter,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
Some(PermissionOverride::Allow) => {
|
||||||
|
if let Some(rule) = ask_rule {
|
||||||
|
let reason = format!(
|
||||||
|
"tool '{tool_name}' requires approval due to ask rule '{}'",
|
||||||
|
rule.raw
|
||||||
|
);
|
||||||
|
return Self::prompt_or_deny(
|
||||||
|
tool_name,
|
||||||
|
input,
|
||||||
|
current_mode,
|
||||||
|
required_mode,
|
||||||
|
Some(reason),
|
||||||
|
prompter,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if allow_rule.is_some()
|
||||||
|
|| current_mode == PermissionMode::Allow
|
||||||
|
|| current_mode >= required_mode
|
||||||
|
{
|
||||||
|
return PermissionOutcome::Allow;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => {}
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(rule) = ask_rule {
|
||||||
|
let reason = format!(
|
||||||
|
"tool '{tool_name}' requires approval due to ask rule '{}'",
|
||||||
|
rule.raw
|
||||||
|
);
|
||||||
|
return Self::prompt_or_deny(
|
||||||
|
tool_name,
|
||||||
|
input,
|
||||||
|
current_mode,
|
||||||
|
required_mode,
|
||||||
|
Some(reason),
|
||||||
|
prompter,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if allow_rule.is_some()
|
||||||
|
|| current_mode == PermissionMode::Allow
|
||||||
|
|| current_mode >= required_mode
|
||||||
|
{
|
||||||
|
return PermissionOutcome::Allow;
|
||||||
|
}
|
||||||
|
|
||||||
if current_mode == PermissionMode::Prompt
|
if current_mode == PermissionMode::Prompt
|
||||||
|| (current_mode == PermissionMode::WorkspaceWrite
|
|| (current_mode == PermissionMode::WorkspaceWrite
|
||||||
&& required_mode == PermissionMode::DangerFullAccess)
|
&& required_mode == PermissionMode::DangerFullAccess)
|
||||||
{
|
{
|
||||||
return match prompter.as_mut() {
|
let reason = Some(format!(
|
||||||
Some(prompter) => match prompter.decide(&request) {
|
"tool '{tool_name}' requires approval to escalate from {} to {}",
|
||||||
PermissionPromptDecision::Allow => PermissionOutcome::Allow,
|
current_mode.as_str(),
|
||||||
PermissionPromptDecision::Deny { reason } => PermissionOutcome::Deny { reason },
|
required_mode.as_str()
|
||||||
},
|
));
|
||||||
None => PermissionOutcome::Deny {
|
return Self::prompt_or_deny(
|
||||||
reason: format!(
|
tool_name,
|
||||||
"tool '{tool_name}' requires approval to escalate from {} to {}",
|
input,
|
||||||
current_mode.as_str(),
|
current_mode,
|
||||||
required_mode.as_str()
|
required_mode,
|
||||||
),
|
reason,
|
||||||
},
|
prompter,
|
||||||
};
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
PermissionOutcome::Deny {
|
PermissionOutcome::Deny {
|
||||||
@@ -132,14 +282,191 @@ impl PermissionPolicy {
|
|||||||
),
|
),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn prompt_or_deny(
|
||||||
|
tool_name: &str,
|
||||||
|
input: &str,
|
||||||
|
current_mode: PermissionMode,
|
||||||
|
required_mode: PermissionMode,
|
||||||
|
reason: Option<String>,
|
||||||
|
mut prompter: Option<&mut dyn PermissionPrompter>,
|
||||||
|
) -> PermissionOutcome {
|
||||||
|
let request = PermissionRequest {
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
input: input.to_string(),
|
||||||
|
current_mode,
|
||||||
|
required_mode,
|
||||||
|
reason: reason.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
match prompter.as_mut() {
|
||||||
|
Some(prompter) => match prompter.decide(&request) {
|
||||||
|
PermissionPromptDecision::Allow => PermissionOutcome::Allow,
|
||||||
|
PermissionPromptDecision::Deny { reason } => PermissionOutcome::Deny { reason },
|
||||||
|
},
|
||||||
|
None => PermissionOutcome::Deny {
|
||||||
|
reason: reason.unwrap_or_else(|| {
|
||||||
|
format!(
|
||||||
|
"tool '{tool_name}' requires approval to run while mode is {}",
|
||||||
|
current_mode.as_str()
|
||||||
|
)
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_matching_rule<'a>(
|
||||||
|
rules: &'a [PermissionRule],
|
||||||
|
tool_name: &str,
|
||||||
|
input: &str,
|
||||||
|
) -> Option<&'a PermissionRule> {
|
||||||
|
rules.iter().find(|rule| rule.matches(tool_name, input))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
struct PermissionRule {
|
||||||
|
raw: String,
|
||||||
|
tool_name: String,
|
||||||
|
matcher: PermissionRuleMatcher,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
enum PermissionRuleMatcher {
|
||||||
|
Any,
|
||||||
|
Exact(String),
|
||||||
|
Prefix(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl PermissionRule {
|
||||||
|
fn parse(raw: &str) -> Self {
|
||||||
|
let trimmed = raw.trim();
|
||||||
|
let open = find_first_unescaped(trimmed, '(');
|
||||||
|
let close = find_last_unescaped(trimmed, ')');
|
||||||
|
|
||||||
|
if let (Some(open), Some(close)) = (open, close) {
|
||||||
|
if close == trimmed.len() - 1 && open < close {
|
||||||
|
let tool_name = trimmed[..open].trim();
|
||||||
|
let content = &trimmed[open + 1..close];
|
||||||
|
if !tool_name.is_empty() {
|
||||||
|
let matcher = parse_rule_matcher(content);
|
||||||
|
return Self {
|
||||||
|
raw: trimmed.to_string(),
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
matcher,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Self {
|
||||||
|
raw: trimmed.to_string(),
|
||||||
|
tool_name: trimmed.to_string(),
|
||||||
|
matcher: PermissionRuleMatcher::Any,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn matches(&self, tool_name: &str, input: &str) -> bool {
|
||||||
|
if self.tool_name != tool_name {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
match &self.matcher {
|
||||||
|
PermissionRuleMatcher::Any => true,
|
||||||
|
PermissionRuleMatcher::Exact(expected) => {
|
||||||
|
extract_permission_subject(input).is_some_and(|candidate| candidate == *expected)
|
||||||
|
}
|
||||||
|
PermissionRuleMatcher::Prefix(prefix) => extract_permission_subject(input)
|
||||||
|
.is_some_and(|candidate| candidate.starts_with(prefix)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_rule_matcher(content: &str) -> PermissionRuleMatcher {
|
||||||
|
let unescaped = unescape_rule_content(content.trim());
|
||||||
|
if unescaped.is_empty() || unescaped == "*" {
|
||||||
|
PermissionRuleMatcher::Any
|
||||||
|
} else if let Some(prefix) = unescaped.strip_suffix(":*") {
|
||||||
|
PermissionRuleMatcher::Prefix(prefix.to_string())
|
||||||
|
} else {
|
||||||
|
PermissionRuleMatcher::Exact(unescaped)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn unescape_rule_content(content: &str) -> String {
|
||||||
|
content
|
||||||
|
.replace(r"\(", "(")
|
||||||
|
.replace(r"\)", ")")
|
||||||
|
.replace(r"\\", r"\")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_first_unescaped(value: &str, needle: char) -> Option<usize> {
|
||||||
|
let mut escaped = false;
|
||||||
|
for (idx, ch) in value.char_indices() {
|
||||||
|
if ch == '\\' {
|
||||||
|
escaped = !escaped;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if ch == needle && !escaped {
|
||||||
|
return Some(idx);
|
||||||
|
}
|
||||||
|
escaped = false;
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_last_unescaped(value: &str, needle: char) -> Option<usize> {
|
||||||
|
let chars = value.char_indices().collect::<Vec<_>>();
|
||||||
|
for (pos, (idx, ch)) in chars.iter().enumerate().rev() {
|
||||||
|
if *ch != needle {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
let mut backslashes = 0;
|
||||||
|
for (_, prev) in chars[..pos].iter().rev() {
|
||||||
|
if *prev == '\\' {
|
||||||
|
backslashes += 1;
|
||||||
|
} else {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if backslashes % 2 == 0 {
|
||||||
|
return Some(*idx);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
|
||||||
|
fn extract_permission_subject(input: &str) -> Option<String> {
|
||||||
|
let parsed = serde_json::from_str::<Value>(input).ok();
|
||||||
|
if let Some(Value::Object(object)) = parsed {
|
||||||
|
for key in [
|
||||||
|
"command",
|
||||||
|
"path",
|
||||||
|
"file_path",
|
||||||
|
"filePath",
|
||||||
|
"notebook_path",
|
||||||
|
"notebookPath",
|
||||||
|
"url",
|
||||||
|
"pattern",
|
||||||
|
"code",
|
||||||
|
"message",
|
||||||
|
] {
|
||||||
|
if let Some(value) = object.get(key).and_then(Value::as_str) {
|
||||||
|
return Some(value.to_string());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
(!input.trim().is_empty()).then(|| input.to_string())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::{
|
use super::{
|
||||||
PermissionMode, PermissionOutcome, PermissionPolicy, PermissionPromptDecision,
|
PermissionContext, PermissionMode, PermissionOutcome, PermissionOverride, PermissionPolicy,
|
||||||
PermissionPrompter, PermissionRequest,
|
PermissionPromptDecision, PermissionPrompter, PermissionRequest,
|
||||||
};
|
};
|
||||||
|
use crate::config::RuntimePermissionRuleConfig;
|
||||||
|
|
||||||
struct RecordingPrompter {
|
struct RecordingPrompter {
|
||||||
seen: Vec<PermissionRequest>,
|
seen: Vec<PermissionRequest>,
|
||||||
@@ -229,4 +556,120 @@ mod tests {
|
|||||||
PermissionOutcome::Deny { reason } if reason == "not now"
|
PermissionOutcome::Deny { reason } if reason == "not now"
|
||||||
));
|
));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn applies_rule_based_denials_and_allows() {
|
||||||
|
let rules = RuntimePermissionRuleConfig::new(
|
||||||
|
vec!["bash(git:*)".to_string()],
|
||||||
|
vec!["bash(rm -rf:*)".to_string()],
|
||||||
|
Vec::new(),
|
||||||
|
);
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::ReadOnly)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess)
|
||||||
|
.with_permission_rules(&rules);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
policy.authorize("bash", r#"{"command":"git status"}"#, None),
|
||||||
|
PermissionOutcome::Allow
|
||||||
|
);
|
||||||
|
assert!(matches!(
|
||||||
|
policy.authorize("bash", r#"{"command":"rm -rf /tmp/x"}"#, None),
|
||||||
|
PermissionOutcome::Deny { reason } if reason.contains("denied by rule")
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ask_rules_force_prompt_even_when_mode_allows() {
|
||||||
|
let rules = RuntimePermissionRuleConfig::new(
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
vec!["bash(git:*)".to_string()],
|
||||||
|
);
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::DangerFullAccess)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess)
|
||||||
|
.with_permission_rules(&rules);
|
||||||
|
let mut prompter = RecordingPrompter {
|
||||||
|
seen: Vec::new(),
|
||||||
|
allow: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
let outcome = policy.authorize("bash", r#"{"command":"git status"}"#, Some(&mut prompter));
|
||||||
|
|
||||||
|
assert_eq!(outcome, PermissionOutcome::Allow);
|
||||||
|
assert_eq!(prompter.seen.len(), 1);
|
||||||
|
assert!(prompter.seen[0]
|
||||||
|
.reason
|
||||||
|
.as_deref()
|
||||||
|
.is_some_and(|reason| reason.contains("ask rule")));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn hook_allow_still_respects_ask_rules() {
|
||||||
|
let rules = RuntimePermissionRuleConfig::new(
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
vec!["bash(git:*)".to_string()],
|
||||||
|
);
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::ReadOnly)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess)
|
||||||
|
.with_permission_rules(&rules);
|
||||||
|
let context = PermissionContext::new(
|
||||||
|
Some(PermissionOverride::Allow),
|
||||||
|
Some("hook approved".to_string()),
|
||||||
|
);
|
||||||
|
let mut prompter = RecordingPrompter {
|
||||||
|
seen: Vec::new(),
|
||||||
|
allow: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
let outcome = policy.authorize_with_context(
|
||||||
|
"bash",
|
||||||
|
r#"{"command":"git status"}"#,
|
||||||
|
&context,
|
||||||
|
Some(&mut prompter),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_eq!(outcome, PermissionOutcome::Allow);
|
||||||
|
assert_eq!(prompter.seen.len(), 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn hook_deny_short_circuits_permission_flow() {
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::DangerFullAccess)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess);
|
||||||
|
let context = PermissionContext::new(
|
||||||
|
Some(PermissionOverride::Deny),
|
||||||
|
Some("blocked by hook".to_string()),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
policy.authorize_with_context("bash", "{}", &context, None),
|
||||||
|
PermissionOutcome::Deny {
|
||||||
|
reason: "blocked by hook".to_string(),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn hook_ask_forces_prompt() {
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::DangerFullAccess)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess);
|
||||||
|
let context = PermissionContext::new(
|
||||||
|
Some(PermissionOverride::Ask),
|
||||||
|
Some("hook requested confirmation".to_string()),
|
||||||
|
);
|
||||||
|
let mut prompter = RecordingPrompter {
|
||||||
|
seen: Vec::new(),
|
||||||
|
allow: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
let outcome = policy.authorize_with_context("bash", "{}", &context, Some(&mut prompter));
|
||||||
|
|
||||||
|
assert_eq!(outcome, PermissionOutcome::Allow);
|
||||||
|
assert_eq!(prompter.seen.len(), 1);
|
||||||
|
assert_eq!(
|
||||||
|
prompter.seen[0].reason.as_deref(),
|
||||||
|
Some("hook requested confirmation")
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1922,13 +1922,14 @@ fn build_runtime(
|
|||||||
permission_mode: PermissionMode,
|
permission_mode: PermissionMode,
|
||||||
) -> Result<ConversationRuntime<AnthropicRuntimeClient, CliToolExecutor>, Box<dyn std::error::Error>>
|
) -> Result<ConversationRuntime<AnthropicRuntimeClient, CliToolExecutor>, Box<dyn std::error::Error>>
|
||||||
{
|
{
|
||||||
|
let feature_config = build_runtime_feature_config()?;
|
||||||
Ok(ConversationRuntime::new_with_features(
|
Ok(ConversationRuntime::new_with_features(
|
||||||
session,
|
session,
|
||||||
AnthropicRuntimeClient::new(model, enable_tools, emit_output, allowed_tools.clone())?,
|
AnthropicRuntimeClient::new(model, enable_tools, emit_output, allowed_tools.clone())?,
|
||||||
CliToolExecutor::new(allowed_tools, emit_output),
|
CliToolExecutor::new(allowed_tools, emit_output),
|
||||||
permission_policy(permission_mode),
|
permission_policy(permission_mode, &feature_config),
|
||||||
system_prompt,
|
system_prompt,
|
||||||
build_runtime_feature_config()?,
|
&feature_config,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2673,12 +2674,14 @@ impl ToolExecutor for CliToolExecutor {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn permission_policy(mode: PermissionMode) -> PermissionPolicy {
|
fn permission_policy(
|
||||||
tool_permission_specs()
|
mode: PermissionMode,
|
||||||
.into_iter()
|
feature_config: &runtime::RuntimeFeatureConfig,
|
||||||
.fold(PermissionPolicy::new(mode), |policy, spec| {
|
) -> PermissionPolicy {
|
||||||
policy.with_tool_requirement(spec.name, spec.required_permission)
|
tool_permission_specs().into_iter().fold(
|
||||||
})
|
PermissionPolicy::new(mode).with_permission_rules(feature_config.permission_rules()),
|
||||||
|
|policy, spec| policy.with_tool_requirement(spec.name, spec.required_permission),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn tool_permission_specs() -> Vec<ToolSpec> {
|
fn tool_permission_specs() -> Vec<ToolSpec> {
|
||||||
|
|||||||
Reference in New Issue
Block a user