Skip to content

Latest commit

 

History

History
130 lines (101 loc) · 4.15 KB

README.md

File metadata and controls

130 lines (101 loc) · 4.15 KB
Raw

Introduction

This is a repository for an analysis and survey of source code sandboxing. It's still in progress.

Please don't post this repository for broader consumption until it's ready, thank you! However, if you want to contribute attestations or sandbox systems, please do.

An attestation means that you or someone you know has used a software sandbox (e.g., pledge) in your software. This means that you or they personally interfaced with the sandbox or made a significant contribution. Please let me know using the documentation below! Make your work known.

A sandbox is a software sandbox system like pledge. I've documented a handful in this repository, but there are more. illumos folks, I'm looking at you: I know about privileges(7). Have you implemented a system with this? Please let me know. All the ones mentioned are in subsystems.json.

Lastly, a system is an operating system like OpenBSD or Linux. All the ones mentioned are in systems.json.

Anywaym, there's way to much hand-waving about software sandboxing. Let's put some numbers down.

Adding a new attestation.

Have you implemented a software sandbox matching one of the examples in the sources directory? Or you have made a considerable contribution to one? Time to show off.

Then add a line or lines to the githubAttestations, then make a pull request with the modifications. If the project is in GitHub, no need to include the domain; if it isn't, then use the full path to your sources. If you don't have a GitHub account (e.g., you're using Sourceforge), then please open an issue and I'll address that later.

githubAttestations:
   GITHUBNAME examplename/examplerepo[/exampledir],
   GITHUBNAME2 https://your.domain/examplerepo[/exampledir],

For example, kristapsdz kristapsdz/kcgi, (note the trailing comma). If your repository has, for example, many directories with separate sandboxes, have those follow the repository.

Please put your new attestation at the beginning of the list. It makes merging the PR easier.

I will be double-checking that you actually contributed... don't fib.

If you've implemented a sandbox using technology not in the examples directory, then please let me know or directly modify the relevant files as described below.

Adding new systems and sandboxes

To add an entirely new sandbox, edit subsystems.json as follows:

{
    "NAME_OF_SUBSYSTEM": {
        "deprecated": null, /* Or a string containing deprecation information. */
        "link": "https://canonical/link/to/sandbox/overview",
        "sources": [
            "https://ALL/sources/we...",
            "https://need/to/understand...",
            "https://and/implement/this...",
            "https://in/our/code",
        ]
    }
}

Same goes with systems.json, except easier:

{
    "NAME_OF_SYSTEM": {
        "link": "https://canonical/link/to/system/overview"
    }
}

That's all.

Subsystems I know about but haven't been mentioned for lack of knowledge: Illumos and Solaris privileges.

Adding new source code examples

Do you have new examples you'd like to list? It's easy to add them. Add your example to the sources directory to do so, then open a pull request.

In this example, I've included example text that the system (operating system) is FreeBSD, although you should omit it if there's no specific operating system such as with Java; lang is C/C++ and must be set; and notes may be empty as well.

The githubAttestations let us demonstrate actual systems using the example. See the above section on adding attestations. I'll use myself as an example in this.

lang: C/C++
system: freebsd
subsystem: NAME_OF_SANDBOX
notes: Any possible notes or just leave this out entirely.
githubAttestations: 
    kristapsdz kristapsdz/sblg,
    kristapsdz kristapsdz/lowdown,

` ` `LANGUAGE
int
main(void)
{
    do_the_security();
    /* SECURE. */
    puts("Hello, world!");
}
` ` `