diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..5d119e3b --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,26 @@ +{ + "projectName": "libos", + "projectOwner": "occlum", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "CONTRIBUTORS.md" + ], + "imageSize": 100, + "commit": false, + "contributors": [ + { + "login": "tatetian", + "name": "Tate, Hongliang Tian", + "avatar_url": "https://avatars0.githubusercontent.com/u/568208?v=4", + "profile": "https://github.com/tatetian", + "contributions": [ + "code", + "test", + "doc", + "maintenance" + ] + } + ], + "contributorsPerLine": 7 +} diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 00000000..086cb51f --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,7 @@ +# Contributors + + + +| [Tate Tian
Tate Tian](https://github.com/tatetian)
[💻](https://github.com/occlum/libos/commits?author=tatetian "Code") [⚠️](https://github.com/occlum/libos/commits?author=tatetian "Tests") [📖](https://github.com/occlum/libos/commits?author=tatetian "Documentation") [🚧](#maintenance-tatetian "Maintenance") | +| :---: | + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..d7d675e9 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,29 @@ +BSD License + +Copyright (C) 2018-2019 Intel Corporation. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index df7c6b2c..5c6d89a7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Occlum +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors) Occlum is a *memory-safe*, *multi-process* library OS (LibOS) for [Intel SGX](https://software.intel.com/en-us/sgx). As a LibOS, it enables *unmodified* applications to run on SGX, thus protecting the confidentiality and integrity of user workloads transparently. @@ -7,7 +8,7 @@ Compared to existing LibOSes for SGX, Occlum has following salient features: * **Efficient multitasking.** The LibOS has a complete and efficient multi-process support, including fast process creation, low-cost IPC, code sharing (e.g., shared libraries) and data sharing (e.g., encrypted file systems). * **Fault isolation.** The crash of one user process cannot crash the LibOS or other user processes, which is good for security and robustness. * **Memory safety.** The LibOS itself is written in [Rust](https://www.rust-lang.org/), a memory-safe programming language, thus free from low-level, memory bugs; - + ## Why Occlum? ### Efficient Multitasking @@ -16,11 +17,11 @@ The primary motivation of Occlum project is to achieve efficient multitasking on Multitasking is an important feature for LibOSes (or any OSes in general), but difficult to implement efficiently on SGX. It is important since virtually any non-trivial application demands more than one process. And its difficulty is evident from the fact that existing LibOSes for SGX either do not support multitasking (e.g., Haven and SCONE) or fail to do so efficiently (e.g., Graphene-SGX is nearly 10,000X slower than Linux on spawning new processes). -To realize efficient multitasking, Occlum adopts a novel *multi-process-per-enclave* approach, which runs all LibOS processes and the LibOS itself inside a single enclave. Running inside a single address space, Occlum’s processes enjoy the benefits of fast startup, low-cost inter-process communication (IPC) and shared system services (e.g., encrypted file systems). +To realize efficient multitasking, Occlum adopts a novel *multi-process-per-enclave* approach, which runs all LibOS processes and the LibOS itself inside a single enclave. Running inside a single address space, Occlum's processes enjoy the benefits of fast startup, low-cost inter-process communication (IPC) and shared system services (e.g., encrypted file systems). ### Fault Isolation -As there are no hardware isolation mechanisms available inside an enclave, Occlum emulates the traditional OS-enforced inter-process isolation and user-kernel isolation with [Software Fault Isolation (SFI)]() technique. Specifically, we design a novel SFI scheme called **Multi-Domain SFI (MDSFI)** that enables Occlum to enforce process sandbox: *any LibOS process cannot compromise or crash other LibOS processes or the LibOS itself*. +As there are no hardware isolation mechanisms available inside an enclave, Occlum emulates the traditional OS-enforced inter-process isolation and user-kernel isolation with [Software Fault Isolation (SFI)](http://www.cse.psu.edu/~gxt29/papers/sfi-final.pdf) technique. Specifically, we design a novel SFI scheme called **Multi-Domain SFI (MDSFI)** that enables Occlum to enforce process sandbox: *any LibOS process cannot compromise or crash other LibOS processes or the LibOS itself*. ### Memory Safety @@ -58,7 +59,7 @@ Then, compile the project and run tests with the following commands ## What is the Implementation Status? -The current version is only for technical preview, not ready for production use. Yet, even with this early version, we can achieve a speedup of multitasking-related operations by up to three orders of magnitude, thus demonstrating the effectiveness of our multi-process-per-enclave approach. +The current version is **only for technical preview, not ready for production use**. Yet, even with this early version, we can achieve a speedup of multitasking-related operations by up to three orders of magnitude, thus demonstrating the effectiveness of our multi-process-per-enclave approach. This project is being actively developed. We now focus on implementing more system calls and hopefully enable real-world applications on Occlum soon. @@ -78,12 +79,12 @@ Of course, Occlum must be run on Intel x86 CPUs with SGX support to do its magic While Occlum was originally designed by and incubated inside Intel, it is NOT an official Intel product. -The original source code was released by Intel under a project named SGX Multi-Process Library Operating System (SGXMPLOS). As the vendor-neutral, community-driven successor of SGXMPLOS, Occlum project is where all future development happens. +The original source code was released by Intel in a BSD-licensed project named [SGX Multi-Process Library Operating System (SGXMPLOS)](https://github.com/sgxmplos/libos). As the vendor-neutral, community-driven successor of SGXMPLOS, Occlum project is where all future development happens. ## Contributors -The original authors of Occlum (or SGXMPLOS) are +The creators of Occlum (or SGXMPLOS) project are * Hongliang Tian and Shoumeng Yan from Intel; and * Youren Shen, Yu Chen, and Kang Chen from Tsinghua University. -For the names of all contributors, see [this list](CONTRIBUTOR.md). +For the names of all contributors, see [this list](CONTRIBUTORS.md). diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 73ba2a07..00000000 --- a/TODO.md +++ /dev/null @@ -1,3 +0,0 @@ -# TODOs -- [ ] Remove src/libc -- [ ] Check all dangerous arithmetic overflows and underflows