1*4b9c6d91SCole Faust# Hacking on Minijail 2*4b9c6d91SCole Faust 3*4b9c6d91SCole Faust## Dependencies 4*4b9c6d91SCole Faust 5*4b9c6d91SCole FaustYou'll need these to build the source: 6*4b9c6d91SCole Faust* [libcap] 7*4b9c6d91SCole Faust* Linux kernel headers 8*4b9c6d91SCole Faust 9*4b9c6d91SCole FaustYou'll need to install the relevant packages from your distro. 10*4b9c6d91SCole Faust 11*4b9c6d91SCole Faust## Building 12*4b9c6d91SCole Faust 13*4b9c6d91SCole FaustFor local experimentation (using Minijail libraries from the source directory): 14*4b9c6d91SCole Faust 15*4b9c6d91SCole Faust``` 16*4b9c6d91SCole Faust$ make LIBDIR=/lib64 17*4b9c6d91SCole Faust$ sudo ./minijail0.sh -u ${USER} -g 5000 -- /usr/bin/id 18*4b9c6d91SCole Faust``` 19*4b9c6d91SCole Faust 20*4b9c6d91SCole FaustFor system-wide usage, install `libminijail.so` and `libminijailpreload.so` to 21*4b9c6d91SCole Faust`/lib64` and `minijail0` to a directory in your `PATH` (e.g. `/usr/bin`). 22*4b9c6d91SCole Faust 23*4b9c6d91SCole Faust## Testing 24*4b9c6d91SCole Faust 25*4b9c6d91SCole FaustWe use [Google Test] (i.e. `gtest` & `gmock`) for unit tests. 26*4b9c6d91SCole FaustYou can download a suitable copy of Google Test using the 27*4b9c6d91SCole Faust[get_googletest.sh](./get_googletest.sh) script. 28*4b9c6d91SCole Faust 29*4b9c6d91SCole Faust``` 30*4b9c6d91SCole Faust$ ./get_googletest.sh 31*4b9c6d91SCole Faustgoogletest-release-1.8.0/ 32*4b9c6d91SCole Faust... 33*4b9c6d91SCole Faust$ make tests 34*4b9c6d91SCole Faust``` 35*4b9c6d91SCole Faust 36*4b9c6d91SCole FaustBuilding the tests will automatically execute them. 37*4b9c6d91SCole Faust 38*4b9c6d91SCole Faust## Code Review 39*4b9c6d91SCole Faust 40*4b9c6d91SCole FaustWe use [Android Review] for Minijail code review. The easiest way to submit 41*4b9c6d91SCole Faustchanges for review is using `repo upload` on a ChromiumOS or Android checkout. 42*4b9c6d91SCole FaustGo to [Android Review HTTP Credentials] to obtain credentials to push code. For 43*4b9c6d91SCole Faustmore detailed instructions see the [Android source documentation] or the 44*4b9c6d91SCole Faust[ChromiumOS documentation]. 45*4b9c6d91SCole Faust 46*4b9c6d91SCole Faust## Source Style 47*4b9c6d91SCole Faust 48*4b9c6d91SCole Faust* Minijail uses kernel coding style: 49*4b9c6d91SCole Faust https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/coding-style.rst 50*4b9c6d91SCole Faust* Utility functions with no side-effects should go in `util.{h|c}`. 51*4b9c6d91SCole Faust* Functions with side effects or with dependencies on operating system 52*4b9c6d91SCole Faust details, but that don't take a `struct minijail` argument, should go 53*4b9c6d91SCole Faust in `system.{h|c}`. 54*4b9c6d91SCole Faust 55*4b9c6d91SCole Faust## Documentation 56*4b9c6d91SCole Faust 57*4b9c6d91SCole Faust### Markdown 58*4b9c6d91SCole Faust 59*4b9c6d91SCole FaustMinijail uses markdown for general/source documentation. 60*4b9c6d91SCole FaustWe follow the [Google Markdown style guide]. 61*4b9c6d91SCole Faust 62*4b9c6d91SCole Faust### Man Pages 63*4b9c6d91SCole Faust 64*4b9c6d91SCole FaustFor users of Minijail (e.g. `minijail0`), we use man pages. 65*4b9c6d91SCole FaustFor style guides, check out the [Linux man-pages project] for general guidance. 66*4b9c6d91SCole FaustIt has a number of useful references for syntax and such. 67*4b9c6d91SCole Faust 68*4b9c6d91SCole Faust* [man-pages(7)](http://man7.org/linux/man-pages/man7/man-pages.7.html) 69*4b9c6d91SCole Faust* [groff-man(7)](http://man7.org/linux/man-pages/man7/groff_man.7.html) 70*4b9c6d91SCole Faust* [groff(7)](http://man7.org/linux/man-pages/man7/groff.7.html) 71*4b9c6d91SCole Faust 72*4b9c6d91SCole Faust[minijail0.1] documents the command line interface. 73*4b9c6d91SCole FaustPlease keep it in sync with [minijail0_cli.c]. 74*4b9c6d91SCole Faust 75*4b9c6d91SCole Faust[minijail0.5] documents the syntax of config files (e.g. seccomp filters). 76*4b9c6d91SCole Faust 77*4b9c6d91SCole Faust[libcap]: https://git.kernel.org/pub/scm/linux/kernel/git/morgan/libcap.git/ 78*4b9c6d91SCole Faust[minijail0.1]: ./minijail0.1 79*4b9c6d91SCole Faust[minijail0.5]: ./minijail0.5 80*4b9c6d91SCole Faust[minijail0_cli.c]: ./minijail0_cli.c 81*4b9c6d91SCole Faust[Android Review]: https://android-review.googlesource.com/ 82*4b9c6d91SCole Faust[Android Review HTTP Credentials]: https://android-review.googlesource.com/settings/#HTTPCredentials 83*4b9c6d91SCole Faust[Android source documentation]: https://source.android.com/setup/start 84*4b9c6d91SCole Faust[ChromiumOS documentation]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/developer_guide.md 85*4b9c6d91SCole Faust[Google Markdown style guide]: https://github.com/google/styleguide/blob/gh-pages/docguide/style.md 86*4b9c6d91SCole Faust[Google Test]: https://github.com/google/googletest 87