From 0aa18e041fe03a841a190e00f36395f0286dba8c Mon Sep 17 00:00:00 2001 From: Raef Coles Date: Wed, 15 Jun 2022 13:05:56 +0100 Subject: [PATCH] Note that LMS sign function is for testing only Signed-off-by: Raef Coles --- include/mbedtls/lms.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/include/mbedtls/lms.h b/include/mbedtls/lms.h index 2de03f7ef6..77559e24b7 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 @@ int mbedtls_lms_set_algorithm_type( mbedtls_lms_context *ctx, * \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.