summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fb20c4c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+Reference implementation
+========================
+
+This folder contains the reference implementation for Lilliput-AE.
+
+It is organized as follows:
+
+`src`
+-----
+
+Contains parameter-independent code.
+
+- `lilliput-ae.h`: main API
+- `tweakey.*`: implementation of Lilliput-TBC's tweakey schedule;
+- `cipher.*`: implementation of the tweakable block-cipher
+ Lilliput-TBC;
+- `constants.*`: tabulated data for
+ - the tweakey schedule's permutation h
+ - the tweakey schedule's multiplication sequences P~0~ to P~5~
+ - Lilliput-TBC's S-box
+- `parameters.h`: byte sizes for inputs and outputs (depends on
+ parameter-dependent `_parameters.h` files)
+- `lilliput-ae-i.c`: implementation of Lilliput-Ⅰ (ΘCB3-based)
+- `lilliput-ae-i.c`: implementation of Lilliput-Ⅱ (SCT-2-based)
+- `ae-common.h`: helper functions for AE schemes