First Publicly Shared Version of ODKiTEE v15

README.md

@@ -0,0 +1,31 @@
+# OEMCrypto Development Kit For Trusted Execution Environments
+
+ODKiTEE is the Widevine hardened reference implementation of OEMCrypto suitable
+to run in a TEE. It is written in C with a thin porting interface to make it
+easier to port to various trusted environments.
+
+## Current Status
+
+This very early preview release contains an early version of the ODKiTEE source
+code. It contains only the following:
+
+1) Code for an IPC layer that implements the OEMCrypto API functions, translates
+   the calls into serialized objects, deserializes the objects inside the TEE,
+   and invokes the appropriate TA function
+2) Code for a Trusted Application that implements the logic of OEMCrypto
+
+No build system is included. No implementation of the porting layers for working
+with different TEE OSes and chip hardware is included.
+
+In addition, the code herein has the following known limitations:
+
+1) The usage table code does not yet encrypt the usage table information.
+2) The code is only sporadically and opportunistically hardened.
+3) Some minor functionality is still missing, though it should all be marked
+   with TODO comments.
+
+If you have received this code, Widevine is looking for your feedback! Please
+let us know where it can be improved. Don't hesitate to call out things you
+think we already know, particularly as regards hardening. We want to know
+whether the places we see room for improvement are the same as the ones where
+you do.