Mbed TLS v4.1.1
Loading...
Searching...
No Matches
lms.h
Go to the documentation of this file.
1
11/*
12 * Copyright The Mbed TLS Contributors
13 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
14 */
15#ifndef MBEDTLS_LMS_H
16#define MBEDTLS_LMS_H
17
18#include <stdint.h>
19#include <stddef.h>
20
21#include "mbedtls/private_access.h"
24
25#define MBEDTLS_ERR_LMS_OUT_OF_PRIVATE_KEYS -0x0013
26#define MBEDTLS_ERR_LMS_VERIFY_FAILED -0x0015
27
28/* Currently only defined for SHA256, 32 is the max hash output size */
29#define MBEDTLS_LMOTS_N_HASH_LEN_MAX (32u)
30#define MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT_MAX (34u)
31#define MBEDTLS_LMOTS_N_HASH_LEN(type) ((type) == MBEDTLS_LMOTS_SHA256_N32_W8 ? 32u : 0)
32#define MBEDTLS_LMOTS_I_KEY_ID_LEN (16u)
33#define MBEDTLS_LMOTS_Q_LEAF_ID_LEN (4u)
34#define MBEDTLS_LMOTS_TYPE_LEN (4u)
35#define MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT(type) ((type) == MBEDTLS_LMOTS_SHA256_N32_W8 ? 34u : 0)
36#define MBEDTLS_LMOTS_C_RANDOM_VALUE_LEN(type) (MBEDTLS_LMOTS_N_HASH_LEN(type))
37
38#define MBEDTLS_LMOTS_SIG_LEN(type) (MBEDTLS_LMOTS_TYPE_LEN + \
39 MBEDTLS_LMOTS_C_RANDOM_VALUE_LEN(type) + \
40 (MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT(type) * \
41 MBEDTLS_LMOTS_N_HASH_LEN(type)))
42
43
44#define MBEDTLS_LMS_TYPE_LEN (4)
45#define MBEDTLS_LMS_H_TREE_HEIGHT(type) ((type) == MBEDTLS_LMS_SHA256_M32_H10 ? 10u : 0)
46
47/* The length of a hash output, Currently only implemented for SHA256.
48 * Max is 32 bytes.
49 */
50#define MBEDTLS_LMS_M_NODE_BYTES(type) ((type) == MBEDTLS_LMS_SHA256_M32_H10 ? 32 : 0)
51#define MBEDTLS_LMS_M_NODE_BYTES_MAX 32
52
53#define MBEDTLS_LMS_SIG_LEN(type, otstype) (MBEDTLS_LMOTS_Q_LEAF_ID_LEN + \
54 MBEDTLS_LMOTS_SIG_LEN(otstype) + \
55 MBEDTLS_LMS_TYPE_LEN + \
56 (MBEDTLS_LMS_H_TREE_HEIGHT(type) * \
57 MBEDTLS_LMS_M_NODE_BYTES(type)))
58
59#define MBEDTLS_LMS_PUBLIC_KEY_LEN(type) (MBEDTLS_LMS_TYPE_LEN + \
60 MBEDTLS_LMOTS_TYPE_LEN + \
61 MBEDTLS_LMOTS_I_KEY_ID_LEN + \
62 MBEDTLS_LMS_M_NODE_BYTES(type))
63
64
65#ifdef __cplusplus
66extern "C" {
67#endif
68
76
84
91typedef struct {
92 unsigned char MBEDTLS_PRIVATE(I_key_identifier[MBEDTLS_LMOTS_I_KEY_ID_LEN]);
94 unsigned char MBEDTLS_PRIVATE(q_leaf_identifier[MBEDTLS_LMOTS_Q_LEAF_ID_LEN]);
97 mbedtls_lmots_algorithm_type_t MBEDTLS_PRIVATE(type);
101
119typedef struct {
120 mbedtls_lmots_parameters_t MBEDTLS_PRIVATE(params);
121 unsigned char MBEDTLS_PRIVATE(public_key)[MBEDTLS_LMOTS_N_HASH_LEN_MAX];
122 unsigned char MBEDTLS_PRIVATE(have_public_key);
125
126#if defined(MBEDTLS_LMS_PRIVATE)
144typedef struct {
145 mbedtls_lmots_parameters_t MBEDTLS_PRIVATE(params);
146 unsigned char MBEDTLS_PRIVATE(private_key)[MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT_MAX][
148 unsigned char MBEDTLS_PRIVATE(have_private_key);
150} mbedtls_lmots_private_t;
151#endif /* defined(MBEDTLS_LMS_PRIVATE) */
152
153
159typedef struct {
160 unsigned char MBEDTLS_PRIVATE(I_key_identifier[MBEDTLS_LMOTS_I_KEY_ID_LEN]);
162 mbedtls_lmots_algorithm_type_t MBEDTLS_PRIVATE(otstype);
165 mbedtls_lms_algorithm_type_t MBEDTLS_PRIVATE(type);
169
188typedef struct {
189 mbedtls_lms_parameters_t MBEDTLS_PRIVATE(params);
190 unsigned char MBEDTLS_PRIVATE(T_1_pub_key)[MBEDTLS_LMS_M_NODE_BYTES_MAX];
192 unsigned char MBEDTLS_PRIVATE(have_public_key);
195
196
197#if defined(MBEDTLS_LMS_PRIVATE)
214typedef struct {
215 mbedtls_lms_parameters_t MBEDTLS_PRIVATE(params);
216 uint32_t MBEDTLS_PRIVATE(q_next_usable_key);
218 mbedtls_lmots_private_t *MBEDTLS_PRIVATE(ots_private_keys);
222 mbedtls_lmots_public_t *MBEDTLS_PRIVATE(ots_public_keys);
228 unsigned char MBEDTLS_PRIVATE(have_private_key);
230} mbedtls_lms_private_t;
231#endif /* defined(MBEDTLS_LMS_PRIVATE) */
232
240
248
269 const unsigned char *key, size_t key_size);
270
295 unsigned char *key, size_t key_size,
296 size_t *key_len);
297
319 const unsigned char *msg, size_t msg_size,
320 const unsigned char *sig, size_t sig_size);
321
322#if defined(MBEDTLS_LMS_PRIVATE)
328void mbedtls_lms_private_init(mbedtls_lms_private_t *ctx);
329
336void mbedtls_lms_private_free(mbedtls_lms_private_t *ctx);
337
360int mbedtls_lms_generate_private_key(mbedtls_lms_private_t *ctx,
363 const unsigned char *seed,
364 size_t seed_size);
365
384int mbedtls_lms_calculate_public_key(mbedtls_lms_public_t *ctx,
385 const mbedtls_lms_private_t *priv_ctx);
386
421int mbedtls_lms_sign(mbedtls_lms_private_t *ctx,
422 const unsigned char *msg,
423 unsigned int msg_size, unsigned char *sig, size_t sig_size,
424 size_t *sig_len);
425#endif /* defined(MBEDTLS_LMS_PRIVATE) */
426
427#ifdef __cplusplus
428}
429#endif
430
431#endif /* MBEDTLS_LMS_H */
Compatibility definitions for MbedTLS 3.x code built with MbedTLS 4.x or TF-PSA-Crypto 1....
int mbedtls_lms_export_public_key(const mbedtls_lms_public_t *ctx, unsigned char *key, size_t key_size, size_t *key_len)
This function exports an LMS public key from a LMS public context that already contains a public key.
#define MBEDTLS_LMOTS_I_KEY_ID_LEN
Definition lms.h:32
#define MBEDTLS_LMOTS_P_SIG_DIGIT_COUNT_MAX
Definition lms.h:30
mbedtls_lmots_algorithm_type_t
Definition lms.h:81
@ MBEDTLS_LMOTS_SHA256_N32_W8
Definition lms.h:82
void mbedtls_lms_public_free(mbedtls_lms_public_t *ctx)
This function uninitializes an LMS public context.
int mbedtls_lms_verify(const mbedtls_lms_public_t *ctx, const unsigned char *msg, size_t msg_size, const unsigned char *sig, size_t sig_size)
This function verifies a LMS signature, using a LMS context that contains a public key.
void mbedtls_lms_public_init(mbedtls_lms_public_t *ctx)
This function initializes an LMS public context.
#define MBEDTLS_LMOTS_N_HASH_LEN_MAX
Definition lms.h:29
mbedtls_lms_algorithm_type_t
Definition lms.h:73
@ MBEDTLS_LMS_SHA256_M32_H10
Definition lms.h:74
int mbedtls_lms_import_public_key(mbedtls_lms_public_t *ctx, const unsigned char *key, size_t key_size)
This function imports an LMS public key into a public LMS context.
#define MBEDTLS_LMS_M_NODE_BYTES_MAX
Definition lms.h:51
#define MBEDTLS_LMOTS_Q_LEAF_ID_LEN
Definition lms.h:33
Build-time configuration info.