lilliput-ae-reference-implementation

commit d1bc581b1923537e7410254d91890565f08d50ca
parent c0d7ffb343d38a301773ea49975de6c54c91e264
Author: Kévin Le Gouguec <kevin.legouguec@gmail.com>
Date:   Sat, 23 Mar 2019 20:04:22 +0100

[implem-python] Documentation du paquet "lilliput"

Diffstat:
M
src/add_python/lilliput/__init__.py
 | 
26
++++++++++++++++++++++++++

1 file changed, 26 insertions(+), 0 deletions(-)
diff --git a/src/add_python/lilliput/__init__.py b/src/add_python/lilliput/__init__.py
@@ -1,3 +1,29 @@
+# Implementation of the Lilliput-AE tweakable block cipher.
+#
+# Authors, hereby denoted as "the implementer":
+#     Kévin Le Gouguec,
+#     Léo Reynaud
+#     2019.
+#
+# For more information, feedback or questions, refer to our website:
+# https://paclido.fr/lilliput-ae
+#
+# To the extent possible under law, the implementer has waived all copyright
+# and related or neighboring rights to the source code in this file.
+# http://creativecommons.org/publicdomain/zero/1.0/
+
+"""Lilliput-AE tweakable block cipher.
+
+This module provides the high-level functions for authenticated encryption and
+decryption.  Both functions take and return bytestring values.
+
+The "mode" argument can be either of the following integers:
+
+- 1, for the ΘCB3 nonce-respecting mode,
+- 2, for the SCT-2 nonce-misuse-resistant mode.
+"""
+
+
 from . import lilliput_ae_1
 from . import lilliput_ae_2
 from .constants import NONCE_BYTES