summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 12 insertions, 32 deletions
diff --git a/README.md b/README.md
index dcafdf6..3f2b776 100644
--- a/README.md
+++ b/README.md
@@ -19,47 +19,27 @@ Contains parameter-independent code for the reference implementation:
Lilliput-TBC
- `constants.*`: tabulated data for
- the tweakey schedule's permutation h
- - the tweakey schedule's multiplication sequences P~0~ to P~5~
+ - the tweakey schedule's multiplication sequences P~1~ to P~6~
- Lilliput-TBC's S-box
- `parameters.h`: byte sizes for inputs and outputs (depends on
parameter-dependent `_parameters.h` files)
-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
-
-`crypto_aead`
--------------
-
-Contains parameter-dependent code. There is one subfolder per member
-of the Lilliput-AE family, named according to NIST's requirements:
-
-> The second-level directory name is a lowercase version of the name
-> of the algorithm, including the version number and a family member
-> identifier (if multiple family members in submission). […] Dashes,
-> dots, slashes, and other punctuation marks are omitted; the
-> directory name consists solely of digits (0123456789) and lowercase
-> ASCII letters (acbdefghijklmnopqrstuvwxyz).
-
-
-The subfolders are thus named `lilliputae${mode}${keybits}v1`:
+There is one subfolder for each variant of the Lilliput-AE family,
+named `${mode}-${keybits}`:
- mode is either i (for ΘCB3) or ii (for SCT-2)
-- keybits is either 128, 192 or 256.
+- keybits is either 128, 192 or 256
-Each subfolders contains:
+`test`
+-------------
-- a `ref` directory, containing parameter-dependent code for the
- reference implementation and tests for these specific parameters
-- other directories with additional implementations, named `add_*`
+Contains test vectors. There is one subfolder per member of the
+Lilliput-AE family, as well as:
-TODO: the tests for a given family member should be moved up alongside
-`ref` and `add_*` folders since they should apply to all
-implementations. Also, the "parameter-dependent" code has been reduced
-to a header with three constants; maybe the whole `crypto_aead` folder
-could be removed.
+- `common.mk`: makefile recipes for test programs
+- `debug.h`: helper functions to dump intermediate values, used in
+ the trace-generating patches
+- `test-helpers.h`: helper functions for test code
`nist`
------