init: create project template

1. Create directory skeleton
2. Create template for VMSDK
3. Add some initial design doc and diagrams

Signed-off-by: Lu, Ken <[email protected]>

.github/cspell.json

@@ -0,0 +1,36 @@
+{
+    "version": "0.2",
+    "ignorepaths": [
+        ".github/",
+        ".git/"
+    ],
+    "ignorewords": [],
+    "ignoreRegExpList": [
+        "/```[\\s\\S]*?```/g",
+        "/`[\\s\\S]*?`/g"
+    ],
+    "import": [],
+    "dictionarydefinitions": [],
+    "dictionaries": [],
+    "words": [
+        "ccnp",
+        "containerd",
+        "daemonset",
+        "Eventlog",
+        "grpcurl",
+        "kustomization",
+        "NFD",
+        "proto",
+        "quoteserver",
+        "RTMR",
+        "TDVM",
+        "udev",
+        "PCCS",
+        "DCAP",
+        "distros",
+        "PCKID",
+        "pccs",
+        "pckcache",
+        "sysfs"
+    ]
+}

.github/workflows/doclint.yaml

@@ -0,0 +1,22 @@
+name: Document Scan
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  scan_doc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: streetsidesoftware/cspell-action@v2
+        with:
+          files: |
+            **/*.md
+            *.md
+          config: .github/cspell.json
+          verbose: true
+          incremental_files_only: false

README.md

@@ -0,0 +1,9 @@
+# CC Trusted API
+
+The project help to access and process the trusted primitives (measurement, eventlog,
+quote) in confidential computing environment. It support multiple language flavors.
+
+It also provides back-end tool, IMA template, services to produce the diverse TCBs
+according to deployment.
+
+![](docs/cc-trusted-api-overview.png)

samples/CCTrustedInspect/README.md

@@ -0,0 +1,4 @@
+# Inspect Tool
+
+Get and dump the trusted primitives like measurement, event log, quote. With different
+back-end SDK, the inspected TCB could be VM base, container or cluster.

utils/README.md

@@ -0,0 +1 @@
+# Utilities

vmsdk/README.md

@@ -0,0 +1,8 @@
+
+# SDK for CC Trusted API in Confidential VM
+
+In confidential VM, the trusted primitives (measurement, eventlog, quote) normally
+can be accessed via device node like /dev/tpm0, sysfs etc, and different vendor
+may provides the different definitions.
+
+![](/docs/cc-trusted-primitives-vendor.png)

vmsdk/python/cctrusted/__init__.py

@@ -0,0 +1,12 @@
+"""
+Package to provide CC trusted API for confidential VM
+"""
+
+def get_measurements():
+    pass
+
+def get_eventlog():
+    pass
+
+def get_quote():
+    pass