RLBox API

RLBox sandboxing API (in C++ 17). See the online docs. This code has been tested on 64-bit versions of Ubuntu and Mac OSX.

Reporting security bugs

If you find a security bug, please do not create a public issue. Instead, file a security bug on bugzilla using the following template link.

Configure cmake to setup a build folder. This is needed to run tests or build the docs.

cmake -S . -B ./build

cmake --build ./build --target check

Alternatively, you can run the build and test targets separately

cmake --build ./build --target all
cmake --build ./build --target test

Currently rlbox has been tested and should work with gcc-7 or later and clang-5 or later.

You can view the pre-built docs checked in to the repo in the docs folder. Alternatively, you can build these yourself with the steps listed below.

Go through Setup listed above first
You need to install doxygen and then the sphinx and breathe python packages (e.g., with pip3).

On Ubuntu:

sudo apt install doxygen python-sphinx python-breathe

On Arch Linux:

sudo pacman -S doxygen python-sphinx python-breathe

cmake -S . -B ./build
cmake --build ./build --target docs

firefox `pwd`/docs/sphinx/index.html

To contribute code, it is recommended you install clang-tidy which the build uses if available. Install using:

On Ubuntu:

sudo apt install clang-tidy

On Arch Linux:

sudo pacman -S clang-tidy

It is recommended you use the dev mode for building during development. This treat warnings as errors, enables clang-tidy checks, runs address sanitizer etc. Also, you probably want to use the debug build. To do this, adjust your build settings as shown below

cmake -DCMAKE_BUILD_TYPE=Debug -DDEV=ON -S . -B ./build

After making changes to the source, add any new required tests and run all tests as described earlier.
Modify the docs as appropriate and rebuild docs as described earlier. Rebuilding is required if you have added new APIs.
To make sure all code/docs are formatted with, we use clang-format. Install using:

On Ubuntu:

sudo apt install clang-format

On Arch Linux:

sudo pacman -S clang-format

cmake --build ./build --target format-source

Name	Latest commit message	Commit time
Failed to load latest commit information.
cmake	Setup documentation with doxygen, sphinx and breathe	Jul 20, 2019
code	Use rlbox_detail_static_fail_because instead of static_assert	May 27, 2020
docs-src	Fix docs break	Mar 31, 2020
docs	Fix docs break	Mar 31, 2020
examples/hello-world-noop	fix readme + update docs	Jan 11, 2020
.clang-format	Macros should require semi colons	Jul 20, 2019
.clang-tidy	RLBOX_EMBEDDER_PROVIDES_TLS_STATIC_VARIABLES support via function	Dec 16, 2019
.gitignore	docs + simple hello world example (#1 )	Aug 2, 2019
.travis.yml	more recent cmake	Jan 11, 2020
CMakeLists.txt	Move timing test to separate binary so that we don't violate ODR	Jan 18, 2020
Doxyfile.in	Setup documentation with doxygen, sphinx and breathe	Jul 20, 2019
LICENSE	Initial commit	Jun 28, 2019
README.md	Minor readme update	Jan 19, 2020
iwyu.imp	Integrate IWYU (include what you use) tool, format cmake, formatting …	Jun 29, 2019
leak_suppressions.txt	Enable a dev mode flag, enable asan on dev builds, fix mem leaks in t…	Dec 30, 2019
ub_suppressions.txt	Enable ubsan in dev mode	Jan 4, 2020