Google Git
Sign in
android / platform / external / nsjail / ab37bf3b4021058ef14511e15885bcb74a092008
commitab37bf3b4021058ef14511e15885bcb74a092008[log] [tgz]
authorrobertswiecki <robert@swiecki.net>Wed Aug 26 17:02:02 2020 +0200
committerGitHub <noreply@github.com>Wed Aug 26 17:02:02 2020 +0200
treebc92a0ba6d14b694dc16a1f508ed926a250dc2a2
parentfc02a3911c798a8b1d86ea0629a732a41c108c2a [diff]
parent27cac8ea5af4342056ad7cece8b6bcad212a0755 [diff]
Merge pull request #150 from joemiller/patch-1

remove build dependency on which
tree: bc92a0ba6d14b694dc16a1f508ed926a250dc2a2
  1. .github/
  2. configs/
  3. kafel
  4. .gitignore
  5. .gitmodules
  6. caps.cc
  7. caps.h
  8. cgroup.cc
  9. cgroup.h
  10. cgroup2.cc
  11. cgroup2.h
  12. cmdline.cc
  13. cmdline.h
  14. config.cc
  15. config.h
  16. config.proto
  17. contain.cc
  18. contain.h
  19. CONTRIBUTING
  20. cpu.cc
  21. cpu.h
  22. Dockerfile
  23. LICENSE
  24. logs.cc
  25. logs.h
  26. macros.h
  27. Makefile
  28. mnt.cc
  29. mnt.h
  30. net.cc
  31. net.h
  32. nsjail.1
  33. nsjail.cc
  34. nsjail.h
  35. pid.cc
  36. pid.h
  37. README.md
  38. sandbox.cc
  39. sandbox.h
  40. subproc.cc
  41. subproc.h
  42. user.cc
  43. user.h
  44. util.cc
  45. util.h
  46. uts.cc
  47. uts.h
README.md

This is NOT an official Google product.

Overview

NsJail is a process isolation tool for Linux. It utilizes Linux namespace subsystem, resource limits, and the seccomp-bpf syscall filters of the Linux kernel.

It can help you with (among other things):

  • Isolating networking services (e.g. web, time, DNS), by isolating them from the rest of the OS
  • Hosting computer security challenges (so-called CTFs)
  • Containing invasive syscall-level OS fuzzers

Features:

What forms of isolation does it provide

  1. Linux namespaces: UTS (hostname), MOUNT (chroot), PID (separate PID tree), IPC, NET (separate networking context), USER, CGROUPS
  2. FS constraints: chroot(), pivot_root(), RO-remounting, custom /proc and tmpfs mount points
  3. Resource limits (wall-time/CPU time limits, VM/mem address space limits, etc.)
  4. Programmable seccomp-bpf syscall filters (through the kafel language)
  5. Cloned and isolated Ethernet interfaces
  6. Cgroups for memory and PID utilization control

Which use-cases are supported

Isolation of network services (inetd style)

PS: You‘ll need to have a valid file-system tree in /chroot. If you don’t have it, change /chroot to /

  • Server:
  • Client:

Isolation with access to a private, cloned interface (requires root/setuid)

PS: You‘ll need to have a valid file-system tree in /chroot. If you don’t have it, change /chroot to /

Isolation of local processes

PS: You‘ll need to have a valid file-system tree in /chroot. If you don’t have it, change /chroot to /

Isolation of local processes (and re-running them, if necessary)

PS: You‘ll need to have a valid file-system tree in /chroot. If you don’t have it, change /chroot to /

Bash in a minimal file-system with uid==0 and access to /dev/urandom only

/usr/bin/find in a minimal file-system (only /usr/bin/find accessible from /usr/bin)

Using /etc/subuid

Even more contrained shell (with seccomp-bpf policies)

Configuration file

You will also find all examples in the configs directory.

config.proto contains ProtoBuf schema for nsjail's configuration format.

You can examine an example config file in configs/bash-with-fake-geteuid.cfg.

Usage:

You can also override certain options with command-line options. Here, the executed binary (/bin/bash) is overriden with /usr/bin/id, yet options from configs/bash-with-fake-geteuid.cfg still apply

You might also want to try using configs/home-documents-with-xorg-no-net.cfg.

The configs/firefox-with-net.cfg config file will allow you to run firefox inside a sandboxed environment:

A more complex setup, which utilizes virtualized (cloned) Ethernet interfaces (to separate it from the main network namespace), can be found in configs/firefox-with-cloned-net.cfg. Remember to change relevant UIDs and Ethernet interface names before use.

As using cloned Ethernet interfaces (MACVTAP) required root privileges, you'll have to run it under sudo:

More info

The command-line options should be self-explanatory, while the proto-buf config options are described in config.proto

Launching in Docker

To launch nsjail in a docker container clone the repository and build the docker image:

This will build up an image containing njsail and kafel.

From now you can either use it in another Dockerfile (FROM nsjailcontainer) or directly:

Contact