网关

沙箱隔离

OpenClaw 可以在沙箱后端内运行工具,以降低影响范围。这是可选的,由配置(agents.defaults.sandboxagents.list[].sandbox)控制。如果沙箱隔离关闭,工具会在主机上运行。Gateway 网关会留在主机上;启用后,工具执行会在隔离的沙箱中运行。

哪些内容会被沙箱隔离

  • 工具执行(execreadwriteeditapply_patchprocess 等)。
  • 可选的沙箱隔离浏览器(agents.defaults.sandbox.browser)。
沙箱隔离浏览器详情
  • 默认情况下,当浏览器工具需要它时,沙箱浏览器会自动启动(确保 CDP 可访问)。通过 agents.defaults.sandbox.browser.autoStartagents.defaults.sandbox.browser.autoStartTimeoutMs 配置。
  • 默认情况下,沙箱浏览器容器使用专用 Docker 网络(openclaw-sandbox-browser),而不是全局 bridge 网络。使用 agents.defaults.sandbox.browser.network 配置。
  • 可选的 agents.defaults.sandbox.browser.cdpSourceRange 使用 CIDR 允许列表限制容器边缘的 CDP 入站访问(例如 172.21.0.1/32)。
  • 默认情况下,noVNC 观察者访问受密码保护;OpenClaw 会生成一个短期有效的令牌 URL,用于提供本地引导页面,并在 URL 片段中携带密码打开 noVNC(不会出现在查询参数或标头日志中)。
  • agents.defaults.sandbox.browser.allowHostControl 允许沙箱隔离会话显式指向主机浏览器。
  • 可选允许列表会限制 target: "custom"allowedControlUrlsallowedControlHostsallowedControlPorts

不会被沙箱隔离:

  • Gateway 网关进程本身。
  • 任何被显式允许在沙箱外运行的工具(例如 tools.elevated)。
    • 提升权限的 exec 会绕过沙箱隔离,并使用配置的逃逸路径(默认是 gateway,当 exec 目标是 node 时则为 node)。
    • 如果沙箱隔离关闭,tools.elevated 不会改变执行方式(已经在主机上)。请参阅提升权限模式

模式

agents.defaults.sandbox.mode 控制何时使用沙箱隔离:

off

无沙箱隔离。

non-main

仅对非主会话进行沙箱隔离(如果你希望普通聊天在主机上运行,这是默认选择)。

"non-main" 基于 session.mainKey(默认 "main"),而不是智能体 ID。群组/渠道会话使用自己的键名,因此会被视为非主会话并进行沙箱隔离。

all

每个会话都在沙箱中运行。

作用域

agents.defaults.sandbox.scope 控制会创建多少个容器

  • "agent"(默认):每个智能体一个容器。
  • "session":每个会话一个容器。
  • "shared":所有沙箱隔离会话共享一个容器。

后端

agents.defaults.sandbox.backend 控制哪个运行时提供沙箱:

  • "docker"(启用沙箱隔离时的默认值):本地 Docker 支持的沙箱运行时。
  • "ssh":通用 SSH 支持的远程沙箱运行时。
  • "openshell":OpenShell 支持的沙箱运行时。

SSH 专用配置位于 agents.defaults.sandbox.ssh 下。OpenShell 专用配置位于 plugins.entries.openshell.config 下。

选择后端

Docker SSH OpenShell
运行位置 本地容器 任何可通过 SSH 访问的主机 OpenShell 管理的沙箱
设置 scripts/sandbox-setup.sh SSH 密钥 + 目标主机 已启用 OpenShell 插件
工作区模型 绑定挂载或复制 远程权威(初始化一次) mirrorremote
网络控制 docker.network(默认:无) 取决于远程主机 取决于 OpenShell
浏览器沙箱 支持 不支持 尚不支持
绑定挂载 docker.binds N/A N/A
最适合 本地开发、完整隔离 卸载到远程机器 带可选双向同步的托管远程沙箱

Docker 后端

沙箱隔离默认关闭。如果你启用沙箱隔离且没有选择后端,OpenClaw 会使用 Docker 后端。它通过 Docker 守护进程套接字(/var/run/docker.sock)在本地执行工具和沙箱浏览器。沙箱容器隔离由 Docker 命名空间决定。

若要将主机 GPU 暴露给 Docker 沙箱,请设置 agents.defaults.sandbox.docker.gpus,或使用每个智能体的 agents.list[].sandbox.docker.gpus 覆盖项。该值会作为单独参数传递给 Docker 的 --gpus 标志,例如 "all""device=GPU-uuid",并且需要兼容的主机运行时,例如 NVIDIA Container Toolkit。

SSH 后端

当你希望 OpenClaw 在任意可通过 SSH 访问的机器上沙箱隔离 exec、文件工具和媒体读取时,请使用 backend: "ssh"

{
  agents: {
    defaults: {
      sandbox: {
        mode: "all",
        backend: "ssh",
        scope: "session",
        workspaceAccess: "rw",
        ssh: {
          target: "user@gateway-host:22",
          workspaceRoot: "/tmp/openclaw-sandboxes",
          strictHostKeyChecking: true,
          updateHostKeys: true,
          identityFile: "~/.ssh/id_ed25519",
          certificateFile: "~/.ssh/id_ed25519-cert.pub",
          knownHostsFile: "~/.ssh/known_hosts",
          // Or use SecretRefs / inline contents instead of local files:
          // identityData: { source: "env", provider: "default", id: "SSH_IDENTITY" },
          // certificateData: { source: "env", provider: "default", id: "SSH_CERTIFICATE" },
          // knownHostsData: { source: "env", provider: "default", id: "SSH_KNOWN_HOSTS" },
        },
      },
    },
  },
}
工作原理
  • OpenClaw 会在 sandbox.ssh.workspaceRoot 下创建按作用域划分的远程根目录。
  • 创建或重新创建后的首次使用时,OpenClaw 会从本地工作区向该远程工作区初始化一次内容。
  • 此后,execreadwriteeditapply_patch、提示媒体读取和入站媒体暂存都会通过 SSH 直接针对远程工作区运行。
  • OpenClaw 不会自动将远程更改同步回本地工作区。
认证材料
  • identityFilecertificateFileknownHostsFile:使用现有本地文件,并通过 OpenSSH 配置传递。
  • identityDatacertificateDataknownHostsData:使用内联字符串或 SecretRefs。OpenClaw 会通过常规密钥运行时快照解析它们,将其写入权限为 0600 的临时文件,并在 SSH 会话结束时删除。
  • 如果同一项同时设置了 *File*Data,则该 SSH 会话会优先使用 *Data
远程权威的影响

这是一个远程权威模型。初始初始化后,远程 SSH 工作区会成为真正的沙箱状态。

  • 初始化步骤之后在 OpenClaw 外部进行的主机本地编辑,在重新创建沙箱前不会在远程可见。
  • openclaw sandbox recreate 会删除按作用域划分的远程根目录,并在下次使用时再次从本地初始化。
  • SSH 后端不支持浏览器沙箱隔离。
  • sandbox.docker.* 设置不适用于 SSH 后端。

OpenShell 后端

当你希望 OpenClaw 在 OpenShell 管理的远程环境中沙箱隔离工具时,请使用 backend: "openshell"。完整的设置指南、配置参考和工作区模式对比,请参阅专门的 OpenShell 页面

OpenShell 复用与通用 SSH 后端相同的核心 SSH 传输和远程文件系统桥接,并添加 OpenShell 专用生命周期(sandbox create/get/deletesandbox ssh-config)以及可选的 mirror 工作区模式。

{
  agents: {
    defaults: {
      sandbox: {
        mode: "all",
        backend: "openshell",
        scope: "session",
        workspaceAccess: "rw",
      },
    },
  },
  plugins: {
    entries: {
      openshell: {
        enabled: true,
        config: {
          from: "openclaw",
          mode: "remote", // mirror | remote
          remoteWorkspaceDir: "/sandbox",
          remoteAgentWorkspaceDir: "/agent",
        },
      },
    },
  },
}

OpenShell 模式:

  • mirror(默认):本地工作区保持权威。OpenClaw 会在 exec 前将本地文件同步到 OpenShell,并在 exec 后将远程工作区同步回来。
  • remote:沙箱创建后,OpenShell 工作区是权威。OpenClaw 会从本地工作区向远程工作区初始化一次,然后文件工具和 exec 会直接针对远程沙箱运行,不会同步更改回来。
远程传输详情
  • OpenClaw 会通过 openshell sandbox ssh-config <name> 向 OpenShell 请求沙箱专用 SSH 配置。
  • 核心会将该 SSH 配置写入临时文件,打开 SSH 会话,并复用 backend: "ssh" 使用的同一个远程文件系统桥接。
  • 仅在 mirror 模式下,生命周期有所不同:exec 前从本地同步到远程,然后 exec 后同步回来。
当前 OpenShell 限制
  • 尚不支持沙箱浏览器
  • OpenShell 后端不支持 sandbox.docker.binds
  • sandbox.docker.* 下的 Docker 专用运行时旋钮仍然只适用于 Docker 后端

工作区模式

OpenShell 有两种工作区模型。这是在实践中最重要的部分。

mirror(本地权威)

当你希望本地工作区保持权威时,请使用 plugins.entries.openshell.config.mode: "mirror"

行为:

  • exec 前,OpenClaw 会将本地工作区同步到 OpenShell 沙箱。
  • exec 后,OpenClaw 会将远程工作区同步回本地工作区。
  • 文件工具仍然通过沙箱桥接运行,但本地工作区在不同轮次之间仍然是事实来源。

适用于以下情况:

  • 你在 OpenClaw 外部本地编辑文件,并希望这些更改自动显示在沙箱中
  • 你希望 OpenShell 沙箱尽可能像 Docker 后端一样运行
  • 你希望主机工作区在每次 exec 回合后反映沙箱写入

取舍:exec 前后会产生额外的同步成本。

remote(OpenShell 权威)

当你希望 OpenShell 工作区成为权威来源时,请使用 plugins.entries.openshell.config.mode: "remote"

行为:

  • 首次创建沙箱时,OpenClaw 会从本地工作区向远程工作区进行一次初始化。
  • 之后,execreadwriteeditapply_patch 会直接作用于远程 OpenShell 工作区。
  • OpenClaw 不会在 exec 后将远程更改同步回本地工作区。
  • 提示词阶段的媒体读取仍可工作,因为文件和媒体工具会通过沙箱桥接读取,而不是假定存在本地主机路径。
  • 传输方式是通过 openshell sandbox ssh-config 返回的配置 SSH 到 OpenShell 沙箱。

重要影响:

  • 如果你在初始化步骤之后,在 OpenClaw 外部的主机上编辑文件,远程沙箱不会自动看到这些更改。
  • 如果重新创建沙箱,远程工作区会再次从本地工作区初始化。
  • 使用 scope: "agent"scope: "shared" 时,该远程工作区会在相同作用域内共享。

适用场景:

  • 沙箱应主要位于远程 OpenShell 侧
  • 你希望降低每回合同步开销
  • 你不希望主机本地编辑静默覆盖远程沙箱状态

如果你将沙箱视为临时执行环境,请选择 mirror。如果你将沙箱视为真实工作区,请选择 remote

OpenShell 生命周期

OpenShell 沙箱仍通过常规沙箱生命周期管理:

  • openclaw sandbox list 会显示 OpenShell 运行时以及 Docker 运行时
  • openclaw sandbox recreate 会删除当前运行时,并让 OpenClaw 在下次使用时重新创建它
  • 清理逻辑也能感知后端

对于 remote 模式,重新创建尤其重要:

  • 重新创建会删除该作用域的权威远程工作区
  • 下次使用时会从本地工作区初始化一个新的远程工作区

对于 mirror 模式,重新创建主要是重置远程执行环境,因为本地工作区仍然是权威来源。

工作区访问

agents.defaults.sandbox.workspaceAccess 控制沙箱可以看到什么

none(默认)

工具会看到 ~/.openclaw/sandboxes 下的沙箱工作区。

ro

以只读方式将 Agent 工作区挂载到 /agent(禁用 write/edit/apply_patch)。

rw

以读写方式将 Agent 工作区挂载到 /workspace

使用 OpenShell 后端时:

  • mirror 模式仍在 exec 回合之间使用本地工作区作为权威来源
  • remote 模式会在初始初始化后使用远程 OpenShell 工作区作为权威来源
  • workspaceAccess: "ro""none" 仍会以相同方式限制写入行为

入站媒体会复制到活动沙箱工作区(media/inbound/*)。

自定义绑定挂载

agents.defaults.sandbox.docker.binds 会将额外的主机目录挂载到容器中。格式:host:container:mode(例如 "/home/user/source:/source:rw")。

全局和按智能体配置的绑定会被合并(而不是替换)。在 scope: "shared" 下,按智能体配置的绑定会被忽略。

agents.defaults.sandbox.browser.binds 只会将额外的主机目录挂载到沙箱浏览器容器中。

  • 设置后(包括 []),它会替换浏览器容器的 agents.defaults.sandbox.docker.binds
  • 省略时,浏览器容器会回退到 agents.defaults.sandbox.docker.binds(向后兼容)。

示例(只读源码 + 一个额外数据目录):

{
  agents: {
    defaults: {
      sandbox: {
        docker: {
          binds: ["/home/user/source:/source:ro", "/var/data/myapp:/data:ro"],
        },
      },
    },
    list: [
      {
        id: "build",
        sandbox: {
          docker: {
            binds: ["/mnt/cache:/cache:rw"],
          },
        },
      },
    ],
  },
}

镜像和设置

默认 Docker 镜像:openclaw-sandbox:bookworm-slim

  • 构建默认镜像

    从源码检出运行:

    scripts/sandbox-setup.sh
    

    从 npm 安装运行(不需要源码检出):

    docker build -t openclaw-sandbox:bookworm-slim - <<'DOCKERFILE'
    FROM debian:bookworm-slim
    ENV DEBIAN_FRONTEND=noninteractive
    RUN apt-get update && apt-get install -y --no-install-recommends \
      bash ca-certificates curl git jq python3 ripgrep \
      && rm -rf /var/lib/apt/lists/*
    RUN useradd --create-home --shell /bin/bash sandbox
    USER sandbox
    WORKDIR /home/sandbox
    CMD ["sleep", "infinity"]
    DOCKERFILE
    

    默认镜像不包含 Node。如果某个 Skill 需要 Node(或其他运行时),请烘焙自定义镜像,或通过 sandbox.docker.setupCommand 安装(需要网络出口 + 可写根目录 + root 用户)。

    当缺少 openclaw-sandbox:bookworm-slim 时,OpenClaw 不会静默替换为普通的 debian:bookworm-slim。在你构建它之前,目标为默认镜像的沙箱运行会快速失败并给出构建说明,因为内置镜像携带了供沙箱 write/edit 辅助工具使用的 python3

  • 可选:构建通用镜像

    如需包含常用工具(例如 curljqnodejspython3git)且功能更完整的沙箱镜像:

    从源码检出运行:

    scripts/sandbox-common-setup.sh
    

    从 npm 安装运行时,先构建默认镜像(见上文),然后使用仓库中的 scripts/docker/sandbox/Dockerfile.common 在其上构建通用镜像。

    然后将 agents.defaults.sandbox.docker.image 设置为 openclaw-sandbox-common:bookworm-slim

  • 可选:构建沙箱浏览器镜像

    从源码检出运行:

    scripts/sandbox-browser-setup.sh
    

    从 npm 安装运行时,使用仓库中的 scripts/docker/sandbox/Dockerfile.browser 构建。

  • 默认情况下,Docker 沙箱容器在无网络状态下运行。可通过 agents.defaults.sandbox.docker.network 覆盖。

    沙箱浏览器 Chromium 默认值

    内置沙箱浏览器镜像还会为容器化工作负载应用保守的 Chromium 启动默认值。当前容器默认值包括:

    • --remote-debugging-address=127.0.0.1
    • --remote-debugging-port=<derived from OPENCLAW_BROWSER_CDP_PORT>
    • --user-data-dir=${HOME}/.chrome
    • --no-first-run
    • --no-default-browser-check
    • --disable-3d-apis
    • --disable-gpu
    • --disable-dev-shm-usage
    • --disable-background-networking
    • --disable-extensions
    • --disable-features=TranslateUI
    • --disable-breakpad
    • --disable-crash-reporter
    • --disable-software-rasterizer
    • --no-zygote
    • --metrics-recording-only
    • --renderer-process-limit=2
    • 启用 noSandbox 时使用 --no-sandbox
    • 三个图形加固标志(--disable-3d-apis--disable-software-rasterizer--disable-gpu)是可选项,在容器缺少 GPU 支持时很有用。如果你的工作负载需要 WebGL 或其他 3D/浏览器功能,请设置 OPENCLAW_BROWSER_DISABLE_GRAPHICS_FLAGS=0
    • 默认启用 --disable-extensions,对于依赖扩展的流程,可以使用 OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0 禁用它。
    • --renderer-process-limit=2OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=&lt;N&gt; 控制,其中 0 保持 Chromium 默认值。

    如果你需要不同的运行时配置,请使用自定义浏览器镜像并提供你自己的入口点。对于本地(非容器)Chromium 配置,请使用 browser.extraArgs 追加额外启动标志。

    网络安全默认值
    • network: "host" 被阻止。
    • 默认阻止 network: "container:<id>"(存在命名空间加入绕过风险)。
    • 紧急覆盖:agents.defaults.sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true

    Docker 安装和容器化 Gateway 网关位于此处:Docker

    对于 Docker Gateway 网关部署,scripts/docker/setup.sh 可以引导沙箱配置。设置 OPENCLAW_SANDBOX=1(或 true/yes/on)以启用该路径。你可以使用 OPENCLAW_DOCKER_SOCKET 覆盖套接字位置。完整设置和环境变量参考:Docker

    setupCommand(一次性容器设置)

    setupCommand 会在沙箱容器创建后运行一次(不是每次运行都执行)。它通过 sh -lc 在容器内执行。

    路径:

    • 全局:agents.defaults.sandbox.docker.setupCommand
    • 按智能体:agents.list[].sandbox.docker.setupCommand
    常见陷阱
    • 默认 docker.network"none"(无出站访问),因此软件包安装会失败。
    • docker.network: "container:<id>" 需要 dangerouslyAllowContainerNamespaceJoin: true,且仅限紧急破例使用。
    • readOnlyRoot: true 会阻止写入;请设置 readOnlyRoot: false 或烘焙自定义镜像。
    • 软件包安装时 user 必须是 root(省略 user 或设置 user: "0:0")。
    • 沙箱 exec 不会继承主机的 process.env。请使用 agents.defaults.sandbox.docker.env(或自定义镜像)配置 skill API keys。

    工具策略与应急通道

    工具允许/拒绝策略仍会在沙箱规则之前生效。如果某个工具在全局或按智能体被拒绝,沙箱隔离不会让它重新可用。

    tools.elevated 是一个显式应急通道,会在沙箱外运行 exec(默认在 gateway 中,或当 exec 目标是 node 时在 node 中)。/exec 指令仅适用于已授权发送者,并会按会话保留;若要彻底禁用 exec,请使用工具策略拒绝(参见沙箱 vs 工具策略 vs 提权)。

    调试:

    • 使用 openclaw sandbox explain 检查实际沙箱模式、工具策略以及修复用配置键。
    • 参见沙箱 vs 工具策略 vs 提权,了解“为什么会被阻止?”的思维模型。

    保持锁定。

    多智能体覆盖

    每个智能体都可以覆盖沙箱 + 工具:agents.list[].sandboxagents.list[].tools(以及用于沙箱工具策略的 agents.list[].tools.sandbox.tools)。参见多智能体沙箱与工具了解优先级。

    最小启用示例

    {
      agents: {
        defaults: {
          sandbox: {
            mode: "non-main",
            scope: "session",
            workspaceAccess: "none",
          },
        },
      },
    }
    

    相关