mirror of
https://github.com/google/sandboxed-api.git
synced 2024-03-22 13:11:30 +08:00
ea1a934d51
This change removes the in-tree documentation in favor of the one hosted on the Google's Developer site. This makes it easier to maintain for the sandbox team, as there is now only a single source of truth for both internal and external documentation. If you find errors/bugs in the documentation, please file regular GitHub issues. PiperOrigin-RevId: 267132623 Change-Id: I4c950fcef77da0b361cb35b99aa2f187efe6f320
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# Sandboxed API
|
|
|
|
Copyright 2019 Google LLC
|
|
|
|
|
|
|
|
|
|
## What is Sandboxed API?
|
|
|
|
The Sandboxed API project (**SAPI**) aims to make sandboxing of C/C++ libraries
|
|
less burdensome: after initial setup of security policies and generation of
|
|
library interfaces, an almost-identical 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 utilized libraries.
|
|
|
|
## Documentation
|
|
|
|
Detailed 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).
|