沙盒
OpenClaw 可以在 沙盒後端內執行工具 以縮小影響範圍。這是 可選的,並由設定 (agents.defaults.sandbox 或 agents.list[].sandbox) 控制。如果關閉沙盒,工具將在主機上執行。Gateway 停留在主機上;啟用時,工具執行會在隔離的沙盒中運作。
什麼會被沙箱化
Section titled “什麼會被沙箱化”- 工具執行 (
exec、read、write、edit、apply_patch、process等)。 - 選用的沙盒瀏覽器 (
agents.defaults.sandbox.browser)。
沙盒瀏覽器詳細資訊
- 預設情況下,當瀏覽器工具需要時,沙盒瀏覽器會自動啟動(確保 CDP 可連線)。透過
agents.defaults.sandbox.browser.autoStart和agents.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 提供本地啟動頁面,並在 URL 片段中包含密碼以開啟 noVNC(而非查詢/標頭日誌)。
agents.defaults.sandbox.browser.allowHostControl允許沙盒工作階段明確以主機瀏覽器為目標。- 選用的白名單會控管
target: "custom":allowedControlUrls、allowedControlHosts、allowedControlPorts。
未沙箱化的項目:
- Gateway 程序本身。
- 任何被明確允許在沙箱外執行的工具(例如
tools.elevated)。- 提權執行會繞過沙箱並使用配置的逃逸路徑(預設為
gateway,當執行目標是node時則為node)。 - 如果停用沙盒機制,
tools.elevated不會改變執行方式(本來就在主機上)。請參閱 提權模式。
- 提權執行會繞過沙箱並使用配置的逃逸路徑(預設為
agents.defaults.sandbox.mode 控制何時使用沙箱:
無沙箱。
僅對非主要會話進行沙箱處理(如果您希望一般對話在主機上執行,這是預設值)。
"non-main" 是基於 session.mainKey(預設 "main"),而非代理程式 ID。群組/頻道會話使用自己的金鑰,因此它們被視為非主要會話並將進入沙箱。
每個會話都在沙箱中執行。
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 外掛程式 |
| 工作區模型 | Bind-mount 或複製 | 遠端為主(種子一次) | mirror 或 remote |
| 網路控制 | docker.network(預設:無) | 取決於遠端主機 | 取決於 OpenShell |
| 瀏覽器沙箱 | 支援 | 不支援 | 尚不支援 |
| 綁定掛載 | docker.binds | 不適用 | 不適用 |
| 最適用於 | 本地開發,完全隔離 | 卸載到遠端機器 | 受管遠端沙箱,具備可選雙向同步 |
Docker 後端
Section titled “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 後端
Section titled “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 會從本地工作區將該遠端工作區種入一次。
- 之後,
exec、read、write、edit、apply_patch、提示媒體讀取和傳入媒體暫存會直接透過 SSH 對遠端工作區執行。 - OpenClaw 不會自動將遠端變更同步回本地工作區。
驗證資料
identityFile、certificateFile、knownHostsFile:使用現有的本地檔案並透過 OpenSSH 設定傳遞它們。identityData、certificateData、knownHostsData:使用內聯字串或 SecretRefs。OpenClaw 會透過正常的 secrets 執行時期快照解析它們,將它們以0600寫入暫存檔案,並在 SSH 會話結束時刪除它們。- 如果為同一個項目同時設定了
*File和*Data,則*Data在該 SSH 會話中優先生效。
以遠端為準的後果
這是一個以遠端為準的模型。遠端 SSH 工作區在初始種入後會成為真實的沙盒狀態。
- 在種入步驟之後,於 OpenClaw 之外進行的本機主機編輯不會在遠端顯示,直到您重新建立沙盒為止。
openclaw sandbox recreate會刪除每個範圍的遠端根目錄,並在下次使用時從本地再次種入。- SSH 後端不支援瀏覽器沙盒。
sandbox.docker.*設定不適用於 SSH 後端。
OpenShell 後端
Section titled “OpenShell 後端”當您希望 OpenClaw 在 OpenShell 管理的遠端環境中對工具進行沙盒化時,請使用 backend: "openshell"。如需完整的設定指南、設定參考以及工作區模式比較,請參閱專屬的 OpenShell 頁面。
OpenShell 重複使用與一般 SSH 後端相同的核心 SSH 傳輸和遠端檔案系統橋接器,並新增了 OpenShell 專有的生命週期 (sandbox create/get/delete、sandbox 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 會在執行前將本地檔案同步至 OpenShell,並在執行後將遠端工作區同步回來。remote:建立沙盒後,OpenShell 工作區即為標準。OpenClaw 會從本地工作區向遠端工作區播種一次,之後檔案工具和執行操作會直接在遠端沙盒上執行,而不會將變更同步回來。
Remote transport details
- OpenClaw 透過 `openshell sandbox ssh-config
向 OpenShell 要求沙盒專屬的 SSH 設定。 - Core 將該 SSH 設定寫入暫存檔,開啟 SSH 連線,並重複使用與backend: “ssh”相同的遠端檔案系統橋接器。 - 在mirror` 模式下,只有生命週期不同:在執行前將本地同步至遠端,然後在執行後同步回來。
Current OpenShell limitations
- 尚不支援沙盒瀏覽器
- OpenShell 後端不支援
sandbox.docker.binds sandbox.docker.*下的 Docker 專用執行時選項仍僅適用於 Docker 後端
OpenShell 有兩種工作區模型。這是在實務上最重要的部分。
當您希望 本機工作區保持為標準 時,請使用 plugins.entries.openshell.config.mode: "mirror"。
行為:
- 在
exec之前,OpenClaw 會將本機工作區同步至 OpenShell 沙箱。 - 在
exec之後,OpenClaw 會將遠端工作區同步回本機工作區。 - 檔案工具仍透過沙箱橋接運作,但本機工作區在回合之間仍維持為唯一真實來源。
在以下情況使用:
- 您在 OpenClaw 外部編輯本機檔案,並希望這些變更自動顯示在沙箱中
- 您希望 OpenShell 沙箱的行為盡可能接近 Docker 後端
- 您希望主機工作區在每次 exec 回合後反映沙箱的寫入
權衡:在 exec 前後需要額外的同步成本。
當您希望 OpenShell 工作區成為標準 時,請使用 plugins.entries.openshell.config.mode: "remote"。
行為:
- 當沙箱首次建立時,OpenClaw 會從本機工作區植入遠端工作區一次。
- 之後,
exec、read、write、edit和apply_patch會直接對遠端 OpenShell 工作區運作。 - OpenClaw 不會 在 exec 後將遠端變更同步回本機工作區。
- 提示時段的媒體讀取仍可運作,因為檔案和媒體工具是透過沙箱橋接讀取,而非假設本機主機路徑。
- 傳輸方式是 SSH 連入由
openshell sandbox ssh-config傳回的 OpenShell 沙箱。
重要後果:
- 如果您在植入步驟之後於 OpenClaw 外部編輯主機上的檔案,遠端沙箱將不會自動看到這些變更。
- 如果重建沙箱,將會再次從本機工作區植入遠端工作區。
- 使用
scope: "agent"或scope: "shared"時,該遠端工作區會在相同範圍內共享。
在以下情況使用:
- 沙箱應主要存在於遠端 OpenShell 端
- 您希望降低每回合的同步負擔
- 您不希望主機本機的編輯無聲地覆寫遠端沙箱狀態
如果您將沙盒視為暫時的執行環境,請選擇 mirror。如果您將沙盒視為真正的工作區,請選擇 remote。
OpenShell 生命週期
Section titled “OpenShell 生命週期”OpenShell 沙箱仍然透過正常的沙箱生命週期進行管理:
openclaw sandbox list會顯示 OpenShell 執行時 以及 Docker 執行時openclaw sandbox recreate會刪除目前的執行時,並讓 OpenClaw 在下次使用時重新建立它- prune 邏輯也具備後端感知能力
對於 remote 模式,重新建立尤其重要:
- recreate 會刪除該範圍的標準遠端工作區
- 下次使用時會從本機工作區重新播種一個全新的遠端工作區
對於 mirror 模式,重新建立主要會重設遠端執行環境,因為本機工作區本來就是正規來源。
agents.defaults.sandbox.workspaceAccess 控制 沙盒可以看到什麼:
工具會看到位於 ~/.openclaw/sandboxes 下的沙盒工作區。
以唯讀方式在 /agent 掛載代理程式工作區 (停用 write/edit/apply_patch)。
以讀寫方式在 /workspace 掛載代理程式工作區。
使用 OpenShell 後端時:
mirror模式仍然在執行轉換之間使用本機工作區作為正規來源remote模式在初始種子之後使用遠端 OpenShell 工作區作為正規來源workspaceAccess: "ro"和"none"仍然以相同方式限制寫入行為
傳入的媒體會被複製到使用中的沙盒工作區 (media/inbound/*)。
自訂綁定掛載
Section titled “自訂綁定掛載”agents.defaults.sandbox.docker.binds 將額外的主機目錄掛載到容器中。格式:host:container:mode (例如 "/home/user/source:/source:rw")。
全域和單一代理的綁定會被合併(而非替換)。在 scope: "shared" 下,單一代理的綁定會被忽略。
agents.defaults.sandbox.browser.binds 僅會將額外的主機目錄掛載至 sandbox browser 容器中。
- 當設定時(包含
[]),它會取代瀏覽器容器的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"], }, }, }, ], },}映像檔與設定
Section titled “映像檔與設定”預設 Docker 映像檔:openclaw-sandbox:bookworm-slim
建構預設映像檔
從 source checkout:
Terminal window scripts/sandbox-setup.sh從 npm install(不需要 source checkout):
Terminal window docker build -t openclaw-sandbox:bookworm-slim - <<'DOCKERFILE'FROM debian:bookworm-slimENV DEBIAN_FRONTEND=noninteractiveRUN 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 sandboxUSER sandboxWORKDIR /home/sandboxCMD ["sleep", "infinity"]DOCKERFILE預設映像檔不包含 Node。如果技能需要 Node(或其他執行環境),請製作自訂映像檔或透過
sandbox.docker.setupCommand安裝(需要網路出口 + 可寫入根目錄 + root 使用者)。當缺少
openclaw-sandbox:bookworm-slim時,OpenClaw 不會無聲地替換純debian:bookworm-slim。以預設映像檔為目標的沙盒執行會在您建構它之前快速失敗,並顯示建構指令,因為隨附的映像檔攜帶了用於沙盒寫入/編輯輔助工具的python3。選用:建構通用映像檔
若要使用通用工具獲得功能更齊全的沙盒映像檔(例如
curl、jq、nodejs、python3、git):從 source checkout:
Terminal window scripts/sandbox-common-setup.sh從 npm install,請先建構預設映像檔(見上文),然後使用儲存庫中的
scripts/docker/sandbox/Dockerfile.common在其上方建構通用映像檔。然後將
agents.defaults.sandbox.docker.image設定為openclaw-sandbox-common:bookworm-slim。選用:建構沙盒瀏覽器映像檔
從 source checkout:
Terminal window scripts/sandbox-browser-setup.sh從 npm install,請使用儲存庫中的
scripts/docker/sandbox/Dockerfile.browser進行建構。
預設情況下,Docker 沙箱容器以無網路模式執行。可以使用 agents.defaults.sandbox.docker.network 覆寫。
沙箱瀏覽器 Chromium 預設值
隨附的沙箱瀏覽器映像檔也針對容器化工作負載套用了保守的 Chromium 啟動預設值。目前的容器預設值包括:
--remote-debugging-address=127.0.0.1- `—remote-debugging-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 -—no-sandbox當啟用noSandbox 時。 - 三個圖形硬化旗標 (—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=2由OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=
控制,其中0` 會保留 Chromium 的預設值。
如果您需要不同的執行設定檔,請使用自訂瀏覽器映像檔並提供您自己的進入點 (entrypoint)。對於本機 (非容器) Chromium 設定檔,請使用 `browser.extraArgs` 附加額外的啟動旗標。網路安全性預設值
network: "host"已被封鎖。- `network: “container:
“ 預設已被封鎖 (命名空間加入繞過風險)。 - 緊急覆寫:agents.defaults.sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true`。
Docker 安裝與容器化閘道位於此處:Docker
對於 Docker 閘道部署,scripts/docker/setup.sh 可以啟動沙盒配置。設定 OPENCLAW_SANDBOX=1(或 true/yes/on)以啟用該路徑。您可以使用 OPENCLAW_DOCKER_SOCKET 覆蓋 socket 位置。完整設定與環境變數參考:Docker。
setupCommand(一次性容器設定)
Section titled “setupCommand(一次性容器設定)”setupCommand 在建立沙盒容器後執行一次(而非每次執行時)。它透過 sh -lc 在容器內執行。
路徑:
- 全域:
agents.defaults.sandbox.docker.setupCommand - 每個代理程式:
agents.list[].sandbox.docker.setupCommand
常見陷阱
- 預設的
docker.network為"none"(無出口流量),因此套件安裝將會失敗。 - `docker.network: “container:
“需要dangerouslyAllowContainerNamespaceJoin: true且僅用於緊急情況。 -readOnlyRoot: true會防止寫入;請設定readOnlyRoot: false或建置自訂映像檔。 -user必須是 root 才能安裝套件(省略user或設定user: “0:0”)。 - 沙盒執行**不會**繼承主機 process.env。請使用 agents.defaults.sandbox.docker.env(或自訂映像檔)來存放技能 API 金鑰。 - agents.defaults.sandbox.docker.env中的值會以明確的 Docker 容器環境變數形式傳遞。任何擁有 Docker daemon 存取權的人都可以使用 Docker 中繼資料命令(例如docker inspect`)來檢查它們。如果無法接受該中繼資料暴露風險,請使用自訂映像檔、掛載的秘密檔案或其他秘密傳遞路徑。
工具原則與緊急應變措施
Section titled “工具原則與緊急應變措施”工具允許/拒絕原則仍會在沙盒規則之前套用。如果某個工具在全域或針對特定代理程式被拒絕,沙盒機制無法使其恢復。
tools.elevated 是一個明確的緊急應變機制(escape hatch),會在沙箱外執行 exec(預設為 gateway,當執行目標為 node 時則為 node)。/exec 指令僅適用於經授權的發送者,並在每個工作階段中持續有效;若要徹底停用 exec,請使用工具政策拒絕(tool policy deny)(請參閱 Sandbox vs Tool Policy vs Elevated)。
除錯:
- 使用
openclaw sandbox explain來檢查有效的沙箱模式、工具政策和修復(fix-it)配置鍵。 - 請參閱 Sandbox vs Tool Policy vs Elevated 以了解「為什麼這被封鎖了?」的心智模型。
保持鎖定狀態。
多重代理覆寫
Section titled “多重代理覆寫”每個代理程式(agent)都可以覆寫沙箱和工具設定:agents.list[].sandbox 和 agents.list[].tools(加上用於沙箱工具政策的 agents.list[].tools.sandbox.tools)。請參閱 Multi-Agent Sandbox & Tools 以了解優先順序。
最小啟用範例
Section titled “最小啟用範例”{ agents: { defaults: { sandbox: { mode: "non-main", scope: "session", workspaceAccess: "none", }, }, },}- Multi-Agent Sandbox & Tools — 每個代理程式的覆寫與優先順序
- OpenShell — 受管沙箱後端設定、工作區模式和配置參考
- Sandbox configuration
- Sandbox vs Tool Policy vs Elevated — 除錯「為什麼這被封鎖了?」
- Security