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