summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index fb20c4c..4623c02 100644
--- a/README.md
+++ b/README.md
@@ -8,18 +8,25 @@ It is organized as follows:
`src`
-----
-Contains parameter-independent code.
+Contains parameter-independent code for the reference implementation:
- `lilliput-ae.h`: main API
-- `tweakey.*`: implementation of Lilliput-TBC's tweakey schedule;
+- `lilliput-ae-i.c`: implementation of Lilliput-Ⅰ (ΘCB3-based)
+- `lilliput-ae-i.c`: implementation of Lilliput-Ⅱ (SCT-2-based)
+- `ae-common.h`: internal helper functions used by both AE schemes
+- `tweakey.*`: implementation of Lilliput-TBC's tweakey schedule
- `cipher.*`: implementation of the tweakable block-cipher
- Lilliput-TBC;
+ 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
+
+Also contains some support files:
+
+- `common.mk`: Makefile recipes to compile and test the implementation
+- `debug.h`: helper functions to ease debugging and dump intermediate
+ values
+