Gateway

Aislamiento en entorno limitado

OpenClaw puede ejecutar herramientas dentro de backends de sandbox para reducir el radio de impacto. Esto es opcional y se controla mediante configuración (agents.defaults.sandbox o agents.list[].sandbox). Si el sandboxing está desactivado, las herramientas se ejecutan en el host. El Gateway permanece en el host; la ejecución de herramientas se realiza en un sandbox aislado cuando está habilitada.

Qué se ejecuta en sandbox

  • Ejecución de herramientas (exec, read, write, edit, apply_patch, process, etc.).
  • Navegador opcional en sandbox (agents.defaults.sandbox.browser).
Detalles del navegador en sandbox
  • De forma predeterminada, el navegador en sandbox se inicia automáticamente (garantiza que CDP sea accesible) cuando la herramienta de navegador lo necesita. Configúralo mediante agents.defaults.sandbox.browser.autoStart y agents.defaults.sandbox.browser.autoStartTimeoutMs.
  • De forma predeterminada, los contenedores del navegador en sandbox usan una red de Docker dedicada (openclaw-sandbox-browser) en lugar de la red global bridge. Configúralo con agents.defaults.sandbox.browser.network.
  • El agents.defaults.sandbox.browser.cdpSourceRange opcional restringe la entrada CDP en el borde del contenedor con una lista de CIDR permitidos (por ejemplo, 172.21.0.1/32).
  • El acceso de observador noVNC está protegido con contraseña de forma predeterminada; OpenClaw emite una URL de token de corta duración que sirve una página de arranque local y abre noVNC con la contraseña en el fragmento de la URL (no en registros de consulta/cabecera).
  • agents.defaults.sandbox.browser.allowHostControl permite que las sesiones en sandbox apunten explícitamente al navegador del host.
  • Las listas de permitidos opcionales controlan target: "custom": allowedControlUrls, allowedControlHosts, allowedControlPorts.

No se ejecuta en sandbox:

  • El propio proceso del Gateway.
  • Cualquier herramienta autorizada explícitamente para ejecutarse fuera del sandbox (por ejemplo, tools.elevated).
    • La ejecución elevada omite el sandboxing y usa la ruta de escape configurada (gateway de forma predeterminada, o node cuando el destino de ejecución es node).
    • Si el sandboxing está desactivado, tools.elevated no cambia la ejecución (ya se ejecuta en el host). Consulta Modo elevado.

Modos

agents.defaults.sandbox.mode controla cuándo se usa el sandboxing:

off

Sin sandboxing.

non-main

Solo las sesiones no principales se ejecutan en sandbox (valor predeterminado si quieres chats normales en el host).

"non-main" se basa en session.mainKey (valor predeterminado "main"), no en el id del agente. Las sesiones de grupo/canal usan sus propias claves, por lo que cuentan como no principales y se ejecutarán en sandbox.

all

Todas las sesiones se ejecutan en un sandbox.

Alcance

agents.defaults.sandbox.scope controla cuántos contenedores se crean:

  • "agent" (valor predeterminado): un contenedor por agente.
  • "session": un contenedor por sesión.
  • "shared": un contenedor compartido por todas las sesiones en sandbox.

Backend

agents.defaults.sandbox.backend controla qué runtime proporciona el sandbox:

  • "docker" (valor predeterminado cuando el sandboxing está habilitado): runtime de sandbox local respaldado por Docker.
  • "ssh": runtime de sandbox remoto genérico respaldado por SSH.
  • "openshell": runtime de sandbox respaldado por OpenShell.

La configuración específica de SSH está en agents.defaults.sandbox.ssh. La configuración específica de OpenShell está en plugins.entries.openshell.config.

Elegir un backend

Docker SSH OpenShell
Dónde se ejecuta Contenedor local Cualquier host accesible por SSH Sandbox gestionado por OpenShell
Configuración scripts/sandbox-setup.sh Clave SSH + host de destino Plugin OpenShell habilitado
Modelo de workspace Montaje bind o copia Canónico remoto (se inicializa una vez) mirror o remote
Control de red docker.network (valor predeterminado: none) Depende del host remoto Depende de OpenShell
Navegador en sandbox Compatible No compatible Aún no compatible
Montajes bind docker.binds N/A N/A
Ideal para Desarrollo local, aislamiento completo Descargar trabajo a una máquina remota Sandboxes remotos gestionados con sincronización bidireccional opcional

Backend Docker

El sandboxing está desactivado de forma predeterminada. Si habilitas el sandboxing y no eliges un backend, OpenClaw usa el backend Docker. Ejecuta herramientas y navegadores en sandbox localmente mediante el socket del daemon de Docker (/var/run/docker.sock). El aislamiento de contenedores de sandbox está determinado por los namespaces de Docker.

Para exponer GPUs del host a sandboxes de Docker, configura agents.defaults.sandbox.docker.gpus o la sobrescritura por agente agents.list[].sandbox.docker.gpus. El valor se pasa a la marca --gpus de Docker como un argumento separado, por ejemplo "all" o "device=GPU-uuid", y requiere un runtime de host compatible, como NVIDIA Container Toolkit.

Backend SSH

Usa backend: "ssh" cuando quieras que OpenClaw ejecute en sandbox exec, herramientas de archivos y lecturas multimedia en una máquina arbitraria accesible por 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" },
        },
      },
    },
  },
}
Cómo funciona
  • OpenClaw crea una raíz remota por alcance bajo sandbox.ssh.workspaceRoot.
  • En el primer uso tras crear o recrear, OpenClaw inicializa ese workspace remoto desde el workspace local una vez.
  • Después de eso, exec, read, write, edit, apply_patch, las lecturas multimedia del prompt y el staging de medios entrantes se ejecutan directamente contra el workspace remoto sobre SSH.
  • OpenClaw no sincroniza automáticamente los cambios remotos de vuelta al workspace local.
Material de autenticación
  • identityFile, certificateFile, knownHostsFile: usan archivos locales existentes y los pasan mediante la configuración de OpenSSH.
  • identityData, certificateData, knownHostsData: usan cadenas en línea o SecretRefs. OpenClaw las resuelve mediante la instantánea normal del runtime de secretos, las escribe en archivos temporales con 0600 y las elimina cuando termina la sesión SSH.
  • Si tanto *File como *Data están configurados para el mismo elemento, *Data prevalece en esa sesión SSH.
Consecuencias del modelo canónico remoto

Este es un modelo canónico remoto. El workspace SSH remoto se convierte en el estado real del sandbox después de la inicialización inicial.

  • Las ediciones locales del host hechas fuera de OpenClaw después del paso de inicialización no son visibles remotamente hasta que recreas el sandbox.
  • openclaw sandbox recreate elimina la raíz remota por alcance y vuelve a inicializar desde local en el siguiente uso.
  • El sandboxing del navegador no es compatible con el backend SSH.
  • La configuración sandbox.docker.* no se aplica al backend SSH.

Backend OpenShell

Usa backend: "openshell" cuando quieras que OpenClaw ejecute herramientas en sandbox en un entorno remoto gestionado por OpenShell. Para la guía completa de configuración, la referencia de configuración y la comparación de modos de workspace, consulta la página de OpenShell dedicada.

OpenShell reutiliza el mismo transporte SSH central y el mismo puente de sistema de archivos remoto que el backend SSH genérico, y añade ciclo de vida específico de OpenShell (sandbox create/get/delete, sandbox ssh-config) más el modo de workspace mirror opcional.

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

Modos de OpenShell:

  • mirror (valor predeterminado): el workspace local permanece canónico. OpenClaw sincroniza archivos locales hacia OpenShell antes de exec y sincroniza el workspace remoto de vuelta después de exec.
  • remote: el workspace de OpenShell es canónico después de crear el sandbox. OpenClaw inicializa el workspace remoto una vez desde el workspace local; luego, las herramientas de archivos y exec se ejecutan directamente contra el sandbox remoto sin sincronizar los cambios de vuelta.
Detalles del transporte remoto
  • OpenClaw solicita a OpenShell configuración SSH específica del sandbox mediante openshell sandbox ssh-config <name>.
  • Core escribe esa configuración SSH en un archivo temporal, abre la sesión SSH y reutiliza el mismo puente de sistema de archivos remoto usado por backend: "ssh".
  • En modo mirror, solo difiere el ciclo de vida: sincronizar local a remoto antes de exec y luego volver a sincronizar después de exec.
Limitaciones actuales de OpenShell
  • el navegador en sandbox aún no es compatible
  • sandbox.docker.binds no es compatible con el backend OpenShell
  • los controles de runtime específicos de Docker bajo sandbox.docker.* siguen aplicándose solo al backend Docker

Modos de workspace

OpenShell tiene dos modelos de workspace. Esta es la parte que más importa en la práctica.

mirror (canónico local)

Usa plugins.entries.openshell.config.mode: "mirror" cuando quieras que el workspace local permanezca canónico.

Comportamiento:

  • Antes de exec, OpenClaw sincroniza el workspace local hacia el sandbox de OpenShell.
  • Después de exec, OpenClaw sincroniza el workspace remoto de vuelta al workspace local.
  • Las herramientas de archivos siguen operando mediante el puente del sandbox, pero el workspace local sigue siendo la fuente de verdad entre turnos.

Usa esto cuando:

  • editas archivos localmente fuera de OpenClaw y quieres que esos cambios aparezcan automáticamente en el sandbox
  • quieres que el sandbox de OpenShell se comporte lo más parecido posible al backend Docker
  • quieres que el workspace del host refleje las escrituras del sandbox después de cada turno de exec

Contrapartida: coste adicional de sincronización antes y después de exec.

remote (OpenShell canonical)

Usa plugins.entries.openshell.config.mode: "remote" cuando quieras que el workspace de OpenShell pase a ser canónico.

Comportamiento:

  • Cuando se crea el sandbox por primera vez, OpenClaw inicializa el workspace remoto desde el workspace local una vez.
  • Después de eso, exec, read, write, edit y apply_patch operan directamente sobre el workspace remoto de OpenShell.
  • OpenClaw no sincroniza los cambios remotos de vuelta al workspace local después de exec.
  • Las lecturas de medios en el momento del prompt siguen funcionando porque las herramientas de archivos y medios leen a través del puente del sandbox en lugar de asumir una ruta local del host.
  • El transporte es SSH hacia el sandbox de OpenShell devuelto por openshell sandbox ssh-config.

Consecuencias importantes:

  • Si editas archivos en el host fuera de OpenClaw después del paso de inicialización, el sandbox remoto no verá esos cambios automáticamente.
  • Si se recrea el sandbox, el workspace remoto se inicializa de nuevo desde el workspace local.
  • Con scope: "agent" o scope: "shared", ese workspace remoto se comparte en ese mismo ámbito.

Usa esto cuando:

  • el sandbox deba vivir principalmente en el lado remoto de OpenShell
  • quieras menor sobrecarga de sincronización por turno
  • no quieras que las ediciones locales del host sobrescriban silenciosamente el estado del sandbox remoto

Elige mirror si piensas en el sandbox como un entorno de ejecución temporal. Elige remote si piensas en el sandbox como el workspace real.

Ciclo de vida de OpenShell

Los sandboxes de OpenShell siguen gestionándose mediante el ciclo de vida normal del sandbox:

  • openclaw sandbox list muestra runtimes de OpenShell, así como runtimes de Docker
  • openclaw sandbox recreate elimina el runtime actual y permite que OpenClaw lo recree en el siguiente uso
  • la lógica de limpieza también conoce el backend

Para el modo remote, recrear es especialmente importante:

  • recrear elimina el workspace remoto canónico para ese ámbito
  • el siguiente uso inicializa un workspace remoto nuevo desde el workspace local

Para el modo mirror, recrear restablece principalmente el entorno de ejecución remoto porque el workspace local sigue siendo canónico de todos modos.

Acceso al workspace

agents.defaults.sandbox.workspaceAccess controla qué puede ver el sandbox:

none (default)

Las herramientas ven un workspace de sandbox bajo ~/.openclaw/sandboxes.

ro

Monta el workspace del agente como solo lectura en /agent (deshabilita write/edit/apply_patch).

rw

Monta el workspace del agente como lectura/escritura en /workspace.

Con el backend de OpenShell:

  • el modo mirror sigue usando el workspace local como fuente canónica entre turnos de exec
  • el modo remote usa el workspace remoto de OpenShell como fuente canónica después de la inicialización inicial
  • workspaceAccess: "ro" y "none" siguen restringiendo el comportamiento de escritura de la misma manera

Los medios entrantes se copian en el workspace del sandbox activo (media/inbound/*).

Montajes bind personalizados

agents.defaults.sandbox.docker.binds monta directorios adicionales del host en el contenedor. Formato: host:container:mode (por ejemplo, "/home/user/source:/source:rw").

Los binds globales y por agente se fusionan (no se reemplazan). Bajo scope: "shared", los binds por agente se ignoran.

agents.defaults.sandbox.browser.binds monta directorios adicionales del host solo en el contenedor del navegador del sandbox.

  • Cuando se define (incluido []), reemplaza agents.defaults.sandbox.docker.binds para el contenedor del navegador.
  • Cuando se omite, el contenedor del navegador recurre a agents.defaults.sandbox.docker.binds (compatible con versiones anteriores).

Ejemplo (fuente de solo lectura + un directorio de datos adicional):

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

Imágenes y configuración

Imagen Docker predeterminada: openclaw-sandbox:bookworm-slim

  • Build the default image

    Desde un checkout de fuente:

    scripts/sandbox-setup.sh
    

    Desde una instalación npm (no se necesita checkout de fuente):

    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
    

    La imagen predeterminada no incluye Node. Si una skill necesita Node (u otros runtimes), crea una imagen personalizada o instala mediante sandbox.docker.setupCommand (requiere salida de red + raíz escribible + usuario root).

    OpenClaw no sustituye silenciosamente por debian:bookworm-slim sin más cuando falta openclaw-sandbox:bookworm-slim. Las ejecuciones de sandbox que apuntan a la imagen predeterminada fallan rápido con una instrucción de compilación hasta que la compiles, porque la imagen incluida lleva python3 para los auxiliares de escritura/edición del sandbox.

  • Optional: build the common image

    Para una imagen de sandbox más funcional con herramientas comunes (por ejemplo curl, jq, nodejs, python3, git):

    Desde un checkout de fuente:

    scripts/sandbox-common-setup.sh
    

    Desde una instalación npm, compila primero la imagen predeterminada (ver arriba) y luego compila la imagen común encima usando el scripts/docker/sandbox/Dockerfile.common del repositorio.

    Luego establece agents.defaults.sandbox.docker.image en openclaw-sandbox-common:bookworm-slim.

  • Optional: build the sandbox browser image

    Desde un checkout de fuente:

    scripts/sandbox-browser-setup.sh
    

    Desde una instalación npm, compila usando el scripts/docker/sandbox/Dockerfile.browser del repositorio.

  • De forma predeterminada, los contenedores de sandbox de Docker se ejecutan sin red. Sobrescríbelo con agents.defaults.sandbox.docker.network.

    Sandbox browser Chromium defaults

    La imagen incluida del navegador del sandbox también aplica valores predeterminados conservadores de inicio de Chromium para cargas de trabajo en contenedores. Los valores predeterminados actuales del contenedor incluyen:

    • --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 cuando noSandbox está habilitado.
    • Las tres marcas de refuerzo gráfico (--disable-3d-apis, --disable-software-rasterizer, --disable-gpu) son opcionales y resultan útiles cuando los contenedores no tienen soporte de GPU. Define OPENCLAW_BROWSER_DISABLE_GRAPHICS_FLAGS=0 si tu carga de trabajo requiere WebGL u otras funciones 3D/del navegador.
    • --disable-extensions está habilitado de forma predeterminada y se puede deshabilitar con OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0 para flujos que dependen de extensiones.
    • --renderer-process-limit=2 se controla mediante OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=&lt;N&gt;, donde 0 conserva el valor predeterminado de Chromium.

    Si necesitas un perfil de runtime diferente, usa una imagen de navegador personalizada y proporciona tu propio punto de entrada. Para perfiles locales (no contenedor) de Chromium, usa browser.extraArgs para anexar marcas de inicio adicionales.

    Network security defaults
    • network: "host" está bloqueado.
    • network: "container:<id>" está bloqueado de forma predeterminada (riesgo de omisión por unión de namespace).
    • Anulación de emergencia: agents.defaults.sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true.

    Las instalaciones de Docker y el Gateway en contenedor viven aquí: Docker

    Para despliegues de Gateway Docker, scripts/docker/setup.sh puede inicializar la configuración de sandbox. Define OPENCLAW_SANDBOX=1 (o true/yes/on) para habilitar esa ruta. Puedes sobrescribir la ubicación del socket con OPENCLAW_DOCKER_SOCKET. Referencia completa de configuración y entorno: Docker.

    setupCommand (configuración única del contenedor)

    setupCommand se ejecuta una vez después de crear el contenedor del sandbox (no en cada ejecución). Se ejecuta dentro del contenedor mediante sh -lc.

    Rutas:

    • Global: agents.defaults.sandbox.docker.setupCommand
    • Por agente: agents.list[].sandbox.docker.setupCommand
    Errores comunes
    • El valor predeterminado de docker.network es "none" (sin salida), por lo que las instalaciones de paquetes fallarán.
    • docker.network: "container:<id>" requiere dangerouslyAllowContainerNamespaceJoin: true y es solo para emergencias.
    • readOnlyRoot: true impide las escrituras; establece readOnlyRoot: false o crea una imagen personalizada.
    • user debe ser root para instalar paquetes (omite user o establece user: "0:0").
    • La ejecución en el entorno aislado no hereda process.env del host. Usa agents.defaults.sandbox.docker.env (o una imagen personalizada) para las claves de API de Skills.

    Política de herramientas y vías de escape

    Las políticas de permitir/denegar herramientas siguen aplicándose antes que las reglas del entorno aislado. Si una herramienta se deniega globalmente o por agente, el aislamiento no la vuelve a habilitar.

    tools.elevated es una vía de escape explícita que ejecuta exec fuera del entorno aislado (gateway de forma predeterminada, o node cuando el destino de ejecución es node). Las directivas /exec solo se aplican a remitentes autorizados y persisten por sesión; para deshabilitar exec de forma estricta, usa la denegación de la política de herramientas (consulta Entorno aislado vs. política de herramientas vs. elevado).

    Depuración:

    • Usa openclaw sandbox explain para inspeccionar el modo efectivo del entorno aislado, la política de herramientas y las claves de configuración de corrección.
    • Consulta Entorno aislado vs. política de herramientas vs. elevado para ver el modelo mental de "¿por qué está bloqueado esto?".

    Mantenlo bloqueado.

    Sobrescrituras multiagente

    Cada agente puede sobrescribir entorno aislado + herramientas: agents.list[].sandbox y agents.list[].tools (más agents.list[].tools.sandbox.tools para la política de herramientas del entorno aislado). Consulta Entorno aislado y herramientas multiagente para ver la precedencia.

    Ejemplo mínimo de habilitación

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

    Relacionado