blob: 404aa80da63ad45c1d06d80627b5ce58e6f7486c [file] [log] [blame]
Raef Coles8ff6df52021-07-21 12:42:15 +01001/*
2 * The LM-OTS one-time public-key signature scheme
3 *
4 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Raef Coles8ff6df52021-07-21 12:42:15 +01006 */
7
8/*
9 * The following sources were referenced in the design of this implementation
10 * of the LM-OTS algorithm:
11 *
12 * [1] IETF RFC8554
13 * D. McGrew, M. Curcio, S.Fluhrer
14 * https://datatracker.ietf.org/doc/html/rfc8554
15 *
16 * [2] NIST Special Publication 800-208
17 * David A. Cooper et. al.
18 * https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-208.pdf
19 */
20
21#include "common.h"
22
Raef Coles5127e852022-10-07 10:35:56 +010023#if defined(MBEDTLS_LMS_C)
Raef Coles8ff6df52021-07-21 12:42:15 +010024
25#include <string.h>
26
Raef Coles7dce69a2022-08-24 14:07:06 +010027#include "lmots.h"
28
Raef Colesc8f96042022-08-25 13:49:54 +010029#include "mbedtls/lms.h"
Raef Coles8ff6df52021-07-21 12:42:15 +010030#include "mbedtls/platform_util.h"
31#include "mbedtls/error.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020032#include "psa_util_internal.h"
Raef Coles8ff6df52021-07-21 12:42:15 +010033
Raef Colesc8f96042022-08-25 13:49:54 +010034#include "psa/crypto.h"
35
Andrzej Kurek00644842023-05-30 05:45:00 -040036/* Define a local translating function to save code size by not using too many
37 * arguments in each translating place. */
38static int local_err_translation(psa_status_t status)
39{
40 return psa_status_to_mbedtls(status, psa_to_lms_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040041 ARRAY_LENGTH(psa_to_lms_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040042 psa_generic_status_to_mbedtls);
43}
44#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050045
Raef Coles57d53282022-09-27 11:30:51 +010046#define PUBLIC_KEY_TYPE_OFFSET (0)
47#define PUBLIC_KEY_I_KEY_ID_OFFSET (PUBLIC_KEY_TYPE_OFFSET + \
48 MBEDTLS_LMOTS_TYPE_LEN)
49#define PUBLIC_KEY_Q_LEAF_ID_OFFSET (PUBLIC_KEY_I_KEY_ID_OFFSET + \
50 MBEDTLS_LMOTS_I_KEY_ID_LEN)
51#define PUBLIC_KEY_KEY_HASH_OFFSET (PUBLIC_KEY_Q_LEAF_ID_OFFSET + \
52 MBEDTLS_LMOTS_Q_LEAF_ID_LEN)
Raef Coles01c71a12022-08-31 15:55:00 +010053
54/* We only support parameter sets that use 8-bit digits, as it does not require
55 * translation logic between digits and bytes */
56#define W_WINTERNITZ_PARAMETER (8u)
57#define CHECKSUM_LEN (2)
58#define I_DIGIT_IDX_LEN (2)
59#define J_HASH_IDX_LEN (1)
60#define D_CONST_LEN (2)
61
Raef Coles9b88ee52022-09-02 12:04:21 +010062#define DIGIT_MAX_VALUE ((1u << W_WINTERNITZ_PARAMETER) - 1u)
Raef Coles01c71a12022-08-31 15:55:00 +010063
Raef Coles9b88ee52022-09-02 12:04:21 +010064#define D_CONST_LEN (2)
Gilles Peskine449bd832023-01-11 14:50:10 +010065static const unsigned char D_PUBLIC_CONSTANT_BYTES[D_CONST_LEN] = { 0x80, 0x80 };
66static const unsigned char D_MESSAGE_CONSTANT_BYTES[D_CONST_LEN] = { 0x81, 0x81 };
Raef Coles8ff6df52021-07-21 12:42:15 +010067
Raef Coles9c9027b2022-09-02 18:26:31 +010068#if defined(MBEDTLS_TEST_HOOKS)
Gilles Peskine449bd832023-01-11 14:50:10 +010069int (*mbedtls_lmots_sign_private_key_invalidated_hook)(unsigned char *) = NULL;
Raef Coles9c9027b2022-09-02 18:26:31 +010070#endif /* defined(MBEDTLS_TEST_HOOKS) */
71
Raef Coles0a967cc2022-09-02 17:46:15 +010072/* Calculate the checksum digits that are appended to the end of the LMOTS digit
73 * string. See NIST SP800-208 section 3.1 or RFC8554 Algorithm 2 for details of
74 * the checksum algorithm.
75 *
Raef Coles98d6e222022-09-23 09:04:04 +010076 * params The LMOTS parameter set, I and q values which
77 * describe the key being used.
Raef Coles0a967cc2022-09-02 17:46:15 +010078 *
Raef Coles98d6e222022-09-23 09:04:04 +010079 * digest The digit string to create the digest from. As
80 * this does not contain a checksum, it is the same
81 * size as a hash output.
Raef Coles0a967cc2022-09-02 17:46:15 +010082 */
Gilles Peskine449bd832023-01-11 14:50:10 +010083static unsigned short lmots_checksum_calculate(const mbedtls_lmots_parameters_t *params,
84 const unsigned char *digest)
Raef Coles8ff6df52021-07-21 12:42:15 +010085{
86 size_t idx;
Raef Coles01c71a12022-08-31 15:55:00 +010087 unsigned sum = 0;
Raef Coles8ff6df52021-07-21 12:42:15 +010088
Gilles Peskine449bd832023-01-11 14:50:10 +010089 for (idx = 0; idx < MBEDTLS_LMOTS_N_HASH_LEN(params->type); idx++) {
Raef Coles01c71a12022-08-31 15:55:00 +010090 sum += DIGIT_MAX_VALUE - digest[idx];
Raef Coles8ff6df52021-07-21 12:42:15 +010091 }
92
Gilles Peskine449bd832023-01-11 14:50:10 +010093 return sum;
Raef Coles8ff6df52021-07-21 12:42:15 +010094}
95
Raef Coles0a967cc2022-09-02 17:46:15 +010096/* Create the string of digest digits (in the base determined by the Winternitz
97 * parameter with the checksum appended to the end (Q || cksm(Q)). See NIST
98 * SP800-208 section 3.1 or RFC8554 Algorithm 3 step 5 (also used in Algorithm
99 * 4b step 3) for details.
100 *
Raef Coles98d6e222022-09-23 09:04:04 +0100101 * params The LMOTS parameter set, I and q values which
102 * describe the key being used.
Raef Coles0a967cc2022-09-02 17:46:15 +0100103 *
Raef Coles98d6e222022-09-23 09:04:04 +0100104 * msg The message that will be hashed to create the
105 * digest.
Raef Coles0a967cc2022-09-02 17:46:15 +0100106 *
Raef Coles98d6e222022-09-23 09:04:04 +0100107 * msg_size The size of the message.
Raef Coles0a967cc2022-09-02 17:46:15 +0100108 *
Raef Coles98d6e222022-09-23 09:04:04 +0100109 * C_random_value The random value that will be combined with the
110 * message digest. This is always the same size as a
111 * hash output for whichever hash algorithm is
112 * determined by the parameter set.
Raef Coles0a967cc2022-09-02 17:46:15 +0100113 *
Raef Coles98d6e222022-09-23 09:04:04 +0100114 * output An output containing the digit string (+
115 * checksum) of length P digits (in the case of
116 * MBEDTLS_LMOTS_SHA256_N32_W8, this means it is of
117 * size P bytes).
Raef Coles0a967cc2022-09-02 17:46:15 +0100118 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100119static int create_digit_array_with_checksum(const mbedtls_lmots_parameters_t *params,
120 const unsigned char *msg,
121 size_t msg_len,
122 const unsigned char *C_random_value,
123 unsigned char *out)
Raef Coles8ff6df52021-07-21 12:42:15 +0100124{
Raef Colesbe0c2f92022-10-07 11:27:35 +0100125 psa_hash_operation_t op = PSA_HASH_OPERATION_INIT;
126 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Raef Colesc8f96042022-08-25 13:49:54 +0100127 size_t output_hash_len;
Raef Coles8ff6df52021-07-21 12:42:15 +0100128 unsigned short checksum;
Raef Coles8ff6df52021-07-21 12:42:15 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 status = psa_hash_setup(&op, PSA_ALG_SHA_256);
131 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100132 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100133 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100134
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 status = psa_hash_update(&op, params->I_key_identifier,
136 MBEDTLS_LMOTS_I_KEY_ID_LEN);
137 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100138 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100140
Gilles Peskine449bd832023-01-11 14:50:10 +0100141 status = psa_hash_update(&op, params->q_leaf_identifier,
142 MBEDTLS_LMOTS_Q_LEAF_ID_LEN);
143 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100144 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100146
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 status = psa_hash_update(&op, D_MESSAGE_CONSTANT_BYTES, D_CONST_LEN);
148 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100149 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100151
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 status = psa_hash_update(&op, C_random_value,
153 MBEDTLS_LMOTS_C_RANDOM_VALUE_LEN(params->type));
154 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100155 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 status = psa_hash_update(&op, msg, msg_len);
159 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100160 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163 status = psa_hash_finish(&op, out,
164 MBEDTLS_LMOTS_N_HASH_LEN(params->type),
165 &output_hash_len);
166 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100167 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 checksum = lmots_checksum_calculate(params, out);
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000171 MBEDTLS_PUT_UINT16_BE(checksum, out, MBEDTLS_LMOTS_N_HASH_LEN(params->type));
Raef Coles8ff6df52021-07-21 12:42:15 +0100172
Raef Coles01c71a12022-08-31 15:55:00 +0100173exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 psa_hash_abort(&op);
Raef Coles8ff6df52021-07-21 12:42:15 +0100175
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500176 return PSA_TO_MBEDTLS_ERR(status);
Raef Coles8ff6df52021-07-21 12:42:15 +0100177}
178
Raef Coles0a967cc2022-09-02 17:46:15 +0100179/* Hash each element of the string of digits (+ checksum), producing a hash
180 * output for each element. This is used in several places (by varying the
181 * hash_idx_min/max_values) in order to calculate a public key from a private
182 * key (RFC8554 Algorithm 1 step 4), in order to sign a message (RFC8554
183 * Algorithm 3 step 5), and to calculate a public key candidate from a
184 * signature and message (RFC8554 Algorithm 4b step 3).
185 *
Raef Coles98d6e222022-09-23 09:04:04 +0100186 * params The LMOTS parameter set, I and q values which
187 * describe the key being used.
Raef Coles0a967cc2022-09-02 17:46:15 +0100188 *
Raef Coles98d6e222022-09-23 09:04:04 +0100189 * x_digit_array The array of digits (of size P, 34 in the case of
190 * MBEDTLS_LMOTS_SHA256_N32_W8).
Raef Coles0a967cc2022-09-02 17:46:15 +0100191 *
Raef Coles98d6e222022-09-23 09:04:04 +0100192 * hash_idx_min_values An array of the starting values of the j iterator
193 * for each of the members of the digit array. If
194 * this value in NULL, then all iterators will start
195 * at 0.
Raef Coles0a967cc2022-09-02 17:46:15 +0100196 *
Raef Coles98d6e222022-09-23 09:04:04 +0100197 * hash_idx_max_values An array of the upper bound values of the j
198 * iterator for each of the members of the digit
199 * array. If this value in NULL, then iterator is
200 * bounded to be less than 2^w - 1 (255 in the case
201 * of MBEDTLS_LMOTS_SHA256_N32_W8)
Raef Coles0a967cc2022-09-02 17:46:15 +0100202 *
Raef Coles98d6e222022-09-23 09:04:04 +0100203 * output An array containing a hash output for each member
204 * of the digit string P. In the case of
205 * MBEDTLS_LMOTS_SHA256_N32_W8, this is of size 32 *
206 * 34.
Raef Coles0a967cc2022-09-02 17:46:15 +0100207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static int hash_digit_array(const mbedtls_lmots_parameters_t *params,
209 const unsigned char *x_digit_array,
210 const unsigned char *hash_idx_min_values,
211 const unsigned char *hash_idx_max_values,
212 unsigned char *output)
Raef Coles8ff6df52021-07-21 12:42:15 +0100213{
Raef Coles8738a492022-09-02 17:13:01 +0100214 unsigned int i_digit_idx;
Raef Coles01c71a12022-08-31 15:55:00 +0100215 unsigned char i_digit_idx_bytes[I_DIGIT_IDX_LEN];
Raef Coles8738a492022-09-02 17:13:01 +0100216 unsigned int j_hash_idx;
217 unsigned char j_hash_idx_bytes[J_HASH_IDX_LEN];
Raef Coles01c71a12022-08-31 15:55:00 +0100218 unsigned int j_hash_idx_min;
219 unsigned int j_hash_idx_max;
Raef Colesbe0c2f92022-10-07 11:27:35 +0100220 psa_hash_operation_t op = PSA_HASH_OPERATION_INIT;
221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Raef Colesc8f96042022-08-25 13:49:54 +0100222 size_t output_hash_len;
Raef Colese9479a02022-09-01 16:06:35 +0100223 unsigned char tmp_hash[MBEDTLS_LMOTS_N_HASH_LEN_MAX];
Raef Coles8ff6df52021-07-21 12:42:15 +0100224
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 for (i_digit_idx = 0;
226 i_digit_idx < MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT(params->type);
227 i_digit_idx++) {
Raef Coles8ff6df52021-07-21 12:42:15 +0100228
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 memcpy(tmp_hash,
230 &x_digit_array[i_digit_idx * MBEDTLS_LMOTS_N_HASH_LEN(params->type)],
231 MBEDTLS_LMOTS_N_HASH_LEN(params->type));
Raef Coles8ff6df52021-07-21 12:42:15 +0100232
Raef Coles366d67d2022-09-01 17:23:12 +0100233 j_hash_idx_min = hash_idx_min_values != NULL ?
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 hash_idx_min_values[i_digit_idx] : 0;
Raef Coles366d67d2022-09-01 17:23:12 +0100235 j_hash_idx_max = hash_idx_max_values != NULL ?
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 hash_idx_max_values[i_digit_idx] : DIGIT_MAX_VALUE;
Raef Coles8ff6df52021-07-21 12:42:15 +0100237
Gilles Peskine449bd832023-01-11 14:50:10 +0100238 for (j_hash_idx = j_hash_idx_min;
239 j_hash_idx < j_hash_idx_max;
240 j_hash_idx++) {
241 status = psa_hash_setup(&op, PSA_ALG_SHA_256);
242 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100243 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 status = psa_hash_update(&op,
247 params->I_key_identifier,
248 MBEDTLS_LMOTS_I_KEY_ID_LEN);
249 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100250 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 status = psa_hash_update(&op,
254 params->q_leaf_identifier,
255 MBEDTLS_LMOTS_Q_LEAF_ID_LEN);
256 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100259
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000260 MBEDTLS_PUT_UINT16_BE(i_digit_idx, i_digit_idx_bytes, 0);
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 status = psa_hash_update(&op, i_digit_idx_bytes, I_DIGIT_IDX_LEN);
262 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100263 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100265
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000266 j_hash_idx_bytes[0] = (uint8_t) j_hash_idx;
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 status = psa_hash_update(&op, j_hash_idx_bytes, J_HASH_IDX_LEN);
268 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100269 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100271
Gilles Peskine449bd832023-01-11 14:50:10 +0100272 status = psa_hash_update(&op, tmp_hash,
273 MBEDTLS_LMOTS_N_HASH_LEN(params->type));
274 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100275 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100277
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 status = psa_hash_finish(&op, tmp_hash, sizeof(tmp_hash),
279 &output_hash_len);
280 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100281 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 psa_hash_abort(&op);
Raef Coles8ff6df52021-07-21 12:42:15 +0100285 }
286
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 memcpy(&output[i_digit_idx * MBEDTLS_LMOTS_N_HASH_LEN(params->type)],
288 tmp_hash, MBEDTLS_LMOTS_N_HASH_LEN(params->type));
Raef Coles8ff6df52021-07-21 12:42:15 +0100289 }
290
Raef Coles01c71a12022-08-31 15:55:00 +0100291exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 psa_hash_abort(&op);
293 mbedtls_platform_zeroize(tmp_hash, sizeof(tmp_hash));
Raef Coles01c71a12022-08-31 15:55:00 +0100294
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500295 return PSA_TO_MBEDTLS_ERR(status);
Raef Coles8ff6df52021-07-21 12:42:15 +0100296}
297
Raef Coles0a967cc2022-09-02 17:46:15 +0100298/* Combine the hashes of the digit array into a public key. This is used in
299 * in order to calculate a public key from a private key (RFC8554 Algorithm 1
300 * step 4), and to calculate a public key candidate from a signature and message
301 * (RFC8554 Algorithm 4b step 3).
302 *
Raef Coles98d6e222022-09-23 09:04:04 +0100303 * params The LMOTS parameter set, I and q values which describe
304 * the key being used.
305 * y_hashed_digits The array of hashes, one hash for each digit of the
306 * symbol array (which is of size P, 34 in the case of
307 * MBEDTLS_LMOTS_SHA256_N32_W8)
Raef Coles0a967cc2022-09-02 17:46:15 +0100308 *
Raef Coles98d6e222022-09-23 09:04:04 +0100309 * pub_key The output public key (or candidate public key in
310 * case this is being run as part of signature
311 * verification), in the form of a hash output.
Raef Coles0a967cc2022-09-02 17:46:15 +0100312 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100313static int public_key_from_hashed_digit_array(const mbedtls_lmots_parameters_t *params,
314 const unsigned char *y_hashed_digits,
315 unsigned char *pub_key)
Raef Coles8ff6df52021-07-21 12:42:15 +0100316{
Raef Colesbe0c2f92022-10-07 11:27:35 +0100317 psa_hash_operation_t op = PSA_HASH_OPERATION_INIT;
318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Raef Colesc8f96042022-08-25 13:49:54 +0100319 size_t output_hash_len;
Raef Coles8ff6df52021-07-21 12:42:15 +0100320
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 status = psa_hash_setup(&op, PSA_ALG_SHA_256);
322 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100323 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 status = psa_hash_update(&op,
327 params->I_key_identifier,
328 MBEDTLS_LMOTS_I_KEY_ID_LEN);
329 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100330 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100332
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 status = psa_hash_update(&op, params->q_leaf_identifier,
334 MBEDTLS_LMOTS_Q_LEAF_ID_LEN);
335 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100336 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100338
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 status = psa_hash_update(&op, D_PUBLIC_CONSTANT_BYTES, D_CONST_LEN);
340 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100341 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100343
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 status = psa_hash_update(&op, y_hashed_digits,
345 MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT(params->type) *
346 MBEDTLS_LMOTS_N_HASH_LEN(params->type));
347 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100348 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 }
Raef Coles8ff6df52021-07-21 12:42:15 +0100350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 status = psa_hash_finish(&op, pub_key,
352 MBEDTLS_LMOTS_N_HASH_LEN(params->type),
353 &output_hash_len);
354 if (status != PSA_SUCCESS) {
Raef Coles8ff6df52021-07-21 12:42:15 +0100355
Raef Coles01c71a12022-08-31 15:55:00 +0100356exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 psa_hash_abort(&op);
358 }
Raef Coles29117d22022-10-07 11:46:06 +0100359
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500360 return PSA_TO_MBEDTLS_ERR(status);
Raef Coles8ff6df52021-07-21 12:42:15 +0100361}
362
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500363#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100364int mbedtls_lms_error_from_psa(psa_status_t status)
Raef Colesc8f96042022-08-25 13:49:54 +0100365{
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 switch (status) {
Raef Colesc8f96042022-08-25 13:49:54 +0100367 case PSA_SUCCESS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return 0;
Raef Colesc8f96042022-08-25 13:49:54 +0100369 case PSA_ERROR_HARDWARE_FAILURE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Raef Colesc8f96042022-08-25 13:49:54 +0100371 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED;
Raef Colesc8f96042022-08-25 13:49:54 +0100373 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return MBEDTLS_ERR_LMS_BUFFER_TOO_SMALL;
Raef Colesc8f96042022-08-25 13:49:54 +0100375 case PSA_ERROR_INVALID_ARGUMENT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Colesc8f96042022-08-25 13:49:54 +0100377 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 return MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Raef Colesc8f96042022-08-25 13:49:54 +0100379 }
380}
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500381#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Raef Colesc8f96042022-08-25 13:49:54 +0100382
Gilles Peskine449bd832023-01-11 14:50:10 +0100383void mbedtls_lmots_public_init(mbedtls_lmots_public_t *ctx)
Raef Coles8ff6df52021-07-21 12:42:15 +0100384{
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 memset(ctx, 0, sizeof(*ctx));
Raef Coles8ff6df52021-07-21 12:42:15 +0100386}
387
Gilles Peskine449bd832023-01-11 14:50:10 +0100388void mbedtls_lmots_public_free(mbedtls_lmots_public_t *ctx)
Raef Coles8ff6df52021-07-21 12:42:15 +0100389{
Troy-Butler9ac3e232024-03-22 14:46:04 -0400390 if (ctx == NULL) {
391 return;
392 }
393
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 mbedtls_platform_zeroize(ctx, sizeof(*ctx));
Raef Coles8ff6df52021-07-21 12:42:15 +0100395}
396
Gilles Peskine449bd832023-01-11 14:50:10 +0100397int mbedtls_lmots_import_public_key(mbedtls_lmots_public_t *ctx,
398 const unsigned char *key, size_t key_len)
Raef Coles8ff6df52021-07-21 12:42:15 +0100399{
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 if (key_len < MBEDTLS_LMOTS_SIG_TYPE_OFFSET + MBEDTLS_LMOTS_TYPE_LEN) {
401 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Colese89488d2022-10-07 16:06:35 +0100402 }
403
Minos Galanakiscaaffc12025-06-02 14:28:31 +0100404 uint32_t type = MBEDTLS_GET_UINT32_BE(key, MBEDTLS_LMOTS_SIG_TYPE_OFFSET);
405 if (type != (uint32_t) MBEDTLS_LMOTS_SHA256_N32_W8) {
406 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
407 }
408 ctx->params.type = (mbedtls_lmots_algorithm_type_t) type;
Raef Coles01c71a12022-08-31 15:55:00 +0100409
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 if (key_len != MBEDTLS_LMOTS_PUBLIC_KEY_LEN(ctx->params.type)) {
411 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Colese9479a02022-09-01 16:06:35 +0100412 }
413
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 memcpy(ctx->params.I_key_identifier,
415 key + PUBLIC_KEY_I_KEY_ID_OFFSET,
416 MBEDTLS_LMOTS_I_KEY_ID_LEN);
Raef Coles01c71a12022-08-31 15:55:00 +0100417
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 memcpy(ctx->params.q_leaf_identifier,
419 key + PUBLIC_KEY_Q_LEAF_ID_OFFSET,
420 MBEDTLS_LMOTS_Q_LEAF_ID_LEN);
Raef Coles01c71a12022-08-31 15:55:00 +0100421
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 memcpy(ctx->public_key,
423 key + PUBLIC_KEY_KEY_HASH_OFFSET,
424 MBEDTLS_LMOTS_N_HASH_LEN(ctx->params.type));
Raef Coles01c71a12022-08-31 15:55:00 +0100425
Raef Colesf5632d32022-09-01 09:56:52 +0100426 ctx->have_public_key = 1;
Raef Coles8ff6df52021-07-21 12:42:15 +0100427
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 return 0;
Raef Coles8ff6df52021-07-21 12:42:15 +0100429}
430
Gilles Peskine449bd832023-01-11 14:50:10 +0100431int mbedtls_lmots_export_public_key(const mbedtls_lmots_public_t *ctx,
432 unsigned char *key, size_t key_size,
433 size_t *key_len)
Raef Coles370cc432022-10-07 16:07:33 +0100434{
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 if (key_size < MBEDTLS_LMOTS_PUBLIC_KEY_LEN(ctx->params.type)) {
436 return MBEDTLS_ERR_LMS_BUFFER_TOO_SMALL;
Raef Coles370cc432022-10-07 16:07:33 +0100437 }
438
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 if (!ctx->have_public_key) {
440 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles370cc432022-10-07 16:07:33 +0100441 }
442
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000443 MBEDTLS_PUT_UINT32_BE(ctx->params.type, key, MBEDTLS_LMOTS_SIG_TYPE_OFFSET);
Raef Coles370cc432022-10-07 16:07:33 +0100444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 memcpy(key + PUBLIC_KEY_I_KEY_ID_OFFSET,
446 ctx->params.I_key_identifier,
447 MBEDTLS_LMOTS_I_KEY_ID_LEN);
Raef Coles370cc432022-10-07 16:07:33 +0100448
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 memcpy(key + PUBLIC_KEY_Q_LEAF_ID_OFFSET,
450 ctx->params.q_leaf_identifier,
451 MBEDTLS_LMOTS_Q_LEAF_ID_LEN);
Raef Coles370cc432022-10-07 16:07:33 +0100452
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 memcpy(key + PUBLIC_KEY_KEY_HASH_OFFSET, ctx->public_key,
454 MBEDTLS_LMOTS_N_HASH_LEN(ctx->params.type));
Raef Coles370cc432022-10-07 16:07:33 +0100455
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 if (key_len != NULL) {
Raef Coles370cc432022-10-07 16:07:33 +0100457 *key_len = MBEDTLS_LMOTS_PUBLIC_KEY_LEN(ctx->params.type);
458 }
459
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 return 0;
Raef Coles370cc432022-10-07 16:07:33 +0100461}
462
Gilles Peskine449bd832023-01-11 14:50:10 +0100463int mbedtls_lmots_calculate_public_key_candidate(const mbedtls_lmots_parameters_t *params,
464 const unsigned char *msg,
465 size_t msg_size,
466 const unsigned char *sig,
467 size_t sig_size,
468 unsigned char *out,
469 size_t out_size,
470 size_t *out_len)
Raef Coles8ff6df52021-07-21 12:42:15 +0100471{
Raef Colese9479a02022-09-01 16:06:35 +0100472 unsigned char tmp_digit_array[MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT_MAX];
473 unsigned char y_hashed_digits[MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT_MAX][MBEDTLS_LMOTS_N_HASH_LEN_MAX];
Raef Coles8ff6df52021-07-21 12:42:15 +0100474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 if (msg == NULL && msg_size != 0) {
477 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles01c71a12022-08-31 15:55:00 +0100478 }
479
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 if (sig_size != MBEDTLS_LMOTS_SIG_LEN(params->type) ||
481 out_size < MBEDTLS_LMOTS_N_HASH_LEN(params->type)) {
482 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles8ff6df52021-07-21 12:42:15 +0100483 }
484
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 ret = create_digit_array_with_checksum(params, msg, msg_size,
486 sig + MBEDTLS_LMOTS_SIG_C_RANDOM_OFFSET,
487 tmp_digit_array);
488 if (ret) {
489 return ret;
Raef Coles8ff6df52021-07-21 12:42:15 +0100490 }
491
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 ret = hash_digit_array(params,
493 sig + MBEDTLS_LMOTS_SIG_SIGNATURE_OFFSET(params->type),
494 tmp_digit_array, NULL, (unsigned char *) y_hashed_digits);
495 if (ret) {
496 return ret;
Raef Coles8ff6df52021-07-21 12:42:15 +0100497 }
498
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 ret = public_key_from_hashed_digit_array(params,
500 (unsigned char *) y_hashed_digits,
501 out);
502 if (ret) {
503 return ret;
Raef Coles8ff6df52021-07-21 12:42:15 +0100504 }
505
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 if (out_len != NULL) {
Raef Colese9479a02022-09-01 16:06:35 +0100507 *out_len = MBEDTLS_LMOTS_N_HASH_LEN(params->type);
Raef Coles01c71a12022-08-31 15:55:00 +0100508 }
509
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return 0;
Raef Coles8ff6df52021-07-21 12:42:15 +0100511}
512
Gilles Peskine449bd832023-01-11 14:50:10 +0100513int mbedtls_lmots_verify(const mbedtls_lmots_public_t *ctx,
514 const unsigned char *msg, size_t msg_size,
515 const unsigned char *sig, size_t sig_size)
Raef Coles8ff6df52021-07-21 12:42:15 +0100516{
Raef Colese9479a02022-09-01 16:06:35 +0100517 unsigned char Kc_public_key_candidate[MBEDTLS_LMOTS_N_HASH_LEN_MAX];
Raef Coles8ff6df52021-07-21 12:42:15 +0100518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
519
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 if (msg == NULL && msg_size != 0) {
521 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles01c71a12022-08-31 15:55:00 +0100522 }
523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 if (!ctx->have_public_key) {
525 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles01c71a12022-08-31 15:55:00 +0100526 }
527
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 if (ctx->params.type != MBEDTLS_LMOTS_SHA256_N32_W8) {
529 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles01c71a12022-08-31 15:55:00 +0100530 }
531
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 if (sig_size < MBEDTLS_LMOTS_SIG_TYPE_OFFSET + MBEDTLS_LMOTS_TYPE_LEN) {
533 return MBEDTLS_ERR_LMS_VERIFY_FAILED;
Raef Coles48294592022-10-10 16:40:00 +0100534 }
535
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000536 if (MBEDTLS_GET_UINT32_BE(sig, MBEDTLS_LMOTS_SIG_TYPE_OFFSET) != MBEDTLS_LMOTS_SHA256_N32_W8) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_ERR_LMS_VERIFY_FAILED;
Raef Coles01c71a12022-08-31 15:55:00 +0100538 }
539
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 ret = mbedtls_lmots_calculate_public_key_candidate(&ctx->params,
541 msg, msg_size, sig, sig_size,
542 Kc_public_key_candidate,
543 MBEDTLS_LMOTS_N_HASH_LEN(ctx->params.type),
544 NULL);
545 if (ret) {
546 return MBEDTLS_ERR_LMS_VERIFY_FAILED;
Raef Coles01c71a12022-08-31 15:55:00 +0100547 }
548
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 if (memcmp(&Kc_public_key_candidate, ctx->public_key,
550 sizeof(ctx->public_key))) {
551 return MBEDTLS_ERR_LMS_VERIFY_FAILED;
Raef Coles01c71a12022-08-31 15:55:00 +0100552 }
553
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 return 0;
Raef Coles01c71a12022-08-31 15:55:00 +0100555}
556
Raef Coles5127e852022-10-07 10:35:56 +0100557#if defined(MBEDTLS_LMS_PRIVATE)
Raef Colesab4f8742022-09-01 12:24:31 +0100558
Gilles Peskine449bd832023-01-11 14:50:10 +0100559void mbedtls_lmots_private_init(mbedtls_lmots_private_t *ctx)
Raef Coles01c71a12022-08-31 15:55:00 +0100560{
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 memset(ctx, 0, sizeof(*ctx));
Raef Coles01c71a12022-08-31 15:55:00 +0100562}
563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564void mbedtls_lmots_private_free(mbedtls_lmots_private_t *ctx)
Raef Coles01c71a12022-08-31 15:55:00 +0100565{
Troy-Butler9ac3e232024-03-22 14:46:04 -0400566 if (ctx == NULL) {
567 return;
568 }
569
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 mbedtls_platform_zeroize(ctx,
571 sizeof(*ctx));
Raef Coles01c71a12022-08-31 15:55:00 +0100572}
573
Gilles Peskine449bd832023-01-11 14:50:10 +0100574int mbedtls_lmots_generate_private_key(mbedtls_lmots_private_t *ctx,
575 mbedtls_lmots_algorithm_type_t type,
576 const unsigned char I_key_identifier[MBEDTLS_LMOTS_I_KEY_ID_LEN],
577 uint32_t q_leaf_identifier,
578 const unsigned char *seed,
579 size_t seed_size)
Raef Coles01c71a12022-08-31 15:55:00 +0100580{
Raef Colesbe0c2f92022-10-07 11:27:35 +0100581 psa_hash_operation_t op = PSA_HASH_OPERATION_INIT;
582 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Raef Coles01c71a12022-08-31 15:55:00 +0100583 size_t output_hash_len;
584 unsigned int i_digit_idx;
585 unsigned char i_digit_idx_bytes[2];
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000586 unsigned char const_bytes[1] = { 0xFF };
Raef Coles01c71a12022-08-31 15:55:00 +0100587
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 if (ctx->have_private_key) {
589 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles01c71a12022-08-31 15:55:00 +0100590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 if (type != MBEDTLS_LMOTS_SHA256_N32_W8) {
593 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles01c71a12022-08-31 15:55:00 +0100594 }
595
Raef Colesf5632d32022-09-01 09:56:52 +0100596 ctx->params.type = type;
Raef Coles01c71a12022-08-31 15:55:00 +0100597
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 memcpy(ctx->params.I_key_identifier,
599 I_key_identifier,
600 sizeof(ctx->params.I_key_identifier));
Raef Coles01c71a12022-08-31 15:55:00 +0100601
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000602 MBEDTLS_PUT_UINT32_BE(q_leaf_identifier, ctx->params.q_leaf_identifier, 0);
Raef Coles01c71a12022-08-31 15:55:00 +0100603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 for (i_digit_idx = 0;
605 i_digit_idx < MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT(ctx->params.type);
606 i_digit_idx++) {
607 status = psa_hash_setup(&op, PSA_ALG_SHA_256);
608 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100609 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 }
Raef Coles01c71a12022-08-31 15:55:00 +0100611
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 status = psa_hash_update(&op,
613 ctx->params.I_key_identifier,
614 sizeof(ctx->params.I_key_identifier));
615 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100616 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 }
Raef Coles01c71a12022-08-31 15:55:00 +0100618
Gilles Peskine449bd832023-01-11 14:50:10 +0100619 status = psa_hash_update(&op,
620 ctx->params.q_leaf_identifier,
621 MBEDTLS_LMOTS_Q_LEAF_ID_LEN);
622 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100623 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 }
Raef Coles01c71a12022-08-31 15:55:00 +0100625
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000626 MBEDTLS_PUT_UINT16_BE(i_digit_idx, i_digit_idx_bytes, 0);
Gilles Peskine449bd832023-01-11 14:50:10 +0100627 status = psa_hash_update(&op, i_digit_idx_bytes, I_DIGIT_IDX_LEN);
628 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100629 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100630 }
Raef Coles01c71a12022-08-31 15:55:00 +0100631
Gilles Peskine449bd832023-01-11 14:50:10 +0100632 status = psa_hash_update(&op, const_bytes, sizeof(const_bytes));
633 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100634 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100635 }
Raef Coles01c71a12022-08-31 15:55:00 +0100636
Gilles Peskine449bd832023-01-11 14:50:10 +0100637 status = psa_hash_update(&op, seed, seed_size);
638 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100639 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 }
Raef Coles01c71a12022-08-31 15:55:00 +0100641
Gilles Peskine449bd832023-01-11 14:50:10 +0100642 status = psa_hash_finish(&op,
643 ctx->private_key[i_digit_idx],
644 MBEDTLS_LMOTS_N_HASH_LEN(ctx->params.type),
645 &output_hash_len);
646 if (status != PSA_SUCCESS) {
Raef Coles01c71a12022-08-31 15:55:00 +0100647 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 }
Raef Coles01c71a12022-08-31 15:55:00 +0100649
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 psa_hash_abort(&op);
Raef Coles01c71a12022-08-31 15:55:00 +0100651 }
652
Raef Colesf5632d32022-09-01 09:56:52 +0100653 ctx->have_private_key = 1;
Raef Coles01c71a12022-08-31 15:55:00 +0100654
655exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 psa_hash_abort(&op);
Raef Coles01c71a12022-08-31 15:55:00 +0100657
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500658 return PSA_TO_MBEDTLS_ERR(status);
Raef Coles01c71a12022-08-31 15:55:00 +0100659}
660
Gilles Peskine449bd832023-01-11 14:50:10 +0100661int mbedtls_lmots_calculate_public_key(mbedtls_lmots_public_t *ctx,
662 const mbedtls_lmots_private_t *priv_ctx)
Raef Coles01c71a12022-08-31 15:55:00 +0100663{
Raef Colese9479a02022-09-01 16:06:35 +0100664 unsigned char y_hashed_digits[MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT_MAX][MBEDTLS_LMOTS_N_HASH_LEN_MAX];
Raef Coles01c71a12022-08-31 15:55:00 +0100665 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
666
Raef Coles8ff6df52021-07-21 12:42:15 +0100667 /* Check that a private key is loaded */
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 if (!priv_ctx->have_private_key) {
669 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles01c71a12022-08-31 15:55:00 +0100670 }
671
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 ret = hash_digit_array(&priv_ctx->params,
673 (unsigned char *) priv_ctx->private_key, NULL,
674 NULL, (unsigned char *) y_hashed_digits);
675 if (ret) {
Raef Coles142e5772022-10-12 10:47:27 +0100676 goto exit;
Raef Coles01c71a12022-08-31 15:55:00 +0100677 }
678
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 ret = public_key_from_hashed_digit_array(&priv_ctx->params,
680 (unsigned char *) y_hashed_digits,
681 ctx->public_key);
682 if (ret) {
Raef Coles142e5772022-10-12 10:47:27 +0100683 goto exit;
Raef Coles01c71a12022-08-31 15:55:00 +0100684 }
685
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 memcpy(&ctx->params, &priv_ctx->params,
687 sizeof(ctx->params));
Raef Coles01c71a12022-08-31 15:55:00 +0100688
Raef Coles9b88ee52022-09-02 12:04:21 +0100689 ctx->have_public_key = 1;
Raef Coles01c71a12022-08-31 15:55:00 +0100690
Raef Coles142e5772022-10-12 10:47:27 +0100691exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 mbedtls_platform_zeroize(y_hashed_digits, sizeof(y_hashed_digits));
Raef Coles142e5772022-10-12 10:47:27 +0100693
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return ret;
Raef Coles01c71a12022-08-31 15:55:00 +0100695}
696
Gilles Peskine449bd832023-01-11 14:50:10 +0100697int mbedtls_lmots_sign(mbedtls_lmots_private_t *ctx,
698 int (*f_rng)(void *, unsigned char *, size_t),
699 void *p_rng, const unsigned char *msg, size_t msg_size,
700 unsigned char *sig, size_t sig_size, size_t *sig_len)
Raef Coles01c71a12022-08-31 15:55:00 +0100701{
Raef Colese9479a02022-09-01 16:06:35 +0100702 unsigned char tmp_digit_array[MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT_MAX];
Raef Coles891c6132022-09-01 11:05:48 +0100703 /* Create a temporary buffer to prepare the signature in. This allows us to
704 * finish creating a signature (ensuring the process doesn't fail), and then
705 * erase the private key **before** writing any data into the sig parameter
706 * buffer. If data were directly written into the sig buffer, it might leak
707 * a partial signature on failure, which effectively compromises the private
708 * key.
709 */
Raef Colese9479a02022-09-01 16:06:35 +0100710 unsigned char tmp_sig[MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT_MAX][MBEDTLS_LMOTS_N_HASH_LEN_MAX];
Raef Colesd48f7e92022-10-10 13:10:07 +0100711 unsigned char tmp_c_random[MBEDTLS_LMOTS_N_HASH_LEN_MAX];
Raef Coles01c71a12022-08-31 15:55:00 +0100712 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
713
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 if (msg == NULL && msg_size != 0) {
715 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles01c71a12022-08-31 15:55:00 +0100716 }
717
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 if (sig_size < MBEDTLS_LMOTS_SIG_LEN(ctx->params.type)) {
719 return MBEDTLS_ERR_LMS_BUFFER_TOO_SMALL;
Raef Coles01c71a12022-08-31 15:55:00 +0100720 }
721
722 /* Check that a private key is loaded */
Gilles Peskine449bd832023-01-11 14:50:10 +0100723 if (!ctx->have_private_key) {
724 return MBEDTLS_ERR_LMS_BAD_INPUT_DATA;
Raef Coles8ff6df52021-07-21 12:42:15 +0100725 }
726
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 ret = f_rng(p_rng, tmp_c_random,
728 MBEDTLS_LMOTS_N_HASH_LEN(ctx->params.type));
729 if (ret) {
730 return ret;
Raef Coles8ff6df52021-07-21 12:42:15 +0100731 }
732
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 ret = create_digit_array_with_checksum(&ctx->params,
734 msg, msg_size,
735 tmp_c_random,
736 tmp_digit_array);
737 if (ret) {
Raef Coles142e5772022-10-12 10:47:27 +0100738 goto exit;
Raef Coles8ff6df52021-07-21 12:42:15 +0100739 }
740
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 ret = hash_digit_array(&ctx->params, (unsigned char *) ctx->private_key,
742 NULL, tmp_digit_array, (unsigned char *) tmp_sig);
743 if (ret) {
Raef Coles142e5772022-10-12 10:47:27 +0100744 goto exit;
Raef Coles8ff6df52021-07-21 12:42:15 +0100745 }
746
Dave Rodgmandf4d4212023-11-09 14:01:39 +0000747 MBEDTLS_PUT_UINT32_BE(ctx->params.type, sig, MBEDTLS_LMOTS_SIG_TYPE_OFFSET);
Raef Coles8ff6df52021-07-21 12:42:15 +0100748
Raef Coles9c9027b2022-09-02 18:26:31 +0100749 /* Test hook to check if sig is being written to before we invalidate the
750 * private key.
751 */
752#if defined(MBEDTLS_TEST_HOOKS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100753 if (mbedtls_lmots_sign_private_key_invalidated_hook != NULL) {
754 ret = (*mbedtls_lmots_sign_private_key_invalidated_hook)(sig);
755 if (ret != 0) {
756 return ret;
757 }
Raef Coles9c9027b2022-09-02 18:26:31 +0100758 }
759#endif /* defined(MBEDTLS_TEST_HOOKS) */
760
Raef Coles8ff6df52021-07-21 12:42:15 +0100761 /* We've got a valid signature now, so it's time to make sure the private
762 * key can't be reused.
763 */
Raef Colesf5632d32022-09-01 09:56:52 +0100764 ctx->have_private_key = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 mbedtls_platform_zeroize(ctx->private_key,
766 sizeof(ctx->private_key));
Raef Coles8ff6df52021-07-21 12:42:15 +0100767
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 memcpy(sig + MBEDTLS_LMOTS_SIG_C_RANDOM_OFFSET, tmp_c_random,
769 MBEDTLS_LMOTS_C_RANDOM_VALUE_LEN(ctx->params.type));
Raef Coles891c6132022-09-01 11:05:48 +0100770
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 memcpy(sig + MBEDTLS_LMOTS_SIG_SIGNATURE_OFFSET(ctx->params.type), tmp_sig,
772 MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT(ctx->params.type)
773 * MBEDTLS_LMOTS_N_HASH_LEN(ctx->params.type));
Raef Coles8ff6df52021-07-21 12:42:15 +0100774
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (sig_len != NULL) {
Raef Colese9479a02022-09-01 16:06:35 +0100776 *sig_len = MBEDTLS_LMOTS_SIG_LEN(ctx->params.type);
Raef Coles8ff6df52021-07-21 12:42:15 +0100777 }
778
Raef Coles142e5772022-10-12 10:47:27 +0100779 ret = 0;
780
781exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 mbedtls_platform_zeroize(tmp_digit_array, sizeof(tmp_digit_array));
783 mbedtls_platform_zeroize(tmp_sig, sizeof(tmp_sig));
Raef Coles142e5772022-10-12 10:47:27 +0100784
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 return ret;
Raef Coles8ff6df52021-07-21 12:42:15 +0100786}
787
Raef Coles5127e852022-10-07 10:35:56 +0100788#endif /* defined(MBEDTLS_LMS_PRIVATE) */
789#endif /* defined(MBEDTLS_LMS_C) */