Skip to content

Commit 177b969

Browse files
cblichmanncblichmann
committed
Sandboxed API OSS release.
PiperOrigin-RevId: 238996664 Change-Id: I9646527e2be68ee0b6b371572b7aafe967102e57 Signed-off-by: Christian Blichmann <cblichmann@google.com>
0 parents  commit 177b969

File tree

252 files changed

+35889
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

252 files changed

+35889
-0
lines changed

‎.clang-format

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
Language: Cpp
3+
BasedOnStyle: Google
4+
...

‎CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Want to contribute? Great! First, read this page (including the small print at the end).
2+
3+
### Before you contribute
4+
Before we can use your code, you must sign the
5+
[Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
6+
(CLA), which you can do online. The CLA is necessary mainly because you own the
7+
copyright to your changes, even after your contribution becomes part of our
8+
codebase, so we need your permission to use and distribute your code. We also
9+
need to be sure of various other things—for instance that you'll tell us if you
10+
know that your code infringes on other people's patents. You don't have to sign
11+
the CLA until after you've submitted your code for review and a member has
12+
approved it, but you must do it before we can put your code into our codebase.
13+
Before you start working on a larger contribution, you should get in touch with
14+
us first through the issue tracker with your idea so that we can help out and
15+
possibly guide you. Coordinating up front makes it much easier to avoid
16+
frustration later on.
17+
18+
### Code reviews
19+
All submissions, including submissions by project members, require review. We
20+
use Github pull requests for this purpose.
21+
22+
### The small print
23+
Contributions made by corporations are covered by a different agreement than
24+
the one above, the
25+
[Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).

‎LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Sandboxed API
2+
3+
Copyright 2019 Google LLC
4+
5+
![Sandbox](sandboxed_api/docs/images/playing-in-sand.png)
6+
7+
8+
## What is Sandboxed API?
9+
10+
The Sandboxed API project (**SAPI**) aims to make sandboxing of C/C++ libraries
11+
less burdensome: after initial setup of security policies and generation of
12+
library interfaces, an almost-identical stub API is generated (using a
13+
[templated based programming variable hierarchy system](sandboxed_api/docs/variables.md)),
14+
transparently forwarding calls using a custom RPC layer to the real library
15+
running inside a sandboxed environment.
16+
17+
Additionally, each SAPI library utilizes a tightly defined security policy, in
18+
contrast to typical sandboxed project, where security policies must cover total
19+
syscall/resource footprint of all utilized libraries.
20+
21+
22+
## Intended audience
23+
24+
SAPI is designed to help you sandbox only a part of binary. That is, a library
25+
or some other code with an unknown security posture.
26+
27+
See [Sandboxing Code](sandboxed_api/docs/sandbox-overview.md) to make sure this is the type of
28+
sandboxing you are looking for.
29+
30+
## How does it work?
31+
32+
Navigate to our [How it works](sandboxed_api/docs/howitworks.md) page.
33+
34+
35+
## Motivation
36+
37+
Sandboxes available for use in Google required additional implementation work
38+
with each new instance of project which was intended to be sandboxed, even if
39+
it reused the same software library. Sandbox security policies and other
40+
restrictions applied to the sandboxed process had to be reimplemented each
41+
time, and data exchange mechanisms between trusted and untrusted parts of
42+
the code had to be designed from the scratch.
43+
44+
While designing the Sandboxed API project, our goal was to make this process
45+
easy and straightforward. Our working motto is: **Sandbox once, use anywhere**.
46+
47+
48+
## Is it proven technology?
49+
50+
The project has been designed, developed and is maintained by members of
51+
the Google Sandbox Team. It also uses our field-tested
52+
[Sandbox 2](sandboxed_api/sandbox2/README.md).
53+
54+
Currently, many internal projects are already using SAPI to isolate
55+
their production workloads. You can read more about them in the
56+
[Examples](sandboxed_api/docs/examples.md) section.
57+
58+
We've also prepared some more example SAPI implementations for your reference.
59+
60+
61+
## Quick Start
62+
63+
Install the required dependencies, this assumes you are running Debian 10
64+
"Buster":
65+
66+
```bash
67+
echo "deb http://storage.googleapis.com/bazel-apt stable jdk1.8" | \
68+
sudo tee /etc/apt/sources.list.d/bazel.list
69+
wget -qO - https://bazel.build/bazel-release.pub.gpg | sudo apt-key add -
70+
sudo apt-get install -qy python-typing python-clang-7 libclang-7-dev
71+
sudo apt-get install -qy build-essential linux-libc-dev bazel
72+
```
73+
74+
Clone and run the build:
75+
```bash
76+
git clone github.com/google/sandboxed-api && cd sandboxed-api
77+
bazel build ...
78+
```
79+
80+
Try out one of the [examples](sandboxed_api/docs/examples.md):
81+
```bash
82+
bazel run //sandboxed_api/examples/stringop:main_stringop
83+
```
84+
85+
There are also a more detailed instructions that should help you
86+
**[getting started with SAPI](sandboxed_api/docs/getting-started.md)**.
87+
88+
89+
## Getting Involved
90+
91+
If you want to contribute, please read [CONTRIBUTING.md](CONTRIBUTING.md) and
92+
send us pull requests. You can also report bugs or file feature requests.
93+
94+
If you'd like to talk to the developers or get notified about major product
95+
updates, you may want to subscribe to our
96+
[mailing list](sandboxed-api-users@googlegroups.com).

0 commit comments

Comments
 (0)