Painless Linux sandboxing API

Go to file

Albert S 631980b775 Include linux/capability.h instead of sys/capability.h Some distros put sys/capability.h into libcap-dev or similiar, which is a bit unforunate, we don't need libcap-dev or anything like that. Since we anyway only used the capget()/capset(), we can just define a simple wrapper and call the syscall directly and therefore avoid above mentioned issue.		2021-12-27 14:15:50 +01:00
exile.h	Include linux/capability.h instead of sys/capability.h	2021-12-27 14:15:50 +01:00
Makefile	Start implementing tests	2021-06-05 20:11:07 +02:00
README.md	rename to exile.h	2021-11-30 18:19:15 +01:00
test.c	test: Add tests for exile_pledge()	2021-12-27 12:35:54 +01:00
test.sh	rename to exile.h	2021-11-30 18:19:15 +01:00

README.md

exile.h

exile.h is a simple header-only library that provides an interface to isolate processes on Linux. Using Seccomp and Linux Namespaces for that purpose requires some knowledge of annoying details which this library aims to abstract away as much as possible, when reasonable. Hence, the goal is to provide a convenient way for processes to restrict themselves in order to mitigate the effect of exploits. Currently, it utilizes technologies like Seccomp, Namespaces and Landlock to this end.

Status

No release yet, expiremental, API is unstable, builds will break on updates of this library.

Currently, it's mainly evolving according to the needs of my other projects.

Features

Systemcall filtering (using seccomp-bpf)
restricting file system access (using Landlock and/or Namespaces)
dropping privileges
isolating the application from the network, etc.

Requirements

Kernel >=3.17

sys/capabilities.h header. Depending on your distribution, libcap might be needed for this.

While mostly transparent to users of this API, kernel >= 5.13 is required to take advantage of Landlock.

FAQ

Does the process need to be priviliged to utilize the library?

No.

It doesn't work on Debian!

You can thank a Debian-specific kernel patch for that. In the future, the library may check against that. Execute echo 1 > /proc/sys/kernel/unprivileged_userns_clone to disable that patch for now.

Examples

looqs: https://gitea.quitesimple.org/crtxcr/looqs
qswiki: https://gitea.quitesimple.org/crtxcr/qswiki
cgit sandboxed: https://gitea.quitesimple.org/crtxcr/cgitsb
qpdfviewsb sandboxed (quick and dirty): https://gitea.quitesimple.org/crtxcr/qpdfviewsb

Contributing

Contributions are very welcome. Options:

Pull-Request on github
Mail to exile at quitesimple.org with instructions on where to pull the changes from.
Mailing a classic patch/diff to the same address.

License

ISC