blob: 427059bb532269affe310077e273a7db1c4b0e35 [file] [log] [blame]
Jens Wiklander817466c2018-05-22 13:49:31 +02001/*
2 * Elliptic curves over GF(p): generic functions
3 *
Jerome Forissier79013242021-07-28 10:24:04 +02004 * Copyright The Mbed TLS Contributors
Tom Van Eyckc1633172024-04-09 18:44:13 +02005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jens Wiklander817466c2018-05-22 13:49:31 +02006 */
7
8/*
9 * References:
10 *
Tom Van Eyckc1633172024-04-09 18:44:13 +020011 * SEC1 https://www.secg.org/sec1-v2.pdf
Jens Wiklander817466c2018-05-22 13:49:31 +020012 * GECC = Guide to Elliptic Curve Cryptography - Hankerson, Menezes, Vanstone
13 * FIPS 186-3 http://csrc.nist.gov/publications/fips/fips186-3/fips_186-3.pdf
14 * RFC 4492 for the related TLS structures and constants
Tom Van Eyckc1633172024-04-09 18:44:13 +020015 * - https://www.rfc-editor.org/rfc/rfc4492
Jens Wiklander3d3b0592019-03-20 15:30:29 +010016 * RFC 7748 for the Curve448 and Curve25519 curve definitions
Tom Van Eyckc1633172024-04-09 18:44:13 +020017 * - https://www.rfc-editor.org/rfc/rfc7748
Jens Wiklander817466c2018-05-22 13:49:31 +020018 *
Tom Van Eyckc1633172024-04-09 18:44:13 +020019 * [Curve25519] https://cr.yp.to/ecdh/curve25519-20060209.pdf
Jens Wiklander817466c2018-05-22 13:49:31 +020020 *
21 * [2] CORON, Jean-S'ebastien. Resistance against differential power analysis
22 * for elliptic curve cryptosystems. In : Cryptographic Hardware and
23 * Embedded Systems. Springer Berlin Heidelberg, 1999. p. 292-302.
24 * <http://link.springer.com/chapter/10.1007/3-540-48059-5_25>
25 *
26 * [3] HEDABOU, Mustapha, PINEL, Pierre, et B'EN'ETEAU, Lucien. A comb method to
27 * render ECC resistant against Side Channel Attacks. IACR Cryptology
28 * ePrint Archive, 2004, vol. 2004, p. 342.
29 * <http://eprint.iacr.org/2004/342.pdf>
30 */
31
Jerome Forissier79013242021-07-28 10:24:04 +020032#include "common.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020033
Jens Wiklander3d3b0592019-03-20 15:30:29 +010034/**
35 * \brief Function level alternative implementation.
36 *
37 * The MBEDTLS_ECP_INTERNAL_ALT macro enables alternative implementations to
38 * replace certain functions in this module. The alternative implementations are
39 * typically hardware accelerators and need to activate the hardware before the
40 * computation starts and deactivate it after it finishes. The
41 * mbedtls_internal_ecp_init() and mbedtls_internal_ecp_free() functions serve
42 * this purpose.
43 *
44 * To preserve the correct functionality the following conditions must hold:
45 *
46 * - The alternative implementation must be activated by
47 * mbedtls_internal_ecp_init() before any of the replaceable functions is
48 * called.
49 * - mbedtls_internal_ecp_free() must \b only be called when the alternative
50 * implementation is activated.
51 * - mbedtls_internal_ecp_init() must \b not be called when the alternative
52 * implementation is activated.
53 * - Public functions must not return while the alternative implementation is
54 * activated.
55 * - Replaceable functions are guarded by \c MBEDTLS_ECP_XXX_ALT macros and
56 * before calling them an \code if( mbedtls_internal_ecp_grp_capable( grp ) )
57 * \endcode ensures that the alternative implementation supports the current
58 * group.
59 */
60#if defined(MBEDTLS_ECP_INTERNAL_ALT)
61#endif
62
Tom Van Eyckc1633172024-04-09 18:44:13 +020063#if defined(MBEDTLS_ECP_LIGHT)
Jens Wiklander817466c2018-05-22 13:49:31 +020064
65#include "mbedtls/ecp.h"
66#include "mbedtls/threading.h"
Jens Wiklander3d3b0592019-03-20 15:30:29 +010067#include "mbedtls/platform_util.h"
Jerome Forissier11fa71b2020-04-20 17:17:56 +020068#include "mbedtls/error.h"
Jerome Forissier79013242021-07-28 10:24:04 +020069
Jens Wiklander32b31802023-10-06 16:59:46 +020070#include "bn_mul.h"
Jerome Forissier79013242021-07-28 10:24:04 +020071#include "ecp_invasive.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020072
73#include <string.h>
74
75#if !defined(MBEDTLS_ECP_ALT)
76
Jens Wiklander817466c2018-05-22 13:49:31 +020077#include "mbedtls/platform.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020078
Jens Wiklander32b31802023-10-06 16:59:46 +020079#include "ecp_internal_alt.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020080
Jens Wiklander817466c2018-05-22 13:49:31 +020081#if defined(MBEDTLS_SELF_TEST)
82/*
83 * Counts of point addition and doubling, and field multiplications.
84 * Used to test resistance of point multiplication to simple timing attacks.
85 */
Tom Van Eyckc1633172024-04-09 18:44:13 +020086#if defined(MBEDTLS_ECP_C)
87static unsigned long add_count, dbl_count;
88#endif /* MBEDTLS_ECP_C */
89static unsigned long mul_count;
Jens Wiklander817466c2018-05-22 13:49:31 +020090#endif
91
Jens Wiklander3d3b0592019-03-20 15:30:29 +010092#if defined(MBEDTLS_ECP_RESTARTABLE)
93/*
94 * Maximum number of "basic operations" to be done in a row.
95 *
96 * Default value 0 means that ECC operations will not yield.
97 * Note that regardless of the value of ecp_max_ops, always at
98 * least one step is performed before yielding.
99 *
100 * Setting ecp_max_ops=1 can be suitable for testing purposes
101 * as it will interrupt computation at all possible points.
102 */
103static unsigned ecp_max_ops = 0;
104
105/*
106 * Set ecp_max_ops
107 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200108void mbedtls_ecp_set_max_ops(unsigned max_ops)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100109{
110 ecp_max_ops = max_ops;
111}
112
113/*
114 * Check if restart is enabled
115 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200116int mbedtls_ecp_restart_is_enabled(void)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100117{
Jens Wiklander32b31802023-10-06 16:59:46 +0200118 return ecp_max_ops != 0;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100119}
120
121/*
122 * Restart sub-context for ecp_mul_comb()
123 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200124struct mbedtls_ecp_restart_mul {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100125 mbedtls_ecp_point R; /* current intermediate result */
126 size_t i; /* current index in various loops, 0 outside */
127 mbedtls_ecp_point *T; /* table for precomputed points */
128 unsigned char T_size; /* number of points in table T */
129 enum { /* what were we doing last time we returned? */
130 ecp_rsm_init = 0, /* nothing so far, dummy initial state */
131 ecp_rsm_pre_dbl, /* precompute 2^n multiples */
132 ecp_rsm_pre_norm_dbl, /* normalize precomputed 2^n multiples */
133 ecp_rsm_pre_add, /* precompute remaining points by adding */
134 ecp_rsm_pre_norm_add, /* normalize all precomputed points */
135 ecp_rsm_comb_core, /* ecp_mul_comb_core() */
136 ecp_rsm_final_norm, /* do the final normalization */
137 } state;
138};
139
140/*
141 * Init restart_mul sub-context
142 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200143static void ecp_restart_rsm_init(mbedtls_ecp_restart_mul_ctx *ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100144{
Jens Wiklander32b31802023-10-06 16:59:46 +0200145 mbedtls_ecp_point_init(&ctx->R);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100146 ctx->i = 0;
147 ctx->T = NULL;
148 ctx->T_size = 0;
149 ctx->state = ecp_rsm_init;
150}
151
152/*
153 * Free the components of a restart_mul sub-context
154 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200155static void ecp_restart_rsm_free(mbedtls_ecp_restart_mul_ctx *ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100156{
157 unsigned char i;
158
Jens Wiklander32b31802023-10-06 16:59:46 +0200159 if (ctx == NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100160 return;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100161 }
162
Jens Wiklander32b31802023-10-06 16:59:46 +0200163 mbedtls_ecp_point_free(&ctx->R);
Jerome Forissier79013242021-07-28 10:24:04 +0200164
Jens Wiklander32b31802023-10-06 16:59:46 +0200165 if (ctx->T != NULL) {
166 for (i = 0; i < ctx->T_size; i++) {
167 mbedtls_ecp_point_free(ctx->T + i);
168 }
169 mbedtls_free(ctx->T);
170 }
171
172 ecp_restart_rsm_init(ctx);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100173}
174
175/*
176 * Restart context for ecp_muladd()
177 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200178struct mbedtls_ecp_restart_muladd {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100179 mbedtls_ecp_point mP; /* mP value */
180 mbedtls_ecp_point R; /* R intermediate result */
181 enum { /* what should we do next? */
182 ecp_rsma_mul1 = 0, /* first multiplication */
183 ecp_rsma_mul2, /* second multiplication */
184 ecp_rsma_add, /* addition */
185 ecp_rsma_norm, /* normalization */
186 } state;
187};
188
189/*
190 * Init restart_muladd sub-context
191 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200192static void ecp_restart_ma_init(mbedtls_ecp_restart_muladd_ctx *ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100193{
Jens Wiklander32b31802023-10-06 16:59:46 +0200194 mbedtls_ecp_point_init(&ctx->mP);
195 mbedtls_ecp_point_init(&ctx->R);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100196 ctx->state = ecp_rsma_mul1;
197}
198
199/*
200 * Free the components of a restart_muladd sub-context
201 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200202static void ecp_restart_ma_free(mbedtls_ecp_restart_muladd_ctx *ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100203{
Jens Wiklander32b31802023-10-06 16:59:46 +0200204 if (ctx == NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100205 return;
Jens Wiklander32b31802023-10-06 16:59:46 +0200206 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100207
Jens Wiklander32b31802023-10-06 16:59:46 +0200208 mbedtls_ecp_point_free(&ctx->mP);
209 mbedtls_ecp_point_free(&ctx->R);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100210
Jens Wiklander32b31802023-10-06 16:59:46 +0200211 ecp_restart_ma_init(ctx);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100212}
213
214/*
215 * Initialize a restart context
216 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200217void mbedtls_ecp_restart_init(mbedtls_ecp_restart_ctx *ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100218{
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100219 ctx->ops_done = 0;
220 ctx->depth = 0;
221 ctx->rsm = NULL;
222 ctx->ma = NULL;
223}
224
225/*
226 * Free the components of a restart context
227 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200228void mbedtls_ecp_restart_free(mbedtls_ecp_restart_ctx *ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100229{
Jens Wiklander32b31802023-10-06 16:59:46 +0200230 if (ctx == NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100231 return;
Jens Wiklander32b31802023-10-06 16:59:46 +0200232 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100233
Jens Wiklander32b31802023-10-06 16:59:46 +0200234 ecp_restart_rsm_free(ctx->rsm);
235 mbedtls_free(ctx->rsm);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100236
Jens Wiklander32b31802023-10-06 16:59:46 +0200237 ecp_restart_ma_free(ctx->ma);
238 mbedtls_free(ctx->ma);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100239
Jens Wiklander32b31802023-10-06 16:59:46 +0200240 mbedtls_ecp_restart_init(ctx);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100241}
242
243/*
244 * Check if we can do the next step
245 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200246int mbedtls_ecp_check_budget(const mbedtls_ecp_group *grp,
247 mbedtls_ecp_restart_ctx *rs_ctx,
248 unsigned ops)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100249{
Jens Wiklander32b31802023-10-06 16:59:46 +0200250 if (rs_ctx != NULL && ecp_max_ops != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100251 /* scale depending on curve size: the chosen reference is 256-bit,
252 * and multiplication is quadratic. Round to the closest integer. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200253 if (grp->pbits >= 512) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100254 ops *= 4;
Jens Wiklander32b31802023-10-06 16:59:46 +0200255 } else if (grp->pbits >= 384) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100256 ops *= 2;
Jens Wiklander32b31802023-10-06 16:59:46 +0200257 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100258
259 /* Avoid infinite loops: always allow first step.
260 * Because of that, however, it's not generally true
261 * that ops_done <= ecp_max_ops, so the check
262 * ops_done > ecp_max_ops below is mandatory. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200263 if ((rs_ctx->ops_done != 0) &&
264 (rs_ctx->ops_done > ecp_max_ops ||
265 ops > ecp_max_ops - rs_ctx->ops_done)) {
266 return MBEDTLS_ERR_ECP_IN_PROGRESS;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100267 }
268
269 /* update running count */
270 rs_ctx->ops_done += ops;
271 }
272
Jens Wiklander32b31802023-10-06 16:59:46 +0200273 return 0;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100274}
275
276/* Call this when entering a function that needs its own sub-context */
Jens Wiklander32b31802023-10-06 16:59:46 +0200277#define ECP_RS_ENTER(SUB) do { \
278 /* reset ops count for this call if top-level */ \
279 if (rs_ctx != NULL && rs_ctx->depth++ == 0) \
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100280 rs_ctx->ops_done = 0; \
281 \
Jens Wiklander32b31802023-10-06 16:59:46 +0200282 /* set up our own sub-context if needed */ \
283 if (mbedtls_ecp_restart_is_enabled() && \
284 rs_ctx != NULL && rs_ctx->SUB == NULL) \
285 { \
286 rs_ctx->SUB = mbedtls_calloc(1, sizeof(*rs_ctx->SUB)); \
287 if (rs_ctx->SUB == NULL) \
288 return MBEDTLS_ERR_ECP_ALLOC_FAILED; \
289 \
290 ecp_restart_## SUB ##_init(rs_ctx->SUB); \
291 } \
292} while (0)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100293
294/* Call this when leaving a function that needs its own sub-context */
Jens Wiklander32b31802023-10-06 16:59:46 +0200295#define ECP_RS_LEAVE(SUB) do { \
296 /* clear our sub-context when not in progress (done or error) */ \
297 if (rs_ctx != NULL && rs_ctx->SUB != NULL && \
298 ret != MBEDTLS_ERR_ECP_IN_PROGRESS) \
299 { \
300 ecp_restart_## SUB ##_free(rs_ctx->SUB); \
301 mbedtls_free(rs_ctx->SUB); \
302 rs_ctx->SUB = NULL; \
303 } \
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100304 \
Jens Wiklander32b31802023-10-06 16:59:46 +0200305 if (rs_ctx != NULL) \
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100306 rs_ctx->depth--; \
Jens Wiklander32b31802023-10-06 16:59:46 +0200307} while (0)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100308
309#else /* MBEDTLS_ECP_RESTARTABLE */
310
Jens Wiklander32b31802023-10-06 16:59:46 +0200311#define ECP_RS_ENTER(sub) (void) rs_ctx;
312#define ECP_RS_LEAVE(sub) (void) rs_ctx;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100313
314#endif /* MBEDTLS_ECP_RESTARTABLE */
315
Tom Van Eyckc1633172024-04-09 18:44:13 +0200316#if defined(MBEDTLS_ECP_C)
Jens Wiklander32b31802023-10-06 16:59:46 +0200317static void mpi_init_many(mbedtls_mpi *arr, size_t size)
318{
319 while (size--) {
320 mbedtls_mpi_init(arr++);
321 }
322}
323
324static void mpi_free_many(mbedtls_mpi *arr, size_t size)
325{
326 while (size--) {
327 mbedtls_mpi_free(arr++);
328 }
329}
Tom Van Eyckc1633172024-04-09 18:44:13 +0200330#endif /* MBEDTLS_ECP_C */
Jens Wiklander32b31802023-10-06 16:59:46 +0200331
Jens Wiklander817466c2018-05-22 13:49:31 +0200332/*
Jens Wiklander817466c2018-05-22 13:49:31 +0200333 * List of supported curves:
334 * - internal ID
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200335 * - TLS NamedCurve ID (RFC 4492 sec. 5.1.1, RFC 7071 sec. 2, RFC 8446 sec. 4.2.7)
Jens Wiklander817466c2018-05-22 13:49:31 +0200336 * - size in bits
337 * - readable name
338 *
339 * Curves are listed in order: largest curves first, and for a given size,
Jens Wiklander32b31802023-10-06 16:59:46 +0200340 * fastest curves first.
Jens Wiklander817466c2018-05-22 13:49:31 +0200341 *
Jens Wiklander32b31802023-10-06 16:59:46 +0200342 * Reminder: update profiles in x509_crt.c and ssl_tls.c when adding a new curve!
Jens Wiklander817466c2018-05-22 13:49:31 +0200343 */
344static const mbedtls_ecp_curve_info ecp_supported_curves[] =
345{
346#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
347 { MBEDTLS_ECP_DP_SECP521R1, 25, 521, "secp521r1" },
348#endif
349#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
350 { MBEDTLS_ECP_DP_BP512R1, 28, 512, "brainpoolP512r1" },
351#endif
352#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
353 { MBEDTLS_ECP_DP_SECP384R1, 24, 384, "secp384r1" },
354#endif
355#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
356 { MBEDTLS_ECP_DP_BP384R1, 27, 384, "brainpoolP384r1" },
357#endif
358#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
359 { MBEDTLS_ECP_DP_SECP256R1, 23, 256, "secp256r1" },
360#endif
361#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED)
362 { MBEDTLS_ECP_DP_SECP256K1, 22, 256, "secp256k1" },
363#endif
364#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
365 { MBEDTLS_ECP_DP_BP256R1, 26, 256, "brainpoolP256r1" },
366#endif
367#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED)
368 { MBEDTLS_ECP_DP_SECP224R1, 21, 224, "secp224r1" },
369#endif
370#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED)
371 { MBEDTLS_ECP_DP_SECP224K1, 20, 224, "secp224k1" },
372#endif
373#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED)
374 { MBEDTLS_ECP_DP_SECP192R1, 19, 192, "secp192r1" },
375#endif
376#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED)
377 { MBEDTLS_ECP_DP_SECP192K1, 18, 192, "secp192k1" },
378#endif
Jerome Forissier79013242021-07-28 10:24:04 +0200379#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200380 { MBEDTLS_ECP_DP_CURVE25519, 29, 256, "x25519" },
381#endif
Jerome Forissier79013242021-07-28 10:24:04 +0200382#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
383 { MBEDTLS_ECP_DP_CURVE448, 30, 448, "x448" },
384#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200385 { MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
386};
387
Jens Wiklander32b31802023-10-06 16:59:46 +0200388#define ECP_NB_CURVES sizeof(ecp_supported_curves) / \
389 sizeof(ecp_supported_curves[0])
Jens Wiklander817466c2018-05-22 13:49:31 +0200390
391static mbedtls_ecp_group_id ecp_supported_grp_id[ECP_NB_CURVES];
392
393/*
394 * List of supported curves and associated info
395 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200396const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list(void)
Jens Wiklander817466c2018-05-22 13:49:31 +0200397{
Jens Wiklander32b31802023-10-06 16:59:46 +0200398 return ecp_supported_curves;
Jens Wiklander817466c2018-05-22 13:49:31 +0200399}
400
401/*
402 * List of supported curves, group ID only
403 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200404const mbedtls_ecp_group_id *mbedtls_ecp_grp_id_list(void)
Jens Wiklander817466c2018-05-22 13:49:31 +0200405{
406 static int init_done = 0;
407
Jens Wiklander32b31802023-10-06 16:59:46 +0200408 if (!init_done) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200409 size_t i = 0;
410 const mbedtls_ecp_curve_info *curve_info;
411
Jens Wiklander32b31802023-10-06 16:59:46 +0200412 for (curve_info = mbedtls_ecp_curve_list();
Jens Wiklander817466c2018-05-22 13:49:31 +0200413 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Jens Wiklander32b31802023-10-06 16:59:46 +0200414 curve_info++) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200415 ecp_supported_grp_id[i++] = curve_info->grp_id;
416 }
417 ecp_supported_grp_id[i] = MBEDTLS_ECP_DP_NONE;
418
419 init_done = 1;
420 }
421
Jens Wiklander32b31802023-10-06 16:59:46 +0200422 return ecp_supported_grp_id;
Jens Wiklander817466c2018-05-22 13:49:31 +0200423}
424
425/*
426 * Get the curve info for the internal identifier
427 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200428const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_grp_id(mbedtls_ecp_group_id grp_id)
Jens Wiklander817466c2018-05-22 13:49:31 +0200429{
430 const mbedtls_ecp_curve_info *curve_info;
431
Jens Wiklander32b31802023-10-06 16:59:46 +0200432 for (curve_info = mbedtls_ecp_curve_list();
Jens Wiklander817466c2018-05-22 13:49:31 +0200433 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Jens Wiklander32b31802023-10-06 16:59:46 +0200434 curve_info++) {
435 if (curve_info->grp_id == grp_id) {
436 return curve_info;
437 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200438 }
439
Jens Wiklander32b31802023-10-06 16:59:46 +0200440 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200441}
442
443/*
444 * Get the curve info from the TLS identifier
445 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200446const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_tls_id(uint16_t tls_id)
Jens Wiklander817466c2018-05-22 13:49:31 +0200447{
448 const mbedtls_ecp_curve_info *curve_info;
449
Jens Wiklander32b31802023-10-06 16:59:46 +0200450 for (curve_info = mbedtls_ecp_curve_list();
Jens Wiklander817466c2018-05-22 13:49:31 +0200451 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Jens Wiklander32b31802023-10-06 16:59:46 +0200452 curve_info++) {
453 if (curve_info->tls_id == tls_id) {
454 return curve_info;
455 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200456 }
457
Jens Wiklander32b31802023-10-06 16:59:46 +0200458 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200459}
460
461/*
462 * Get the curve info from the name
463 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200464const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_name(const char *name)
Jens Wiklander817466c2018-05-22 13:49:31 +0200465{
466 const mbedtls_ecp_curve_info *curve_info;
467
Jens Wiklander32b31802023-10-06 16:59:46 +0200468 if (name == NULL) {
469 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200470 }
471
Jens Wiklander32b31802023-10-06 16:59:46 +0200472 for (curve_info = mbedtls_ecp_curve_list();
473 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
474 curve_info++) {
475 if (strcmp(curve_info->name, name) == 0) {
476 return curve_info;
477 }
478 }
479
480 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200481}
482
483/*
484 * Get the type of a curve
485 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200486mbedtls_ecp_curve_type mbedtls_ecp_get_type(const mbedtls_ecp_group *grp)
Jens Wiklander817466c2018-05-22 13:49:31 +0200487{
Jens Wiklander32b31802023-10-06 16:59:46 +0200488 if (grp->G.X.p == NULL) {
489 return MBEDTLS_ECP_TYPE_NONE;
490 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200491
Jens Wiklander32b31802023-10-06 16:59:46 +0200492 if (grp->G.Y.p == NULL) {
493 return MBEDTLS_ECP_TYPE_MONTGOMERY;
494 } else {
495 return MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS;
496 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200497}
498
499/*
500 * Initialize (the components of) a point
501 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200502void mbedtls_ecp_point_init(mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +0200503{
Jens Wiklander32b31802023-10-06 16:59:46 +0200504 mbedtls_mpi_init(&pt->X);
505 mbedtls_mpi_init(&pt->Y);
506 mbedtls_mpi_init(&pt->Z);
Jens Wiklander817466c2018-05-22 13:49:31 +0200507}
508
509/*
510 * Initialize (the components of) a group
511 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200512void mbedtls_ecp_group_init(mbedtls_ecp_group *grp)
Jens Wiklander817466c2018-05-22 13:49:31 +0200513{
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100514 grp->id = MBEDTLS_ECP_DP_NONE;
Jens Wiklander32b31802023-10-06 16:59:46 +0200515 mbedtls_mpi_init(&grp->P);
516 mbedtls_mpi_init(&grp->A);
517 mbedtls_mpi_init(&grp->B);
518 mbedtls_ecp_point_init(&grp->G);
519 mbedtls_mpi_init(&grp->N);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100520 grp->pbits = 0;
521 grp->nbits = 0;
522 grp->h = 0;
523 grp->modp = NULL;
524 grp->t_pre = NULL;
525 grp->t_post = NULL;
526 grp->t_data = NULL;
527 grp->T = NULL;
528 grp->T_size = 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200529}
530
531/*
532 * Initialize (the components of) a key pair
533 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200534void mbedtls_ecp_keypair_init(mbedtls_ecp_keypair *key)
Jens Wiklander817466c2018-05-22 13:49:31 +0200535{
Jens Wiklander32b31802023-10-06 16:59:46 +0200536 mbedtls_ecp_group_init(&key->grp);
537 mbedtls_mpi_init(&key->d);
538 mbedtls_ecp_point_init(&key->Q);
Jens Wiklander817466c2018-05-22 13:49:31 +0200539}
540
541/*
542 * Unallocate (the components of) a point
543 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200544void mbedtls_ecp_point_free(mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +0200545{
Jens Wiklander32b31802023-10-06 16:59:46 +0200546 if (pt == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200547 return;
Jens Wiklander32b31802023-10-06 16:59:46 +0200548 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200549
Jens Wiklander32b31802023-10-06 16:59:46 +0200550 mbedtls_mpi_free(&(pt->X));
551 mbedtls_mpi_free(&(pt->Y));
552 mbedtls_mpi_free(&(pt->Z));
553}
554
555/*
556 * Check that the comb table (grp->T) is static initialized.
557 */
558static int ecp_group_is_static_comb_table(const mbedtls_ecp_group *grp)
559{
560#if MBEDTLS_ECP_FIXED_POINT_OPTIM == 1
561 return grp->T != NULL && grp->T_size == 0;
562#else
563 (void) grp;
564 return 0;
565#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200566}
567
568/*
569 * Unallocate (the components of) a group
570 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200571void mbedtls_ecp_group_free(mbedtls_ecp_group *grp)
Jens Wiklander817466c2018-05-22 13:49:31 +0200572{
573 size_t i;
574
Jens Wiklander32b31802023-10-06 16:59:46 +0200575 if (grp == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200576 return;
Jens Wiklander817466c2018-05-22 13:49:31 +0200577 }
578
Jens Wiklander32b31802023-10-06 16:59:46 +0200579 if (grp->h != 1) {
580 mbedtls_mpi_free(&grp->A);
581 mbedtls_mpi_free(&grp->B);
582 mbedtls_ecp_point_free(&grp->G);
Tom Van Eyckc1633172024-04-09 18:44:13 +0200583
584#if !defined(MBEDTLS_ECP_WITH_MPI_UINT)
585 mbedtls_mpi_free(&grp->N);
586 mbedtls_mpi_free(&grp->P);
587#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200588 }
589
Jens Wiklander32b31802023-10-06 16:59:46 +0200590 if (!ecp_group_is_static_comb_table(grp) && grp->T != NULL) {
591 for (i = 0; i < grp->T_size; i++) {
592 mbedtls_ecp_point_free(&grp->T[i]);
593 }
594 mbedtls_free(grp->T);
595 }
596
597 mbedtls_platform_zeroize(grp, sizeof(mbedtls_ecp_group));
Jens Wiklander817466c2018-05-22 13:49:31 +0200598}
599
600/*
601 * Unallocate (the components of) a key pair
602 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200603void mbedtls_ecp_keypair_free(mbedtls_ecp_keypair *key)
Jens Wiklander817466c2018-05-22 13:49:31 +0200604{
Jens Wiklander32b31802023-10-06 16:59:46 +0200605 if (key == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200606 return;
Jens Wiklander32b31802023-10-06 16:59:46 +0200607 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200608
Jens Wiklander32b31802023-10-06 16:59:46 +0200609 mbedtls_ecp_group_free(&key->grp);
610 mbedtls_mpi_free(&key->d);
611 mbedtls_ecp_point_free(&key->Q);
Jens Wiklander817466c2018-05-22 13:49:31 +0200612}
613
614/*
615 * Copy the contents of a point
616 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200617int mbedtls_ecp_copy(mbedtls_ecp_point *P, const mbedtls_ecp_point *Q)
Jens Wiklander817466c2018-05-22 13:49:31 +0200618{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200619 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +0200620 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->X, &Q->X));
621 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->Y, &Q->Y));
622 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->Z, &Q->Z));
Jens Wiklander817466c2018-05-22 13:49:31 +0200623
624cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200625 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200626}
627
628/*
629 * Copy the contents of a group object
630 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200631int mbedtls_ecp_group_copy(mbedtls_ecp_group *dst, const mbedtls_ecp_group *src)
Jens Wiklander817466c2018-05-22 13:49:31 +0200632{
Jens Wiklander32b31802023-10-06 16:59:46 +0200633 return mbedtls_ecp_group_load(dst, src->id);
Jens Wiklander817466c2018-05-22 13:49:31 +0200634}
635
636/*
637 * Set point to zero
638 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200639int mbedtls_ecp_set_zero(mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +0200640{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +0200642 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->X, 1));
643 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Y, 1));
644 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 0));
Jens Wiklander817466c2018-05-22 13:49:31 +0200645
646cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200647 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200648}
649
650/*
651 * Tell if a point is zero
652 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200653int mbedtls_ecp_is_zero(mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +0200654{
Jens Wiklander32b31802023-10-06 16:59:46 +0200655 return mbedtls_mpi_cmp_int(&pt->Z, 0) == 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200656}
657
658/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100659 * Compare two points lazily
Jens Wiklander817466c2018-05-22 13:49:31 +0200660 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200661int mbedtls_ecp_point_cmp(const mbedtls_ecp_point *P,
662 const mbedtls_ecp_point *Q)
Jens Wiklander817466c2018-05-22 13:49:31 +0200663{
Jens Wiklander32b31802023-10-06 16:59:46 +0200664 if (mbedtls_mpi_cmp_mpi(&P->X, &Q->X) == 0 &&
665 mbedtls_mpi_cmp_mpi(&P->Y, &Q->Y) == 0 &&
666 mbedtls_mpi_cmp_mpi(&P->Z, &Q->Z) == 0) {
667 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200668 }
669
Jens Wiklander32b31802023-10-06 16:59:46 +0200670 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +0200671}
672
673/*
674 * Import a non-zero point from ASCII strings
675 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200676int mbedtls_ecp_point_read_string(mbedtls_ecp_point *P, int radix,
677 const char *x, const char *y)
Jens Wiklander817466c2018-05-22 13:49:31 +0200678{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200679 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +0200680 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(&P->X, radix, x));
681 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(&P->Y, radix, y));
682 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&P->Z, 1));
Jens Wiklander817466c2018-05-22 13:49:31 +0200683
684cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200685 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200686}
687
688/*
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200689 * Export a point into unsigned binary data (SEC1 2.3.3 and RFC7748)
Jens Wiklander817466c2018-05-22 13:49:31 +0200690 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200691int mbedtls_ecp_point_write_binary(const mbedtls_ecp_group *grp,
692 const mbedtls_ecp_point *P,
693 int format, size_t *olen,
694 unsigned char *buf, size_t buflen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200695{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200696 int ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +0200697 size_t plen;
Jens Wiklander32b31802023-10-06 16:59:46 +0200698 if (format != MBEDTLS_ECP_PF_UNCOMPRESSED &&
699 format != MBEDTLS_ECP_PF_COMPRESSED) {
700 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
701 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200702
Jens Wiklander32b31802023-10-06 16:59:46 +0200703 plen = mbedtls_mpi_size(&grp->P);
Jens Wiklander817466c2018-05-22 13:49:31 +0200704
Jerome Forissier79013242021-07-28 10:24:04 +0200705#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
706 (void) format; /* Montgomery curves always use the same point format */
Jens Wiklander32b31802023-10-06 16:59:46 +0200707 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200708 *olen = plen;
Jens Wiklander32b31802023-10-06 16:59:46 +0200709 if (buflen < *olen) {
710 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
711 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200712
Jens Wiklander32b31802023-10-06 16:59:46 +0200713 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary_le(&P->X, buf, plen));
Jens Wiklander817466c2018-05-22 13:49:31 +0200714 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200715#endif
Jerome Forissier79013242021-07-28 10:24:04 +0200716#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200717 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200718 /*
719 * Common case: P == 0
720 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200721 if (mbedtls_mpi_cmp_int(&P->Z, 0) == 0) {
722 if (buflen < 1) {
723 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
724 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200725
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200726 buf[0] = 0x00;
727 *olen = 1;
Jens Wiklander817466c2018-05-22 13:49:31 +0200728
Jens Wiklander32b31802023-10-06 16:59:46 +0200729 return 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200730 }
731
Jens Wiklander32b31802023-10-06 16:59:46 +0200732 if (format == MBEDTLS_ECP_PF_UNCOMPRESSED) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200733 *olen = 2 * plen + 1;
734
Jens Wiklander32b31802023-10-06 16:59:46 +0200735 if (buflen < *olen) {
736 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
737 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200738
739 buf[0] = 0x04;
Jens Wiklander32b31802023-10-06 16:59:46 +0200740 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->X, buf + 1, plen));
741 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->Y, buf + 1 + plen, plen));
742 } else if (format == MBEDTLS_ECP_PF_COMPRESSED) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200743 *olen = plen + 1;
744
Jens Wiklander32b31802023-10-06 16:59:46 +0200745 if (buflen < *olen) {
746 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
747 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200748
Jens Wiklander32b31802023-10-06 16:59:46 +0200749 buf[0] = 0x02 + mbedtls_mpi_get_bit(&P->Y, 0);
750 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->X, buf + 1, plen));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200751 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200752 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200753#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200754
755cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200756 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200757}
758
Jens Wiklander32b31802023-10-06 16:59:46 +0200759#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
760static int mbedtls_ecp_sw_derive_y(const mbedtls_ecp_group *grp,
761 const mbedtls_mpi *X,
762 mbedtls_mpi *Y,
763 int parity_bit);
764#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
765
Jens Wiklander817466c2018-05-22 13:49:31 +0200766/*
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200767 * Import a point from unsigned binary data (SEC1 2.3.4 and RFC7748)
Jens Wiklander817466c2018-05-22 13:49:31 +0200768 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200769int mbedtls_ecp_point_read_binary(const mbedtls_ecp_group *grp,
770 mbedtls_ecp_point *pt,
771 const unsigned char *buf, size_t ilen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200772{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200773 int ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +0200774 size_t plen;
Jens Wiklander32b31802023-10-06 16:59:46 +0200775 if (ilen < 1) {
776 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
777 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200778
Jens Wiklander32b31802023-10-06 16:59:46 +0200779 plen = mbedtls_mpi_size(&grp->P);
Jens Wiklander817466c2018-05-22 13:49:31 +0200780
Jerome Forissier79013242021-07-28 10:24:04 +0200781#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200782 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
783 if (plen != ilen) {
784 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
785 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200786
Jens Wiklander32b31802023-10-06 16:59:46 +0200787 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&pt->X, buf, plen));
788 mbedtls_mpi_free(&pt->Y);
Jens Wiklander817466c2018-05-22 13:49:31 +0200789
Jens Wiklander32b31802023-10-06 16:59:46 +0200790 if (grp->id == MBEDTLS_ECP_DP_CURVE25519) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200791 /* Set most significant bit to 0 as prescribed in RFC7748 §5 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200792 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&pt->X, plen * 8 - 1, 0));
793 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200794
Jens Wiklander32b31802023-10-06 16:59:46 +0200795 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 1));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200796 }
797#endif
Jerome Forissier79013242021-07-28 10:24:04 +0200798#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200799 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
800 if (buf[0] == 0x00) {
801 if (ilen == 1) {
802 return mbedtls_ecp_set_zero(pt);
803 } else {
804 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
805 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200806 }
807
Jens Wiklander32b31802023-10-06 16:59:46 +0200808 if (ilen < 1 + plen) {
809 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
810 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200811
Jens Wiklander32b31802023-10-06 16:59:46 +0200812 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&pt->X, buf + 1, plen));
813 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 1));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200814
Jens Wiklander32b31802023-10-06 16:59:46 +0200815 if (buf[0] == 0x04) {
816 /* format == MBEDTLS_ECP_PF_UNCOMPRESSED */
817 if (ilen != 1 + plen * 2) {
818 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
819 }
820 return mbedtls_mpi_read_binary(&pt->Y, buf + 1 + plen, plen);
821 } else if (buf[0] == 0x02 || buf[0] == 0x03) {
822 /* format == MBEDTLS_ECP_PF_COMPRESSED */
823 if (ilen != 1 + plen) {
824 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
825 }
826 return mbedtls_ecp_sw_derive_y(grp, &pt->X, &pt->Y,
827 (buf[0] & 1));
828 } else {
829 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
830 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200831 }
832#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200833
834cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200835 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200836}
837
838/*
839 * Import a point from a TLS ECPoint record (RFC 4492)
840 * struct {
841 * opaque point <1..2^8-1>;
842 * } ECPoint;
843 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200844int mbedtls_ecp_tls_read_point(const mbedtls_ecp_group *grp,
845 mbedtls_ecp_point *pt,
846 const unsigned char **buf, size_t buf_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200847{
848 unsigned char data_len;
849 const unsigned char *buf_start;
Jens Wiklander817466c2018-05-22 13:49:31 +0200850 /*
851 * We must have at least two bytes (1 for length, at least one for data)
852 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200853 if (buf_len < 2) {
854 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
855 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200856
857 data_len = *(*buf)++;
Jens Wiklander32b31802023-10-06 16:59:46 +0200858 if (data_len < 1 || data_len > buf_len - 1) {
859 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
860 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200861
862 /*
863 * Save buffer start for read_binary and update buf
864 */
865 buf_start = *buf;
866 *buf += data_len;
867
Jens Wiklander32b31802023-10-06 16:59:46 +0200868 return mbedtls_ecp_point_read_binary(grp, pt, buf_start, data_len);
Jens Wiklander817466c2018-05-22 13:49:31 +0200869}
870
871/*
872 * Export a point as a TLS ECPoint record (RFC 4492)
873 * struct {
874 * opaque point <1..2^8-1>;
875 * } ECPoint;
876 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200877int mbedtls_ecp_tls_write_point(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt,
878 int format, size_t *olen,
879 unsigned char *buf, size_t blen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200880{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +0200882 if (format != MBEDTLS_ECP_PF_UNCOMPRESSED &&
883 format != MBEDTLS_ECP_PF_COMPRESSED) {
884 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
885 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200886
887 /*
888 * buffer length must be at least one, for our length byte
889 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200890 if (blen < 1) {
891 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
892 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200893
Jens Wiklander32b31802023-10-06 16:59:46 +0200894 if ((ret = mbedtls_ecp_point_write_binary(grp, pt, format,
895 olen, buf + 1, blen - 1)) != 0) {
896 return ret;
897 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200898
899 /*
900 * write length to the first byte and update total length
901 */
902 buf[0] = (unsigned char) *olen;
903 ++*olen;
904
Jens Wiklander32b31802023-10-06 16:59:46 +0200905 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200906}
907
908/*
909 * Set a group from an ECParameters record (RFC 4492)
910 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200911int mbedtls_ecp_tls_read_group(mbedtls_ecp_group *grp,
912 const unsigned char **buf, size_t len)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100913{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100915 mbedtls_ecp_group_id grp_id;
Jens Wiklander32b31802023-10-06 16:59:46 +0200916 if ((ret = mbedtls_ecp_tls_read_group_id(&grp_id, buf, len)) != 0) {
917 return ret;
918 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100919
Jens Wiklander32b31802023-10-06 16:59:46 +0200920 return mbedtls_ecp_group_load(grp, grp_id);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100921}
922
923/*
924 * Read a group id from an ECParameters record (RFC 4492) and convert it to
925 * mbedtls_ecp_group_id.
926 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200927int mbedtls_ecp_tls_read_group_id(mbedtls_ecp_group_id *grp,
928 const unsigned char **buf, size_t len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200929{
930 uint16_t tls_id;
931 const mbedtls_ecp_curve_info *curve_info;
Jens Wiklander817466c2018-05-22 13:49:31 +0200932 /*
933 * We expect at least three bytes (see below)
934 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200935 if (len < 3) {
936 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
937 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200938
939 /*
940 * First byte is curve_type; only named_curve is handled
941 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200942 if (*(*buf)++ != MBEDTLS_ECP_TLS_NAMED_CURVE) {
943 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
944 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200945
946 /*
947 * Next two bytes are the namedcurve value
948 */
Tom Van Eyckc1633172024-04-09 18:44:13 +0200949 tls_id = MBEDTLS_GET_UINT16_BE(*buf, 0);
950 *buf += 2;
Jens Wiklander817466c2018-05-22 13:49:31 +0200951
Jens Wiklander32b31802023-10-06 16:59:46 +0200952 if ((curve_info = mbedtls_ecp_curve_info_from_tls_id(tls_id)) == NULL) {
953 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
954 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200955
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100956 *grp = curve_info->grp_id;
957
Jens Wiklander32b31802023-10-06 16:59:46 +0200958 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200959}
960
961/*
962 * Write the ECParameters record corresponding to a group (RFC 4492)
963 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200964int mbedtls_ecp_tls_write_group(const mbedtls_ecp_group *grp, size_t *olen,
965 unsigned char *buf, size_t blen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200966{
967 const mbedtls_ecp_curve_info *curve_info;
Jens Wiklander32b31802023-10-06 16:59:46 +0200968 if ((curve_info = mbedtls_ecp_curve_info_from_grp_id(grp->id)) == NULL) {
969 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
970 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200971
972 /*
973 * We are going to write 3 bytes (see below)
974 */
975 *olen = 3;
Jens Wiklander32b31802023-10-06 16:59:46 +0200976 if (blen < *olen) {
977 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
978 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200979
980 /*
981 * First byte is curve_type, always named_curve
982 */
983 *buf++ = MBEDTLS_ECP_TLS_NAMED_CURVE;
984
985 /*
986 * Next two bytes are the namedcurve value
987 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200988 MBEDTLS_PUT_UINT16_BE(curve_info->tls_id, buf, 0);
Jens Wiklander817466c2018-05-22 13:49:31 +0200989
Jens Wiklander32b31802023-10-06 16:59:46 +0200990 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200991}
992
993/*
994 * Wrapper around fast quasi-modp functions, with fall-back to mbedtls_mpi_mod_mpi.
995 * See the documentation of struct mbedtls_ecp_group.
996 *
997 * This function is in the critial loop for mbedtls_ecp_mul, so pay attention to perf.
998 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200999static int ecp_modp(mbedtls_mpi *N, const mbedtls_ecp_group *grp)
Jens Wiklander817466c2018-05-22 13:49:31 +02001000{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001002
Jens Wiklander32b31802023-10-06 16:59:46 +02001003 if (grp->modp == NULL) {
1004 return mbedtls_mpi_mod_mpi(N, N, &grp->P);
Jens Wiklander817466c2018-05-22 13:49:31 +02001005 }
1006
Jens Wiklander32b31802023-10-06 16:59:46 +02001007 /* N->s < 0 is a much faster test, which fails only if N is 0 */
1008 if ((N->s < 0 && mbedtls_mpi_cmp_int(N, 0) != 0) ||
1009 mbedtls_mpi_bitlen(N) > 2 * grp->pbits) {
1010 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1011 }
1012
1013 MBEDTLS_MPI_CHK(grp->modp(N));
Jens Wiklander817466c2018-05-22 13:49:31 +02001014
1015 /* N->s < 0 is a much faster test, which fails only if N is 0 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001016 while (N->s < 0 && mbedtls_mpi_cmp_int(N, 0) != 0) {
1017 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(N, N, &grp->P));
1018 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001019
Jens Wiklander32b31802023-10-06 16:59:46 +02001020 while (mbedtls_mpi_cmp_mpi(N, &grp->P) >= 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001021 /* we known P, N and the result are positive */
Jens Wiklander32b31802023-10-06 16:59:46 +02001022 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_abs(N, N, &grp->P));
1023 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001024
1025cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001026 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001027}
1028
1029/*
1030 * Fast mod-p functions expect their argument to be in the 0..p^2 range.
1031 *
1032 * In order to guarantee that, we need to ensure that operands of
1033 * mbedtls_mpi_mul_mpi are in the 0..p range. So, after each operation we will
1034 * bring the result back to this range.
1035 *
1036 * The following macros are shortcuts for doing that.
1037 */
1038
1039/*
1040 * Reduce a mbedtls_mpi mod p in-place, general case, to use after mbedtls_mpi_mul_mpi
1041 */
1042#if defined(MBEDTLS_SELF_TEST)
1043#define INC_MUL_COUNT mul_count++;
1044#else
1045#define INC_MUL_COUNT
1046#endif
1047
Jens Wiklander32b31802023-10-06 16:59:46 +02001048#define MOD_MUL(N) \
Jerome Forissier5b25c762020-04-07 11:18:49 +02001049 do \
1050 { \
Jens Wiklander32b31802023-10-06 16:59:46 +02001051 MBEDTLS_MPI_CHK(ecp_modp(&(N), grp)); \
Jerome Forissier5b25c762020-04-07 11:18:49 +02001052 INC_MUL_COUNT \
Jens Wiklander32b31802023-10-06 16:59:46 +02001053 } while (0)
Jens Wiklander817466c2018-05-22 13:49:31 +02001054
Jens Wiklander32b31802023-10-06 16:59:46 +02001055static inline int mbedtls_mpi_mul_mod(const mbedtls_ecp_group *grp,
1056 mbedtls_mpi *X,
1057 const mbedtls_mpi *A,
1058 const mbedtls_mpi *B)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001059{
1060 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001061 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mpi(X, A, B));
1062 MOD_MUL(*X);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001063cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001064 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001065}
1066
Jens Wiklander817466c2018-05-22 13:49:31 +02001067/*
1068 * Reduce a mbedtls_mpi mod p in-place, to use after mbedtls_mpi_sub_mpi
1069 * N->s < 0 is a very fast test, which fails only if N is 0
1070 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001071#define MOD_SUB(N) \
1072 do { \
1073 while ((N)->s < 0 && mbedtls_mpi_cmp_int((N), 0) != 0) \
1074 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi((N), (N), &grp->P)); \
1075 } while (0)
Jens Wiklander817466c2018-05-22 13:49:31 +02001076
Tom Van Eyckc1633172024-04-09 18:44:13 +02001077MBEDTLS_MAYBE_UNUSED
Jens Wiklander32b31802023-10-06 16:59:46 +02001078static inline int mbedtls_mpi_sub_mod(const mbedtls_ecp_group *grp,
1079 mbedtls_mpi *X,
1080 const mbedtls_mpi *A,
1081 const mbedtls_mpi *B)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001082{
1083 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001084 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(X, A, B));
1085 MOD_SUB(X);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001086cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001087 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001088}
1089
Jens Wiklander817466c2018-05-22 13:49:31 +02001090/*
1091 * Reduce a mbedtls_mpi mod p in-place, to use after mbedtls_mpi_add_mpi and mbedtls_mpi_mul_int.
1092 * We known P, N and the result are positive, so sub_abs is correct, and
1093 * a bit faster.
1094 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001095#define MOD_ADD(N) \
1096 while (mbedtls_mpi_cmp_mpi((N), &grp->P) >= 0) \
1097 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_abs((N), (N), &grp->P))
Jens Wiklander817466c2018-05-22 13:49:31 +02001098
Jens Wiklander32b31802023-10-06 16:59:46 +02001099static inline int mbedtls_mpi_add_mod(const mbedtls_ecp_group *grp,
1100 mbedtls_mpi *X,
1101 const mbedtls_mpi *A,
1102 const mbedtls_mpi *B)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001103{
1104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001105 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(X, A, B));
1106 MOD_ADD(X);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001107cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001108 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001109}
1110
Tom Van Eyckc1633172024-04-09 18:44:13 +02001111MBEDTLS_MAYBE_UNUSED
Jens Wiklander32b31802023-10-06 16:59:46 +02001112static inline int mbedtls_mpi_mul_int_mod(const mbedtls_ecp_group *grp,
1113 mbedtls_mpi *X,
1114 const mbedtls_mpi *A,
1115 mbedtls_mpi_uint c)
1116{
1117 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1118
1119 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_int(X, A, c));
1120 MOD_ADD(X);
1121cleanup:
1122 return ret;
1123}
1124
Tom Van Eyckc1633172024-04-09 18:44:13 +02001125MBEDTLS_MAYBE_UNUSED
Jens Wiklander32b31802023-10-06 16:59:46 +02001126static inline int mbedtls_mpi_sub_int_mod(const mbedtls_ecp_group *grp,
1127 mbedtls_mpi *X,
1128 const mbedtls_mpi *A,
1129 mbedtls_mpi_uint c)
1130{
1131 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1132
1133 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(X, A, c));
1134 MOD_SUB(X);
1135cleanup:
1136 return ret;
1137}
1138
1139#define MPI_ECP_SUB_INT(X, A, c) \
1140 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int_mod(grp, X, A, c))
1141
Tom Van Eyckc1633172024-04-09 18:44:13 +02001142MBEDTLS_MAYBE_UNUSED
Jens Wiklander32b31802023-10-06 16:59:46 +02001143static inline int mbedtls_mpi_shift_l_mod(const mbedtls_ecp_group *grp,
1144 mbedtls_mpi *X,
1145 size_t count)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001146{
1147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001148 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_l(X, count));
1149 MOD_ADD(X);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001150cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001151 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001152}
Jens Wiklander32b31802023-10-06 16:59:46 +02001153
1154/*
1155 * Macro wrappers around ECP modular arithmetic
1156 *
1157 * Currently, these wrappers are defined via the bignum module.
1158 */
1159
1160#define MPI_ECP_ADD(X, A, B) \
1161 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mod(grp, X, A, B))
1162
1163#define MPI_ECP_SUB(X, A, B) \
1164 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mod(grp, X, A, B))
1165
1166#define MPI_ECP_MUL(X, A, B) \
1167 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mod(grp, X, A, B))
1168
1169#define MPI_ECP_SQR(X, A) \
1170 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mod(grp, X, A, A))
1171
1172#define MPI_ECP_MUL_INT(X, A, c) \
1173 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_int_mod(grp, X, A, c))
1174
1175#define MPI_ECP_INV(dst, src) \
1176 MBEDTLS_MPI_CHK(mbedtls_mpi_inv_mod((dst), (src), &grp->P))
1177
1178#define MPI_ECP_MOV(X, A) \
1179 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(X, A))
1180
1181#define MPI_ECP_SHIFT_L(X, count) \
1182 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_l_mod(grp, X, count))
1183
1184#define MPI_ECP_LSET(X, c) \
1185 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(X, c))
1186
1187#define MPI_ECP_CMP_INT(X, c) \
1188 mbedtls_mpi_cmp_int(X, c)
1189
1190#define MPI_ECP_CMP(X, Y) \
1191 mbedtls_mpi_cmp_mpi(X, Y)
1192
1193/* Needs f_rng, p_rng to be defined. */
1194#define MPI_ECP_RAND(X) \
1195 MBEDTLS_MPI_CHK(mbedtls_mpi_random((X), 2, &grp->P, f_rng, p_rng))
1196
1197/* Conditional negation
1198 * Needs grp and a temporary MPI tmp to be defined. */
1199#define MPI_ECP_COND_NEG(X, cond) \
1200 do \
1201 { \
1202 unsigned char nonzero = mbedtls_mpi_cmp_int((X), 0) != 0; \
1203 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&tmp, &grp->P, (X))); \
1204 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign((X), &tmp, \
1205 nonzero & cond)); \
1206 } while (0)
1207
1208#define MPI_ECP_NEG(X) MPI_ECP_COND_NEG((X), 1)
1209
1210#define MPI_ECP_VALID(X) \
1211 ((X)->p != NULL)
1212
1213#define MPI_ECP_COND_ASSIGN(X, Y, cond) \
1214 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign((X), (Y), (cond)))
1215
1216#define MPI_ECP_COND_SWAP(X, Y, cond) \
1217 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_swap((X), (Y), (cond)))
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001218
Jerome Forissier79013242021-07-28 10:24:04 +02001219#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001220
1221/*
1222 * Computes the right-hand side of the Short Weierstrass equation
1223 * RHS = X^3 + A X + B
1224 */
1225static int ecp_sw_rhs(const mbedtls_ecp_group *grp,
1226 mbedtls_mpi *rhs,
1227 const mbedtls_mpi *X)
1228{
1229 int ret;
1230
1231 /* Compute X^3 + A X + B as X (X^2 + A) + B */
1232 MPI_ECP_SQR(rhs, X);
1233
1234 /* Special case for A = -3 */
Tom Van Eyckc1633172024-04-09 18:44:13 +02001235 if (mbedtls_ecp_group_a_is_minus_3(grp)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001236 MPI_ECP_SUB_INT(rhs, rhs, 3);
1237 } else {
1238 MPI_ECP_ADD(rhs, rhs, &grp->A);
1239 }
1240
1241 MPI_ECP_MUL(rhs, rhs, X);
1242 MPI_ECP_ADD(rhs, rhs, &grp->B);
1243
1244cleanup:
1245 return ret;
1246}
1247
1248/*
1249 * Derive Y from X and a parity bit
1250 */
1251static int mbedtls_ecp_sw_derive_y(const mbedtls_ecp_group *grp,
1252 const mbedtls_mpi *X,
1253 mbedtls_mpi *Y,
1254 int parity_bit)
1255{
1256 /* w = y^2 = x^3 + ax + b
1257 * y = sqrt(w) = w^((p+1)/4) mod p (for prime p where p = 3 mod 4)
1258 *
1259 * Note: this method for extracting square root does not validate that w
1260 * was indeed a square so this function will return garbage in Y if X
1261 * does not correspond to a point on the curve.
1262 */
1263
1264 /* Check prerequisite p = 3 mod 4 */
1265 if (mbedtls_mpi_get_bit(&grp->P, 0) != 1 ||
1266 mbedtls_mpi_get_bit(&grp->P, 1) != 1) {
1267 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
1268 }
1269
1270 int ret;
1271 mbedtls_mpi exp;
1272 mbedtls_mpi_init(&exp);
1273
1274 /* use Y to store intermediate result, actually w above */
1275 MBEDTLS_MPI_CHK(ecp_sw_rhs(grp, Y, X));
1276
1277 /* w = y^2 */ /* Y contains y^2 intermediate result */
1278 /* exp = ((p+1)/4) */
1279 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&exp, &grp->P, 1));
1280 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_r(&exp, 2));
1281 /* sqrt(w) = w^((p+1)/4) mod p (for prime p where p = 3 mod 4) */
1282 MBEDTLS_MPI_CHK(mbedtls_mpi_exp_mod(Y, Y /*y^2*/, &exp, &grp->P, NULL));
1283
1284 /* check parity bit match or else invert Y */
1285 /* This quick inversion implementation is valid because Y != 0 for all
1286 * Short Weierstrass curves supported by mbedtls, as each supported curve
1287 * has an order that is a large prime, so each supported curve does not
1288 * have any point of order 2, and a point with Y == 0 would be of order 2 */
1289 if (mbedtls_mpi_get_bit(Y, 0) != parity_bit) {
1290 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(Y, &grp->P, Y));
1291 }
1292
1293cleanup:
1294
1295 mbedtls_mpi_free(&exp);
1296 return ret;
1297}
Tom Van Eyckc1633172024-04-09 18:44:13 +02001298#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander32b31802023-10-06 16:59:46 +02001299
Tom Van Eyckc1633172024-04-09 18:44:13 +02001300#if defined(MBEDTLS_ECP_C)
1301#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02001302/*
1303 * For curves in short Weierstrass form, we do all the internal operations in
1304 * Jacobian coordinates.
1305 *
Jerome Forissier039e02d2022-08-09 17:10:15 +02001306 * For multiplication, we'll use a comb method with countermeasures against
Jens Wiklander817466c2018-05-22 13:49:31 +02001307 * SPA, hence timing attacks.
1308 */
1309
1310/*
1311 * Normalize jacobian coordinates so that Z == 0 || Z == 1 (GECC 3.2.1)
1312 * Cost: 1N := 1I + 3M + 1S
1313 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001314static int ecp_normalize_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +02001315{
Jens Wiklander32b31802023-10-06 16:59:46 +02001316 if (MPI_ECP_CMP_INT(&pt->Z, 0) == 0) {
1317 return 0;
1318 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001319
1320#if defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001321 if (mbedtls_internal_ecp_grp_capable(grp)) {
1322 return mbedtls_internal_ecp_normalize_jac(grp, pt);
1323 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001324#endif /* MBEDTLS_ECP_NORMALIZE_JAC_ALT */
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001325
Jerome Forissier79013242021-07-28 10:24:04 +02001326#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001327 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001328#else
1329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001330 mbedtls_mpi T;
1331 mbedtls_mpi_init(&T);
Jens Wiklander817466c2018-05-22 13:49:31 +02001332
Jens Wiklander32b31802023-10-06 16:59:46 +02001333 MPI_ECP_INV(&T, &pt->Z); /* T <- 1 / Z */
1334 MPI_ECP_MUL(&pt->Y, &pt->Y, &T); /* Y' <- Y*T = Y / Z */
1335 MPI_ECP_SQR(&T, &T); /* T <- T^2 = 1 / Z^2 */
1336 MPI_ECP_MUL(&pt->X, &pt->X, &T); /* X <- X * T = X / Z^2 */
1337 MPI_ECP_MUL(&pt->Y, &pt->Y, &T); /* Y'' <- Y' * T = Y / Z^3 */
Jens Wiklander817466c2018-05-22 13:49:31 +02001338
Jens Wiklander32b31802023-10-06 16:59:46 +02001339 MPI_ECP_LSET(&pt->Z, 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001340
1341cleanup:
1342
Jens Wiklander32b31802023-10-06 16:59:46 +02001343 mbedtls_mpi_free(&T);
Jens Wiklander817466c2018-05-22 13:49:31 +02001344
Jens Wiklander32b31802023-10-06 16:59:46 +02001345 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001346#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001347}
1348
1349/*
1350 * Normalize jacobian coordinates of an array of (pointers to) points,
1351 * using Montgomery's trick to perform only one inversion mod P.
1352 * (See for example Cohen's "A Course in Computational Algebraic Number
1353 * Theory", Algorithm 10.3.4.)
1354 *
1355 * Warning: fails (returning an error) if one of the points is zero!
1356 * This should never happen, see choice of w in ecp_mul_comb().
1357 *
1358 * Cost: 1N(t) := 1I + (6t - 3)M + 1S
1359 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001360static int ecp_normalize_jac_many(const mbedtls_ecp_group *grp,
1361 mbedtls_ecp_point *T[], size_t T_size)
Jens Wiklander817466c2018-05-22 13:49:31 +02001362{
Jens Wiklander32b31802023-10-06 16:59:46 +02001363 if (T_size < 2) {
1364 return ecp_normalize_jac(grp, *T);
1365 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001366
1367#if defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001368 if (mbedtls_internal_ecp_grp_capable(grp)) {
1369 return mbedtls_internal_ecp_normalize_jac_many(grp, T, T_size);
1370 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001371#endif
1372
Jerome Forissier79013242021-07-28 10:24:04 +02001373#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001374 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001375#else
1376 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1377 size_t i;
Jens Wiklander32b31802023-10-06 16:59:46 +02001378 mbedtls_mpi *c, t;
Jerome Forissier79013242021-07-28 10:24:04 +02001379
Jens Wiklander32b31802023-10-06 16:59:46 +02001380 if ((c = mbedtls_calloc(T_size, sizeof(mbedtls_mpi))) == NULL) {
1381 return MBEDTLS_ERR_ECP_ALLOC_FAILED;
1382 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001383
Jens Wiklander32b31802023-10-06 16:59:46 +02001384 mbedtls_mpi_init(&t);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001385
Jens Wiklander32b31802023-10-06 16:59:46 +02001386 mpi_init_many(c, T_size);
Jens Wiklander817466c2018-05-22 13:49:31 +02001387 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02001388 * c[i] = Z_0 * ... * Z_i, i = 0,..,n := T_size-1
Jens Wiklander817466c2018-05-22 13:49:31 +02001389 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001390 MPI_ECP_MOV(&c[0], &T[0]->Z);
1391 for (i = 1; i < T_size; i++) {
1392 MPI_ECP_MUL(&c[i], &c[i-1], &T[i]->Z);
Jens Wiklander817466c2018-05-22 13:49:31 +02001393 }
1394
1395 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02001396 * c[n] = 1 / (Z_0 * ... * Z_n) mod P
Jens Wiklander817466c2018-05-22 13:49:31 +02001397 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001398 MPI_ECP_INV(&c[T_size-1], &c[T_size-1]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001399
Jens Wiklander32b31802023-10-06 16:59:46 +02001400 for (i = T_size - 1;; i--) {
1401 /* At the start of iteration i (note that i decrements), we have
1402 * - c[j] = Z_0 * .... * Z_j for j < i,
1403 * - c[j] = 1 / (Z_0 * .... * Z_j) for j == i,
1404 *
1405 * This is maintained via
1406 * - c[i-1] <- c[i] * Z_i
1407 *
1408 * We also derive 1/Z_i = c[i] * c[i-1] for i>0 and use that
1409 * to do the actual normalization. For i==0, we already have
1410 * c[0] = 1 / Z_0.
Jens Wiklander817466c2018-05-22 13:49:31 +02001411 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001412
1413 if (i > 0) {
1414 /* Compute 1/Z_i and establish invariant for the next iteration. */
1415 MPI_ECP_MUL(&t, &c[i], &c[i-1]);
1416 MPI_ECP_MUL(&c[i-1], &c[i], &T[i]->Z);
1417 } else {
1418 MPI_ECP_MOV(&t, &c[0]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001419 }
1420
Jens Wiklander32b31802023-10-06 16:59:46 +02001421 /* Now t holds 1 / Z_i; normalize as in ecp_normalize_jac() */
1422 MPI_ECP_MUL(&T[i]->Y, &T[i]->Y, &t);
1423 MPI_ECP_SQR(&t, &t);
1424 MPI_ECP_MUL(&T[i]->X, &T[i]->X, &t);
1425 MPI_ECP_MUL(&T[i]->Y, &T[i]->Y, &t);
Jens Wiklander817466c2018-05-22 13:49:31 +02001426
1427 /*
1428 * Post-precessing: reclaim some memory by shrinking coordinates
1429 * - not storing Z (always 1)
1430 * - shrinking other coordinates, but still keeping the same number of
1431 * limbs as P, as otherwise it will too likely be regrown too fast.
1432 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001433 MBEDTLS_MPI_CHK(mbedtls_mpi_shrink(&T[i]->X, grp->P.n));
1434 MBEDTLS_MPI_CHK(mbedtls_mpi_shrink(&T[i]->Y, grp->P.n));
Jens Wiklander817466c2018-05-22 13:49:31 +02001435
Jens Wiklander32b31802023-10-06 16:59:46 +02001436 MPI_ECP_LSET(&T[i]->Z, 1);
1437
1438 if (i == 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001439 break;
Jens Wiklander32b31802023-10-06 16:59:46 +02001440 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001441 }
1442
1443cleanup:
1444
Jens Wiklander32b31802023-10-06 16:59:46 +02001445 mbedtls_mpi_free(&t);
1446 mpi_free_many(c, T_size);
1447 mbedtls_free(c);
Jens Wiklander817466c2018-05-22 13:49:31 +02001448
Jens Wiklander32b31802023-10-06 16:59:46 +02001449 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001450#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001451}
1452
1453/*
1454 * Conditional point inversion: Q -> -Q = (Q.X, -Q.Y, Q.Z) without leak.
1455 * "inv" must be 0 (don't invert) or 1 (invert) or the result will be invalid
1456 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001457static int ecp_safe_invert_jac(const mbedtls_ecp_group *grp,
1458 mbedtls_ecp_point *Q,
1459 unsigned char inv)
Jens Wiklander817466c2018-05-22 13:49:31 +02001460{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001461 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001462 mbedtls_mpi tmp;
1463 mbedtls_mpi_init(&tmp);
Jens Wiklander817466c2018-05-22 13:49:31 +02001464
Jens Wiklander32b31802023-10-06 16:59:46 +02001465 MPI_ECP_COND_NEG(&Q->Y, inv);
Jens Wiklander817466c2018-05-22 13:49:31 +02001466
1467cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001468 mbedtls_mpi_free(&tmp);
1469 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001470}
1471
1472/*
1473 * Point doubling R = 2 P, Jacobian coordinates
1474 *
1475 * Based on http://www.hyperelliptic.org/EFD/g1p/auto-shortw-jacobian.html#doubling-dbl-1998-cmo-2 .
1476 *
1477 * We follow the variable naming fairly closely. The formula variations that trade a MUL for a SQR
1478 * (plus a few ADDs) aren't useful as our bignum implementation doesn't distinguish squaring.
1479 *
1480 * Standard optimizations are applied when curve parameter A is one of { 0, -3 }.
1481 *
1482 * Cost: 1D := 3M + 4S (A == 0)
1483 * 4M + 4S (A == -3)
1484 * 3M + 6S + 1a otherwise
1485 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001486static int ecp_double_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
1487 const mbedtls_ecp_point *P,
1488 mbedtls_mpi tmp[4])
Jens Wiklander817466c2018-05-22 13:49:31 +02001489{
Jens Wiklander817466c2018-05-22 13:49:31 +02001490#if defined(MBEDTLS_SELF_TEST)
1491 dbl_count++;
1492#endif
1493
1494#if defined(MBEDTLS_ECP_DOUBLE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001495 if (mbedtls_internal_ecp_grp_capable(grp)) {
1496 return mbedtls_internal_ecp_double_jac(grp, R, P);
1497 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001498#endif /* MBEDTLS_ECP_DOUBLE_JAC_ALT */
1499
Jerome Forissier79013242021-07-28 10:24:04 +02001500#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_DOUBLE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001501 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001502#else
1503 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001504
1505 /* Special case for A = -3 */
Tom Van Eyckc1633172024-04-09 18:44:13 +02001506 if (mbedtls_ecp_group_a_is_minus_3(grp)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001507 /* tmp[0] <- M = 3(X + Z^2)(X - Z^2) */
1508 MPI_ECP_SQR(&tmp[1], &P->Z);
1509 MPI_ECP_ADD(&tmp[2], &P->X, &tmp[1]);
1510 MPI_ECP_SUB(&tmp[3], &P->X, &tmp[1]);
1511 MPI_ECP_MUL(&tmp[1], &tmp[2], &tmp[3]);
1512 MPI_ECP_MUL_INT(&tmp[0], &tmp[1], 3);
1513 } else {
1514 /* tmp[0] <- M = 3.X^2 + A.Z^4 */
1515 MPI_ECP_SQR(&tmp[1], &P->X);
1516 MPI_ECP_MUL_INT(&tmp[0], &tmp[1], 3);
Jens Wiklander817466c2018-05-22 13:49:31 +02001517
1518 /* Optimize away for "koblitz" curves with A = 0 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001519 if (MPI_ECP_CMP_INT(&grp->A, 0) != 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001520 /* M += A.Z^4 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001521 MPI_ECP_SQR(&tmp[1], &P->Z);
1522 MPI_ECP_SQR(&tmp[2], &tmp[1]);
1523 MPI_ECP_MUL(&tmp[1], &tmp[2], &grp->A);
1524 MPI_ECP_ADD(&tmp[0], &tmp[0], &tmp[1]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001525 }
1526 }
1527
Jens Wiklander32b31802023-10-06 16:59:46 +02001528 /* tmp[1] <- S = 4.X.Y^2 */
1529 MPI_ECP_SQR(&tmp[2], &P->Y);
1530 MPI_ECP_SHIFT_L(&tmp[2], 1);
1531 MPI_ECP_MUL(&tmp[1], &P->X, &tmp[2]);
1532 MPI_ECP_SHIFT_L(&tmp[1], 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001533
Jens Wiklander32b31802023-10-06 16:59:46 +02001534 /* tmp[3] <- U = 8.Y^4 */
1535 MPI_ECP_SQR(&tmp[3], &tmp[2]);
1536 MPI_ECP_SHIFT_L(&tmp[3], 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001537
Jens Wiklander32b31802023-10-06 16:59:46 +02001538 /* tmp[2] <- T = M^2 - 2.S */
1539 MPI_ECP_SQR(&tmp[2], &tmp[0]);
1540 MPI_ECP_SUB(&tmp[2], &tmp[2], &tmp[1]);
1541 MPI_ECP_SUB(&tmp[2], &tmp[2], &tmp[1]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001542
Jens Wiklander32b31802023-10-06 16:59:46 +02001543 /* tmp[1] <- S = M(S - T) - U */
1544 MPI_ECP_SUB(&tmp[1], &tmp[1], &tmp[2]);
1545 MPI_ECP_MUL(&tmp[1], &tmp[1], &tmp[0]);
1546 MPI_ECP_SUB(&tmp[1], &tmp[1], &tmp[3]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001547
Jens Wiklander32b31802023-10-06 16:59:46 +02001548 /* tmp[3] <- U = 2.Y.Z */
1549 MPI_ECP_MUL(&tmp[3], &P->Y, &P->Z);
1550 MPI_ECP_SHIFT_L(&tmp[3], 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001551
Jens Wiklander32b31802023-10-06 16:59:46 +02001552 /* Store results */
1553 MPI_ECP_MOV(&R->X, &tmp[2]);
1554 MPI_ECP_MOV(&R->Y, &tmp[1]);
1555 MPI_ECP_MOV(&R->Z, &tmp[3]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001556
1557cleanup:
Jens Wiklander817466c2018-05-22 13:49:31 +02001558
Jens Wiklander32b31802023-10-06 16:59:46 +02001559 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001560#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_DOUBLE_JAC_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001561}
1562
1563/*
1564 * Addition: R = P + Q, mixed affine-Jacobian coordinates (GECC 3.22)
1565 *
1566 * The coordinates of Q must be normalized (= affine),
1567 * but those of P don't need to. R is not normalized.
1568 *
Jens Wiklander32b31802023-10-06 16:59:46 +02001569 * P,Q,R may alias, but only at the level of EC points: they must be either
1570 * equal as pointers, or disjoint (including the coordinate data buffers).
1571 * Fine-grained aliasing at the level of coordinates is not supported.
1572 *
Jens Wiklander817466c2018-05-22 13:49:31 +02001573 * Special cases: (1) P or Q is zero, (2) R is zero, (3) P == Q.
1574 * None of these cases can happen as intermediate step in ecp_mul_comb():
1575 * - at each step, P, Q and R are multiples of the base point, the factor
1576 * being less than its order, so none of them is zero;
1577 * - Q is an odd multiple of the base point, P an even multiple,
1578 * due to the choice of precomputed points in the modified comb method.
1579 * So branches for these cases do not leak secret information.
1580 *
Jens Wiklander817466c2018-05-22 13:49:31 +02001581 * Cost: 1A := 8M + 3S
1582 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001583static int ecp_add_mixed(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
1584 const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q,
1585 mbedtls_mpi tmp[4])
Jens Wiklander817466c2018-05-22 13:49:31 +02001586{
Jens Wiklander817466c2018-05-22 13:49:31 +02001587#if defined(MBEDTLS_SELF_TEST)
1588 add_count++;
1589#endif
1590
1591#if defined(MBEDTLS_ECP_ADD_MIXED_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001592 if (mbedtls_internal_ecp_grp_capable(grp)) {
1593 return mbedtls_internal_ecp_add_mixed(grp, R, P, Q);
1594 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001595#endif /* MBEDTLS_ECP_ADD_MIXED_ALT */
1596
Jerome Forissier79013242021-07-28 10:24:04 +02001597#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_ADD_MIXED_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001598 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001599#else
1600 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001601
1602 /* NOTE: Aliasing between input and output is allowed, so one has to make
1603 * sure that at the point X,Y,Z are written, {P,Q}->{X,Y,Z} are no
1604 * longer read from. */
1605 mbedtls_mpi * const X = &R->X;
1606 mbedtls_mpi * const Y = &R->Y;
1607 mbedtls_mpi * const Z = &R->Z;
1608
1609 if (!MPI_ECP_VALID(&Q->Z)) {
1610 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1611 }
Jerome Forissier79013242021-07-28 10:24:04 +02001612
Jens Wiklander817466c2018-05-22 13:49:31 +02001613 /*
1614 * Trivial cases: P == 0 or Q == 0 (case 1)
1615 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001616 if (MPI_ECP_CMP_INT(&P->Z, 0) == 0) {
1617 return mbedtls_ecp_copy(R, Q);
1618 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001619
Jens Wiklander32b31802023-10-06 16:59:46 +02001620 if (MPI_ECP_CMP_INT(&Q->Z, 0) == 0) {
1621 return mbedtls_ecp_copy(R, P);
1622 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001623
1624 /*
1625 * Make sure Q coordinates are normalized
1626 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001627 if (MPI_ECP_CMP_INT(&Q->Z, 1) != 0) {
1628 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1629 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001630
Jens Wiklander32b31802023-10-06 16:59:46 +02001631 MPI_ECP_SQR(&tmp[0], &P->Z);
1632 MPI_ECP_MUL(&tmp[1], &tmp[0], &P->Z);
1633 MPI_ECP_MUL(&tmp[0], &tmp[0], &Q->X);
1634 MPI_ECP_MUL(&tmp[1], &tmp[1], &Q->Y);
1635 MPI_ECP_SUB(&tmp[0], &tmp[0], &P->X);
1636 MPI_ECP_SUB(&tmp[1], &tmp[1], &P->Y);
Jens Wiklander817466c2018-05-22 13:49:31 +02001637
1638 /* Special cases (2) and (3) */
Jens Wiklander32b31802023-10-06 16:59:46 +02001639 if (MPI_ECP_CMP_INT(&tmp[0], 0) == 0) {
1640 if (MPI_ECP_CMP_INT(&tmp[1], 0) == 0) {
1641 ret = ecp_double_jac(grp, R, P, tmp);
Jens Wiklander817466c2018-05-22 13:49:31 +02001642 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +02001643 } else {
1644 ret = mbedtls_ecp_set_zero(R);
Jens Wiklander817466c2018-05-22 13:49:31 +02001645 goto cleanup;
1646 }
1647 }
1648
Jens Wiklander32b31802023-10-06 16:59:46 +02001649 /* {P,Q}->Z no longer used, so OK to write to Z even if there's aliasing. */
1650 MPI_ECP_MUL(Z, &P->Z, &tmp[0]);
1651 MPI_ECP_SQR(&tmp[2], &tmp[0]);
1652 MPI_ECP_MUL(&tmp[3], &tmp[2], &tmp[0]);
1653 MPI_ECP_MUL(&tmp[2], &tmp[2], &P->X);
Jens Wiklander817466c2018-05-22 13:49:31 +02001654
Jens Wiklander32b31802023-10-06 16:59:46 +02001655 MPI_ECP_MOV(&tmp[0], &tmp[2]);
1656 MPI_ECP_SHIFT_L(&tmp[0], 1);
1657
1658 /* {P,Q}->X no longer used, so OK to write to X even if there's aliasing. */
1659 MPI_ECP_SQR(X, &tmp[1]);
1660 MPI_ECP_SUB(X, X, &tmp[0]);
1661 MPI_ECP_SUB(X, X, &tmp[3]);
1662 MPI_ECP_SUB(&tmp[2], &tmp[2], X);
1663 MPI_ECP_MUL(&tmp[2], &tmp[2], &tmp[1]);
1664 MPI_ECP_MUL(&tmp[3], &tmp[3], &P->Y);
1665 /* {P,Q}->Y no longer used, so OK to write to Y even if there's aliasing. */
1666 MPI_ECP_SUB(Y, &tmp[2], &tmp[3]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001667
1668cleanup:
1669
Jens Wiklander32b31802023-10-06 16:59:46 +02001670 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001671#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_ADD_MIXED_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001672}
1673
1674/*
1675 * Randomize jacobian coordinates:
1676 * (X, Y, Z) -> (l^2 X, l^3 Y, l Z) for random l
1677 * This is sort of the reverse operation of ecp_normalize_jac().
1678 *
1679 * This countermeasure was first suggested in [2].
1680 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001681static int ecp_randomize_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt,
1682 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02001683{
Jens Wiklander817466c2018-05-22 13:49:31 +02001684#if defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001685 if (mbedtls_internal_ecp_grp_capable(grp)) {
1686 return mbedtls_internal_ecp_randomize_jac(grp, pt, f_rng, p_rng);
1687 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001688#endif /* MBEDTLS_ECP_RANDOMIZE_JAC_ALT */
1689
Jerome Forissier79013242021-07-28 10:24:04 +02001690#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001691 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001692#else
1693 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001694 mbedtls_mpi l;
Jerome Forissier79013242021-07-28 10:24:04 +02001695
Jens Wiklander32b31802023-10-06 16:59:46 +02001696 mbedtls_mpi_init(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001697
1698 /* Generate l such that 1 < l < p */
Jens Wiklander32b31802023-10-06 16:59:46 +02001699 MPI_ECP_RAND(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001700
Jens Wiklander32b31802023-10-06 16:59:46 +02001701 /* Z' = l * Z */
1702 MPI_ECP_MUL(&pt->Z, &pt->Z, &l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001703
Jens Wiklander32b31802023-10-06 16:59:46 +02001704 /* Y' = l * Y */
1705 MPI_ECP_MUL(&pt->Y, &pt->Y, &l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001706
Jens Wiklander32b31802023-10-06 16:59:46 +02001707 /* X' = l^2 * X */
1708 MPI_ECP_SQR(&l, &l);
1709 MPI_ECP_MUL(&pt->X, &pt->X, &l);
1710
1711 /* Y'' = l^2 * Y' = l^3 * Y */
1712 MPI_ECP_MUL(&pt->Y, &pt->Y, &l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001713
1714cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001715 mbedtls_mpi_free(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001716
Jens Wiklander32b31802023-10-06 16:59:46 +02001717 if (ret == MBEDTLS_ERR_MPI_NOT_ACCEPTABLE) {
Jerome Forissier79013242021-07-28 10:24:04 +02001718 ret = MBEDTLS_ERR_ECP_RANDOM_FAILED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001719 }
1720 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001721#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001722}
1723
1724/*
1725 * Check and define parameters used by the comb method (see below for details)
1726 */
1727#if MBEDTLS_ECP_WINDOW_SIZE < 2 || MBEDTLS_ECP_WINDOW_SIZE > 7
1728#error "MBEDTLS_ECP_WINDOW_SIZE out of bounds"
1729#endif
1730
1731/* d = ceil( n / w ) */
Jens Wiklander32b31802023-10-06 16:59:46 +02001732#define COMB_MAX_D (MBEDTLS_ECP_MAX_BITS + 1) / 2
Jens Wiklander817466c2018-05-22 13:49:31 +02001733
1734/* number of precomputed points */
Jens Wiklander32b31802023-10-06 16:59:46 +02001735#define COMB_MAX_PRE (1 << (MBEDTLS_ECP_WINDOW_SIZE - 1))
Jens Wiklander817466c2018-05-22 13:49:31 +02001736
1737/*
1738 * Compute the representation of m that will be used with our comb method.
1739 *
1740 * The basic comb method is described in GECC 3.44 for example. We use a
1741 * modified version that provides resistance to SPA by avoiding zero
1742 * digits in the representation as in [3]. We modify the method further by
1743 * requiring that all K_i be odd, which has the small cost that our
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001744 * representation uses one more K_i, due to carries, but saves on the size of
1745 * the precomputed table.
Jens Wiklander817466c2018-05-22 13:49:31 +02001746 *
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001747 * Summary of the comb method and its modifications:
1748 *
1749 * - The goal is to compute m*P for some w*d-bit integer m.
1750 *
1751 * - The basic comb method splits m into the w-bit integers
1752 * x[0] .. x[d-1] where x[i] consists of the bits in m whose
1753 * index has residue i modulo d, and computes m * P as
1754 * S[x[0]] + 2 * S[x[1]] + .. + 2^(d-1) S[x[d-1]], where
1755 * S[i_{w-1} .. i_0] := i_{w-1} 2^{(w-1)d} P + ... + i_1 2^d P + i_0 P.
1756 *
1757 * - If it happens that, say, x[i+1]=0 (=> S[x[i+1]]=0), one can replace the sum by
1758 * .. + 2^{i-1} S[x[i-1]] - 2^i S[x[i]] + 2^{i+1} S[x[i]] + 2^{i+2} S[x[i+2]] ..,
1759 * thereby successively converting it into a form where all summands
1760 * are nonzero, at the cost of negative summands. This is the basic idea of [3].
1761 *
1762 * - More generally, even if x[i+1] != 0, we can first transform the sum as
1763 * .. - 2^i S[x[i]] + 2^{i+1} ( S[x[i]] + S[x[i+1]] ) + 2^{i+2} S[x[i+2]] ..,
1764 * and then replace S[x[i]] + S[x[i+1]] = S[x[i] ^ x[i+1]] + 2 S[x[i] & x[i+1]].
1765 * Performing and iterating this procedure for those x[i] that are even
1766 * (keeping track of carry), we can transform the original sum into one of the form
1767 * S[x'[0]] +- 2 S[x'[1]] +- .. +- 2^{d-1} S[x'[d-1]] + 2^d S[x'[d]]
1768 * with all x'[i] odd. It is therefore only necessary to know S at odd indices,
1769 * which is why we are only computing half of it in the first place in
1770 * ecp_precompute_comb and accessing it with index abs(i) / 2 in ecp_select_comb.
1771 *
1772 * - For the sake of compactness, only the seven low-order bits of x[i]
1773 * are used to represent its absolute value (K_i in the paper), and the msb
1774 * of x[i] encodes the sign (s_i in the paper): it is set if and only if
1775 * if s_i == -1;
Jens Wiklander817466c2018-05-22 13:49:31 +02001776 *
1777 * Calling conventions:
1778 * - x is an array of size d + 1
1779 * - w is the size, ie number of teeth, of the comb, and must be between
1780 * 2 and 7 (in practice, between 2 and MBEDTLS_ECP_WINDOW_SIZE)
1781 * - m is the MPI, expected to be odd and such that bitlength(m) <= w * d
1782 * (the result will be incorrect if these assumptions are not satisfied)
1783 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001784static void ecp_comb_recode_core(unsigned char x[], size_t d,
1785 unsigned char w, const mbedtls_mpi *m)
Jens Wiklander817466c2018-05-22 13:49:31 +02001786{
1787 size_t i, j;
1788 unsigned char c, cc, adjust;
1789
Jens Wiklander32b31802023-10-06 16:59:46 +02001790 memset(x, 0, d+1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001791
1792 /* First get the classical comb values (except for x_d = 0) */
Jens Wiklander32b31802023-10-06 16:59:46 +02001793 for (i = 0; i < d; i++) {
1794 for (j = 0; j < w; j++) {
1795 x[i] |= mbedtls_mpi_get_bit(m, i + d * j) << j;
1796 }
1797 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001798
1799 /* Now make sure x_1 .. x_d are odd */
1800 c = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02001801 for (i = 1; i <= d; i++) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001802 /* Add carry and update it */
1803 cc = x[i] & c;
1804 x[i] = x[i] ^ c;
1805 c = cc;
1806
1807 /* Adjust if needed, avoiding branches */
Jens Wiklander32b31802023-10-06 16:59:46 +02001808 adjust = 1 - (x[i] & 0x01);
1809 c |= x[i] & (x[i-1] * adjust);
1810 x[i] = x[i] ^ (x[i-1] * adjust);
Jens Wiklander817466c2018-05-22 13:49:31 +02001811 x[i-1] |= adjust << 7;
1812 }
1813}
1814
1815/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001816 * Precompute points for the adapted comb method
Jens Wiklander817466c2018-05-22 13:49:31 +02001817 *
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001818 * Assumption: T must be able to hold 2^{w - 1} elements.
Jens Wiklander817466c2018-05-22 13:49:31 +02001819 *
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001820 * Operation: If i = i_{w-1} ... i_1 is the binary representation of i,
1821 * sets T[i] = i_{w-1} 2^{(w-1)d} P + ... + i_1 2^d P + P.
Jens Wiklander817466c2018-05-22 13:49:31 +02001822 *
1823 * Cost: d(w-1) D + (2^{w-1} - 1) A + 1 N(w-1) + 1 N(2^{w-1} - 1)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001824 *
1825 * Note: Even comb values (those where P would be omitted from the
1826 * sum defining T[i] above) are not needed in our adaption
1827 * the comb method. See ecp_comb_recode_core().
1828 *
1829 * This function currently works in four steps:
1830 * (1) [dbl] Computation of intermediate T[i] for 2-power values of i
1831 * (2) [norm_dbl] Normalization of coordinates of these T[i]
1832 * (3) [add] Computation of all T[i]
1833 * (4) [norm_add] Normalization of all T[i]
1834 *
1835 * Step 1 can be interrupted but not the others; together with the final
1836 * coordinate normalization they are the largest steps done at once, depending
1837 * on the window size. Here are operation counts for P-256:
1838 *
1839 * step (2) (3) (4)
1840 * w = 5 142 165 208
1841 * w = 4 136 77 160
1842 * w = 3 130 33 136
1843 * w = 2 124 11 124
1844 *
1845 * So if ECC operations are blocking for too long even with a low max_ops
1846 * value, it's useful to set MBEDTLS_ECP_WINDOW_SIZE to a lower value in order
1847 * to minimize maximum blocking time.
Jens Wiklander817466c2018-05-22 13:49:31 +02001848 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001849static int ecp_precompute_comb(const mbedtls_ecp_group *grp,
1850 mbedtls_ecp_point T[], const mbedtls_ecp_point *P,
1851 unsigned char w, size_t d,
1852 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +02001853{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001854 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001855 unsigned char i;
1856 size_t j = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02001857 const unsigned char T_size = 1U << (w - 1);
1858 mbedtls_ecp_point *cur, *TT[COMB_MAX_PRE - 1] = { NULL };
1859
1860 mbedtls_mpi tmp[4];
1861
1862 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander817466c2018-05-22 13:49:31 +02001863
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001864#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001865 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
1866 if (rs_ctx->rsm->state == ecp_rsm_pre_dbl) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001867 goto dbl;
Jens Wiklander32b31802023-10-06 16:59:46 +02001868 }
1869 if (rs_ctx->rsm->state == ecp_rsm_pre_norm_dbl) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001870 goto norm_dbl;
Jens Wiklander32b31802023-10-06 16:59:46 +02001871 }
1872 if (rs_ctx->rsm->state == ecp_rsm_pre_add) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001873 goto add;
Jens Wiklander32b31802023-10-06 16:59:46 +02001874 }
1875 if (rs_ctx->rsm->state == ecp_rsm_pre_norm_add) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001876 goto norm_add;
Jens Wiklander32b31802023-10-06 16:59:46 +02001877 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001878 }
1879#else
1880 (void) rs_ctx;
1881#endif
1882
1883#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001884 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001885 rs_ctx->rsm->state = ecp_rsm_pre_dbl;
1886
1887 /* initial state for the loop */
1888 rs_ctx->rsm->i = 0;
1889 }
1890
1891dbl:
1892#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02001893 /*
1894 * Set T[0] = P and
1895 * T[2^{l-1}] = 2^{dl} P for l = 1 .. w-1 (this is not the final value)
1896 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001897 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(&T[0], P));
Jens Wiklander817466c2018-05-22 13:49:31 +02001898
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001899#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001900 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->i != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001901 j = rs_ctx->rsm->i;
Jens Wiklander32b31802023-10-06 16:59:46 +02001902 } else
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001903#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02001904 j = 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001905
Jens Wiklander32b31802023-10-06 16:59:46 +02001906 for (; j < d * (w - 1); j++) {
1907 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_DBL);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001908
Jens Wiklander32b31802023-10-06 16:59:46 +02001909 i = 1U << (j / d);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001910 cur = T + i;
1911
Jens Wiklander32b31802023-10-06 16:59:46 +02001912 if (j % d == 0) {
1913 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(cur, T + (i >> 1)));
1914 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001915
Jens Wiklander32b31802023-10-06 16:59:46 +02001916 MBEDTLS_MPI_CHK(ecp_double_jac(grp, cur, cur, tmp));
Jens Wiklander817466c2018-05-22 13:49:31 +02001917 }
1918
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001919#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001920 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001921 rs_ctx->rsm->state = ecp_rsm_pre_norm_dbl;
Jens Wiklander32b31802023-10-06 16:59:46 +02001922 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001923
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001924norm_dbl:
1925#endif
1926 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02001927 * Normalize current elements in T to allow them to be used in
1928 * ecp_add_mixed() below, which requires one normalized input.
1929 *
1930 * As T has holes, use an auxiliary array of pointers to elements in T.
1931 *
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001932 */
1933 j = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02001934 for (i = 1; i < T_size; i <<= 1) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001935 TT[j++] = T + i;
Jens Wiklander32b31802023-10-06 16:59:46 +02001936 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001937
Jens Wiklander32b31802023-10-06 16:59:46 +02001938 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV + 6 * j - 2);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001939
Jens Wiklander32b31802023-10-06 16:59:46 +02001940 MBEDTLS_MPI_CHK(ecp_normalize_jac_many(grp, TT, j));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001941
1942#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001943 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001944 rs_ctx->rsm->state = ecp_rsm_pre_add;
Jens Wiklander32b31802023-10-06 16:59:46 +02001945 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001946
1947add:
1948#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02001949 /*
1950 * Compute the remaining ones using the minimal number of additions
1951 * Be careful to update T[2^l] only after using it!
1952 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001953 MBEDTLS_ECP_BUDGET((T_size - 1) * MBEDTLS_ECP_OPS_ADD);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001954
Jens Wiklander32b31802023-10-06 16:59:46 +02001955 for (i = 1; i < T_size; i <<= 1) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001956 j = i;
Jens Wiklander32b31802023-10-06 16:59:46 +02001957 while (j--) {
1958 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, &T[i + j], &T[j], &T[i], tmp));
1959 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001960 }
1961
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001962#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001963 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001964 rs_ctx->rsm->state = ecp_rsm_pre_norm_add;
Jens Wiklander32b31802023-10-06 16:59:46 +02001965 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001966
1967norm_add:
1968#endif
1969 /*
1970 * Normalize final elements in T. Even though there are no holes now, we
1971 * still need the auxiliary array for homogeneity with the previous
1972 * call. Also, skip T[0] which is already normalised, being a copy of P.
1973 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001974 for (j = 0; j + 1 < T_size; j++) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001975 TT[j] = T + j + 1;
Jens Wiklander32b31802023-10-06 16:59:46 +02001976 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001977
Jens Wiklander32b31802023-10-06 16:59:46 +02001978 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV + 6 * j - 2);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001979
Jens Wiklander32b31802023-10-06 16:59:46 +02001980 MBEDTLS_MPI_CHK(ecp_normalize_jac_many(grp, TT, j));
1981
1982 /* Free Z coordinate (=1 after normalization) to save RAM.
1983 * This makes T[i] invalid as mbedtls_ecp_points, but this is OK
1984 * since from this point onwards, they are only accessed indirectly
1985 * via the getter function ecp_select_comb() which does set the
1986 * target's Z coordinate to 1. */
1987 for (i = 0; i < T_size; i++) {
1988 mbedtls_mpi_free(&T[i].Z);
1989 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001990
1991cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001992
1993 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
1994
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001995#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001996 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
1997 ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
1998 if (rs_ctx->rsm->state == ecp_rsm_pre_dbl) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001999 rs_ctx->rsm->i = j;
Jens Wiklander32b31802023-10-06 16:59:46 +02002000 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002001 }
2002#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02002003
Jens Wiklander32b31802023-10-06 16:59:46 +02002004 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002005}
2006
2007/*
2008 * Select precomputed point: R = sign(i) * T[ abs(i) / 2 ]
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002009 *
2010 * See ecp_comb_recode_core() for background
Jens Wiklander817466c2018-05-22 13:49:31 +02002011 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002012static int ecp_select_comb(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2013 const mbedtls_ecp_point T[], unsigned char T_size,
2014 unsigned char i)
Jens Wiklander817466c2018-05-22 13:49:31 +02002015{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002017 unsigned char ii, j;
2018
2019 /* Ignore the "sign" bit and scale down */
Jens Wiklander32b31802023-10-06 16:59:46 +02002020 ii = (i & 0x7Fu) >> 1;
Jens Wiklander817466c2018-05-22 13:49:31 +02002021
2022 /* Read the whole table to thwart cache-based timing attacks */
Jens Wiklander32b31802023-10-06 16:59:46 +02002023 for (j = 0; j < T_size; j++) {
2024 MPI_ECP_COND_ASSIGN(&R->X, &T[j].X, j == ii);
2025 MPI_ECP_COND_ASSIGN(&R->Y, &T[j].Y, j == ii);
Jens Wiklander817466c2018-05-22 13:49:31 +02002026 }
2027
2028 /* Safely invert result if i is "negative" */
Jens Wiklander32b31802023-10-06 16:59:46 +02002029 MBEDTLS_MPI_CHK(ecp_safe_invert_jac(grp, R, i >> 7));
2030
2031 MPI_ECP_LSET(&R->Z, 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02002032
2033cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002034 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002035}
2036
2037/*
2038 * Core multiplication algorithm for the (modified) comb method.
2039 * This part is actually common with the basic comb method (GECC 3.44)
2040 *
2041 * Cost: d A + d D + 1 R
2042 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002043static int ecp_mul_comb_core(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2044 const mbedtls_ecp_point T[], unsigned char T_size,
2045 const unsigned char x[], size_t d,
2046 int (*f_rng)(void *, unsigned char *, size_t),
2047 void *p_rng,
2048 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +02002049{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002051 mbedtls_ecp_point Txi;
Jens Wiklander32b31802023-10-06 16:59:46 +02002052 mbedtls_mpi tmp[4];
Jens Wiklander817466c2018-05-22 13:49:31 +02002053 size_t i;
2054
Jens Wiklander32b31802023-10-06 16:59:46 +02002055 mbedtls_ecp_point_init(&Txi);
2056 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander817466c2018-05-22 13:49:31 +02002057
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002058#if !defined(MBEDTLS_ECP_RESTARTABLE)
2059 (void) rs_ctx;
2060#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02002061
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002062#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002063 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2064 rs_ctx->rsm->state != ecp_rsm_comb_core) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002065 rs_ctx->rsm->i = 0;
2066 rs_ctx->rsm->state = ecp_rsm_comb_core;
2067 }
2068
2069 /* new 'if' instead of nested for the sake of the 'else' branch */
Jens Wiklander32b31802023-10-06 16:59:46 +02002070 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->i != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002071 /* restore current index (R already pointing to rs_ctx->rsm->R) */
2072 i = rs_ctx->rsm->i;
Jens Wiklander32b31802023-10-06 16:59:46 +02002073 } else
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002074#endif
2075 {
2076 /* Start with a non-zero point and randomize its coordinates */
2077 i = d;
Jens Wiklander32b31802023-10-06 16:59:46 +02002078 MBEDTLS_MPI_CHK(ecp_select_comb(grp, R, T, T_size, x[i]));
2079 if (f_rng != 0) {
2080 MBEDTLS_MPI_CHK(ecp_randomize_jac(grp, R, f_rng, p_rng));
2081 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002082 }
2083
Jens Wiklander32b31802023-10-06 16:59:46 +02002084 while (i != 0) {
2085 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_DBL + MBEDTLS_ECP_OPS_ADD);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002086 --i;
2087
Jens Wiklander32b31802023-10-06 16:59:46 +02002088 MBEDTLS_MPI_CHK(ecp_double_jac(grp, R, R, tmp));
2089 MBEDTLS_MPI_CHK(ecp_select_comb(grp, &Txi, T, T_size, x[i]));
2090 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, R, R, &Txi, tmp));
Jens Wiklander817466c2018-05-22 13:49:31 +02002091 }
2092
2093cleanup:
2094
Jens Wiklander32b31802023-10-06 16:59:46 +02002095 mbedtls_ecp_point_free(&Txi);
2096 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander817466c2018-05-22 13:49:31 +02002097
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002098#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002099 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2100 ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002101 rs_ctx->rsm->i = i;
2102 /* no need to save R, already pointing to rs_ctx->rsm->R */
2103 }
2104#endif
2105
Jens Wiklander32b31802023-10-06 16:59:46 +02002106 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002107}
2108
2109/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002110 * Recode the scalar to get constant-time comb multiplication
2111 *
2112 * As the actual scalar recoding needs an odd scalar as a starting point,
2113 * this wrapper ensures that by replacing m by N - m if necessary, and
2114 * informs the caller that the result of multiplication will be negated.
2115 *
2116 * This works because we only support large prime order for Short Weierstrass
2117 * curves, so N is always odd hence either m or N - m is.
2118 *
2119 * See ecp_comb_recode_core() for background.
Jens Wiklander817466c2018-05-22 13:49:31 +02002120 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002121static int ecp_comb_recode_scalar(const mbedtls_ecp_group *grp,
2122 const mbedtls_mpi *m,
2123 unsigned char k[COMB_MAX_D + 1],
2124 size_t d,
2125 unsigned char w,
2126 unsigned char *parity_trick)
Jens Wiklander817466c2018-05-22 13:49:31 +02002127{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002129 mbedtls_mpi M, mm;
2130
Jens Wiklander32b31802023-10-06 16:59:46 +02002131 mbedtls_mpi_init(&M);
2132 mbedtls_mpi_init(&mm);
Jens Wiklander817466c2018-05-22 13:49:31 +02002133
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002134 /* N is always odd (see above), just make extra sure */
Jens Wiklander32b31802023-10-06 16:59:46 +02002135 if (mbedtls_mpi_get_bit(&grp->N, 0) != 1) {
2136 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2137 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002138
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002139 /* do we need the parity trick? */
Jens Wiklander32b31802023-10-06 16:59:46 +02002140 *parity_trick = (mbedtls_mpi_get_bit(m, 0) == 0);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002141
2142 /* execute parity fix in constant time */
Jens Wiklander32b31802023-10-06 16:59:46 +02002143 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&M, m));
2144 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&mm, &grp->N, m));
2145 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign(&M, &mm, *parity_trick));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002146
2147 /* actual scalar recoding */
Jens Wiklander32b31802023-10-06 16:59:46 +02002148 ecp_comb_recode_core(k, d, w, &M);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002149
2150cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002151 mbedtls_mpi_free(&mm);
2152 mbedtls_mpi_free(&M);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002153
Jens Wiklander32b31802023-10-06 16:59:46 +02002154 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002155}
2156
2157/*
2158 * Perform comb multiplication (for short Weierstrass curves)
2159 * once the auxiliary table has been pre-computed.
2160 *
2161 * Scalar recoding may use a parity trick that makes us compute -m * P,
2162 * if that is the case we'll need to recover m * P at the end.
2163 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002164static int ecp_mul_comb_after_precomp(const mbedtls_ecp_group *grp,
2165 mbedtls_ecp_point *R,
2166 const mbedtls_mpi *m,
2167 const mbedtls_ecp_point *T,
2168 unsigned char T_size,
2169 unsigned char w,
2170 size_t d,
2171 int (*f_rng)(void *, unsigned char *, size_t),
2172 void *p_rng,
2173 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002174{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002176 unsigned char parity_trick;
2177 unsigned char k[COMB_MAX_D + 1];
2178 mbedtls_ecp_point *RR = R;
2179
2180#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002181 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002182 RR = &rs_ctx->rsm->R;
2183
Jens Wiklander32b31802023-10-06 16:59:46 +02002184 if (rs_ctx->rsm->state == ecp_rsm_final_norm) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002185 goto final_norm;
Jens Wiklander32b31802023-10-06 16:59:46 +02002186 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002187 }
2188#endif
2189
Jens Wiklander32b31802023-10-06 16:59:46 +02002190 MBEDTLS_MPI_CHK(ecp_comb_recode_scalar(grp, m, k, d, w,
2191 &parity_trick));
2192 MBEDTLS_MPI_CHK(ecp_mul_comb_core(grp, RR, T, T_size, k, d,
2193 f_rng, p_rng, rs_ctx));
2194 MBEDTLS_MPI_CHK(ecp_safe_invert_jac(grp, RR, parity_trick));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002195
2196#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002197 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002198 rs_ctx->rsm->state = ecp_rsm_final_norm;
Jens Wiklander32b31802023-10-06 16:59:46 +02002199 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002200
2201final_norm:
Jens Wiklander32b31802023-10-06 16:59:46 +02002202 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002203#endif
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002204 /*
2205 * Knowledge of the jacobian coordinates may leak the last few bits of the
2206 * scalar [1], and since our MPI implementation isn't constant-flow,
2207 * inversion (used for coordinate normalization) may leak the full value
2208 * of its input via side-channels [2].
2209 *
2210 * [1] https://eprint.iacr.org/2003/191
2211 * [2] https://eprint.iacr.org/2020/055
2212 *
2213 * Avoid the leak by randomizing coordinates before we normalize them.
2214 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002215 if (f_rng != 0) {
2216 MBEDTLS_MPI_CHK(ecp_randomize_jac(grp, RR, f_rng, p_rng));
2217 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002218
Jens Wiklander32b31802023-10-06 16:59:46 +02002219 MBEDTLS_MPI_CHK(ecp_normalize_jac(grp, RR));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002220
2221#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002222 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
2223 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, RR));
2224 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002225#endif
2226
2227cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002228 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002229}
2230
2231/*
2232 * Pick window size based on curve size and whether we optimize for base point
2233 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002234static unsigned char ecp_pick_window_size(const mbedtls_ecp_group *grp,
2235 unsigned char p_eq_g)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002236{
2237 unsigned char w;
2238
Jens Wiklander817466c2018-05-22 13:49:31 +02002239 /*
2240 * Minimize the number of multiplications, that is minimize
2241 * 10 * d * w + 18 * 2^(w-1) + 11 * d + 7 * w, with d = ceil( nbits / w )
2242 * (see costs of the various parts, with 1S = 1M)
2243 */
2244 w = grp->nbits >= 384 ? 5 : 4;
2245
2246 /*
2247 * If P == G, pre-compute a bit more, since this may be re-used later.
2248 * Just adding one avoids upping the cost of the first mul too much,
2249 * and the memory cost too.
2250 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002251 if (p_eq_g) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002252 w++;
Jens Wiklander32b31802023-10-06 16:59:46 +02002253 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002254
2255 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02002256 * If static comb table may not be used (!p_eq_g) or static comb table does
2257 * not exists, make sure w is within bounds.
Jens Wiklander817466c2018-05-22 13:49:31 +02002258 * (The last test is useful only for very small curves in the test suite.)
Jens Wiklander32b31802023-10-06 16:59:46 +02002259 *
2260 * The user reduces MBEDTLS_ECP_WINDOW_SIZE does not changes the size of
2261 * static comb table, because the size of static comb table is fixed when
2262 * it is generated.
Jens Wiklander817466c2018-05-22 13:49:31 +02002263 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002264#if (MBEDTLS_ECP_WINDOW_SIZE < 6)
2265 if ((!p_eq_g || !ecp_group_is_static_comb_table(grp)) && w > MBEDTLS_ECP_WINDOW_SIZE) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002266 w = MBEDTLS_ECP_WINDOW_SIZE;
Jens Wiklander32b31802023-10-06 16:59:46 +02002267 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002268#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002269 if (w >= grp->nbits) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002270 w = 2;
Jens Wiklander32b31802023-10-06 16:59:46 +02002271 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002272
Jens Wiklander32b31802023-10-06 16:59:46 +02002273 return w;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002274}
2275
2276/*
2277 * Multiplication using the comb method - for curves in short Weierstrass form
2278 *
2279 * This function is mainly responsible for administrative work:
2280 * - managing the restart context if enabled
2281 * - managing the table of precomputed points (passed between the below two
Jerome Forissier039e02d2022-08-09 17:10:15 +02002282 * functions): allocation, computation, ownership transfer, freeing.
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002283 *
2284 * It delegates the actual arithmetic work to:
2285 * ecp_precompute_comb() and ecp_mul_comb_with_precomp()
2286 *
2287 * See comments on ecp_comb_recode_core() regarding the computation strategy.
2288 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002289static int ecp_mul_comb(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2290 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2291 int (*f_rng)(void *, unsigned char *, size_t),
2292 void *p_rng,
2293 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002294{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002296 unsigned char w, p_eq_g, i;
2297 size_t d;
Jerome Forissier79013242021-07-28 10:24:04 +02002298 unsigned char T_size = 0, T_ok = 0;
2299 mbedtls_ecp_point *T = NULL;
Jerome Forissier79013242021-07-28 10:24:04 +02002300
Jens Wiklander32b31802023-10-06 16:59:46 +02002301 ECP_RS_ENTER(rsm);
Jerome Forissier79013242021-07-28 10:24:04 +02002302
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002303 /* Is P the base point ? */
2304#if MBEDTLS_ECP_FIXED_POINT_OPTIM == 1
Jens Wiklander32b31802023-10-06 16:59:46 +02002305 p_eq_g = (MPI_ECP_CMP(&P->Y, &grp->G.Y) == 0 &&
2306 MPI_ECP_CMP(&P->X, &grp->G.X) == 0);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002307#else
2308 p_eq_g = 0;
2309#endif
2310
2311 /* Pick window size and deduce related sizes */
Jens Wiklander32b31802023-10-06 16:59:46 +02002312 w = ecp_pick_window_size(grp, p_eq_g);
2313 T_size = 1U << (w - 1);
2314 d = (grp->nbits + w - 1) / w;
Jens Wiklander817466c2018-05-22 13:49:31 +02002315
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002316 /* Pre-computed table: do we have it already for the base point? */
Jens Wiklander32b31802023-10-06 16:59:46 +02002317 if (p_eq_g && grp->T != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002318 /* second pointer to the same table, will be deleted on exit */
2319 T = grp->T;
2320 T_ok = 1;
Jens Wiklander32b31802023-10-06 16:59:46 +02002321 } else
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002322#if defined(MBEDTLS_ECP_RESTARTABLE)
2323 /* Pre-computed table: do we have one in progress? complete? */
Jens Wiklander32b31802023-10-06 16:59:46 +02002324 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->T != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002325 /* transfer ownership of T from rsm to local function */
2326 T = rs_ctx->rsm->T;
2327 rs_ctx->rsm->T = NULL;
2328 rs_ctx->rsm->T_size = 0;
2329
2330 /* This effectively jumps to the call to mul_comb_after_precomp() */
2331 T_ok = rs_ctx->rsm->state >= ecp_rsm_comb_core;
Jens Wiklander32b31802023-10-06 16:59:46 +02002332 } else
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002333#endif
2334 /* Allocate table if we didn't have any */
2335 {
Jens Wiklander32b31802023-10-06 16:59:46 +02002336 T = mbedtls_calloc(T_size, sizeof(mbedtls_ecp_point));
2337 if (T == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002338 ret = MBEDTLS_ERR_ECP_ALLOC_FAILED;
2339 goto cleanup;
2340 }
2341
Jens Wiklander32b31802023-10-06 16:59:46 +02002342 for (i = 0; i < T_size; i++) {
2343 mbedtls_ecp_point_init(&T[i]);
2344 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002345
2346 T_ok = 0;
2347 }
2348
2349 /* Compute table (or finish computing it) if not done already */
Jens Wiklander32b31802023-10-06 16:59:46 +02002350 if (!T_ok) {
2351 MBEDTLS_MPI_CHK(ecp_precompute_comb(grp, T, P, w, d, rs_ctx));
Jens Wiklander817466c2018-05-22 13:49:31 +02002352
Jens Wiklander32b31802023-10-06 16:59:46 +02002353 if (p_eq_g) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002354 /* almost transfer ownership of T to the group, but keep a copy of
2355 * the pointer to use for calling the next function more easily */
Jens Wiklander817466c2018-05-22 13:49:31 +02002356 grp->T = T;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002357 grp->T_size = T_size;
Jens Wiklander817466c2018-05-22 13:49:31 +02002358 }
2359 }
2360
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002361 /* Actual comb multiplication using precomputed points */
Jens Wiklander32b31802023-10-06 16:59:46 +02002362 MBEDTLS_MPI_CHK(ecp_mul_comb_after_precomp(grp, R, m,
2363 T, T_size, w, d,
2364 f_rng, p_rng, rs_ctx));
Jens Wiklander817466c2018-05-22 13:49:31 +02002365
2366cleanup:
2367
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002368 /* does T belong to the group? */
Jens Wiklander32b31802023-10-06 16:59:46 +02002369 if (T == grp->T) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002370 T = NULL;
Jens Wiklander32b31802023-10-06 16:59:46 +02002371 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002372
2373 /* does T belong to the restart context? */
2374#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002375 if (rs_ctx != NULL && rs_ctx->rsm != NULL && ret == MBEDTLS_ERR_ECP_IN_PROGRESS && T != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002376 /* transfer ownership of T from local function to rsm */
2377 rs_ctx->rsm->T_size = T_size;
2378 rs_ctx->rsm->T = T;
2379 T = NULL;
2380 }
2381#endif
2382
2383 /* did T belong to us? then let's destroy it! */
Jens Wiklander32b31802023-10-06 16:59:46 +02002384 if (T != NULL) {
2385 for (i = 0; i < T_size; i++) {
2386 mbedtls_ecp_point_free(&T[i]);
2387 }
2388 mbedtls_free(T);
Jens Wiklander817466c2018-05-22 13:49:31 +02002389 }
2390
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002391 /* prevent caller from using invalid value */
Jens Wiklander32b31802023-10-06 16:59:46 +02002392 int should_free_R = (ret != 0);
2393#if defined(MBEDTLS_ECP_RESTARTABLE)
2394 /* don't free R while in progress in case R == P */
2395 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
2396 should_free_R = 0;
2397 }
2398#endif
2399 if (should_free_R) {
2400 mbedtls_ecp_point_free(R);
2401 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002402
Jens Wiklander32b31802023-10-06 16:59:46 +02002403 ECP_RS_LEAVE(rsm);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002404
Jens Wiklander32b31802023-10-06 16:59:46 +02002405 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002406}
2407
Jerome Forissier79013242021-07-28 10:24:04 +02002408#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02002409
Jerome Forissier79013242021-07-28 10:24:04 +02002410#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02002411/*
2412 * For Montgomery curves, we do all the internal arithmetic in projective
2413 * coordinates. Import/export of points uses only the x coordinates, which is
Jerome Forissier039e02d2022-08-09 17:10:15 +02002414 * internally represented as X / Z.
Jens Wiklander817466c2018-05-22 13:49:31 +02002415 *
2416 * For scalar multiplication, we'll use a Montgomery ladder.
2417 */
2418
2419/*
2420 * Normalize Montgomery x/z coordinates: X = X/Z, Z = 1
2421 * Cost: 1M + 1I
2422 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002423static int ecp_normalize_mxz(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P)
Jens Wiklander817466c2018-05-22 13:49:31 +02002424{
Jens Wiklander817466c2018-05-22 13:49:31 +02002425#if defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002426 if (mbedtls_internal_ecp_grp_capable(grp)) {
2427 return mbedtls_internal_ecp_normalize_mxz(grp, P);
2428 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002429#endif /* MBEDTLS_ECP_NORMALIZE_MXZ_ALT */
2430
Jerome Forissier79013242021-07-28 10:24:04 +02002431#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002432 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02002433#else
2434 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02002435 MPI_ECP_INV(&P->Z, &P->Z);
2436 MPI_ECP_MUL(&P->X, &P->X, &P->Z);
2437 MPI_ECP_LSET(&P->Z, 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02002438
2439cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002440 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02002441#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02002442}
2443
2444/*
2445 * Randomize projective x/z coordinates:
2446 * (X, Z) -> (l X, l Z) for random l
2447 * This is sort of the reverse operation of ecp_normalize_mxz().
2448 *
2449 * This countermeasure was first suggested in [2].
2450 * Cost: 2M
2451 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002452static int ecp_randomize_mxz(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P,
2453 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02002454{
Jens Wiklander817466c2018-05-22 13:49:31 +02002455#if defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002456 if (mbedtls_internal_ecp_grp_capable(grp)) {
2457 return mbedtls_internal_ecp_randomize_mxz(grp, P, f_rng, p_rng);
2458 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002459#endif /* MBEDTLS_ECP_RANDOMIZE_MXZ_ALT */
2460
Jerome Forissier79013242021-07-28 10:24:04 +02002461#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002462 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02002463#else
2464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2465 mbedtls_mpi l;
Jens Wiklander32b31802023-10-06 16:59:46 +02002466 mbedtls_mpi_init(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02002467
2468 /* Generate l such that 1 < l < p */
Jens Wiklander32b31802023-10-06 16:59:46 +02002469 MPI_ECP_RAND(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02002470
Jens Wiklander32b31802023-10-06 16:59:46 +02002471 MPI_ECP_MUL(&P->X, &P->X, &l);
2472 MPI_ECP_MUL(&P->Z, &P->Z, &l);
Jens Wiklander817466c2018-05-22 13:49:31 +02002473
2474cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002475 mbedtls_mpi_free(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02002476
Jens Wiklander32b31802023-10-06 16:59:46 +02002477 if (ret == MBEDTLS_ERR_MPI_NOT_ACCEPTABLE) {
Jerome Forissier79013242021-07-28 10:24:04 +02002478 ret = MBEDTLS_ERR_ECP_RANDOM_FAILED;
Jens Wiklander32b31802023-10-06 16:59:46 +02002479 }
2480 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02002481#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02002482}
2483
2484/*
2485 * Double-and-add: R = 2P, S = P + Q, with d = X(P - Q),
2486 * for Montgomery curves in x/z coordinates.
2487 *
2488 * http://www.hyperelliptic.org/EFD/g1p/auto-code/montgom/xz/ladder/mladd-1987-m.op3
2489 * with
2490 * d = X1
2491 * P = (X2, Z2)
2492 * Q = (X3, Z3)
2493 * R = (X4, Z4)
2494 * S = (X5, Z5)
2495 * and eliminating temporary variables tO, ..., t4.
2496 *
2497 * Cost: 5M + 4S
2498 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002499static int ecp_double_add_mxz(const mbedtls_ecp_group *grp,
2500 mbedtls_ecp_point *R, mbedtls_ecp_point *S,
2501 const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q,
2502 const mbedtls_mpi *d,
2503 mbedtls_mpi T[4])
Jens Wiklander817466c2018-05-22 13:49:31 +02002504{
Jens Wiklander817466c2018-05-22 13:49:31 +02002505#if defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002506 if (mbedtls_internal_ecp_grp_capable(grp)) {
2507 return mbedtls_internal_ecp_double_add_mxz(grp, R, S, P, Q, d);
2508 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002509#endif /* MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT */
2510
Jerome Forissier79013242021-07-28 10:24:04 +02002511#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002512 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02002513#else
2514 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerome Forissier79013242021-07-28 10:24:04 +02002515
Jens Wiklander32b31802023-10-06 16:59:46 +02002516 MPI_ECP_ADD(&T[0], &P->X, &P->Z); /* Pp := PX + PZ */
2517 MPI_ECP_SUB(&T[1], &P->X, &P->Z); /* Pm := PX - PZ */
2518 MPI_ECP_ADD(&T[2], &Q->X, &Q->Z); /* Qp := QX + XZ */
2519 MPI_ECP_SUB(&T[3], &Q->X, &Q->Z); /* Qm := QX - QZ */
2520 MPI_ECP_MUL(&T[3], &T[3], &T[0]); /* Qm * Pp */
2521 MPI_ECP_MUL(&T[2], &T[2], &T[1]); /* Qp * Pm */
2522 MPI_ECP_SQR(&T[0], &T[0]); /* Pp^2 */
2523 MPI_ECP_SQR(&T[1], &T[1]); /* Pm^2 */
2524 MPI_ECP_MUL(&R->X, &T[0], &T[1]); /* Pp^2 * Pm^2 */
2525 MPI_ECP_SUB(&T[0], &T[0], &T[1]); /* Pp^2 - Pm^2 */
2526 MPI_ECP_MUL(&R->Z, &grp->A, &T[0]); /* A * (Pp^2 - Pm^2) */
2527 MPI_ECP_ADD(&R->Z, &T[1], &R->Z); /* [ A * (Pp^2-Pm^2) ] + Pm^2 */
2528 MPI_ECP_ADD(&S->X, &T[3], &T[2]); /* Qm*Pp + Qp*Pm */
2529 MPI_ECP_SQR(&S->X, &S->X); /* (Qm*Pp + Qp*Pm)^2 */
2530 MPI_ECP_SUB(&S->Z, &T[3], &T[2]); /* Qm*Pp - Qp*Pm */
2531 MPI_ECP_SQR(&S->Z, &S->Z); /* (Qm*Pp - Qp*Pm)^2 */
2532 MPI_ECP_MUL(&S->Z, d, &S->Z); /* d * ( Qm*Pp - Qp*Pm )^2 */
2533 MPI_ECP_MUL(&R->Z, &T[0], &R->Z); /* [A*(Pp^2-Pm^2)+Pm^2]*(Pp^2-Pm^2) */
Jens Wiklander817466c2018-05-22 13:49:31 +02002534
2535cleanup:
Jens Wiklander817466c2018-05-22 13:49:31 +02002536
Jens Wiklander32b31802023-10-06 16:59:46 +02002537 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02002538#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02002539}
2540
2541/*
2542 * Multiplication with Montgomery ladder in x/z coordinates,
2543 * for curves in Montgomery form
2544 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002545static int ecp_mul_mxz(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2546 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2547 int (*f_rng)(void *, unsigned char *, size_t),
2548 void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02002549{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002551 size_t i;
2552 unsigned char b;
2553 mbedtls_ecp_point RP;
2554 mbedtls_mpi PX;
Jens Wiklander32b31802023-10-06 16:59:46 +02002555 mbedtls_mpi tmp[4];
2556 mbedtls_ecp_point_init(&RP); mbedtls_mpi_init(&PX);
Jens Wiklander817466c2018-05-22 13:49:31 +02002557
Jens Wiklander32b31802023-10-06 16:59:46 +02002558 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander817466c2018-05-22 13:49:31 +02002559
Jens Wiklander32b31802023-10-06 16:59:46 +02002560 if (f_rng == NULL) {
2561 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jerome Forissier79013242021-07-28 10:24:04 +02002562 }
Jerome Forissier79013242021-07-28 10:24:04 +02002563
Jens Wiklander817466c2018-05-22 13:49:31 +02002564 /* Save PX and read from P before writing to R, in case P == R */
Jens Wiklander32b31802023-10-06 16:59:46 +02002565 MPI_ECP_MOV(&PX, &P->X);
2566 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(&RP, P));
Jens Wiklander817466c2018-05-22 13:49:31 +02002567
2568 /* Set R to zero in modified x/z coordinates */
Jens Wiklander32b31802023-10-06 16:59:46 +02002569 MPI_ECP_LSET(&R->X, 1);
2570 MPI_ECP_LSET(&R->Z, 0);
2571 mbedtls_mpi_free(&R->Y);
Jens Wiklander817466c2018-05-22 13:49:31 +02002572
Jerome Forissier039e02d2022-08-09 17:10:15 +02002573 /* RP.X might be slightly larger than P, so reduce it */
Jens Wiklander32b31802023-10-06 16:59:46 +02002574 MOD_ADD(&RP.X);
Jens Wiklander817466c2018-05-22 13:49:31 +02002575
2576 /* Randomize coordinates of the starting point */
Jens Wiklander32b31802023-10-06 16:59:46 +02002577 MBEDTLS_MPI_CHK(ecp_randomize_mxz(grp, &RP, f_rng, p_rng));
Jens Wiklander817466c2018-05-22 13:49:31 +02002578
2579 /* Loop invariant: R = result so far, RP = R + P */
Jens Wiklander32b31802023-10-06 16:59:46 +02002580 i = grp->nbits + 1; /* one past the (zero-based) required msb for private keys */
2581 while (i-- > 0) {
2582 b = mbedtls_mpi_get_bit(m, i);
Jens Wiklander817466c2018-05-22 13:49:31 +02002583 /*
2584 * if (b) R = 2R + P else R = 2R,
2585 * which is:
2586 * if (b) double_add( RP, R, RP, R )
2587 * else double_add( R, RP, R, RP )
2588 * but using safe conditional swaps to avoid leaks
2589 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002590 MPI_ECP_COND_SWAP(&R->X, &RP.X, b);
2591 MPI_ECP_COND_SWAP(&R->Z, &RP.Z, b);
2592 MBEDTLS_MPI_CHK(ecp_double_add_mxz(grp, R, &RP, R, &RP, &PX, tmp));
2593 MPI_ECP_COND_SWAP(&R->X, &RP.X, b);
2594 MPI_ECP_COND_SWAP(&R->Z, &RP.Z, b);
Jens Wiklander817466c2018-05-22 13:49:31 +02002595 }
2596
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002597 /*
2598 * Knowledge of the projective coordinates may leak the last few bits of the
2599 * scalar [1], and since our MPI implementation isn't constant-flow,
2600 * inversion (used for coordinate normalization) may leak the full value
2601 * of its input via side-channels [2].
2602 *
2603 * [1] https://eprint.iacr.org/2003/191
2604 * [2] https://eprint.iacr.org/2020/055
2605 *
2606 * Avoid the leak by randomizing coordinates before we normalize them.
2607 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002608 MBEDTLS_MPI_CHK(ecp_randomize_mxz(grp, R, f_rng, p_rng));
2609 MBEDTLS_MPI_CHK(ecp_normalize_mxz(grp, R));
Jens Wiklander817466c2018-05-22 13:49:31 +02002610
2611cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002612 mbedtls_ecp_point_free(&RP); mbedtls_mpi_free(&PX);
Jerome Forissier79013242021-07-28 10:24:04 +02002613
Jens Wiklander32b31802023-10-06 16:59:46 +02002614 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
2615 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002616}
2617
Jerome Forissier79013242021-07-28 10:24:04 +02002618#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02002619
2620/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002621 * Restartable multiplication R = m * P
Jens Wiklander32b31802023-10-06 16:59:46 +02002622 *
2623 * This internal function can be called without an RNG in case where we know
2624 * the inputs are not sensitive.
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002625 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002626static int ecp_mul_restartable_internal(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2627 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2628 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
2629 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002630{
2631 int ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2632#if defined(MBEDTLS_ECP_INTERNAL_ALT)
2633 char is_grp_capable = 0;
2634#endif
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002635
2636#if defined(MBEDTLS_ECP_RESTARTABLE)
2637 /* reset ops count for this call if top-level */
Jens Wiklander32b31802023-10-06 16:59:46 +02002638 if (rs_ctx != NULL && rs_ctx->depth++ == 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002639 rs_ctx->ops_done = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02002640 }
Jerome Forissier79013242021-07-28 10:24:04 +02002641#else
2642 (void) rs_ctx;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002643#endif
2644
2645#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002646 if ((is_grp_capable = mbedtls_internal_ecp_grp_capable(grp))) {
2647 MBEDTLS_MPI_CHK(mbedtls_internal_ecp_init(grp));
2648 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002649#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2650
Jens Wiklander32b31802023-10-06 16:59:46 +02002651 int restarting = 0;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002652#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002653 restarting = (rs_ctx != NULL && rs_ctx->rsm != NULL);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002654#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002655 /* skip argument check when restarting */
2656 if (!restarting) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002657 /* check_privkey is free */
Jens Wiklander32b31802023-10-06 16:59:46 +02002658 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_CHK);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002659
2660 /* Common sanity checks */
Jens Wiklander32b31802023-10-06 16:59:46 +02002661 MBEDTLS_MPI_CHK(mbedtls_ecp_check_privkey(grp, m));
2662 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002663 }
2664
2665 ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jerome Forissier79013242021-07-28 10:24:04 +02002666#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02002667 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
2668 MBEDTLS_MPI_CHK(ecp_mul_mxz(grp, R, m, P, f_rng, p_rng));
2669 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002670#endif
Jerome Forissier79013242021-07-28 10:24:04 +02002671#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02002672 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
2673 MBEDTLS_MPI_CHK(ecp_mul_comb(grp, R, m, P, f_rng, p_rng, rs_ctx));
2674 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002675#endif
2676
2677cleanup:
2678
2679#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002680 if (is_grp_capable) {
2681 mbedtls_internal_ecp_free(grp);
2682 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002683#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2684
2685#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002686 if (rs_ctx != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002687 rs_ctx->depth--;
Jens Wiklander32b31802023-10-06 16:59:46 +02002688 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002689#endif
2690
Jens Wiklander32b31802023-10-06 16:59:46 +02002691 return ret;
2692}
2693
2694/*
2695 * Restartable multiplication R = m * P
2696 */
2697int mbedtls_ecp_mul_restartable(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2698 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2699 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
2700 mbedtls_ecp_restart_ctx *rs_ctx)
2701{
2702 if (f_rng == NULL) {
2703 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2704 }
2705
2706 return ecp_mul_restartable_internal(grp, R, m, P, f_rng, p_rng, rs_ctx);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002707}
2708
2709/*
Jens Wiklander817466c2018-05-22 13:49:31 +02002710 * Multiplication R = m * P
2711 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002712int mbedtls_ecp_mul(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2713 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2714 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02002715{
Jens Wiklander32b31802023-10-06 16:59:46 +02002716 return mbedtls_ecp_mul_restartable(grp, R, m, P, f_rng, p_rng, NULL);
Jens Wiklander817466c2018-05-22 13:49:31 +02002717}
Tom Van Eyckc1633172024-04-09 18:44:13 +02002718#endif /* MBEDTLS_ECP_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02002719
Jerome Forissier79013242021-07-28 10:24:04 +02002720#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02002721/*
2722 * Check that an affine point is valid as a public key,
2723 * short weierstrass curves (SEC1 3.2.3.1)
2724 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002725static int ecp_check_pubkey_sw(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +02002726{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002727 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002728 mbedtls_mpi YY, RHS;
2729
2730 /* pt coordinates must be normalized for our checks */
Jens Wiklander32b31802023-10-06 16:59:46 +02002731 if (mbedtls_mpi_cmp_int(&pt->X, 0) < 0 ||
2732 mbedtls_mpi_cmp_int(&pt->Y, 0) < 0 ||
2733 mbedtls_mpi_cmp_mpi(&pt->X, &grp->P) >= 0 ||
2734 mbedtls_mpi_cmp_mpi(&pt->Y, &grp->P) >= 0) {
2735 return MBEDTLS_ERR_ECP_INVALID_KEY;
2736 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002737
Jens Wiklander32b31802023-10-06 16:59:46 +02002738 mbedtls_mpi_init(&YY); mbedtls_mpi_init(&RHS);
Jens Wiklander817466c2018-05-22 13:49:31 +02002739
2740 /*
2741 * YY = Y^2
Jens Wiklander32b31802023-10-06 16:59:46 +02002742 * RHS = X^3 + A X + B
Jens Wiklander817466c2018-05-22 13:49:31 +02002743 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002744 MPI_ECP_SQR(&YY, &pt->Y);
2745 MBEDTLS_MPI_CHK(ecp_sw_rhs(grp, &RHS, &pt->X));
Jens Wiklander817466c2018-05-22 13:49:31 +02002746
Jens Wiklander32b31802023-10-06 16:59:46 +02002747 if (MPI_ECP_CMP(&YY, &RHS) != 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002748 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
Jens Wiklander32b31802023-10-06 16:59:46 +02002749 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002750
2751cleanup:
2752
Jens Wiklander32b31802023-10-06 16:59:46 +02002753 mbedtls_mpi_free(&YY); mbedtls_mpi_free(&RHS);
Jens Wiklander817466c2018-05-22 13:49:31 +02002754
Jens Wiklander32b31802023-10-06 16:59:46 +02002755 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002756}
Jerome Forissier79013242021-07-28 10:24:04 +02002757#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02002758
Tom Van Eyckc1633172024-04-09 18:44:13 +02002759#if defined(MBEDTLS_ECP_C)
Jerome Forissier79013242021-07-28 10:24:04 +02002760#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02002761/*
Jerome Forissier79013242021-07-28 10:24:04 +02002762 * R = m * P with shortcuts for m == 0, m == 1 and m == -1
Jens Wiklander817466c2018-05-22 13:49:31 +02002763 * NOT constant-time - ONLY for short Weierstrass!
2764 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002765static int mbedtls_ecp_mul_shortcuts(mbedtls_ecp_group *grp,
2766 mbedtls_ecp_point *R,
2767 const mbedtls_mpi *m,
2768 const mbedtls_ecp_point *P,
2769 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +02002770{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002771 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02002772 mbedtls_mpi tmp;
2773 mbedtls_mpi_init(&tmp);
Jens Wiklander817466c2018-05-22 13:49:31 +02002774
Jens Wiklander32b31802023-10-06 16:59:46 +02002775 if (mbedtls_mpi_cmp_int(m, 0) == 0) {
2776 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2777 MBEDTLS_MPI_CHK(mbedtls_ecp_set_zero(R));
2778 } else if (mbedtls_mpi_cmp_int(m, 1) == 0) {
2779 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2780 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, P));
2781 } else if (mbedtls_mpi_cmp_int(m, -1) == 0) {
2782 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2783 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, P));
2784 MPI_ECP_NEG(&R->Y);
2785 } else {
2786 MBEDTLS_MPI_CHK(ecp_mul_restartable_internal(grp, R, m, P,
2787 NULL, NULL, rs_ctx));
Jens Wiklander817466c2018-05-22 13:49:31 +02002788 }
2789
2790cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002791 mbedtls_mpi_free(&tmp);
2792
2793 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002794}
2795
2796/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002797 * Restartable linear combination
2798 * NOT constant-time
2799 */
2800int mbedtls_ecp_muladd_restartable(
Jens Wiklander32b31802023-10-06 16:59:46 +02002801 mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2802 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2803 const mbedtls_mpi *n, const mbedtls_ecp_point *Q,
2804 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002805{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002806 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002807 mbedtls_ecp_point mP;
2808 mbedtls_ecp_point *pmP = &mP;
2809 mbedtls_ecp_point *pR = R;
Jens Wiklander32b31802023-10-06 16:59:46 +02002810 mbedtls_mpi tmp[4];
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002811#if defined(MBEDTLS_ECP_INTERNAL_ALT)
2812 char is_grp_capable = 0;
2813#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002814 if (mbedtls_ecp_get_type(grp) != MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
2815 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
2816 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002817
Jens Wiklander32b31802023-10-06 16:59:46 +02002818 mbedtls_ecp_point_init(&mP);
2819 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002820
Jens Wiklander32b31802023-10-06 16:59:46 +02002821 ECP_RS_ENTER(ma);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002822
2823#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002824 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002825 /* redirect intermediate results to restart context */
2826 pmP = &rs_ctx->ma->mP;
2827 pR = &rs_ctx->ma->R;
2828
2829 /* jump to next operation */
Jens Wiklander32b31802023-10-06 16:59:46 +02002830 if (rs_ctx->ma->state == ecp_rsma_mul2) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002831 goto mul2;
Jens Wiklander32b31802023-10-06 16:59:46 +02002832 }
2833 if (rs_ctx->ma->state == ecp_rsma_add) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002834 goto add;
Jens Wiklander32b31802023-10-06 16:59:46 +02002835 }
2836 if (rs_ctx->ma->state == ecp_rsma_norm) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002837 goto norm;
Jens Wiklander32b31802023-10-06 16:59:46 +02002838 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002839 }
2840#endif /* MBEDTLS_ECP_RESTARTABLE */
2841
Jens Wiklander32b31802023-10-06 16:59:46 +02002842 MBEDTLS_MPI_CHK(mbedtls_ecp_mul_shortcuts(grp, pmP, m, P, rs_ctx));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002843#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002844 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002845 rs_ctx->ma->state = ecp_rsma_mul2;
Jens Wiklander32b31802023-10-06 16:59:46 +02002846 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002847
2848mul2:
2849#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002850 MBEDTLS_MPI_CHK(mbedtls_ecp_mul_shortcuts(grp, pR, n, Q, rs_ctx));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002851
2852#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002853 if ((is_grp_capable = mbedtls_internal_ecp_grp_capable(grp))) {
2854 MBEDTLS_MPI_CHK(mbedtls_internal_ecp_init(grp));
2855 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002856#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2857
2858#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002859 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002860 rs_ctx->ma->state = ecp_rsma_add;
Jens Wiklander32b31802023-10-06 16:59:46 +02002861 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002862
2863add:
2864#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002865 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_ADD);
2866 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, pR, pmP, pR, tmp));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002867#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002868 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002869 rs_ctx->ma->state = ecp_rsma_norm;
Jens Wiklander32b31802023-10-06 16:59:46 +02002870 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002871
2872norm:
2873#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002874 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV);
2875 MBEDTLS_MPI_CHK(ecp_normalize_jac(grp, pR));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002876
2877#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002878 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
2879 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, pR));
2880 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002881#endif
2882
2883cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002884
2885 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
2886
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002887#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002888 if (is_grp_capable) {
2889 mbedtls_internal_ecp_free(grp);
2890 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002891#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2892
Jens Wiklander32b31802023-10-06 16:59:46 +02002893 mbedtls_ecp_point_free(&mP);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002894
Jens Wiklander32b31802023-10-06 16:59:46 +02002895 ECP_RS_LEAVE(ma);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002896
Jens Wiklander32b31802023-10-06 16:59:46 +02002897 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002898}
2899
2900/*
Jens Wiklander817466c2018-05-22 13:49:31 +02002901 * Linear combination
2902 * NOT constant-time
2903 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002904int mbedtls_ecp_muladd(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2905 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2906 const mbedtls_mpi *n, const mbedtls_ecp_point *Q)
Jens Wiklander817466c2018-05-22 13:49:31 +02002907{
Jens Wiklander32b31802023-10-06 16:59:46 +02002908 return mbedtls_ecp_muladd_restartable(grp, R, m, P, n, Q, NULL);
Jens Wiklander817466c2018-05-22 13:49:31 +02002909}
Jerome Forissier79013242021-07-28 10:24:04 +02002910#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Tom Van Eyckc1633172024-04-09 18:44:13 +02002911#endif /* MBEDTLS_ECP_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02002912
Jerome Forissier79013242021-07-28 10:24:04 +02002913#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
2914#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Tom Van Eyckc1633172024-04-09 18:44:13 +02002915#define ECP_MPI_INIT(_p, _n) { .p = (mbedtls_mpi_uint *) (_p), .s = 1, .n = (_n) }
Jerome Forissier79013242021-07-28 10:24:04 +02002916#define ECP_MPI_INIT_ARRAY(x) \
Tom Van Eyckc1633172024-04-09 18:44:13 +02002917 ECP_MPI_INIT(x, sizeof(x) / sizeof(mbedtls_mpi_uint))
Jerome Forissier79013242021-07-28 10:24:04 +02002918/*
2919 * Constants for the two points other than 0, 1, -1 (mod p) in
2920 * https://cr.yp.to/ecdh.html#validate
2921 * See ecp_check_pubkey_x25519().
2922 */
2923static const mbedtls_mpi_uint x25519_bad_point_1[] = {
Jens Wiklander32b31802023-10-06 16:59:46 +02002924 MBEDTLS_BYTES_TO_T_UINT_8(0xe0, 0xeb, 0x7a, 0x7c, 0x3b, 0x41, 0xb8, 0xae),
2925 MBEDTLS_BYTES_TO_T_UINT_8(0x16, 0x56, 0xe3, 0xfa, 0xf1, 0x9f, 0xc4, 0x6a),
2926 MBEDTLS_BYTES_TO_T_UINT_8(0xda, 0x09, 0x8d, 0xeb, 0x9c, 0x32, 0xb1, 0xfd),
2927 MBEDTLS_BYTES_TO_T_UINT_8(0x86, 0x62, 0x05, 0x16, 0x5f, 0x49, 0xb8, 0x00),
Jerome Forissier79013242021-07-28 10:24:04 +02002928};
2929static const mbedtls_mpi_uint x25519_bad_point_2[] = {
Jens Wiklander32b31802023-10-06 16:59:46 +02002930 MBEDTLS_BYTES_TO_T_UINT_8(0x5f, 0x9c, 0x95, 0xbc, 0xa3, 0x50, 0x8c, 0x24),
2931 MBEDTLS_BYTES_TO_T_UINT_8(0xb1, 0xd0, 0xb1, 0x55, 0x9c, 0x83, 0xef, 0x5b),
2932 MBEDTLS_BYTES_TO_T_UINT_8(0x04, 0x44, 0x5c, 0xc4, 0x58, 0x1c, 0x8e, 0x86),
2933 MBEDTLS_BYTES_TO_T_UINT_8(0xd8, 0x22, 0x4e, 0xdd, 0xd0, 0x9f, 0x11, 0x57),
Jerome Forissier79013242021-07-28 10:24:04 +02002934};
2935static const mbedtls_mpi ecp_x25519_bad_point_1 = ECP_MPI_INIT_ARRAY(
Jens Wiklander32b31802023-10-06 16:59:46 +02002936 x25519_bad_point_1);
Jerome Forissier79013242021-07-28 10:24:04 +02002937static const mbedtls_mpi ecp_x25519_bad_point_2 = ECP_MPI_INIT_ARRAY(
Jens Wiklander32b31802023-10-06 16:59:46 +02002938 x25519_bad_point_2);
Jerome Forissier79013242021-07-28 10:24:04 +02002939#endif /* MBEDTLS_ECP_DP_CURVE25519_ENABLED */
2940
2941/*
2942 * Check that the input point is not one of the low-order points.
2943 * This is recommended by the "May the Fourth" paper:
2944 * https://eprint.iacr.org/2017/806.pdf
2945 * Those points are never sent by an honest peer.
2946 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002947static int ecp_check_bad_points_mx(const mbedtls_mpi *X, const mbedtls_mpi *P,
2948 const mbedtls_ecp_group_id grp_id)
Jerome Forissier79013242021-07-28 10:24:04 +02002949{
2950 int ret;
2951 mbedtls_mpi XmP;
2952
Jens Wiklander32b31802023-10-06 16:59:46 +02002953 mbedtls_mpi_init(&XmP);
Jerome Forissier79013242021-07-28 10:24:04 +02002954
2955 /* Reduce X mod P so that we only need to check values less than P.
2956 * We know X < 2^256 so we can proceed by subtraction. */
Jens Wiklander32b31802023-10-06 16:59:46 +02002957 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&XmP, X));
2958 while (mbedtls_mpi_cmp_mpi(&XmP, P) >= 0) {
2959 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&XmP, &XmP, P));
2960 }
Jerome Forissier79013242021-07-28 10:24:04 +02002961
2962 /* Check against the known bad values that are less than P. For Curve448
2963 * these are 0, 1 and -1. For Curve25519 we check the values less than P
2964 * from the following list: https://cr.yp.to/ecdh.html#validate */
Jens Wiklander32b31802023-10-06 16:59:46 +02002965 if (mbedtls_mpi_cmp_int(&XmP, 1) <= 0) { /* takes care of 0 and 1 */
Jerome Forissier79013242021-07-28 10:24:04 +02002966 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2967 goto cleanup;
2968 }
2969
2970#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02002971 if (grp_id == MBEDTLS_ECP_DP_CURVE25519) {
2972 if (mbedtls_mpi_cmp_mpi(&XmP, &ecp_x25519_bad_point_1) == 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02002973 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2974 goto cleanup;
2975 }
2976
Jens Wiklander32b31802023-10-06 16:59:46 +02002977 if (mbedtls_mpi_cmp_mpi(&XmP, &ecp_x25519_bad_point_2) == 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02002978 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2979 goto cleanup;
2980 }
2981 }
2982#else
2983 (void) grp_id;
2984#endif
2985
2986 /* Final check: check if XmP + 1 is P (final because it changes XmP!) */
Jens Wiklander32b31802023-10-06 16:59:46 +02002987 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&XmP, &XmP, 1));
2988 if (mbedtls_mpi_cmp_mpi(&XmP, P) == 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02002989 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2990 goto cleanup;
2991 }
2992
2993 ret = 0;
2994
2995cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002996 mbedtls_mpi_free(&XmP);
Jerome Forissier79013242021-07-28 10:24:04 +02002997
Jens Wiklander32b31802023-10-06 16:59:46 +02002998 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02002999}
3000
Jens Wiklander817466c2018-05-22 13:49:31 +02003001/*
3002 * Check validity of a public key for Montgomery curves with x-only schemes
3003 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003004static int ecp_check_pubkey_mx(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +02003005{
3006 /* [Curve25519 p. 5] Just check X is the correct number of bytes */
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003007 /* Allow any public value, if it's too big then we'll just reduce it mod p
3008 * (RFC 7748 sec. 5 para. 3). */
Jens Wiklander32b31802023-10-06 16:59:46 +02003009 if (mbedtls_mpi_size(&pt->X) > (grp->nbits + 7) / 8) {
3010 return MBEDTLS_ERR_ECP_INVALID_KEY;
3011 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003012
Jerome Forissier79013242021-07-28 10:24:04 +02003013 /* Implicit in all standards (as they don't consider negative numbers):
3014 * X must be non-negative. This is normally ensured by the way it's
3015 * encoded for transmission, but let's be extra sure. */
Jens Wiklander32b31802023-10-06 16:59:46 +02003016 if (mbedtls_mpi_cmp_int(&pt->X, 0) < 0) {
3017 return MBEDTLS_ERR_ECP_INVALID_KEY;
3018 }
Jerome Forissier79013242021-07-28 10:24:04 +02003019
Jens Wiklander32b31802023-10-06 16:59:46 +02003020 return ecp_check_bad_points_mx(&pt->X, &grp->P, grp->id);
Jens Wiklander817466c2018-05-22 13:49:31 +02003021}
Jerome Forissier79013242021-07-28 10:24:04 +02003022#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003023
3024/*
3025 * Check that a point is valid as a public key
3026 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003027int mbedtls_ecp_check_pubkey(const mbedtls_ecp_group *grp,
3028 const mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +02003029{
3030 /* Must use affine coordinates */
Jens Wiklander32b31802023-10-06 16:59:46 +02003031 if (mbedtls_mpi_cmp_int(&pt->Z, 1) != 0) {
3032 return MBEDTLS_ERR_ECP_INVALID_KEY;
3033 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003034
Jerome Forissier79013242021-07-28 10:24:04 +02003035#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003036 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3037 return ecp_check_pubkey_mx(grp, pt);
3038 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003039#endif
Jerome Forissier79013242021-07-28 10:24:04 +02003040#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003041 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3042 return ecp_check_pubkey_sw(grp, pt);
3043 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003044#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02003045 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +02003046}
3047
3048/*
3049 * Check that an mbedtls_mpi is valid as a private key
3050 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003051int mbedtls_ecp_check_privkey(const mbedtls_ecp_group *grp,
3052 const mbedtls_mpi *d)
Jens Wiklander817466c2018-05-22 13:49:31 +02003053{
Jerome Forissier79013242021-07-28 10:24:04 +02003054#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003055 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003056 /* see RFC 7748 sec. 5 para. 5 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003057 if (mbedtls_mpi_get_bit(d, 0) != 0 ||
3058 mbedtls_mpi_get_bit(d, 1) != 0 ||
3059 mbedtls_mpi_bitlen(d) - 1 != grp->nbits) { /* mbedtls_mpi_bitlen is one-based! */
3060 return MBEDTLS_ERR_ECP_INVALID_KEY;
3061 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003062
3063 /* see [Curve25519] page 5 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003064 if (grp->nbits == 254 && mbedtls_mpi_get_bit(d, 2) != 0) {
3065 return MBEDTLS_ERR_ECP_INVALID_KEY;
3066 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003067
Jens Wiklander32b31802023-10-06 16:59:46 +02003068 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02003069 }
Jerome Forissier79013242021-07-28 10:24:04 +02003070#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
3071#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003072 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
Jens Wiklander817466c2018-05-22 13:49:31 +02003073 /* see SEC1 3.2 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003074 if (mbedtls_mpi_cmp_int(d, 1) < 0 ||
3075 mbedtls_mpi_cmp_mpi(d, &grp->N) >= 0) {
3076 return MBEDTLS_ERR_ECP_INVALID_KEY;
3077 } else {
3078 return 0;
3079 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003080 }
Jerome Forissier79013242021-07-28 10:24:04 +02003081#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003082
Jens Wiklander32b31802023-10-06 16:59:46 +02003083 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +02003084}
3085
Jerome Forissier79013242021-07-28 10:24:04 +02003086#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3087MBEDTLS_STATIC_TESTABLE
Jens Wiklander32b31802023-10-06 16:59:46 +02003088int mbedtls_ecp_gen_privkey_mx(size_t high_bit,
3089 mbedtls_mpi *d,
3090 int (*f_rng)(void *, unsigned char *, size_t),
3091 void *p_rng)
Jerome Forissier79013242021-07-28 10:24:04 +02003092{
3093 int ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3094 size_t n_random_bytes = high_bit / 8 + 1;
3095
3096 /* [Curve25519] page 5 */
3097 /* Generate a (high_bit+1)-bit random number by generating just enough
3098 * random bytes, then shifting out extra bits from the top (necessary
3099 * when (high_bit+1) is not a multiple of 8). */
Jens Wiklander32b31802023-10-06 16:59:46 +02003100 MBEDTLS_MPI_CHK(mbedtls_mpi_fill_random(d, n_random_bytes,
3101 f_rng, p_rng));
3102 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_r(d, 8 * n_random_bytes - high_bit - 1));
Jerome Forissier79013242021-07-28 10:24:04 +02003103
Jens Wiklander32b31802023-10-06 16:59:46 +02003104 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, high_bit, 1));
Jerome Forissier79013242021-07-28 10:24:04 +02003105
3106 /* Make sure the last two bits are unset for Curve448, three bits for
3107 Curve25519 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003108 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 0, 0));
3109 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 1, 0));
3110 if (high_bit == 254) {
3111 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 2, 0));
Jerome Forissier79013242021-07-28 10:24:04 +02003112 }
3113
3114cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003115 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003116}
3117#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
3118
3119#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3120static int mbedtls_ecp_gen_privkey_sw(
3121 const mbedtls_mpi *N, mbedtls_mpi *d,
Jens Wiklander32b31802023-10-06 16:59:46 +02003122 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jerome Forissier79013242021-07-28 10:24:04 +02003123{
Jens Wiklander32b31802023-10-06 16:59:46 +02003124 int ret = mbedtls_mpi_random(d, 1, N, f_rng, p_rng);
3125 switch (ret) {
Jerome Forissier79013242021-07-28 10:24:04 +02003126 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Jens Wiklander32b31802023-10-06 16:59:46 +02003127 return MBEDTLS_ERR_ECP_RANDOM_FAILED;
Jerome Forissier79013242021-07-28 10:24:04 +02003128 default:
Jens Wiklander32b31802023-10-06 16:59:46 +02003129 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003130 }
3131}
3132#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3133
Jens Wiklander817466c2018-05-22 13:49:31 +02003134/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003135 * Generate a private key
Jens Wiklander817466c2018-05-22 13:49:31 +02003136 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003137int mbedtls_ecp_gen_privkey(const mbedtls_ecp_group *grp,
3138 mbedtls_mpi *d,
3139 int (*f_rng)(void *, unsigned char *, size_t),
3140 void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02003141{
Jerome Forissier79013242021-07-28 10:24:04 +02003142#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003143 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3144 return mbedtls_ecp_gen_privkey_mx(grp->nbits, d, f_rng, p_rng);
3145 }
Jerome Forissier79013242021-07-28 10:24:04 +02003146#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003147
Jerome Forissier79013242021-07-28 10:24:04 +02003148#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003149 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3150 return mbedtls_ecp_gen_privkey_sw(&grp->N, d, f_rng, p_rng);
3151 }
Jerome Forissier79013242021-07-28 10:24:04 +02003152#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003153
Jens Wiklander32b31802023-10-06 16:59:46 +02003154 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003155}
Jens Wiklander817466c2018-05-22 13:49:31 +02003156
Tom Van Eyckc1633172024-04-09 18:44:13 +02003157#if defined(MBEDTLS_ECP_C)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003158/*
3159 * Generate a keypair with configurable base point
3160 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003161int mbedtls_ecp_gen_keypair_base(mbedtls_ecp_group *grp,
3162 const mbedtls_ecp_point *G,
3163 mbedtls_mpi *d, mbedtls_ecp_point *Q,
3164 int (*f_rng)(void *, unsigned char *, size_t),
3165 void *p_rng)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003166{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02003168 MBEDTLS_MPI_CHK(mbedtls_ecp_gen_privkey(grp, d, f_rng, p_rng));
3169 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, Q, d, G, f_rng, p_rng));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003170
3171cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003172 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02003173}
3174
3175/*
3176 * Generate key pair, wrapper for conventional base point
3177 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003178int mbedtls_ecp_gen_keypair(mbedtls_ecp_group *grp,
3179 mbedtls_mpi *d, mbedtls_ecp_point *Q,
3180 int (*f_rng)(void *, unsigned char *, size_t),
3181 void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02003182{
Jens Wiklander32b31802023-10-06 16:59:46 +02003183 return mbedtls_ecp_gen_keypair_base(grp, &grp->G, d, Q, f_rng, p_rng);
Jens Wiklander817466c2018-05-22 13:49:31 +02003184}
3185
3186/*
3187 * Generate a keypair, prettier wrapper
3188 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003189int mbedtls_ecp_gen_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
3190 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02003191{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003192 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02003193 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3194 return ret;
3195 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003196
Jens Wiklander32b31802023-10-06 16:59:46 +02003197 return mbedtls_ecp_gen_keypair(&key->grp, &key->d, &key->Q, f_rng, p_rng);
Jens Wiklander817466c2018-05-22 13:49:31 +02003198}
Tom Van Eyckc1633172024-04-09 18:44:13 +02003199#endif /* MBEDTLS_ECP_C */
3200
3201int mbedtls_ecp_set_public_key(mbedtls_ecp_group_id grp_id,
3202 mbedtls_ecp_keypair *key,
3203 const mbedtls_ecp_point *Q)
3204{
3205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3206
3207 if (key->grp.id == MBEDTLS_ECP_DP_NONE) {
3208 /* Group not set yet */
3209 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3210 return ret;
3211 }
3212 } else if (key->grp.id != grp_id) {
3213 /* Group mismatch */
3214 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3215 }
3216 return mbedtls_ecp_copy(&key->Q, Q);
3217}
3218
Jens Wiklander817466c2018-05-22 13:49:31 +02003219
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003220#define ECP_CURVE25519_KEY_SIZE 32
Jens Wiklander32b31802023-10-06 16:59:46 +02003221#define ECP_CURVE448_KEY_SIZE 56
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003222/*
3223 * Read a private key.
3224 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003225int mbedtls_ecp_read_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
3226 const unsigned char *buf, size_t buflen)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003227{
3228 int ret = 0;
3229
Jens Wiklander32b31802023-10-06 16:59:46 +02003230 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3231 return ret;
3232 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003233
3234 ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
3235
Jerome Forissier79013242021-07-28 10:24:04 +02003236#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003237 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003238 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02003239 * Mask the key as mandated by RFC7748 for Curve25519 and Curve448.
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003240 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003241 if (grp_id == MBEDTLS_ECP_DP_CURVE25519) {
3242 if (buflen != ECP_CURVE25519_KEY_SIZE) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003243 return MBEDTLS_ERR_ECP_INVALID_KEY;
Jens Wiklander32b31802023-10-06 16:59:46 +02003244 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003245
Jens Wiklander32b31802023-10-06 16:59:46 +02003246 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&key->d, buf, buflen));
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003247
3248 /* Set the three least significant bits to 0 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003249 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 0, 0));
3250 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 1, 0));
3251 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 2, 0));
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003252
3253 /* Set the most significant bit to 0 */
3254 MBEDTLS_MPI_CHK(
Jens Wiklander32b31802023-10-06 16:59:46 +02003255 mbedtls_mpi_set_bit(&key->d,
3256 ECP_CURVE25519_KEY_SIZE * 8 - 1, 0)
3257 );
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003258
3259 /* Set the second most significant bit to 1 */
3260 MBEDTLS_MPI_CHK(
Jens Wiklander32b31802023-10-06 16:59:46 +02003261 mbedtls_mpi_set_bit(&key->d,
3262 ECP_CURVE25519_KEY_SIZE * 8 - 2, 1)
3263 );
3264 } else if (grp_id == MBEDTLS_ECP_DP_CURVE448) {
3265 if (buflen != ECP_CURVE448_KEY_SIZE) {
3266 return MBEDTLS_ERR_ECP_INVALID_KEY;
3267 }
3268
3269 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&key->d, buf, buflen));
3270
3271 /* Set the two least significant bits to 0 */
3272 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 0, 0));
3273 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 1, 0));
3274
3275 /* Set the most significant bit to 1 */
3276 MBEDTLS_MPI_CHK(
3277 mbedtls_mpi_set_bit(&key->d,
3278 ECP_CURVE448_KEY_SIZE * 8 - 1, 1)
3279 );
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003280 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003281 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003282#endif
Jerome Forissier79013242021-07-28 10:24:04 +02003283#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003284 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3285 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&key->d, buf, buflen));
Tom Van Eyckc1633172024-04-09 18:44:13 +02003286 }
3287#endif
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003288
Tom Van Eyckc1633172024-04-09 18:44:13 +02003289 if (ret == 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +02003290 MBEDTLS_MPI_CHK(mbedtls_ecp_check_privkey(&key->grp, &key->d));
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003291 }
3292
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003293cleanup:
3294
Jens Wiklander32b31802023-10-06 16:59:46 +02003295 if (ret != 0) {
3296 mbedtls_mpi_free(&key->d);
3297 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003298
Jens Wiklander32b31802023-10-06 16:59:46 +02003299 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003300}
3301
Jens Wiklander817466c2018-05-22 13:49:31 +02003302/*
Jerome Forissier79013242021-07-28 10:24:04 +02003303 * Write a private key.
3304 */
Tom Van Eyckc1633172024-04-09 18:44:13 +02003305#if !defined MBEDTLS_DEPRECATED_REMOVED
Jens Wiklander32b31802023-10-06 16:59:46 +02003306int mbedtls_ecp_write_key(mbedtls_ecp_keypair *key,
3307 unsigned char *buf, size_t buflen)
Jerome Forissier79013242021-07-28 10:24:04 +02003308{
Tom Van Eyckc1633172024-04-09 18:44:13 +02003309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerome Forissier79013242021-07-28 10:24:04 +02003310
Jerome Forissier79013242021-07-28 10:24:04 +02003311#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003312 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3313 if (key->grp.id == MBEDTLS_ECP_DP_CURVE25519) {
3314 if (buflen < ECP_CURVE25519_KEY_SIZE) {
Jerome Forissier79013242021-07-28 10:24:04 +02003315 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
Jens Wiklander32b31802023-10-06 16:59:46 +02003316 }
Jerome Forissier79013242021-07-28 10:24:04 +02003317
Jens Wiklander32b31802023-10-06 16:59:46 +02003318 } else if (key->grp.id == MBEDTLS_ECP_DP_CURVE448) {
3319 if (buflen < ECP_CURVE448_KEY_SIZE) {
3320 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3321 }
Jerome Forissier79013242021-07-28 10:24:04 +02003322 }
Jens Wiklander32b31802023-10-06 16:59:46 +02003323 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary_le(&key->d, buf, buflen));
Jerome Forissier79013242021-07-28 10:24:04 +02003324 }
Jerome Forissier79013242021-07-28 10:24:04 +02003325#endif
3326#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003327 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3328 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&key->d, buf, buflen));
Jerome Forissier79013242021-07-28 10:24:04 +02003329 }
3330
3331#endif
3332cleanup:
3333
Jens Wiklander32b31802023-10-06 16:59:46 +02003334 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003335}
Tom Van Eyckc1633172024-04-09 18:44:13 +02003336#endif /* MBEDTLS_DEPRECATED_REMOVED */
3337
3338int mbedtls_ecp_write_key_ext(const mbedtls_ecp_keypair *key,
3339 size_t *olen, unsigned char *buf, size_t buflen)
3340{
3341 size_t len = (key->grp.nbits + 7) / 8;
3342 if (len > buflen) {
3343 /* For robustness, ensure *olen <= buflen even on error. */
3344 *olen = 0;
3345 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3346 }
3347 *olen = len;
3348
3349 /* Private key not set */
3350 if (key->d.n == 0) {
3351 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3352 }
3353
3354#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3355 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3356 return mbedtls_mpi_write_binary_le(&key->d, buf, len);
3357 }
3358#endif
3359
3360#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3361 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3362 return mbedtls_mpi_write_binary(&key->d, buf, len);
3363 }
3364#endif
3365
3366 /* Private key set but no recognized curve type? This shouldn't happen. */
3367 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3368}
3369
3370/*
3371 * Write a public key.
3372 */
3373int mbedtls_ecp_write_public_key(const mbedtls_ecp_keypair *key,
3374 int format, size_t *olen,
3375 unsigned char *buf, size_t buflen)
3376{
3377 return mbedtls_ecp_point_write_binary(&key->grp, &key->Q,
3378 format, olen, buf, buflen);
3379}
Jerome Forissier79013242021-07-28 10:24:04 +02003380
3381
Tom Van Eyckc1633172024-04-09 18:44:13 +02003382#if defined(MBEDTLS_ECP_C)
Jerome Forissier79013242021-07-28 10:24:04 +02003383/*
Jens Wiklander817466c2018-05-22 13:49:31 +02003384 * Check a public-private key pair
3385 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003386int mbedtls_ecp_check_pub_priv(
3387 const mbedtls_ecp_keypair *pub, const mbedtls_ecp_keypair *prv,
3388 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02003389{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003390 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02003391 mbedtls_ecp_point Q;
3392 mbedtls_ecp_group grp;
Jens Wiklander32b31802023-10-06 16:59:46 +02003393 if (pub->grp.id == MBEDTLS_ECP_DP_NONE ||
Jens Wiklander817466c2018-05-22 13:49:31 +02003394 pub->grp.id != prv->grp.id ||
Jens Wiklander32b31802023-10-06 16:59:46 +02003395 mbedtls_mpi_cmp_mpi(&pub->Q.X, &prv->Q.X) ||
3396 mbedtls_mpi_cmp_mpi(&pub->Q.Y, &prv->Q.Y) ||
3397 mbedtls_mpi_cmp_mpi(&pub->Q.Z, &prv->Q.Z)) {
3398 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +02003399 }
3400
Jens Wiklander32b31802023-10-06 16:59:46 +02003401 mbedtls_ecp_point_init(&Q);
3402 mbedtls_ecp_group_init(&grp);
Jens Wiklander817466c2018-05-22 13:49:31 +02003403
3404 /* mbedtls_ecp_mul() needs a non-const group... */
Jens Wiklander32b31802023-10-06 16:59:46 +02003405 mbedtls_ecp_group_copy(&grp, &prv->grp);
Jens Wiklander817466c2018-05-22 13:49:31 +02003406
3407 /* Also checks d is valid */
Jens Wiklander32b31802023-10-06 16:59:46 +02003408 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(&grp, &Q, &prv->d, &prv->grp.G, f_rng, p_rng));
Jens Wiklander817466c2018-05-22 13:49:31 +02003409
Jens Wiklander32b31802023-10-06 16:59:46 +02003410 if (mbedtls_mpi_cmp_mpi(&Q.X, &prv->Q.X) ||
3411 mbedtls_mpi_cmp_mpi(&Q.Y, &prv->Q.Y) ||
3412 mbedtls_mpi_cmp_mpi(&Q.Z, &prv->Q.Z)) {
Jens Wiklander817466c2018-05-22 13:49:31 +02003413 ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3414 goto cleanup;
3415 }
3416
3417cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003418 mbedtls_ecp_point_free(&Q);
3419 mbedtls_ecp_group_free(&grp);
Jens Wiklander817466c2018-05-22 13:49:31 +02003420
Jens Wiklander32b31802023-10-06 16:59:46 +02003421 return ret;
3422}
3423
Tom Van Eyckc1633172024-04-09 18:44:13 +02003424int mbedtls_ecp_keypair_calc_public(mbedtls_ecp_keypair *key,
3425 int (*f_rng)(void *, unsigned char *, size_t),
3426 void *p_rng)
3427{
3428 return mbedtls_ecp_mul(&key->grp, &key->Q, &key->d, &key->grp.G,
3429 f_rng, p_rng);
3430}
3431#endif /* MBEDTLS_ECP_C */
3432
3433mbedtls_ecp_group_id mbedtls_ecp_keypair_get_group_id(
3434 const mbedtls_ecp_keypair *key)
3435{
3436 return key->grp.id;
3437}
3438
Jens Wiklander32b31802023-10-06 16:59:46 +02003439/*
3440 * Export generic key-pair parameters.
3441 */
3442int mbedtls_ecp_export(const mbedtls_ecp_keypair *key, mbedtls_ecp_group *grp,
3443 mbedtls_mpi *d, mbedtls_ecp_point *Q)
3444{
3445 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3446
Tom Van Eyckc1633172024-04-09 18:44:13 +02003447 if (grp != NULL && (ret = mbedtls_ecp_group_copy(grp, &key->grp)) != 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +02003448 return ret;
3449 }
3450
Tom Van Eyckc1633172024-04-09 18:44:13 +02003451 if (d != NULL && (ret = mbedtls_mpi_copy(d, &key->d)) != 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +02003452 return ret;
3453 }
3454
Tom Van Eyckc1633172024-04-09 18:44:13 +02003455 if (Q != NULL && (ret = mbedtls_ecp_copy(Q, &key->Q)) != 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +02003456 return ret;
3457 }
3458
3459 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02003460}
3461
3462#if defined(MBEDTLS_SELF_TEST)
3463
Tom Van Eyckc1633172024-04-09 18:44:13 +02003464#if defined(MBEDTLS_ECP_C)
Jens Wiklander32b31802023-10-06 16:59:46 +02003465/*
3466 * PRNG for test - !!!INSECURE NEVER USE IN PRODUCTION!!!
3467 *
3468 * This is the linear congruential generator from numerical recipes,
3469 * except we only use the low byte as the output. See
3470 * https://en.wikipedia.org/wiki/Linear_congruential_generator#Parameters_in_common_use
3471 */
3472static int self_test_rng(void *ctx, unsigned char *out, size_t len)
3473{
3474 static uint32_t state = 42;
3475
3476 (void) ctx;
3477
3478 for (size_t i = 0; i < len; i++) {
3479 state = state * 1664525u + 1013904223u;
3480 out[i] = (unsigned char) state;
3481 }
3482
3483 return 0;
3484}
3485
Jerome Forissier79013242021-07-28 10:24:04 +02003486/* Adjust the exponent to be a valid private point for the specified curve.
3487 * This is sometimes necessary because we use a single set of exponents
3488 * for all curves but the validity of values depends on the curve. */
Jens Wiklander32b31802023-10-06 16:59:46 +02003489static int self_test_adjust_exponent(const mbedtls_ecp_group *grp,
3490 mbedtls_mpi *m)
Jerome Forissier79013242021-07-28 10:24:04 +02003491{
3492 int ret = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02003493 switch (grp->id) {
3494 /* If Curve25519 is available, then that's what we use for the
3495 * Montgomery test, so we don't need the adjustment code. */
3496#if !defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Jerome Forissier79013242021-07-28 10:24:04 +02003497#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
3498 case MBEDTLS_ECP_DP_CURVE448:
3499 /* Move highest bit from 254 to N-1. Setting bit N-1 is
3500 * necessary to enforce the highest-bit-set constraint. */
Jens Wiklander32b31802023-10-06 16:59:46 +02003501 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(m, 254, 0));
3502 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(m, grp->nbits, 1));
Jerome Forissier79013242021-07-28 10:24:04 +02003503 /* Copy second-highest bit from 253 to N-2. This is not
3504 * necessary but improves the test variety a bit. */
3505 MBEDTLS_MPI_CHK(
Jens Wiklander32b31802023-10-06 16:59:46 +02003506 mbedtls_mpi_set_bit(m, grp->nbits - 1,
3507 mbedtls_mpi_get_bit(m, 253)));
Jerome Forissier79013242021-07-28 10:24:04 +02003508 break;
3509#endif
3510#endif /* ! defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) */
3511 default:
3512 /* Non-Montgomery curves and Curve25519 need no adjustment. */
3513 (void) grp;
3514 (void) m;
3515 goto cleanup;
3516 }
3517cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003518 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003519}
3520
3521/* Calculate R = m.P for each m in exponents. Check that the number of
3522 * basic operations doesn't depend on the value of m. */
Jens Wiklander32b31802023-10-06 16:59:46 +02003523static int self_test_point(int verbose,
3524 mbedtls_ecp_group *grp,
3525 mbedtls_ecp_point *R,
3526 mbedtls_mpi *m,
3527 const mbedtls_ecp_point *P,
3528 const char *const *exponents,
3529 size_t n_exponents)
Jerome Forissier79013242021-07-28 10:24:04 +02003530{
3531 int ret = 0;
3532 size_t i = 0;
3533 unsigned long add_c_prev, dbl_c_prev, mul_c_prev;
3534 add_count = 0;
3535 dbl_count = 0;
3536 mul_count = 0;
3537
Jens Wiklander32b31802023-10-06 16:59:46 +02003538 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(m, 16, exponents[0]));
3539 MBEDTLS_MPI_CHK(self_test_adjust_exponent(grp, m));
3540 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, R, m, P, self_test_rng, NULL));
Jerome Forissier79013242021-07-28 10:24:04 +02003541
Jens Wiklander32b31802023-10-06 16:59:46 +02003542 for (i = 1; i < n_exponents; i++) {
Jerome Forissier79013242021-07-28 10:24:04 +02003543 add_c_prev = add_count;
3544 dbl_c_prev = dbl_count;
3545 mul_c_prev = mul_count;
3546 add_count = 0;
3547 dbl_count = 0;
3548 mul_count = 0;
3549
Jens Wiklander32b31802023-10-06 16:59:46 +02003550 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(m, 16, exponents[i]));
3551 MBEDTLS_MPI_CHK(self_test_adjust_exponent(grp, m));
3552 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, R, m, P, self_test_rng, NULL));
Jerome Forissier79013242021-07-28 10:24:04 +02003553
Jens Wiklander32b31802023-10-06 16:59:46 +02003554 if (add_count != add_c_prev ||
Jerome Forissier79013242021-07-28 10:24:04 +02003555 dbl_count != dbl_c_prev ||
Jens Wiklander32b31802023-10-06 16:59:46 +02003556 mul_count != mul_c_prev) {
Jerome Forissier79013242021-07-28 10:24:04 +02003557 ret = 1;
3558 break;
3559 }
3560 }
3561
3562cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003563 if (verbose != 0) {
3564 if (ret != 0) {
3565 mbedtls_printf("failed (%u)\n", (unsigned int) i);
3566 } else {
3567 mbedtls_printf("passed\n");
3568 }
Jerome Forissier79013242021-07-28 10:24:04 +02003569 }
Jens Wiklander32b31802023-10-06 16:59:46 +02003570 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003571}
Tom Van Eyckc1633172024-04-09 18:44:13 +02003572#endif /* MBEDTLS_ECP_C */
Jerome Forissier79013242021-07-28 10:24:04 +02003573
Jens Wiklander817466c2018-05-22 13:49:31 +02003574/*
3575 * Checkup routine
3576 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003577int mbedtls_ecp_self_test(int verbose)
Jens Wiklander817466c2018-05-22 13:49:31 +02003578{
Tom Van Eyckc1633172024-04-09 18:44:13 +02003579#if defined(MBEDTLS_ECP_C)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003580 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02003581 mbedtls_ecp_group grp;
3582 mbedtls_ecp_point R, P;
3583 mbedtls_mpi m;
Jerome Forissier79013242021-07-28 10:24:04 +02003584
3585#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3586 /* Exponents especially adapted for secp192k1, which has the lowest
3587 * order n of all supported curves (secp192r1 is in a slightly larger
3588 * field but the order of its base point is slightly smaller). */
3589 const char *sw_exponents[] =
Jens Wiklander817466c2018-05-22 13:49:31 +02003590 {
3591 "000000000000000000000000000000000000000000000001", /* one */
Jerome Forissier79013242021-07-28 10:24:04 +02003592 "FFFFFFFFFFFFFFFFFFFFFFFE26F2FC170F69466A74DEFD8C", /* n - 1 */
Jens Wiklander817466c2018-05-22 13:49:31 +02003593 "5EA6F389A38B8BC81E767753B15AA5569E1782E30ABE7D25", /* random */
3594 "400000000000000000000000000000000000000000000000", /* one and zeros */
3595 "7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", /* all ones */
3596 "555555555555555555555555555555555555555555555555", /* 101010... */
3597 };
Jerome Forissier79013242021-07-28 10:24:04 +02003598#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3599#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3600 const char *m_exponents[] =
3601 {
3602 /* Valid private values for Curve25519. In a build with Curve448
3603 * but not Curve25519, they will be adjusted in
3604 * self_test_adjust_exponent(). */
3605 "4000000000000000000000000000000000000000000000000000000000000000",
3606 "5C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C30",
3607 "5715ECCE24583F7A7023C24164390586842E816D7280A49EF6DF4EAE6B280BF8",
3608 "41A2B017516F6D254E1F002BCCBADD54BE30F8CEC737A0E912B4963B6BA74460",
3609 "5555555555555555555555555555555555555555555555555555555555555550",
3610 "7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF8",
3611 };
3612#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003613
Jens Wiklander32b31802023-10-06 16:59:46 +02003614 mbedtls_ecp_group_init(&grp);
3615 mbedtls_ecp_point_init(&R);
3616 mbedtls_ecp_point_init(&P);
3617 mbedtls_mpi_init(&m);
Jens Wiklander817466c2018-05-22 13:49:31 +02003618
Jerome Forissier79013242021-07-28 10:24:04 +02003619#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02003620 /* Use secp192r1 if available, or any available curve */
3621#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003622 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_SECP192R1));
Jens Wiklander817466c2018-05-22 13:49:31 +02003623#else
Jens Wiklander32b31802023-10-06 16:59:46 +02003624 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, mbedtls_ecp_curve_list()->grp_id));
Jens Wiklander817466c2018-05-22 13:49:31 +02003625#endif
3626
Jens Wiklander32b31802023-10-06 16:59:46 +02003627 if (verbose != 0) {
3628 mbedtls_printf(" ECP SW test #1 (constant op_count, base point G): ");
3629 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003630 /* Do a dummy multiplication first to trigger precomputation */
Jens Wiklander32b31802023-10-06 16:59:46 +02003631 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&m, 2));
3632 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(&grp, &P, &m, &grp.G, self_test_rng, NULL));
3633 ret = self_test_point(verbose,
3634 &grp, &R, &m, &grp.G,
3635 sw_exponents,
3636 sizeof(sw_exponents) / sizeof(sw_exponents[0]));
3637 if (ret != 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02003638 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +02003639 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003640
Jens Wiklander32b31802023-10-06 16:59:46 +02003641 if (verbose != 0) {
3642 mbedtls_printf(" ECP SW test #2 (constant op_count, other point): ");
3643 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003644 /* We computed P = 2G last time, use it */
Jens Wiklander32b31802023-10-06 16:59:46 +02003645 ret = self_test_point(verbose,
3646 &grp, &R, &m, &P,
3647 sw_exponents,
3648 sizeof(sw_exponents) / sizeof(sw_exponents[0]));
3649 if (ret != 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02003650 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +02003651 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003652
Jens Wiklander32b31802023-10-06 16:59:46 +02003653 mbedtls_ecp_group_free(&grp);
3654 mbedtls_ecp_point_free(&R);
Jerome Forissier79013242021-07-28 10:24:04 +02003655#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003656
Jerome Forissier79013242021-07-28 10:24:04 +02003657#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003658 if (verbose != 0) {
3659 mbedtls_printf(" ECP Montgomery test (constant op_count): ");
3660 }
Jerome Forissier79013242021-07-28 10:24:04 +02003661#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003662 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_CURVE25519));
Jerome Forissier79013242021-07-28 10:24:04 +02003663#elif defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003664 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_CURVE448));
Jerome Forissier79013242021-07-28 10:24:04 +02003665#else
3666#error "MBEDTLS_ECP_MONTGOMERY_ENABLED is defined, but no curve is supported for self-test"
3667#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02003668 ret = self_test_point(verbose,
3669 &grp, &R, &m, &grp.G,
3670 m_exponents,
3671 sizeof(m_exponents) / sizeof(m_exponents[0]));
3672 if (ret != 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02003673 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +02003674 }
Jerome Forissier79013242021-07-28 10:24:04 +02003675#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003676
3677cleanup:
3678
Jens Wiklander32b31802023-10-06 16:59:46 +02003679 if (ret < 0 && verbose != 0) {
3680 mbedtls_printf("Unexpected error, return code = %08X\n", (unsigned int) ret);
3681 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003682
Jens Wiklander32b31802023-10-06 16:59:46 +02003683 mbedtls_ecp_group_free(&grp);
3684 mbedtls_ecp_point_free(&R);
3685 mbedtls_ecp_point_free(&P);
3686 mbedtls_mpi_free(&m);
Jens Wiklander817466c2018-05-22 13:49:31 +02003687
Jens Wiklander32b31802023-10-06 16:59:46 +02003688 if (verbose != 0) {
3689 mbedtls_printf("\n");
3690 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003691
Jens Wiklander32b31802023-10-06 16:59:46 +02003692 return ret;
Tom Van Eyckc1633172024-04-09 18:44:13 +02003693#else /* MBEDTLS_ECP_C */
3694 (void) verbose;
3695 return 0;
3696#endif /* MBEDTLS_ECP_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02003697}
3698
3699#endif /* MBEDTLS_SELF_TEST */
3700
3701#endif /* !MBEDTLS_ECP_ALT */
3702
Tom Van Eyckc1633172024-04-09 18:44:13 +02003703#endif /* MBEDTLS_ECP_LIGHT */