echo_execution 0.1.4

Execution layer for echo-agent framework (sandbox, skills, tools)
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
//! Docker 容器沙箱执行器
//!
//! 通过 Docker CLI 实现容器级隔离:
//! - 自动创建临时容器
//! - cgroups 资源限制
//! - 网络隔离
//! - 挂载控制
//! - 显式 label + 清理路径,避免孤立容器长期残留
//!
//! 需要宿主机安装 Docker Engine。

use super::{
    CommandKind, ExecutionResult, IsolationLevel, ResourceLimits, SENSITIVE_MOUNT_PATHS,
    SandboxCommand, SandboxExecutor, select_image_for_command,
};
use echo_core::error::Result;
use echo_core::error::SandboxError;
use futures::future::BoxFuture;
use serde::{Deserialize, Serialize};
use std::sync::{Mutex, OnceLock};
use std::time::{Duration, Instant};
use tokio::io::AsyncWriteExt;
use tokio::process::Command;

const SANDBOX_LABEL: &str = "echo-sandbox=true";
const DOCKER_CACHE_TTL: Duration = Duration::from_secs(30);

/// Docker 沙箱配置
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DockerConfig {
    /// 默认镜像
    pub default_image: String,
    /// 语言与镜像映射
    pub language_images: std::collections::HashMap<String, String>,
    /// 是否移除已完成的容器
    pub auto_remove: bool,
    /// 是否禁用网络
    pub disable_network: bool,
    /// 内存限制(字节),默认 256MB
    pub memory_limit: Option<u64>,
    /// CPU 配额(纳秒/周期),如 50000 = 50%
    pub cpu_quota: Option<u64>,
    /// 只读根文件系统
    pub read_only_rootfs: bool,
    /// 额外的 docker run 参数
    pub extra_args: Vec<String>,
}

/// 缓存 Docker 可用性检查结果(短 TTL,避免一次失败后永久陈旧)
static DOCKER_CHECK_CACHE: OnceLock<Mutex<Option<(Instant, bool)>>> = OnceLock::new();

/// 危险 Docker 参数,即使配置中有也应当过滤掉
const DANGEROUS_DOCKER_ARGS: &[&str] = &[
    "--privileged",
    "--pid=host",
    "--network=host",
    "--ipc=host",
    "--uts=host",
    "--cap-add",
    "--security-opt=seccomp=unconfined",
    "--security-opt=apparmor=unconfined",
    "--userns=host",
    "--device=",
    "--volume=/",
    "-v=/etc",
    "-v=/proc",
    "-v=/sys",
    "-v=/",
];

impl Default for DockerConfig {
    fn default() -> Self {
        let mut language_images = std::collections::HashMap::new();
        language_images.insert("python".to_string(), "python:3.12-slim".to_string());
        language_images.insert("python3".to_string(), "python:3.12-slim".to_string());
        language_images.insert("node".to_string(), "node:20-slim".to_string());
        language_images.insert("javascript".to_string(), "node:20-slim".to_string());
        language_images.insert("ruby".to_string(), "ruby:3.3-slim".to_string());
        language_images.insert("go".to_string(), "golang:1.22-alpine".to_string());
        language_images.insert("rust".to_string(), "rust:1.77-slim".to_string());

        Self {
            default_image: "ubuntu:22.04".to_string(),
            language_images,
            auto_remove: true,
            disable_network: true,
            memory_limit: Some(256 * 1024 * 1024), // 256 MB
            cpu_quota: Some(50_000),
            read_only_rootfs: true,
            extra_args: vec![],
        }
    }
}

/// Docker 容器沙箱
#[derive(Debug, Clone)]
pub struct DockerSandbox {
    config: DockerConfig,
}

impl DockerSandbox {
    pub fn new(config: DockerConfig) -> Self {
        Self { config }
    }

    /// 检测 Docker 是否安装且可用(带缓存)
    async fn check_docker() -> bool {
        let cache = DOCKER_CHECK_CACHE.get_or_init(|| Mutex::new(None));
        if let Ok(guard) = cache.lock()
            && let Some((checked_at, available)) = *guard
            && checked_at.elapsed() < DOCKER_CACHE_TTL
        {
            return available;
        }

        let available = Command::new("docker")
            .arg("info")
            .stdout(std::process::Stdio::null())
            .stderr(std::process::Stdio::null())
            .status()
            .await
            .map(|s| s.success())
            .unwrap_or(false);
        if let Ok(mut guard) = cache.lock() {
            *guard = Some((Instant::now(), available));
        }
        available
    }

    /// 为命令选择合适的镜像
    fn select_image(&self, command: &SandboxCommand) -> String {
        select_image_for_command(
            command,
            &self.config.language_images,
            &self.config.default_image,
        )
    }

    /// 构建 docker create 命令行参数(不含 `docker` 可执行文件本身)。
    ///
    /// 这里直接面向 `docker create` 组装参数,而不是先拼 `docker run`
    /// 再反推 image / command 边界,避免 create/start 路径漂移。
    fn build_docker_create_args(
        &self,
        command: &SandboxCommand,
        limits: Option<&ResourceLimits>,
    ) -> Result<Vec<String>> {
        let mut args = vec!["create".to_string()];
        args.push("--label".to_string());
        args.push(SANDBOX_LABEL.to_string());

        // 网络隔离
        let network_allowed = limits
            .map(|l| l.network)
            .unwrap_or(!self.config.disable_network);
        if !network_allowed {
            args.push("--network=none".to_string());
        }

        // 内存限制
        let mem = limits
            .and_then(|l| l.memory_bytes)
            .or(self.config.memory_limit);
        if let Some(mem) = mem {
            args.push(format!("--memory={mem}"));
            args.push(format!("--memory-swap={mem}")); // 禁用 swap
        }

        // CPU 限制
        if let Some(quota) = self.config.cpu_quota {
            args.push(format!("--cpu-quota={quota}"));
        }

        // 进程限制
        if let Some(limits) = limits
            && let Some(max_procs) = limits.max_processes
        {
            args.push(format!("--pids-limit={max_procs}"));
        }

        // 只读根文件系统
        if self.config.read_only_rootfs {
            args.push("--read-only".to_string());
            // 需要 tmpfs 给 /tmp
            args.push("--tmpfs=/tmp:rw,noexec,nosuid,size=64m".to_string());
        }

        // 安全选项:移除所有 capabilities
        args.push("--cap-drop=ALL".to_string());
        // 禁止提权
        args.push("--security-opt=no-new-privileges".to_string());
        // 防止僵尸进程累积
        args.push("--init".to_string());
        // 防止容器意外重启
        args.push("--restart=no".to_string());
        // 限制资源使用上限
        args.push("--ulimit=nofile=256:512".to_string());
        args.push("--ulimit=nproc=64:128".to_string());

        // 环境变量
        for (k, v) in &command.env {
            args.push("-e".to_string());
            args.push(format!("{k}={v}"));
        }

        // 挂载卷(limits 中的路径),需验证安全性
        if let Some(limits) = limits {
            for path in &limits.read_only_paths {
                Self::validate_mount_paths(std::slice::from_ref(path)).map_err(|e| {
                    echo_core::error::ReactError::Sandbox(SandboxError::PermissionDenied(e))
                })?;
                args.push("-v".to_string());
                args.push(format!("{}:{}:ro", path.display(), path.display()));
            }
            for path in &limits.writable_paths {
                Self::validate_mount_paths(std::slice::from_ref(path)).map_err(|e| {
                    echo_core::error::ReactError::Sandbox(SandboxError::PermissionDenied(e))
                })?;
                args.push("-v".to_string());
                args.push(format!("{}:{}", path.display(), path.display()));
            }
        }

        // 工作目录
        if let Some(ref dir) = command.working_dir {
            args.push("-w".to_string());
            args.push(dir.display().to_string());
        }

        // 额外参数:过滤掉危险选项
        for arg in &self.config.extra_args {
            if !DANGEROUS_DOCKER_ARGS.iter().any(|d| arg.starts_with(d)) {
                args.push(arg.clone());
            }
        }

        // 镜像
        args.push(self.select_image(command));
        args.extend(Self::build_inner_command(command));

        Ok(args)
    }

    /// 验证挂载路径,拒绝敏感目录
    fn validate_mount_paths(paths: &[std::path::PathBuf]) -> std::result::Result<(), String> {
        for path in paths {
            let path_str = path.display().to_string();
            for sensitive in SENSITIVE_MOUNT_PATHS.iter() {
                if path_str == *sensitive || path_str.starts_with(&format!("{sensitive}/")) {
                    return Err(format!(
                        "Mount path '{}' accesses sensitive directory '{}'",
                        path_str, sensitive
                    ));
                }
            }
        }
        Ok(())
    }

    /// 构建容器内的执行命令
    fn build_inner_command(command: &SandboxCommand) -> Vec<String> {
        match &command.kind {
            CommandKind::Shell(cmd) => vec!["sh".to_string(), "-c".to_string(), cmd.clone()],
            CommandKind::Program { program, args } => {
                let mut v = vec![program.clone()];
                v.extend(args.clone());
                v
            }
            CommandKind::Code { language, code } => {
                let (interpreter, flag) = match language.as_str() {
                    "python" | "python3" => ("python3", "-c"),
                    "node" | "javascript" | "js" => ("node", "-e"),
                    "ruby" => ("ruby", "-e"),
                    "perl" => ("perl", "-e"),
                    "php" => ("php", "-r"),
                    _ => ("sh", "-c"),
                };
                vec![interpreter.to_string(), flag.to_string(), code.clone()]
            }
        }
    }

    /// 清理所有带有 echo-sandbox 标签的容器
    pub async fn cleanup_sandbox_containers() -> Result<()> {
        let output = Command::new("docker")
            .args(["ps", "-aq", "--filter", &format!("label={SANDBOX_LABEL}")])
            .output()
            .await
            .map_err(|e| {
                echo_core::error::ReactError::Sandbox(SandboxError::IoError(format!(
                    "Failed to list sandbox containers: {e}"
                )))
            })?;

        let containers = String::from_utf8_lossy(&output.stdout);
        if !containers.trim().is_empty() {
            for container_id in containers.lines() {
                let _ = Command::new("docker")
                    .args(["rm", "-f", container_id])
                    .output()
                    .await;
            }
        }
        Ok(())
    }

    async fn remove_container(container_id: &str) {
        let _ = Command::new("docker")
            .args(["rm", "-f", container_id])
            .output()
            .await;
    }
}

impl SandboxExecutor for DockerSandbox {
    fn name(&self) -> &str {
        "docker"
    }

    fn isolation_level(&self) -> IsolationLevel {
        IsolationLevel::Container
    }

    fn is_available(&self) -> BoxFuture<'_, bool> {
        Box::pin(Self::check_docker())
    }

    fn cleanup(&self) -> BoxFuture<'_, Result<()>> {
        Box::pin(Self::cleanup_sandbox_containers())
    }

    fn execute(&self, command: SandboxCommand) -> BoxFuture<'_, Result<ExecutionResult>> {
        Box::pin(async move {
            if !Self::check_docker().await {
                return Err(echo_core::error::ReactError::Sandbox(
                    SandboxError::Unavailable("Docker is not available".to_string()),
                ));
            }

            let timeout = command.timeout;
            let docker_args = self.build_docker_create_args(&command, None)?;

            let start = Instant::now();

            let output = Command::new("docker")
                .args(&docker_args)
                .output()
                .await
                .map_err(|e| {
                    echo_core::error::ReactError::Sandbox(SandboxError::StartFailed(format!(
                        "Failed to create docker container: {e}"
                    )))
                })?;

            let container_id = String::from_utf8_lossy(&output.stdout).trim().to_string();
            if container_id.is_empty() {
                let stderr = String::from_utf8_lossy(&output.stderr);
                return Err(echo_core::error::ReactError::Sandbox(
                    SandboxError::StartFailed(format!("Failed to get container ID: {stderr}")),
                ));
            }

            // 启动并等待结果
            let mut start_cmd = Command::new("docker");
            let attach_flag = if command.stdin.is_some() { "-ai" } else { "-a" };
            start_cmd
                .args(["start", attach_flag, &container_id])
                .stdin(if command.stdin.is_some() {
                    std::process::Stdio::piped()
                } else {
                    std::process::Stdio::null()
                })
                .stdout(std::process::Stdio::piped())
                .stderr(std::process::Stdio::piped());

            let mut child = start_cmd.spawn().map_err(|e| {
                echo_core::error::ReactError::Sandbox(SandboxError::StartFailed(format!(
                    "Failed to start docker container: {e}"
                )))
            })?;

            if let Some(input) = command.stdin.as_deref()
                && let Some(mut stdin) = child.stdin.take()
            {
                stdin.write_all(input.as_bytes()).await.map_err(|e| {
                    echo_core::error::ReactError::Sandbox(SandboxError::IoError(format!(
                        "Failed to write docker stdin: {e}"
                    )))
                })?;
            }

            match tokio::time::timeout(timeout, child.wait_with_output()).await {
                Ok(Ok(output)) => {
                    // 清理容器
                    Self::remove_container(&container_id).await;

                    Ok(ExecutionResult {
                        exit_code: output.status.code().unwrap_or(-1),
                        stdout: String::from_utf8_lossy(&output.stdout).to_string(),
                        stderr: String::from_utf8_lossy(&output.stderr).to_string(),
                        duration: start.elapsed(),
                        sandbox_type: "docker".to_string(),
                        timed_out: false,
                    })
                }
                Ok(Err(e)) => {
                    Self::remove_container(&container_id).await;
                    Err(echo_core::error::ReactError::Sandbox(
                        SandboxError::IoError(format!("Docker IO error: {e}")),
                    ))
                }
                Err(_) => {
                    // 超时:强制 kill 容器
                    let _ = Command::new("docker")
                        .args(["kill", &container_id])
                        .output()
                        .await;
                    Self::remove_container(&container_id).await;

                    Ok(ExecutionResult {
                        exit_code: -1,
                        stdout: String::new(),
                        stderr: format!("Docker execution timed out after {}s", timeout.as_secs()),
                        duration: start.elapsed(),
                        sandbox_type: "docker".to_string(),
                        timed_out: true,
                    })
                }
            }
        })
    }

    fn execute_with_limits(
        &self,
        command: SandboxCommand,
        limits: ResourceLimits,
    ) -> BoxFuture<'_, Result<ExecutionResult>> {
        Box::pin(async move {
            if !Self::check_docker().await {
                return Err(echo_core::error::ReactError::Sandbox(
                    SandboxError::Unavailable("Docker is not available".to_string()),
                ));
            }

            let timeout = limits
                .cpu_time_secs
                .map(std::time::Duration::from_secs)
                .unwrap_or(command.timeout);

            let docker_args = self.build_docker_create_args(&command, Some(&limits))?;

            let start = Instant::now();

            let output = Command::new("docker")
                .args(&docker_args)
                .output()
                .await
                .map_err(|e| {
                    echo_core::error::ReactError::Sandbox(SandboxError::StartFailed(format!(
                        "Failed to create docker container: {e}"
                    )))
                })?;

            let container_id = String::from_utf8_lossy(&output.stdout).trim().to_string();
            if container_id.is_empty() {
                let stderr = String::from_utf8_lossy(&output.stderr);
                return Err(echo_core::error::ReactError::Sandbox(
                    SandboxError::StartFailed(format!("Failed to get container ID: {stderr}")),
                ));
            }

            let mut start_cmd = Command::new("docker");
            let attach_flag = if command.stdin.is_some() { "-ai" } else { "-a" };
            start_cmd
                .args(["start", attach_flag, &container_id])
                .stdin(if command.stdin.is_some() {
                    std::process::Stdio::piped()
                } else {
                    std::process::Stdio::null()
                })
                .stdout(std::process::Stdio::piped())
                .stderr(std::process::Stdio::piped());

            let mut child = start_cmd.spawn().map_err(|e| {
                echo_core::error::ReactError::Sandbox(SandboxError::StartFailed(format!(
                    "Failed to start docker container: {e}"
                )))
            })?;

            if let Some(input) = command.stdin.as_deref()
                && let Some(mut stdin) = child.stdin.take()
            {
                stdin.write_all(input.as_bytes()).await.map_err(|e| {
                    echo_core::error::ReactError::Sandbox(SandboxError::IoError(format!(
                        "Failed to write docker stdin: {e}"
                    )))
                })?;
            }

            match tokio::time::timeout(timeout, child.wait_with_output()).await {
                Ok(Ok(output)) => {
                    Self::remove_container(&container_id).await;

                    let mut stdout = String::from_utf8_lossy(&output.stdout).to_string();
                    let mut stderr = String::from_utf8_lossy(&output.stderr).to_string();

                    if let Some(max) = limits.max_output_bytes {
                        let max = max as usize;
                        if stdout.len() > max {
                            stdout.truncate(max);
                            stdout.push_str("\n... [output truncated]");
                        }
                        if stderr.len() > max {
                            stderr.truncate(max);
                            stderr.push_str("\n... [output truncated]");
                        }
                    }

                    Ok(ExecutionResult {
                        exit_code: output.status.code().unwrap_or(-1),
                        stdout,
                        stderr,
                        duration: start.elapsed(),
                        sandbox_type: "docker".to_string(),
                        timed_out: false,
                    })
                }
                Ok(Err(e)) => {
                    Self::remove_container(&container_id).await;
                    Err(echo_core::error::ReactError::Sandbox(
                        SandboxError::IoError(format!("Docker IO error: {e}")),
                    ))
                }
                Err(_) => {
                    let _ = Command::new("docker")
                        .args(["kill", &container_id])
                        .output()
                        .await;
                    Self::remove_container(&container_id).await;

                    Ok(ExecutionResult {
                        exit_code: -1,
                        stdout: String::new(),
                        stderr: format!("Docker execution timed out after {}s", timeout.as_secs()),
                        duration: start.elapsed(),
                        sandbox_type: "docker".to_string(),
                        timed_out: true,
                    })
                }
            }
        })
    }
}

// ── 单元测试 ────────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_docker_config_default() {
        let config = DockerConfig::default();
        assert_eq!(config.default_image, "ubuntu:22.04");
        assert!(config.auto_remove);
        assert!(config.disable_network);
    }

    #[test]
    fn test_select_image_python() {
        let sandbox = DockerSandbox::new(DockerConfig::default());
        let cmd = SandboxCommand::code("python", "print(1)");
        let image = sandbox.select_image(&cmd);
        assert_eq!(image, "python:3.12-slim");
    }

    #[test]
    fn test_select_image_fallback() {
        let sandbox = DockerSandbox::new(DockerConfig::default());
        let cmd = SandboxCommand::shell("echo hello");
        let image = sandbox.select_image(&cmd);
        assert_eq!(image, "ubuntu:22.04");
    }

    #[test]
    fn test_docker_args_security() {
        let sandbox = DockerSandbox::new(DockerConfig::default());
        let cmd = SandboxCommand::shell("echo test");
        let args = sandbox.build_docker_create_args(&cmd, None).unwrap();

        assert_eq!(args.first().map(String::as_str), Some("create"));
        assert!(args.contains(&"--label".to_string()));
        assert!(args.contains(&SANDBOX_LABEL.to_string()));
        assert!(args.contains(&"--cap-drop=ALL".to_string()));
        assert!(args.contains(&"--security-opt=no-new-privileges".to_string()));
        assert!(args.contains(&"--network=none".to_string()));
        assert!(args.contains(&"--init".to_string()));
        assert!(args.contains(&"--restart=no".to_string()));
        assert!(args.contains(&"--read-only".to_string()));
        assert!(args.contains(&"--ulimit=nofile=256:512".to_string()));
        assert!(args.contains(&"--ulimit=nproc=64:128".to_string()));
    }

    #[test]
    fn test_docker_args_with_limits() {
        let sandbox = DockerSandbox::new(DockerConfig::default());
        let cmd = SandboxCommand::shell("echo test");
        let limits = ResourceLimits {
            max_processes: Some(16),
            network: true,
            ..Default::default()
        };
        let args = sandbox
            .build_docker_create_args(&cmd, Some(&limits))
            .unwrap();

        assert!(args.contains(&"--pids-limit=16".to_string()));
        // network=true in limits overrides config
        assert!(!args.contains(&"--network=none".to_string()));
    }

    #[test]
    fn test_inner_command_shell() {
        let cmd = SandboxCommand::shell("ls -la");
        let inner = DockerSandbox::build_inner_command(&cmd);
        assert_eq!(inner, vec!["sh", "-c", "ls -la"]);
    }

    #[test]
    fn test_inner_command_code() {
        let cmd = SandboxCommand::code("python", "print('hi')");
        let inner = DockerSandbox::build_inner_command(&cmd);
        assert_eq!(inner, vec!["python3", "-c", "print('hi')"]);
    }

    #[test]
    fn test_docker_args_include_full_command() {
        let sandbox = DockerSandbox::new(DockerConfig::default());
        let cmd = SandboxCommand::program("python3", vec!["-V".to_string()]);
        let args = sandbox.build_docker_create_args(&cmd, None).unwrap();

        assert_eq!(args.first().map(String::as_str), Some("create"));
        assert!(args.contains(&"python3".to_string()));
        assert!(args.contains(&"-V".to_string()));
        assert!(!args.contains(&"run".to_string()));
    }
}