diff options
-rw-r--r-- | LICENSE | 27 | ||||
-rw-r--r-- | README.md | 22 |
2 files changed, 49 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8bafca3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,27 @@ +// Copyright 2017 The Chromium OS Authors. 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 Google Inc. 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 new file mode 100644 index 0000000..8ad2ec5 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Chrome OS KVM + +This component, known as crosvm, runs untrusted operating systems along with +virtualized devices. No actual hardware is emulated. This only runs VMs +through the Linux's KVM interface. What makes crosvm unique is a focus on +safety within the programming language and a sandbox around the virtual +devices to protect the kernel from attack in case of an exploit in the +devices. + +## Overview + +The crosvm source code is organized into crates, each with their own +unit tests. These crates are: + +* `kvm-sys` low-level (mostly) auto-generated structures and constants for using KVM +* `kvm` unsafe, low-level wrapper code for using kvm-sys +* `crosvm` the top-level binary front-end for using crosvm + +## Usage + +Currently there is no front-end, so the best you can do is run `cargo test` in +each crate. |