crabmate 0.4.0

Rust AI agent: OpenAI-compatible chat/completions, function calling, HTTP serve, ops CLI
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
/// `sync_default_tool_sandbox_mode = docker` 时,在宿主完成审批/白名单后把本类工具交给容器内 `tool-runner-internal`。
async fn dispatch_non_sync_tool_to_docker(
    env: &ToolExecEnv<'_>,
    effective_working_dir: &Path,
    workspace_is_set: bool,
    kind: &str,
    args: &str,
    runner_cfg_path: Result<PathBuf, String>,
) -> Option<(String, Option<serde_json::Value>)> {
    if env.cfg.sync_tool_sandbox.sync_default_tool_sandbox_mode
        != SyncDefaultToolSandboxMode::Docker
    {
        return None;
    }
    if !workspace_is_set {
        return Some((
            "错误:未设置工作区,无法在 Docker 沙盒中执行该工具(请先设置工作区目录)。"
                .to_string(),
            None,
        ));
    }
    let path = match runner_cfg_path {
        Ok(p) => p,
        Err(e) => return Some((e, None)),
    };
    let inv = crate::cm_internal::tool_sandbox::ToolInvocationLine {
        kind: kind.to_string(),
        tool: None,
        args_json: args.to_string(),
    };
    let out = crate::cm_internal::tool_sandbox::run_tool_in_docker(
        env.sandbox_backend,
        env.cfg.as_ref(),
        effective_working_dir,
        path,
        inv,
    )
    .await;
    Some(match out {
        Ok(s) => (s, None),
        Err(e) => (e, None),
    })
}

struct ParsedRunCommandJson {
    cmd: String,
    command_raw: String,
    cmd_args: Vec<String>,
    script: String,
}

fn parse_run_command_json(args: &str) -> ParsedRunCommandJson {
    let v: serde_json::Value = serde_json::from_str(args).unwrap_or_default();
    let command_raw = v
        .get("command")
        .and_then(|x| x.as_str())
        .unwrap_or("")
        .trim()
        .to_string();
    let cmd = command_raw.to_lowercase();
    let cmd_args: Vec<String> = v
        .get("args")
        .and_then(|x| x.as_array())
        .map(|arr| {
            arr.iter()
                .filter_map(|x| x.as_str().map(str::to_string))
                .collect()
        })
        .unwrap_or_default();
    let script = tools::join_run_command_shell_script(&command_raw, &cmd_args);
    ParsedRunCommandJson {
        cmd,
        command_raw,
        cmd_args,
        script,
    }
}

/// 解析 `run_command` 白名单与交互审批,返回最终生效的 `allowed_commands` 快照(可能与配置不同)。
async fn run_command_resolve_effective_allowlist(
    cfg: &Arc<AgentConfig>,
    effective_working_dir: &Path,
    web_ctx: Option<&WebToolRuntime>,
    cmd: &str,
    command_raw: &str,
    script: &str,
    needs_shell: bool,
) -> Result<Arc<[String]>, (String, Option<serde_json::Value>)> {
    let base_allowed = Arc::clone(&cfg.command_exec.allowed_commands);
    let mut effective_allowed_arc: Arc<[String]> = base_allowed;
    if !cmd.is_empty()
        && !effective_allowed_arc
            .iter()
            .any(|c| c.eq_ignore_ascii_case(cmd))
    {
        if crate::cm_internal::tools::run_command_invocation_targets_workspace_script_or_executable(
            effective_working_dir,
            command_raw,
        ) {
            effective_allowed_arc = extend_allowed_commands_arc(&effective_allowed_arc, cmd);
        } else {
            let already_allowed = match web_ctx {
                Some(w) => w.persistent_allowlist_shared.lock().await.contains(cmd),
                None => false,
            };
            if already_allowed {
                effective_allowed_arc = extend_allowed_commands_arc(&effective_allowed_arc, cmd);
            } else {
                let allow_handles = crate::cm_internal::tool_approval::SharedAllowlistHandles {
                    web: web_ctx.map(|w| &w.persistent_allowlist_shared),
                };
                let cmd_show = if script.is_empty() {
                    cmd.to_string()
                } else {
                    script.to_string()
                };
                let spec = crate::cm_internal::tool_approval::ApprovalRequestSpec {
                    capability: crate::cm_internal::tool_approval::SensitiveCapability::HostShell,
                    sse_command: cmd.to_string(),
                    sse_args: cmd_show.clone(),
                    allowlist_key: None,
                    cli_title: "run_command 审批",
                    cli_detail: format!("命令不在白名单;审批对象为完整脚本:\n{}", cmd_show.trim()),
                    web_timeline_prefix_zh: "命令审批:",
                };
                let decision_opt = if web_ctx.is_some() {
                    match crate::cm_internal::tool_approval::request_tool_interactive_approval(
                        web_ctx.map(crate::cm_internal::tool_approval::web_tool_runtime_approval_sink),
                        &spec,
                        "tool_registry::run_command approval",
                    )
                    .await
                    {
                        Ok(d) => Some(d),
                        Err(crate::cm_internal::tool_approval::ToolApprovalWebError::ChannelUnavailable) => {
                            return Err(("错误:审批通道不可用,请重试。".to_string(), None));
                        }
                    }
                } else {
                    return Err((
                        format!(
                            "命令 '{}' 不在白名单中,且审批通道不可用。请在请求中提供 approval_session_id 以启用命令审批流程。",
                            cmd
                        ),
                        None,
                    ));
                };
                if let Some(decision) = decision_opt {
                    match decision {
                        CommandApprovalDecision::Deny => {
                            return Err((format!("用户拒绝执行命令:{}", cmd_show.trim()), None));
                        }
                        CommandApprovalDecision::AllowOnce => {
                            effective_allowed_arc = extend_allowlist_with_cmd_and_optional_bash(
                                &cfg.command_exec.allowed_commands,
                                cmd,
                                needs_shell,
                            );
                        }
                        CommandApprovalDecision::AllowAlways => {
                            crate::cm_internal::tool_approval::persist_allowlist_key(&allow_handles, cmd).await;
                            effective_allowed_arc = extend_allowlist_with_cmd_and_optional_bash(
                                &cfg.command_exec.allowed_commands,
                                cmd,
                                needs_shell,
                            );
                        }
                    }
                }
            }
        }
    }
    Ok(effective_allowed_arc)
}

fn extend_allowlist_with_cmd_and_optional_bash(
    base: &Arc<[String]>,
    cmd: &str,
    needs_shell: bool,
) -> Arc<[String]> {
    let with_cmd = extend_allowed_commands_arc(base, cmd);
    if needs_shell {
        extend_allowed_commands_arc(&with_cmd, "bash")
    } else {
        with_cmd
    }
}

/// glob/`$VAR` 且白名单已有 bash:静默包装。Web 上独立 argv 操作符即使已有 bash 也再审(避免 `ls && rm` 绕过单命令白名单)。无审批通道且已有 bash 时仍包装。
fn posix_shell_wrap_needs_interactive_approval(
    command_raw: &str,
    cmd_args: &[String],
    bash_on_allowlist: bool,
    has_web_ctx: bool,
) -> bool {
    let expansion = tools::argv_needs_shell_expansion(command_raw, cmd_args);
    let operators = tools::argv_has_shell_operators(command_raw, cmd_args);
    if !expansion && !operators {
        return false;
    }
    if !bash_on_allowlist {
        return true;
    }
    operators && has_web_ctx
}

/// 白名单无 bash/sh 但 argv 需要 glob/`$VAR` 时,或 Web 上 argv 含 `&&`/`|` 等操作符时:审批完整脚本。
async fn approve_posix_shell_wrap_if_needed(
    command_raw: &str,
    cmd_args: &[String],
    script: &str,
    effective_allowed: Arc<[String]>,
    web_ctx: Option<&WebToolRuntime>,
    sse_command: &str,
) -> Result<Arc<[String]>, String> {
    if !posix_shell_wrap_needs_interactive_approval(
        command_raw,
        cmd_args,
        tools::posix_shell_on_allowlist(effective_allowed.as_ref()).is_some(),
        web_ctx.is_some(),
    ) {
        return Ok(effective_allowed);
    }
    if web_ctx.is_none() {
        return Err(format!(
            "错误:{sse_command} 脚本含 glob / 变量 / 管道等,需经 bash -c 执行,但白名单无 bash/sh 且无审批通道。完整脚本:{}",
            script.trim()
        ));
    }
    let spec = ApprovalRequestSpec {
        capability: SensitiveCapability::HostShell,
        sse_command: sse_command.to_string(),
        sse_args: script.to_string(),
        allowlist_key: None,
        cli_title: if sse_command == "terminal_session" {
            "terminal_session 脚本审批"
        } else {
            "run_command 脚本审批"
        },
        cli_detail: format!(
            "将经 bash -c 执行整行(glob / $VAR 会展开;独立 argv 中的 && / | 等会绕过单命令白名单):\n{}",
            script.trim()
        ),
        web_timeline_prefix_zh: "脚本审批:",
    };
    let allow_handles = SharedAllowlistHandles {
        web: web_ctx.map(|w| &w.persistent_allowlist_shared),
    };
    match tool_approval::interactive_gate_after_whitelist_miss(
        web_ctx.map(tool_approval::web_tool_runtime_approval_sink),
        &spec,
        "tool_registry::run_command shell script approval",
        &allow_handles,
    )
    .await
    {
        Ok(InteractiveGateOutcome::Allowed) => {
            Ok(extend_allowed_commands_arc(&effective_allowed, "bash"))
        }
        Ok(InteractiveGateOutcome::Denied(msg)) => Err(format!("已拒绝:{msg}")),
        Err(ToolApprovalWebError::ChannelUnavailable) => {
            Err("错误:审批通道不可用,请重试。".to_string())
        }
    }
}

async fn resolve_run_command_shell_allowlist(
    cfg: &Arc<AgentConfig>,
    effective_working_dir: &Path,
    web_ctx: Option<&WebToolRuntime>,
    parsed: &ParsedRunCommandJson,
    sse_command: &str,
) -> Result<Arc<[String]>, (String, Option<serde_json::Value>)> {
    let (policy_cmd, policy_args) =
        tools::peel_cd_prefix_argv_for_shell_policy(&parsed.command_raw, &parsed.cmd_args);
    let needs_shell = tools::argv_needs_posix_shell_wrap(&policy_cmd, &policy_args);
    let allowed = run_command_resolve_effective_allowlist(
        cfg,
        effective_working_dir,
        web_ctx,
        parsed.cmd.as_str(),
        parsed.command_raw.as_str(),
        parsed.script.as_str(),
        needs_shell,
    )
    .await?;
    match approve_posix_shell_wrap_if_needed(
        policy_cmd.as_str(),
        &policy_args,
        parsed.script.as_str(),
        allowed,
        web_ctx,
        sse_command,
    )
    .await
    {
        Ok(a) => Ok(a),
        Err(e) => Err((e, None)),
    }
}

/// 工作区外路径 / `..` 预检三态:仅 [`ExternalPathGate::Approved`] 可置 `skip_arg_safety`。
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum ExternalPathGate {
    NotNeeded,
    Approved,
}

/// 配置关或无危险参数 → [`NotNeeded`];Docker / 无通道 / 拒绝 → `Err`;批准 → [`Approved`]。
async fn approve_external_run_command_paths_if_needed(
    cfg: &AgentConfig,
    args_json: &str,
    working_dir: &Path,
    allowed_commands: &[String],
    web_ctx: Option<&WebToolRuntime>,
    sse_command: &str,
) -> Result<ExternalPathGate, String> {
    if !cfg.command_exec.allow_external_path_with_approval {
        return Ok(ExternalPathGate::NotNeeded);
    }
    let unsafe_args = match tools::scan_run_command_unsafe_args_json(
        args_json,
        working_dir,
        allowed_commands,
    ) {
        Ok(v) => v,
        Err(e) => return Err(e.extended_user_message()),
    };
    if unsafe_args.is_empty() {
        return Ok(ExternalPathGate::NotNeeded);
    }
    if cfg.sync_tool_sandbox.sync_default_tool_sandbox_mode == SyncDefaultToolSandboxMode::Docker {
        return Err(format!(
            "错误:Docker 同步工具沙盒模式下不支持工作区外路径参数({})。请改用宿主模式或去掉外部路径 / 路径穿越形 \"..\"",
            unsafe_args.join(", ")
        ));
    }
    if web_ctx.is_none() {
        return Err(format!(
            "错误:{sse_command} 访问工作区外路径({})需要审批通道(当前无可用会话)。",
            unsafe_args.join(", ")
        ));
    }
    let detail_paths = unsafe_args.join(", ");
    let spec = ApprovalRequestSpec {
        capability: SensitiveCapability::WorkspaceExternalPath,
        sse_command: sse_command.to_string(),
        sse_args: format!("external_paths={detail_paths}"),
        allowlist_key: None,
        cli_title: if sse_command == "terminal_session" {
            "terminal_session 工作区外路径审批"
        } else {
            "run_command 工作区外路径审批"
        },
        cli_detail: format!(
            "{sse_command} 请求使用工作区外路径或 \"..\"{detail_paths}\n仅在可信环境下批准。\n(不审计 bash/sh -c 脚本字符串内部路径。)"
        ),
        web_timeline_prefix_zh: "工作区外路径审批:",
    };
    let allow_handles = SharedAllowlistHandles {
        web: web_ctx.map(|w| &w.persistent_allowlist_shared),
    };
    match tool_approval::interactive_gate_after_whitelist_miss(
        web_ctx.map(tool_approval::web_tool_runtime_approval_sink),
        &spec,
        "tool_registry::run_command external path approval",
        &allow_handles,
    )
    .await
    {
        Ok(InteractiveGateOutcome::Allowed) => Ok(ExternalPathGate::Approved),
        Ok(InteractiveGateOutcome::Denied(msg)) => Err(format!("已拒绝:{}", msg)),
        Err(ToolApprovalWebError::ChannelUnavailable) => {
            Err("错误:审批通道不可用,请重试。".to_string())
        }
    }
}

async fn execute_run_command_impl(
    env: &ToolExecEnv<'_>,
    effective_working_dir: &Path,
    workspace_is_set: bool,
    workspace_changed: &mut bool,
    web_ctx: Option<&WebToolRuntime>,
    name: &str,
    args: &str,
) -> (String, Option<serde_json::Value>) {
    let cfg = env.cfg;
    if !workspace_is_set {
        return (web_tool_err_workspace_not_set("执行命令"), None);
    }
    let parsed = parse_run_command_json(args);
    let effective_allowed_arc = match resolve_run_command_shell_allowlist(
        cfg,
        effective_working_dir,
        web_ctx,
        &parsed,
        "run_command",
    )
    .await
    {
        Ok(a) => a,
        Err(e) => return e,
    };

    let gate = match approve_external_run_command_paths_if_needed(
        cfg.as_ref(),
        args,
        effective_working_dir,
        effective_allowed_arc.as_ref(),
        web_ctx,
        "run_command",
    )
    .await
    {
        Ok(g) => g,
        Err(e) => return (e, None),
    };
    let skip_arg_safety = matches!(gate, ExternalPathGate::Approved);

    if let Some((s, inj)) = dispatch_non_sync_tool_to_docker(
        env,
        effective_working_dir,
        workspace_is_set,
        "run_command",
        args,
        crate::cm_internal::tool_sandbox::write_runner_config_json_with_allowed_commands(
            cfg.as_ref(),
            effective_allowed_arc.as_ref(),
        ),
    )
    .await
    {
        if tools::is_compile_command_success(args, &s) {
            *workspace_changed = true;
        }
        return (s, inj);
    }

    let name_in = name.to_string();
    let cmd_timeout = cfg.command_exec.command_timeout_secs;
    let cfg = Arc::clone(cfg);
    let work_dir = effective_working_dir.to_path_buf();
    let args_cloned = args.to_string();
    let allowed_for_run = Arc::clone(&effective_allowed_arc);
    let github_token = crate::cm_tools::github_token::resolve_token_plaintext();
    let handle = tokio::task::spawn_blocking(move || {
        crate::cm_tools::github_token::with_request_github_token_blocking(github_token, || {
            if skip_arg_safety {
                // 审批放行路径:直接带 skip_arg_safety 调用(不经 ToolContext)。
                match tools::run_checked(
                    &args_cloned,
                    cfg.command_exec.command_max_output_len,
                    allowed_for_run.as_ref(),
                    work_dir.as_path(),
                    None,
                    true,
                ) {
                    Ok(s) => s,
                    Err(e) => e.extended_user_message(),
                }
            } else {
                let ctx = tools::tool_context_for(
                    cfg.as_ref(),
                    allowed_for_run.as_ref(),
                    work_dir.as_path(),
                );
                tools::run_tool(&name_in, &args_cloned, &ctx)
            }
        })
    });
    let s = match tokio::time::timeout(Duration::from_secs(cmd_timeout), handle).await {
        Ok(Ok(s)) => s,
        Ok(Err(e)) => {
            error!(
                target: "crabmate",
                "工具执行异常 tool={} error={:?}",
                name,
                e
            );
            format!("工具执行异常:{:?}", e)
        }
        Err(_) => {
            error!(target: "crabmate", "命令执行超时 tool={}", name);
            format!("命令执行超时({} 秒)", cmd_timeout)
        }
    };
    if tools::is_compile_command_success(args, &s) {
        *workspace_changed = true;
    }
    (s, None)
}

/// 并行只读批内 **`http_fetch`**:在 `spawn_blocking` 之前串行完成解析与白名单/审批,避免多请求竞态修改 `persistent_allowlist`。
/// 返回 `(name, args) -> 错误文案`;未出现的键表示已获准或本就匹配前缀。
pub async fn prefetch_http_fetch_parallel_approvals(
    tool_calls: &[ToolCall],
    cfg: &Arc<AgentConfig>,
    web_ctx: Option<&WebToolRuntime>,
) -> HashMap<(String, String), String> {
    let mut failures: HashMap<(String, String), String> = HashMap::new();
    let mut seen: HashSet<(String, String)> = HashSet::new();
    for tc in tool_calls {
        if tc.function.name != "http_fetch" {
            continue;
        }
        let key = (tc.function.name.clone(), tc.function.arguments.clone());
        if !seen.insert(key.clone()) {
            continue;
        }
        let args = tc.function.arguments.as_str();
        let (url, method, _) = match tools::http_fetch::parse_http_fetch_args(args) {
            Ok(x) => x,
            Err(e) => {
                failures.insert(key, format!("错误:{}", e));
                continue;
            }
        };
        let storage_key = tools::http_fetch::storage_key(&url);
        let approval_args = tools::http_fetch::approval_args_display(method, &url);
        let allowed_by_cfg = tools::http_fetch::url_matches_allowed_prefixes(
            &url,
            &cfg.http_fetch.http_fetch_allowed_prefixes,
        );
        let allowed_by_list = match web_ctx {
            Some(w) => w
                .persistent_allowlist_shared
                .lock()
                .await
                .contains(&storage_key),
            None => false,
        };
        if allowed_by_cfg || allowed_by_list {
            continue;
        }
        if web_ctx.is_none() {
            failures.insert(
                key,
                "错误:当前 URL 未匹配配置的 http_fetch_allowed_prefixes,且无法使用审批通道(例如非流式 Web 会话)。"
                    .to_string(),
            );
            continue;
        }
        let spec = crate::cm_internal::tool_approval::ApprovalRequestSpec {
            capability: crate::cm_internal::tool_approval::SensitiveCapability::OutboundHttpRead,
            sse_command: "http_fetch".to_string(),
            sse_args: approval_args.clone(),
            allowlist_key: Some(storage_key.clone()),
            cli_title: "http_fetch 审批",
            cli_detail: format!(
                "URL 未匹配 http_fetch_allowed_prefixes(同源 + 路径前缀边界):\n{}",
                approval_args
            ),
            web_timeline_prefix_zh: "http_fetch 审批:",
        };
        let allow_handles = crate::cm_internal::tool_approval::SharedAllowlistHandles {
            web: web_ctx.map(|w| &w.persistent_allowlist_shared),
        };
        match crate::cm_internal::tool_approval::interactive_gate_after_whitelist_miss(
            web_ctx.map(crate::cm_internal::tool_approval::web_tool_runtime_approval_sink),
            &spec,
            "tool_registry::http_fetch approval parallel prefetch",
            &allow_handles,
        )
        .await
        {
            Ok(crate::cm_internal::tool_approval::InteractiveGateOutcome::Allowed) => {}
            Ok(crate::cm_internal::tool_approval::InteractiveGateOutcome::Denied(msg)) => {
                failures.insert(key, msg);
            }
            Err(crate::cm_internal::tool_approval::ToolApprovalWebError::ChannelUnavailable) => {
                failures.insert(key, "错误:审批通道不可用,请重试。".to_string());
            }
        }
    }
    failures
}