Minijail v18.

New in this release:
* When a process encounters a seccomp policy failure,
  print the path to the failing policy.
* Add support for a text-based configuration file.
* Add support for setting and resetting the jailed process'
  environment.
Always get mount flags for the source of a bind mount.

mount_one was assuming that |original_mnt_flags| was always populated,
even if the destination of a bind-mount existed.

setup_mount_destination, on the other hand, exits early when the
destination exists, assuming that if the destination exists the source
flags are not needed. This is incorrect, since bind mounts are
routinely used to make a filesystem object read-only only inside a
specific mount namespace. In order to make something read-only using
a bind mount, Minijail needs to perform two mounts: one bind-mount,
and a remount with MS_RDONLY. Without knowing the flags of the original
mount, the remount cannot replicate the original mount.

Fix this by always obtaining the flags of the source, even if the
destination exists. Do this by extracting the flag-getting
functionality into a separate function. Realistically, functionality
about mount flags for the *source* has nothing to do being called in a
function referring to the destination.

Bug: 235145151
Test: Repro in bug no longer works.
Change-Id: Ia5166fdd3f36a4a01d86271e8e2dc12d6eb148ab
4 files changed
tree: 88e0774bc587f1e0e6f2a9c69b67e0479f0a807a
  1. .github/
  2. examples/
  3. linux-x86/
  4. rust/
  5. test/
  6. tools/
  7. .clang-format
  8. .gitignore
  9. Android.bp
  10. arch.h
  11. bpf.c
  12. bpf.h
  13. CleanSpec.mk
  14. common.mk
  15. config_parser.c
  16. config_parser.h
  17. config_parser_unittest.cc
  18. CPPLINT.cfg
  19. DIR_METADATA
  20. dump_constants.cc
  21. elfparse.c
  22. elfparse.h
  23. gen_constants-inl.h
  24. gen_constants.c
  25. gen_constants.sh
  26. gen_syscalls-inl.h
  27. gen_syscalls.c
  28. gen_syscalls.sh
  29. get_googletest.sh
  30. HACKING.md
  31. libconstants.h
  32. libminijail-private.h
  33. libminijail.c
  34. libminijail.h
  35. libminijail.pc.in
  36. libminijail_unittest.cc
  37. libminijailpreload.c
  38. libsyscalls.h
  39. LICENSE
  40. Makefile
  41. METADATA
  42. minijail0.1
  43. minijail0.5
  44. minijail0.c
  45. minijail0.sh
  46. minijail0_cli.c
  47. minijail0_cli.h
  48. minijail0_cli_unittest.cc
  49. MODULE_LICENSE_BSD
  50. navbar.md
  51. NOTICE
  52. OWNERS
  53. OWNERS_GENERAL
  54. parse_seccomp_policy.cc
  55. platform2_preinstall.sh
  56. PRESUBMIT.cfg
  57. PREUPLOAD.cfg
  58. README.md
  59. RELEASE.md
  60. scoped_minijail.h
  61. setup.py
  62. signal_handler.c
  63. signal_handler.h
  64. syscall_filter.c
  65. syscall_filter.h
  66. syscall_filter_unittest.cc
  67. syscall_filter_unittest_macros.h
  68. syscall_wrapper.c
  69. syscall_wrapper.h
  70. system.c
  71. system.h
  72. system_unittest.cc
  73. TEST_MAPPING
  74. test_util.cc
  75. test_util.h
  76. testrunner.cc
  77. util.c
  78. util.h
  79. util_unittest.cc
README.md

Minijail

The Minijail homepage is https://google.github.io/minijail/.

The main source repo is https://android.googlesource.com/platform/external/minijail/.

There might be other copies floating around, but this is the official one!

What is it?

Minijail is a sandboxing and containment tool used in Chrome OS and Android. It provides an executable that can be used to launch and sandbox other programs, and a library that can be used by code to sandbox itself.

Getting the code

You're one git clone away from happiness.

$ git clone https://android.googlesource.com/platform/external/minijail
$ cd minijail

Releases are tagged as linux-vXX: https://android.googlesource.com/platform/external/minijail/+refs

Building

See the HACKING.md document for more details.

Release process

See the RELEASE.md document for more details.

Additional tools

See the tools/README.md document for more details.

Contact

We've got a couple of contact points.

Talks and presentations

The following talk serves as a good introduction to Minijail and how it can be used.

Video, slides.

Example usage

The Chromium OS project has a comprehensive sandboxing document that is largely based on Minijail.

After you play with the simple examples below, you should check that out.

Change root to any user

# id
uid=0(root) gid=0(root) groups=0(root),128(pkcs11)
# minijail0 -u jorgelo -g 5000 /usr/bin/id
uid=72178(jorgelo) gid=5000(eng) groups=5000(eng)

Drop root while keeping some capabilities

# minijail0 -u jorgelo -c 3000 -- /bin/cat /proc/self/status
Name: cat
...
CapInh: 0000000000003000
CapPrm: 0000000000003000
CapEff: 0000000000003000
CapBnd: 0000000000003000

Historical notes

Q. “Why is it called minijail0?”

A. It is minijail0 because it was a rewrite of an earlier program named minijail, which was considerably less mini, and in particular had a dependency on libchrome (the Chrome OS packaged version of Chromium's //base). We needed a new name to not collide with the deprecated one.

We didn‘t want to call it minijail2 or something that would make people start using it before we were ready, and it was also concretely less since it dropped libbase, etc. Technically, we needed to be able to fork/preload with minimal extra syscall noise which was too hard with libbase at the time (onexit handlers, etc that called syscalls we didn’t want to allow). Also, Elly made a strong case that C would be the right choice for this for linking and ease of controlled surprise system call use.

https://crrev.com/c/4585/ added the original implementation.

Source: Conversations with original authors, ellyjones@ and wad@.

How to manually upgrade Minijail on Chrome OS

Minijail is manually upgraded on Chrome OS so that there is a way to test changes in the Chrome OS commit queue. Committed changes have already passed Android's presubmit checks, but the ebuild upgrade CL goes through the Chrome OS commit queue and must pass the tests before any additional changes are available for use on Chrome OS. To upgrade minijail on Chrome OS, complete the following steps.

# Sync Minijail repo
cd ~/chromiumos/src/aosp/external/minijail
git checkout m/main
repo sync .

# Set up local branch.
cd ~/trunk/src/third_party/chromiumos-overlay/
repo start minijail .  # replace minijail with the local branch name you want.

# Run upgrade script.
~/trunk/chromite/scripts/cros_uprev --force --overlay-type public \
  --packages chromeos-base/minijail:dev-rust/minijail-sys:dev-rust/minijail

At this point the Minijail-related packages should be upgraded, so you may want to add the changes to a commit and do some local testing before uploading a change list. Here are the recommended local tests to try (make sure you are not working on the minijail packages first i.e. cros_workon list-all):

# Check build.
./build_packages --board=${BOARD}

# Check unit tests.
FEATURES=test emerge-${BOARD} chromeos-base/minijail dev-rust/minijail-sys \
  dev-rust/minijail

# Check integration tests.
cros deploy <DUT> chromeos-base/minijail
tast run <DUT> security.Minijail.* security.MinijailSeccomp

Finally, when uploading the CL make sure to include the list of changes since the last uprev. The command to generate the list is as follows:

git log --oneline --no-merges <previous hash in ebuild file>..HEAD