sandboxed-api/README.md
Christian Blichmann e77099876a Update/rephrase README
PiperOrigin-RevId: 355129169
Change-Id: Ie2670f15d65c0075db7a639f61402278dde7b49c
2021-02-02 03:08:31 -08:00

37 lines
1.6 KiB
Markdown

![Sandbox](sandboxed_api/docs/images/sapi-lockup-vertical.png)
Copyright 2019-2021 Google LLC.
[![Bazel build status](https://badge.buildkite.com/2f662d7bddfd1c07d25bf92d243538c8344bc6fbf38fe187f8.svg)](https://buildkite.com/bazel/sandboxed-api)
[![CMake build status](https://github.com/google/sandboxed-api/workflows/CMake/badge.svg)](https://github.com/google/sandboxed-api/actions?query=workflow%3ACMake)
## What is Sandboxed API?
The Sandboxed API project (**SAPI**) makes sandboxing of C/C++ libraries less
burdensome: after initial setup of security policies and generation of library
interfaces, a stub API is generated, transparently forwarding calls using a
custom RPC layer to the real library running inside a sandboxed environment.
Additionally, each SAPI library utilizes a tightly defined security policy, in
contrast to the typical sandboxed project, where security policies must cover
the total syscall/resource footprint of all its libraries.
## Documentation
Developer documentation is available on the Google Developers site for
[Sandboxed API](https://developers.google.com/sandboxed-api).
There is also a
[Getting Started](https://developers.google.com/sandboxed-api/docs/getting-started)
guide.
## Getting Involved
If you want to contribute, please read [CONTRIBUTING.md](CONTRIBUTING.md) and
send us pull requests. You can also report bugs or file feature requests.
If you'd like to talk to the developers or get notified about major product
updates, you may want to subscribe to our
[mailing list](mailto:sandboxed-api-users@googlegroups.com) or sign up with this
[link](https://groups.google.com/forum/#!forum/sandboxed-api-users).