diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..99943c834 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,134 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations + diff --git a/CONTRIBUTING.md b/Documentation/CONTRIBUTING.md similarity index 86% rename from CONTRIBUTING.md rename to Documentation/CONTRIBUTING.md index f3c1779b2..2253b6c15 100644 --- a/CONTRIBUTING.md +++ b/Documentation/CONTRIBUTING.md @@ -50,4 +50,11 @@ before allowing them to be committed. It can be installed by running from the projects root directory. For detailed instructions on documentation guidelines please have a look at -[GUIDELINES.md](Documentation/GUIDELINES.md). +[RUSTDOC-GUIDELINES.md](RUSTDOC-GUIDELINES.md). + +Fuzzing +------- + +The SVSM project includes a number of fuzzing targets to test parts of the +code-base. For details on how to run the fuzzers and extend the fuzzing +functionality, please have a look at [FUZZING.md](FUZZING.md). diff --git a/FUZZING.md b/Documentation/FUZZING.md similarity index 100% rename from FUZZING.md rename to Documentation/FUZZING.md diff --git a/INSTALL.md b/Documentation/INSTALL.md similarity index 100% rename from INSTALL.md rename to Documentation/INSTALL.md diff --git a/Documentation/GUIDELINES.md b/Documentation/RUSTDOC-GUIDELINES.md similarity index 100% rename from Documentation/GUIDELINES.md rename to Documentation/RUSTDOC-GUIDELINES.md diff --git a/LICENSE-APACHE-2.0.txt b/LICENSE-APACHE similarity index 100% rename from LICENSE-APACHE-2.0.txt rename to LICENSE-APACHE diff --git a/LICENSE.MIT b/LICENSE-MIT similarity index 100% rename from LICENSE.MIT rename to LICENSE-MIT diff --git a/README.md b/README.md index d321ee0ae..03dec4fad 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,8 @@ Secure Nested Paging (AMD SEV-SNP), especially the VM Privilege Level (VMPL) feature. The COCONUT-SVSM is dual-licensed under the MIT or Apache-2.0 licenses. -The licenses are included in the [LICENSE.MIT](LICENSE.MIT) or -[LICENSE-APACHE-2.0.txt](LICENSE-APACHE-2.0.txt) files. +The licenses are included in the [LICENSE-MIT](LICENSE-MIT) or +[LICENSE-APACHE](LICENSE-APACHE) files. The project builds on support code written for the [linux-svsm](https://github.com/AMDESE/linux-svsm), a software written and published by AMD. This includes the necessary @@ -35,7 +35,7 @@ advanced features like TPM emulation and live migration. Installation ------------ -Detailed installation instructions are in the [INSTALL.md](INSTALL.md) +Detailed installation instructions are in the [INSTALL.md](Documentation/INSTALL.md) file. It walks through the process of building all the necessary parts to get a virtual machine powered by the COCONUT-SVSM up and running. @@ -63,8 +63,8 @@ Contributing Contributing to the project is as easy as sending a pull-request via GitHub. For detailed instructions on patch formatting and contribution -guidelines please have a look at [CONTRIBUTING.md](CONTRIBUTING.md). -For documentation guidelines consult [GUIDELINES.md](Documentation/GUIDELINES.md). +guidelines please have a look at [CONTRIBUTING.md](Documentation/CONTRIBUTING.md). +For documentation guidelines consult [RUSTDOC-GUIDELINES.md](Documentation/RUSTDOC-GUIDELINES.md). TODO List --------- diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..690d99800 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +# Security Issue Response Process + +Please report any security issue to this [email address](mailto:security@coconut-svsm.dev). diff --git a/build.rs b/build.rs index 18ef9efbc..cc539bd52 100644 --- a/build.rs +++ b/build.rs @@ -8,14 +8,14 @@ fn main() { // Stage 2 println!("cargo:rustc-link-arg-bin=stage2=-nostdlib"); println!("cargo:rustc-link-arg-bin=stage2=--build-id=none"); - println!("cargo:rustc-link-arg-bin=stage2=-Tstage2.lds"); + println!("cargo:rustc-link-arg-bin=stage2=-Tsrc/stage2.lds"); println!("cargo:rustc-link-arg-bin=stage2=-no-pie"); // SVSM 2 println!("cargo:rustc-link-arg-bin=svsm=-nostdlib"); println!("cargo:rustc-link-arg-bin=svsm=--build-id=none"); println!("cargo:rustc-link-arg-bin=svsm=--no-relax"); - println!("cargo:rustc-link-arg-bin=svsm=-Tsvsm.lds"); + println!("cargo:rustc-link-arg-bin=svsm=-Tsrc/svsm.lds"); println!("cargo:rustc-link-arg-bin=svsm=-no-pie"); // Extra linker args for tests. @@ -25,7 +25,7 @@ fn main() { println!("cargo:rustc-link-arg=-nostdlib"); println!("cargo:rustc-link-arg=--build-id=none"); println!("cargo:rustc-link-arg=--no-relax"); - println!("cargo:rustc-link-arg=-Tsvsm.lds"); + println!("cargo:rustc-link-arg=-Tsrc/svsm.lds"); println!("cargo:rustc-link-arg=-no-pie"); } } diff --git a/stage2.lds b/src/stage2.lds similarity index 77% rename from stage2.lds rename to src/stage2.lds index 3d1ef076f..7e1edbbd6 100644 --- a/stage2.lds +++ b/src/stage2.lds @@ -12,7 +12,15 @@ SECTIONS { . = 64k; .stext = .; - .text : { *(.startup.*) *(.text) *(.text.*) } + .text : { + *(.startup.*) + *(.text) + *(.text.*) + . = ALIGN(16); + exception_table_start = .; + KEEP(*(__exception_table)) + exception_table_end = .; + } . = ALIGN(16); .data : { *(.data) } . = ALIGN(16); diff --git a/svsm.lds b/src/svsm.lds similarity index 100% rename from svsm.lds rename to src/svsm.lds