Gateway

Afgeschermde uitvoering

Status: active

OpenClaw kan tools binnen sandbox-backends uitvoeren om de impactradius te beperken. Dit is optioneel en wordt door configuratie beheerd (agents.defaults.sandbox of agents.list[].sandbox). Als sandboxing uit staat, draaien tools op de host. De Gateway blijft op de host; tooluitvoering draait in een geisoleerde sandbox wanneer dit is ingeschakeld.

Wat wordt in een sandbox uitgevoerd

  • Tooluitvoering (exec, read, write, edit, apply_patch, process, enz.).
  • Optionele browser in sandbox (agents.defaults.sandbox.browser).
Details van browser in sandbox
  • Standaard start de sandboxbrowser automatisch (zorgt ervoor dat CDP bereikbaar is) wanneer de browsertool die nodig heeft. Configureer via agents.defaults.sandbox.browser.autoStart en agents.defaults.sandbox.browser.autoStartTimeoutMs.
  • Standaard gebruiken sandboxbrowsercontainers een speciaal Docker-netwerk (openclaw-sandbox-browser) in plaats van het globale bridge-netwerk. Configureer met agents.defaults.sandbox.browser.network.
  • Optioneel beperkt agents.defaults.sandbox.browser.cdpSourceRange CDP-ingress aan de containerrand met een CIDR-allowlist (bijvoorbeeld 172.21.0.1/32).
  • noVNC-observertoegang is standaard met een wachtwoord beschermd; OpenClaw geeft een kortlevende token-URL uit die een lokale bootstrappagina serveert en noVNC opent met het wachtwoord in het URL-fragment (niet in query-/headerlogs).
  • agents.defaults.sandbox.browser.allowHostControl laat sandboxsessies expliciet de hostbrowser aansturen.
  • Optionele allowlists bewaken target: "custom": allowedControlUrls, allowedControlHosts, allowedControlPorts.

Niet in een sandbox uitgevoerd:

  • Het Gateway-proces zelf.
  • Elke tool die expliciet buiten de sandbox mag draaien (bijv. tools.elevated).
    • Elevated exec omzeilt sandboxing en gebruikt het geconfigureerde ontsnappingspad (gateway standaard, of node wanneer het exec-doel node is).
    • Als sandboxing uit staat, verandert tools.elevated de uitvoering niet (al op de host). Zie Elevated Mode.

Modi

agents.defaults.sandbox.mode bepaalt wanneer sandboxing wordt gebruikt:

off

Geen sandboxing.

non-main

Alleen niet-main sessies in een sandbox (standaard als je normale chats op de host wilt).

"non-main" is gebaseerd op session.mainKey (standaard "main"), niet op agent-id. Groeps-/kanaalsessies gebruiken hun eigen sleutels, dus ze tellen als niet-main en worden in een sandbox uitgevoerd.

all

Elke sessie draait in een sandbox.

Bereik

agents.defaults.sandbox.scope bepaalt hoeveel containers worden gemaakt:

  • "agent" (standaard): een container per agent.
  • "session": een container per sessie.
  • "shared": een container gedeeld door alle sandboxsessies.

Backend

agents.defaults.sandbox.backend bepaalt welke runtime de sandbox levert:

  • "docker" (standaard wanneer sandboxing is ingeschakeld): lokale door Docker ondersteunde sandboxruntime.
  • "ssh": generieke door SSH ondersteunde externe sandboxruntime.
  • "openshell": door OpenShell ondersteunde sandboxruntime.

SSH-specifieke configuratie staat onder agents.defaults.sandbox.ssh. OpenShell-specifieke configuratie staat onder plugins.entries.openshell.config.

Een backend kiezen

Docker SSH OpenShell
Waar het draait Lokale container Elke via SSH bereikbare host Door OpenShell beheerde sandbox
Setup scripts/sandbox-setup.sh SSH-sleutel + doelhost OpenShell-Plugin ingeschakeld
Werkruimtemodel Bind-mount of kopie Extern-canoniek (eenmalig seeden) mirror of remote
Netwerkbeheer docker.network (standaard: geen) Afhankelijk van externe host Afhankelijk van OpenShell
Browsersandbox Ondersteund Niet ondersteund Nog niet ondersteund
Bind mounts docker.binds n.v.t. n.v.t.
Beste voor Lokale ontwikkeling, volledige isolatie Uitbesteden aan een externe machine Beheerde externe sandboxes met optionele tweerichtingssynchronisatie

Docker-backend

Sandboxing staat standaard uit. Als je sandboxing inschakelt en geen backend kiest, gebruikt OpenClaw de Docker-backend. Die voert tools en sandboxbrowsers lokaal uit via de Docker-daemonsocket (/var/run/docker.sock). Isolatie van sandboxcontainers wordt bepaald door Docker-namespaces.

Om host-GPU's aan Docker-sandboxes bloot te stellen, stel je agents.defaults.sandbox.docker.gpus in of de per-agent-override agents.list[].sandbox.docker.gpus. De waarde wordt als afzonderlijk argument doorgegeven aan Docker's --gpus-vlag, bijvoorbeeld "all" of "device=GPU-uuid", en vereist een compatibele hostruntime zoals NVIDIA Container Toolkit.

SSH-backend

Gebruik backend: "ssh" wanneer je wilt dat OpenClaw exec, bestandstools en medialezingen in een sandbox op een willekeurige via SSH bereikbare machine uitvoert.

json5
{  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" },        },      },    },  },}
Hoe het werkt
  • OpenClaw maakt een externe root per bereik onder sandbox.ssh.workspaceRoot.
  • Bij eerste gebruik na aanmaken of opnieuw aanmaken seedt OpenClaw die externe werkruimte eenmalig vanuit de lokale werkruimte.
  • Daarna draaien exec, read, write, edit, apply_patch, promptmedialezingen en inkomende mediastaging rechtstreeks tegen de externe werkruimte via SSH.
  • OpenClaw synchroniseert externe wijzigingen niet automatisch terug naar de lokale werkruimte.
Authenticatiemateriaal
  • identityFile, certificateFile, knownHostsFile: gebruik bestaande lokale bestanden en geef ze door via OpenSSH-configuratie.
  • identityData, certificateData, knownHostsData: gebruik inline strings of SecretRefs. OpenClaw lost ze op via de normale secrets-runtime-snapshot, schrijft ze naar tijdelijke bestanden met 0600 en verwijdert ze wanneer de SSH-sessie eindigt.
  • Als zowel *File als *Data voor hetzelfde item zijn ingesteld, wint *Data voor die SSH-sessie.
Gevolgen van extern-canoniek

Dit is een extern-canoniek model. De externe SSH-werkruimte wordt na de initiele seed de echte sandboxstatus.

  • Host-lokale bewerkingen die buiten OpenClaw na de seedstap worden gemaakt, zijn extern niet zichtbaar totdat je de sandbox opnieuw aanmaakt.
  • openclaw sandbox recreate verwijdert de externe root per bereik en seedt opnieuw vanuit lokaal bij het volgende gebruik.
  • Browsersandboxing wordt niet ondersteund op de SSH-backend.
  • sandbox.docker.*-instellingen zijn niet van toepassing op de SSH-backend.

OpenShell-backend

Gebruik backend: "openshell" wanneer je wilt dat OpenClaw tools in een door OpenShell beheerde externe omgeving in een sandbox uitvoert. Zie de speciale OpenShell-pagina voor de volledige setupgids, configuratiereferentie en vergelijking van werkruimtemodi.

OpenShell hergebruikt hetzelfde kern-SSH-transport en dezelfde externe bestandssysteembridge als de generieke SSH-backend, en voegt OpenShell-specifieke lifecycle toe (sandbox create/get/delete, sandbox ssh-config) plus de optionele mirror-werkruimtemodus.

json5
{  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-modi:

  • mirror (standaard): de lokale werkruimte blijft canoniek. OpenClaw synchroniseert lokale bestanden naar OpenShell voor exec en synchroniseert de externe werkruimte terug na exec.
  • remote: de OpenShell-werkruimte is canoniek nadat de sandbox is gemaakt. OpenClaw seedt de externe werkruimte eenmalig vanuit de lokale werkruimte, waarna bestandstools en exec rechtstreeks tegen de externe sandbox draaien zonder wijzigingen terug te synchroniseren.
Details van extern transport
  • OpenClaw vraagt OpenShell om sandboxspecifieke SSH-configuratie via openshell sandbox ssh-config <name>.
  • Core schrijft die SSH-configuratie naar een tijdelijk bestand, opent de SSH-sessie en hergebruikt dezelfde externe bestandssysteembridge die door backend: "ssh" wordt gebruikt.
  • Alleen in mirror-modus verschilt de lifecycle: synchroniseer lokaal naar extern voor exec en synchroniseer daarna terug na exec.
Huidige OpenShell-beperkingen
  • sandboxbrowser wordt nog niet ondersteund
  • sandbox.docker.binds wordt niet ondersteund op de OpenShell-backend
  • Docker-specifieke runtimeknoppen onder sandbox.docker.* blijven alleen van toepassing op de Docker-backend

Werkruimtemodi

OpenShell heeft twee werkruimtemodellen. Dit is het deel dat in de praktijk het belangrijkst is.

mirror (lokaal canoniek)

Gebruik plugins.entries.openshell.config.mode: "mirror" wanneer je wilt dat de lokale werkruimte canoniek blijft.

Gedrag:

  • Vóór exec synchroniseert OpenClaw de lokale workspace naar de OpenShell-sandbox.
  • Na exec synchroniseert OpenClaw de externe workspace terug naar de lokale workspace.
  • Bestandstools werken nog steeds via de sandbox-bridge, maar de lokale workspace blijft tussen beurten de bron van waarheid.

Gebruik dit wanneer:

  • je bestanden lokaal buiten OpenClaw bewerkt en wilt dat die wijzigingen automatisch in de sandbox verschijnen
  • je wilt dat de OpenShell-sandbox zich zoveel mogelijk gedraagt als de Docker-backend
  • je wilt dat de host-workspace sandbox-schrijfacties weerspiegelt na elke exec-beurt

Afweging: extra synchronisatiekosten vóór en na exec.

remote (OpenShell canonical)

Gebruik plugins.entries.openshell.config.mode: "remote" wanneer je wilt dat de OpenShell-workspace canoniek wordt.

Gedrag:

  • Wanneer de sandbox voor het eerst wordt aangemaakt, vult OpenClaw de externe workspace eenmalig vanuit de lokale workspace.
  • Daarna werken exec, read, write, edit en apply_patch rechtstreeks tegen de externe OpenShell-workspace.
  • OpenClaw synchroniseert externe wijzigingen na exec niet terug naar de lokale workspace.
  • Media-lezingen tijdens prompts blijven werken omdat bestands- en mediatools via de sandbox-bridge lezen in plaats van uit te gaan van een lokaal hostpad.
  • Transport is SSH naar de OpenShell-sandbox die wordt geretourneerd door openshell sandbox ssh-config.

Belangrijke gevolgen:

  • Als je na de initiële vulling bestanden op de host buiten OpenClaw bewerkt, ziet de externe sandbox die wijzigingen niet automatisch.
  • Als de sandbox opnieuw wordt aangemaakt, wordt de externe workspace opnieuw gevuld vanuit de lokale workspace.
  • Met scope: "agent" of scope: "shared" wordt die externe workspace gedeeld op hetzelfde bereik.

Gebruik dit wanneer:

  • de sandbox primair aan de externe OpenShell-kant moet leven
  • je lagere synchronisatie-overhead per beurt wilt
  • je niet wilt dat host-lokale bewerkingen stilzwijgend de externe sandboxstatus overschrijven

Kies mirror als je de sandbox ziet als een tijdelijke uitvoeringsomgeving. Kies remote als je de sandbox ziet als de echte workspace.

OpenShell-levenscyclus

OpenShell-sandboxes worden nog steeds beheerd via de normale sandbox-levenscyclus:

  • openclaw sandbox list toont zowel OpenShell-runtimes als Docker-runtimes
  • openclaw sandbox recreate verwijdert de huidige runtime en laat OpenClaw die bij het volgende gebruik opnieuw aanmaken
  • opschoonlogica is ook backend-bewust

Voor de remote-modus is opnieuw aanmaken extra belangrijk:

  • opnieuw aanmaken verwijdert de canonieke externe workspace voor dat bereik
  • het volgende gebruik vult een nieuwe externe workspace vanuit de lokale workspace

Voor de mirror-modus reset opnieuw aanmaken vooral de externe uitvoeringsomgeving, omdat de lokale workspace toch canoniek blijft.

Workspace-toegang

agents.defaults.sandbox.workspaceAccess bepaalt wat de sandbox kan zien:

none (default)

Tools zien een sandbox-workspace onder ~/.openclaw/sandboxes.

ro

Koppelt de agent-workspace alleen-lezen op /agent (schakelt write/edit/apply_patch uit).

rw

Koppelt de agent-workspace lezen/schrijven op /workspace.

Met de OpenShell-backend:

  • mirror-modus gebruikt tussen exec-beurten nog steeds de lokale workspace als canonieke bron
  • remote-modus gebruikt na de initiële vulling de externe OpenShell-workspace als canonieke bron
  • workspaceAccess: "ro" en "none" beperken schrijfgdrag nog steeds op dezelfde manier

Binnenkomende media worden gekopieerd naar de actieve sandbox-workspace (media/inbound/*).

Aangepaste bind mounts

agents.defaults.sandbox.docker.binds koppelt extra hostmappen in de container. Formaat: host:container:mode (bijv. "/home/user/source:/source:rw").

Globale en per-agent binds worden samengevoegd (niet vervangen). Onder scope: "shared" worden per-agent binds genegeerd.

agents.defaults.sandbox.browser.binds koppelt extra hostmappen alleen in de sandboxbrowser-container.

  • Wanneer ingesteld (inclusief []), vervangt dit agents.defaults.sandbox.docker.binds voor de browsercontainer.
  • Wanneer weggelaten, valt de browsercontainer terug op agents.defaults.sandbox.docker.binds (achterwaarts compatibel).

Voorbeeld (alleen-lezen bron + een extra datamap):

json5
{  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"],          },        },      },    ],  },}

Images en setup

Standaard Docker-image: openclaw-sandbox:bookworm-slim

  • Build the default image

    Vanuit een bron-checkout:

    bash
    scripts/sandbox-setup.sh

    Vanuit een npm-installatie (geen bron-checkout nodig):

    bash
    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

    De standaard-image bevat geen Node. Als een skill Node (of andere runtimes) nodig heeft, bak dan een aangepaste image of installeer via sandbox.docker.setupCommand (vereist netwerk-egress + beschrijfbare root + rootgebruiker).

    OpenClaw vervangt niet stilzwijgend door gewone debian:bookworm-slim wanneer openclaw-sandbox:bookworm-slim ontbreekt. Sandbox-runs die op de standaard-image mikken, falen snel met een build-instructie totdat je die bouwt, omdat de gebundelde image python3 bevat voor sandbox-write/edit-helpers.

  • Optional: build the common image

    Voor een functionelere sandbox-image met veelgebruikte tooling (bijvoorbeeld curl, jq, nodejs, python3, git):

    Vanuit een bron-checkout:

    bash
    scripts/sandbox-common-setup.sh

    Bouw vanuit een npm-installatie eerst de standaard-image (zie hierboven) en bouw daarna de common-image erbovenop met de scripts/docker/sandbox/Dockerfile.common uit de repository.

    Stel daarna agents.defaults.sandbox.docker.image in op openclaw-sandbox-common:bookworm-slim.

  • Optional: build the sandbox browser image

    Vanuit een bron-checkout:

    bash
    scripts/sandbox-browser-setup.sh

    Bouw vanuit een npm-installatie met de scripts/docker/sandbox/Dockerfile.browser uit de repository.

  • Standaard draaien Docker-sandboxcontainers met geen netwerk. Overschrijf dit met agents.defaults.sandbox.docker.network.

    Sandbox browser Chromium defaults

    De gebundelde sandboxbrowser-image past ook conservatieve Chromium-opstartstandaarden toe voor gecontaineriseerde workloads. Huidige containerstandaarden omvatten:

    • --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
    • --no-sandbox wanneer noSandbox is ingeschakeld.
    • De drie graphics-hardening-flags (--disable-3d-apis, --disable-software-rasterizer, --disable-gpu) zijn optioneel en nuttig wanneer containers geen GPU-ondersteuning hebben. Stel OPENCLAW_BROWSER_DISABLE_GRAPHICS_FLAGS=0 in als je workload WebGL of andere 3D-/browserfuncties vereist.
    • --disable-extensions is standaard ingeschakeld en kan worden uitgeschakeld met OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0 voor flows die afhankelijk zijn van extensies.
    • --renderer-process-limit=2 wordt geregeld door OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=&lt;N&gt;, waarbij 0 de standaard van Chromium behoudt.

    Als je een ander runtimeprofiel nodig hebt, gebruik dan een aangepaste browser-image en lever je eigen entrypoint. Gebruik voor lokale (niet-container) Chromium-profielen browser.extraArgs om extra opstartflags toe te voegen.

    Network security defaults
    • network: "host" wordt geblokkeerd.
    • network: "container:<id>" wordt standaard geblokkeerd (risico op omzeiling via namespace-join).
    • Break-glass-override: agents.defaults.sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true.

    Docker-installaties en de gecontaineriseerde Gateway staan hier: Docker

    Voor Docker Gateway-deployments kan scripts/docker/setup.sh sandboxconfiguratie bootstrappen. Stel OPENCLAW_SANDBOX=1 (of true/yes/on) in om dat pad in te schakelen. Je kunt de socketlocatie overschrijven met OPENCLAW_DOCKER_SOCKET. Volledige setup- en env-referentie: Docker.

    setupCommand (eenmalige container-setup)

    setupCommand draait één keer nadat de sandboxcontainer is aangemaakt (niet bij elke run). Het wordt binnen de container uitgevoerd via sh -lc.

    Paden:

    • Globaal: agents.defaults.sandbox.docker.setupCommand
    • Per agent: agents.list[].sandbox.docker.setupCommand
    Common pitfalls
    • Standaard is docker.network "none" (geen uitgaand netwerkverkeer), dus pakketinstallaties mislukken.
    • docker.network: "container:<id>" vereist dangerouslyAllowContainerNamespaceJoin: true en is alleen voor noodsituaties.
    • readOnlyRoot: true voorkomt schrijfacties; stel readOnlyRoot: false in of bak een aangepaste image.
    • user moet root zijn voor pakketinstallaties (laat user weg of stel user: "0:0" in).
    • Sandbox exec erft host-process.env niet. Gebruik agents.defaults.sandbox.docker.env (of een aangepaste image) voor skill-API-sleutels.

    Toolbeleid en uitwijkroutes

    Beleid voor toestaan/weigeren van tools blijft gelden vóór sandboxregels. Als een tool globaal of per agent wordt geweigerd, brengt sandboxing deze niet terug.

    tools.elevated is een expliciete uitwijkroute die exec buiten de sandbox uitvoert (standaard gateway, of node wanneer het exec-doel node is). /exec-directieven gelden alleen voor geautoriseerde afzenders en blijven per sessie behouden; gebruik toolbeleid met weigeren om exec hard uit te schakelen (zie Sandbox vs Tool Policy vs Elevated).

    Debuggen:

    • Gebruik openclaw sandbox explain om de effectieve sandboxmodus, het toolbeleid en fix-it-configuratiesleutels te inspecteren.
    • Zie Sandbox vs Tool Policy vs Elevated voor het mentale model achter "waarom wordt dit geblokkeerd?".

    Houd het vergrendeld.

    Multi-agent-overrides

    Elke agent kan sandbox + tools overschrijven: agents.list[].sandbox en agents.list[].tools (plus agents.list[].tools.sandbox.tools voor sandbox-toolbeleid). Zie Multi-Agent Sandbox & Tools voor prioriteit.

    Minimaal inschakelvoorbeeld

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

    Gerelateerd

    Was this useful?