mirror of https://github.com/google/sandboxed-api.git synced 2024-03-22 13:11:30 +08:00

History

Christian Blichmann 4c87556901 Use Abseil's log/flags instead of glog/gflags Follow-up changes might be required to fully fix up the contrib sandboxes. PiperOrigin-RevId: 482475998 Change-Id: Iff631eb838a024b2f047a1be61bb27e35a8ff2f4		2022-10-20 06:48:51 -07:00
..
examples	Use Abseil's log/flags instead of glog/gflags	2022-10-20 06:48:51 -07:00
ld_preload_example	Use Abseil's log/flags instead of glog/gflags	2022-10-20 06:48:51 -07:00
patches	renamed main project folder	2020-09-28 15:35:51 +00:00
test	Change license link to HTTPS URL	2022-01-28 01:39:09 -08:00
.gitignore	Modified sandbox to limit ioctl. Use .value() instead of manually checking .ok().	2020-10-02 15:52:29 +00:00
CMakeLists.txt	Change license link to HTTPS URL	2022-01-28 01:39:09 -08:00
functions_to_sandbox.txt	renamed main project folder	2020-09-28 15:35:51 +00:00
README.md	added empty line at the end of files (was removed by clang-format)	2020-10-07 14:36:24 +00:00

README.md

libarchive Sandboxed API

Sandboxed version of the libarchive minitar example using Sandboxed API.

Build

mkdir -p build && cd build
cmake .. -G Ninja
cmake --build .

The example binary file can be found at build/examples/sapi_minitar and the unit tests at build/test/sapi_minitar_test.

Patches

The original libarchive code required patching since one of the custom types produced errors with libclang Python byndings. The patches are applied automatically during the build step and they do not modify the functionality of the library. The repository is also fetched automatically.

Examples

In this project, the minitar example is sandboxed. The code is found in the examples directory and is structured as follows:

sapi_minitar_main.cc - main function of the minitar tool. This is mostly similar to the original example.
sapi_minitar.h and sapi_minitar.cc - The two main functions (CreateArchive and ExtractArchive) and other helper functions.
sandbox.h - Custom security policies, depending on the whether the user creates or extracts an archive.

On top of that, unit tests can be found in the test/minitar_test.cc file.

Usage

The unit tests can be executed with ./build/test/sapi_minitar_test.

The sapi_minitar command line tool can be used in the same way as the original example. It is also similar to the tar command, only with fewer options:

./build/examples/sapi_minitar -[options] [-f file] [files]

The available options are:

c - Create archive.
x - Extract archive.
t - Extract archive but only print entries.
p - Preserve.
v - Verbose.
j or y - Compress with BZIP2.
Z - Default compression.
z - Compress with GZIP.

If no compression method is chosen (in the case of archive creation) the files will only be stored.