Skip to content

Latest commit

 

History

History
134 lines (84 loc) · 3.74 KB

README.md

File metadata and controls

134 lines (84 loc) · 3.74 KB
Raw

hako - A minimal sandboxing tool

License

hako = chroot + Linux namespace.

It is created out of a need for a simple tool like chroot but with extra isolation.

What it does

  • It generally works like chroot with the added benefit of isolation using Linux namespace.
  • It can run on a read-only filesystem.
  • Some rudimentary form of privilege dropping through setuid, setgid and PR_SET_NO_NEW_PRIVS.

What it does not do

  • Networking: use docker/runc instead or setup something with iproute2 and veth. With the --network switch, a sandbox can use the host's or another sandbox's network. Alternatively, Unix socket works for sandboxes in the same host too.
  • Seccomp: I might start a new project for this if needed. Something like seccomp-exec <rule-file> <command> [args] would be nice.

Build requirements

  • A C99 compiler (gcc/clang)
  • Recent Linux headers
  • make

Usage

Creating a sandbox

mkdir sandbox
mkdir sandbox/.hako
touch sandbox/.hako/init
chmod +x sandbox/.hako/init
mkdir sandbox/bin
touch sandbox/bin/busybox
ln -s busybox sandbox/bin/sh

Content of .hako/init:

#!/bin/sh -e

mount -o ro,bind $(which busybox) ./bin/busybox

Run it with:

hako-run sandbox /bin/sh

General syntax is: hako-run [options] <target> [command] [args].

If command is not given, it will default to /bin/sh.

The file .hako/init must be present and will be executed to initialize the sandbox. It can do things like bind mounting files from the host into the sandbox.

Run hako-run --help for more info.

Entering an existing sandbox

Given:

hako-run --pid-file sandbox.pid sandbox

One can enter the sandbox with:

hako-enter --fork $(cat sandbox.pid) /bin/sh

General syntax is: hako-enter [options] <pid> [command] [args].

If command is not given, it will default to /bin/sh.

Run hako-enter --help for more info.

FAQ

Why not docker?

Docker does too many things. It also requires a daemon running. While it's possible to use it without building image, it's just annoying in general.

Why not runc (aka: Docker, the good part)?

runc looks good but I only need something a little more than chroot that runs only on Linux. I rather like the idea of simple Unix tools and Bernstein chaining. If I need features like seccomp, I'd probably write a separate chain wrapper for it.

Why not systemd-nspawn?

  1. It requires glibc, according to buildroot. hako can be built with musl.
  2. While I'm sure it can be used standalone, it comes with a bunch of dependencies from the systemd project.
  3. It's systemd (jk).

Why must the sandbox contains an empty .hako directory?

pivot_root requires it. It also provides access to the old root filesystem while creating the sandbox. runc relies on an undocumented trick but I'd rather not.

How to build with musl?

CC='musl-gcc -static' make

How to use tmpfs in the container?

Put this in .hako/init: mount -t tmpfs tmpfs ./tmpfs.

How to hide .hako content?

Put this in .hako/init: mount -t tmpfs -o ro tmpfs .hako.

How to pass arguments to .hako/init?

Use environment variable (e.g: SOME_INIT_ARGS="some-args" hako-enter sandbox).

How to allow a sandbox to use the host's network namespace?

hako-run --network sandbox

How to put a sandbox in another one's network namespace?

hako-run --network=/proc/$(cat other-sandbox.pid)/net/ns sandbox