Hacking on Minijail

Dependencies

You'll need these to build the source:

libcap
Linux kernel headers

You'll need to install the relevant packages from your distro.

Building

For local experimentation (using Minijail libraries from the source directory):

$ make LIBDIR=`pwd`
$ sudo ./minijail0 -u jorgelo -g 5000 /usr/bin/id

For system-wide usage, change LIBDIR to the final location of the libraries:

$ make LIBDIR=/lib64

Then install libminijail.so and libminijailpreload.so to /lib64 and minijail0 to your PATH (e.g. /usr/bin).

Testing

We use Google Test (i.e. gtest & gmock) for unit tests. You can download a suitable copy of Google Test using the get_googletest.sh script.

$ ./get_googletest.sh
googletest-release-1.8.0/
...
$ make LIBDIR=`pwd` tests

Building the tests will automatically execute them.

Source Style

Minijail uses kernel coding style: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/coding-style.rst
Utility functions with no side-effects should go in util.{h|c}.
Functions with side effects or with dependencies on operating system details, but that don't take a struct minijail argument, should go in system.{h|c}.

Documentation

Markdown

Minijail uses markdown for general/source documentation. We follow the Google Markdown style guide.

Man Pages

For users of Minijail (e.g. minijail0), we use man pages. For style guides, check out the [Linux man-pages project] for general guidance. It has a number of useful references for syntax and such.

minijail0.1 documents the command line interface. Please keep it in sync with minijail0_cli.c.

minijail0.5 documents the syntax of config files (e.g. seccomp filters).