[incubator-teaclave] branch master updated: Add more docs (#369)

[ms...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mssun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-teaclave.git


The following commit(s) were added to refs/heads/master by this push:
     new 326980f  Add more docs (#369)
326980f is described below

commit 326980f4f52b186978267ec741b55eb7fb141041
Author: Mingshen Sun <bo...@mssun.me>
AuthorDate: Tue Jun 23 17:17:54 2020 -0700

    Add more docs (#369)
---
 CONTRIBUTORS.md  |  1 +
 README.md        |  4 ++++
 binder/README.md |  7 +++++++
 common/README.md | 10 ++++++++++
 crypto/README.md | 11 +++++++++++
 docs/README.md   |  4 ++++
 types/README.md  |  5 +++++
 7 files changed, 42 insertions(+)

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
index e1fe2fc..89da0dd 100644
--- a/CONTRIBUTORS.md
+++ b/CONTRIBUTORS.md
@@ -48,6 +48,7 @@ List of external contributors of Teaclave and Teaclave SGX SDK (in alphabetical
   - [Akhil Velagapudi](https://github.com/akhilles)
   - [David Phan](https://github.com/davidp94)
   - [Elichai Turkel](https://github.com/elichai)
+  - [GeminiCarrie](https://github.com/GeminiCarrie)
   - [Greg Kapka](https://github.com/gskapka)
   - [Hongbin Mao](https://github.com/hello2mao)
   - [Jackson Owens](https://github.com/jbowens)
diff --git a/README.md b/README.md
index b2d554b..2589a90 100644
--- a/README.md
+++ b/README.md
@@ -52,10 +52,13 @@ platform, making computation on privacy-sensitive data safe and simple.
 ### Codebase
 
 - [Attestation](attestation)
+- [Binder](binder)
 - [Built-in Functions](function)
 - [Client SDK](sdk)
 - [Command Line Tool](cli)
+- [Common Libraries](common)
 - [Configurations in Teaclave](config)
+- [Crypto Primitives](crypto)
 - [Data Center Attestation Service](dcap)
 - [Dockerfile and Compose File](docker)
 - [Examples](examples)
@@ -68,6 +71,7 @@ platform, making computation on privacy-sensitive data safe and simple.
 - [Teaclave Worker](worker)
 - [Test Harness and Test Cases](tests)
 - [Third-Party Dependency Vendoring](third_party)
+- [Types](types)
 
 ### API Docs
 
diff --git a/binder/README.md b/binder/README.md
new file mode 100644
index 0000000..40e2907
--- /dev/null
+++ b/binder/README.md
@@ -0,0 +1,7 @@
+# Binder
+
+The binder library provides communication interfaces between TEE's app/enclave
+worlds. More specific, the binder implements a message passing protocol for
+intra-procedure communication. The protocol provides a secure and (type) safe
+channel to pass information. For example, in Teaclave, we use the binder library
+to launch Teaclave services and pass runtime configurations to trusted enclaves.
diff --git a/common/README.md b/common/README.md
new file mode 100644
index 0000000..24b9fa7
--- /dev/null
+++ b/common/README.md
@@ -0,0 +1,10 @@
+# Common Libraries
+
+This directory contains some supporting libraries such as error handling, file
+system, and database for the Teaclave platform, or more general TEE system.
+
+- `mayfail`: A crate to help manage chained error in Rust.
+- `protected_fs_rs`: A userspace file system implementation secured by SGX.
+- `rusty_leveldb_sgx`: A LevelDB implementation, making key-value database in
+  SGX enclave possible.
+
diff --git a/crypto/README.md b/crypto/README.md
new file mode 100644
index 0000000..b662dee
--- /dev/null
+++ b/crypto/README.md
@@ -0,0 +1,11 @@
+# Crypto Primitives
+
+This directory hosts all the implementations of cryptographic primitives used in
+Teaclave for encryption/decryption of registered data.
+
+Current crypto primitives include:
+
+- AES GCM: Commonly used symmetric-key cryptographic block ciphers. Supported
+  key sizes are: 128bits, 256bits.
+- Teaclave File Key: Key for Teaclave file system (i.e., protected FS). Only
+  128bits key is supported.
diff --git a/docs/README.md b/docs/README.md
index b484c76..992837d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -24,10 +24,13 @@ permalink: /docs/
 ## Codebase
 
 - [Attestation](../attestation/README.md)
+- [Binder](../binder/README.md)
 - [Built-in Functions](../function/README.md)
 - [Client SDK](../sdk/README.md)
 - [Command Line Tool](../cli/README.md)
+- [Common Libraries](../common/README.md)
 - [Configurations in Teaclave](../config/README.md)
+- [Crypto Primitives](../crypto/README.md)
 - [Data Center Attestation Service](../dcap/README.md)
 - [Dockerfile and Compose File](../docker/README.md)
 - [Examples](../examples/README.md)
@@ -40,3 +43,4 @@ permalink: /docs/
 - [Teaclave Worker](../worker/README.md)
 - [Test Harness and Test Cases](../tests/README.md)
 - [Third-Party Dependency Vendoring](../third_party/README.md)
+- [Types](../types/README.md)
diff --git a/types/README.md b/types/README.md
new file mode 100644
index 0000000..68b245f
--- /dev/null
+++ b/types/README.md
@@ -0,0 +1,5 @@
+# Types
+
+This directory defines common types (useful structs and traits) such as file,
+function, and task used in the Teaclave platform. Note that the `teaclave_types`
+crate can be used in both app and trusted enclave parts.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@teaclave.apache.org
For additional commands, e-mail: commits-help@teaclave.apache.org