commit 26f3a55a9990a83bc991fbb4d488120172d2ce4f Author: Dan Middleton Date: Fri Nov 12 12:33:05 2021 -0600 Add README, CoC, LICENSE and PR review guide Add files from Confidential-Containers and Kata orgs Signed-off-by: Dan Middleton diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..b235c37 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,4 @@ +## Confidential Containers Code of Conduct + +Confidential Containers follows the +[CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/PR-Review-Guide.md b/PR-Review-Guide.md new file mode 100644 index 0000000..b91e585 --- /dev/null +++ b/PR-Review-Guide.md @@ -0,0 +1,136 @@ +* [High level considerations](#high-level-considerations) + * [Security](#security) + * [Reliability](#reliability) + * [Performance](#performance) + * [Maintenance](#maintenance) + * [Usability](#usability) +* [Specifics to consider](#specifics-to-consider) + * [Basics](#basics) + * [Layout and formatting](#layout-and-formatting) + * [Design](#design) + * [Code comments](#code-comments) + * [Documentation](#documentation) + * [Logging and debugging](#logging-and-debugging) + * [Testing](#testing) + * [Environments](#environments) + * [Upgrades](#upgrades) +* [Mandatory checks](#mandatory-checks) + +--- + +This document attempts to capture some of the points to consider when +reviewing a [new code contribution](CONTRIBUTING.md) (a Pull Request (PR)) to +ensure overall quality is high. + +## High level considerations + +### Security + +- Does the change introduce a potential security risk? + - What additional checks resolve the potential security risk? + +### Reliability + +- What happens on failure? Consider **every** possible failure. For example: + - Are temporary files left on the disk? + - Are any resources (e.g. memory and open files) leaked? + +- If the code crashes, what is the overall system impact? + - Can the system be restarted and recovered? + - Is [security](#security) compromised? + +### Performance + +- Does this change negatively impact performance? +- Can any calls block? If yes, there must be a log call before the blocking call explaining what is about to be done. + +### Maintenance + +- How easy is this code to maintain: + - By an experienced developer on the project? + - By a developer with none or almost no experience of the code base or the project? + +### Usability + +- Does the change improve usability or make it worse? +- Can usability be improved further? + +## Specifics to consider + +### Basics + +- Consider *all* inputs and outputs. +- What resources are being used (e.g. memory, disk, etc.)? Are the resources released? +- Are all return values and arguments checked? +- Are there any magic numbers? + +### Layout and formatting + +- Is formatting and naming consistent? +- Are there any spelling mistakes ("typos")? +- Do all new files contain the required licence header? + +### Design + +- Can the code be simplified or refactored? + - Is the code "too clever"? Overly clever code can be fragile. Reject it unless there is a **very** good documented reason. +- Is there a better (simpler) solution to the problem? +- Is there any duplication? +- Does the code "reinvent the wheel?" Is there a standard package you can use instead? +- What assumptions does the code make? Are the assumptions valid and documented? +- Does the code make sense? + - Someone with minimal exposure to the codebase should be able to guess what the code is doing. + +### Code comments + +- Is the code well commented? +- Are all functions and function parameters documented. For `golang` programs, is their purpose obvious? +- Does this change require an update to the README(s) or architecture docs, installation docs, or limitations docs? +- Are any lines commented out? If yes, remove them. +- Are there any `FIXME` or `TODO`'s? If yes, replace them with a full URL to an issue number tracking the work to be done. + +### Documentation + +- Should the document update be applied to any *other* documents? + For example, when a PR updates an installation guide, determine whether those changes apply to one or more of the other installation guides. +- Does the PR make any of the following changes? If yes, determine if a documentation change is necessary: + - New programs or scripts are added or removed. + - New program or script options are added or removed. + - New config options are added or removed. + - New features are added or removed. + - Existing bug(s) are fixed. + +### Logging and debugging + +- Can someone debug this code from a logfile if it fails? +- Are all fatal scenarios logged? +- Are error messages and log calls useful and comprehensive? Ensure sensitive information is **not** displayed. + +### Testing + +- Is the code easy to test? +- Are there new unit tests? If not, why not? +- What other classes of testing (e.g. integration, system, stress, fuzz) can someone write to check the code? + +### Environments + +- Does the code work on all distributions? +- Does the code work on all architectures? +- What environments does your code run in? +- Which user does the code run as? If it runs as the superuser, have clear documentation to explain why this is necessary. + +### Upgrades + +- If the code logs internal state to a file or shared memory, how are upgrades handled? +For example, if a new version introduces a new state file format, does the new version consume the old state file format files? +- If upgrades cannot be handled, document this. + +## Mandatory checks + +- Provide constructive comments on the code. + - If you particularly like some aspect of the code, say so. + - If you do not like something about the code, respectfully state what you do not like. + - If you do not understand the code, say so because code should **always** be clear. + +- Ensure all automated checks pass. +- Ensure the PR contains at least one `Fixes #XXX` commit message referencing an issue that this PR fixes. diff --git a/README.md b/README.md new file mode 100644 index 0000000..21147d1 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +![alt text](coco_logo.png "Confidential Containers") + +## Welcome to confidential-containers + +We are interested in integrating existing [Trusted Execution +Environments](https://en.wikipedia.org/wiki/Trusted_execution_environment) (TEE) infrastructure +support and technologies with the cloud native world. Our focus is to place a kubernetes pod into a +TEE. + +### Find out more... +- [Documentation](https://github.com/confidential-containers/documentation) : Find out more about + the progress to date, overall goals and work in progress. + +### Get started quickly... +- [Kubernetes Operator for Confidential + Computing](https://github.com/confidential-containers/confidential-containers-operator) : An + operator to deploy confidential containers runtime (and required configs) on a Kubernetes cluster diff --git a/coco_logo.png b/coco_logo.png new file mode 100644 index 0000000..adbdaf2 Binary files /dev/null and b/coco_logo.png differ