aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ef8732
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+keywrap
+=======
+## Introduction ##
+
+This core implememts AES KEY WRAP as defined in [RFC
+3394](https://tools.ietf.org/html/rfc3394) and the keywrap with padding
+according to [RFC 5694](https://tools.ietf.org/html/rfc5649)
+
+The user/host system writes data to be wrapped/unwrapped to the core as
+well as the wrapping key. The core then handles the wrapping/unwrapping
+operation independently. When operation has completed the result can be
+read back.
+
+
+## Status ##
+Initial design has just been started. Does not work. Do not use.