summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKévin Le Gouguec <kevin.legouguec@airbus.com>2018-11-29 17:23:25 +0100
committerKévin Le Gouguec <kevin.legouguec@airbus.com>2018-11-29 17:23:25 +0100
commit03dbcc215140ae1d465242cc22e97c3df504d7d1 (patch)
tree914e667568ee5393bb9728ffa9248e9a30dab3a8 /README.md
parent4ee53ce2ac2e32aa9ae9c2334f0770d7f5f28fa8 (diff)
downloadlilliput-ae-implem-03dbcc215140ae1d465242cc22e97c3df504d7d1.tar.xz
Début de documentation pour l'implémentation de référence
Diffstat (limited to 'README.md')
-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