commit 0aa18e041fe03a841a190e00f36395f0286dba8c
author Raef Coles <raef.coles@arm.com> Wed Jun 15 13:05:56 2022 +0100
committer Raef Coles <raef.coles@arm.com> Thu Oct 13 14:28:18 2022 +0100
tree 20e56e4cba31f79319ad0ba7da351a64916ec116
parent c464746d456557135ec04b22c602865dc532ff8c

Note that LMS sign function is for testing only

Signed-off-by: Raef Coles <raef.coles@arm.com>

include/mbedtls/lms.h

diff --git a/include/mbedtls/lms.h b/include/mbedtls/lms.h
index 2de03f7..77559e2 100644
--- a/include/mbedtls/lms.h
+++ b/include/mbedtls/lms.h
@@ -34,7 +34,7 @@
 #define MBEDTLS_ERR_LMS_VERIFY_FAILED    -0x0015 /**< LMS signature verification failed */
 #define MBEDTLS_ERR_LMS_ALLOC_FAILED     -0x0017 /**< LMS failed to allocate space for a private key */
 
-#define MBEDTLS_LMS_TYPE_LEN        (4)
+#define MBEDTLS_LMS_TYPE_LEN            (4)
 #define MBEDTLS_LMS_H_TREE_HEIGHT       (10)
 #define MBEDTLS_LMS_M_NODE_BYTES        (32)
 
@@ -123,6 +123,10 @@
  * \brief                    This function creates a LMS signature, using a
  *                           LMOTS context that contains a private key.
  *
+ * \note                     This function is intended for _testing purposes
+ *                           only_, due to complexities around updating stateful
+ *                           keys.
+ *
  * \note                     Before this function is called, the context must
  *                           have been initialized and must contain a private
  *                           key.