xref: /aosp_15_r20/external/sandboxed-api/README.md (revision ec63e07ab9515d95e79c211197c445ef84cefa6a)
1![Sandbox](sandboxed_api/docs/images/sapi-lockup-vertical.png)
2
3Copyright 2019-2023 Google LLC
4
5[![Bazel build status](https://badge.buildkite.com/2f662d7bddfd1c07d25bf92d243538c8344bc6fbf38fe187f8.svg)](https://buildkite.com/bazel/sandboxed-api)
6[![CMake build status](https://github.com/google/sandboxed-api/workflows/CMake/badge.svg)](https://github.com/google/sandboxed-api/actions?query=workflow%3ACMake)
7
8## What is Sandboxed API?
9
10The Sandboxed API project (**SAPI**) makes sandboxing of C/C++ libraries less
11burdensome: after initial setup of security policies and generation of library
12interfaces, a stub API is generated, transparently forwarding calls using a
13custom RPC layer to the real library running inside a sandboxed environment.
14
15Additionally, each SAPI library utilizes a tightly defined security policy, in
16contrast to the typical sandboxed project, where security policies must cover
17the total syscall/resource footprint of all its libraries.
18
19## Documentation
20
21Developer documentation is available on the Google Developers site for
22[Sandboxed API](https://developers.google.com/code-sandboxing/sandboxed-api).
23
24There is also a
25[Getting Started](https://developers.google.com/code-sandboxing/sandboxed-api/getting-started)
26guide.
27
28## Getting Involved
29
30If you want to contribute, please read [CONTRIBUTING.md](CONTRIBUTING.md) and
31send us pull requests. You can also report bugs or file feature requests.
32
33If you'd like to talk to the developers or get notified about major product
34updates, you may want to subscribe to our
35[mailing list](mailto:[email protected]) or sign up with this
36[link](https://groups.google.com/forum/#!forum/sandboxed-api-users).
37