Sandlock

​

Installation

​

Usage

from mirage import RAMVFS, MountMode, Workspace
from mirage.runtime.sandlock import SandlockRuntime

runtime = SandlockRuntime(
    captures=["@python", "@external"],
    config={"fs_readable": ["/opt/tools"], "fs_writable": ["/tmp/work"]},
)
ws = Workspace({"/data": RAMVFS()}, mode=MountMode.EXEC, runtimes=[runtime])
await ws.shell("python3 -c 'print(1 + 1)'")

import { MountMode, RAMVFS, SandlockRuntime, Workspace } from '@struktoai/mirage-node'

const runtime = new SandlockRuntime({
  captures: ['@python', '@external'],
  config: { fsReadable: ['/opt/tools'], fsWritable: ['/tmp/work'] },
})
const ws = new Workspace({ '/data': new RAMVFS() }, { mode: MountMode.EXEC, runtimes: [runtime] })
await ws.shell("python3 -c 'print(1 + 1)'")

mode: exec
runtimes:
  - name: sandlock
    captures: ["@python", "@external"]
    config:
      fs_readable: [/opt/tools]
      fs_writable: [/tmp/work]
      max_memory: 512M
mounts:
  /data:
    vfs: ram

​

Connecting the workspace

mounts:
  /data:
    vfs: s3
    config:
      bucket: my-bucket
    backend: fuse
    mountpoint: /data
runtimes:
  - name: sandlock
    captures: ["@python", "@external"]
    config:
      fs_writable: [/data]

• Put the folder at the mount’s own path when you can, so a path typed in the shell names the same file in the program.
• Calls into the folder follow mount modes and policies. A folder added in code with a session, add_fuse_mount(prefix, mountpoint, session_id) or addFuseMount(prefix, mountpoint, sessionId), also follows that session’s permissions.

​

Runtime behavior

​

Notes

• Under a system_time, programs see that time through libfaketime when it is installed, and the host’s clock without it.
• An interpreter installed outside the system paths needs an fs_readable grant.
• Host credentials are not passed to the program.
• A workspace whose network limits anything, or whose policies judge connections, runs nothing here: the program connects from this host, around both. It answers Permission denied, exit 126.
• The runtime does not create the FUSE folder or bind it to a session.
• Program lookup uses the sandbox’s PATH, with the CLI’s system default when the session does not set one. Add directories such as /usr/local/bin to the session’s PATH when required. Missing-program diagnostics come from Sandlock.
• A working directory absent from the host refuses the command with exit 126.
• A timeout kills the program.