blob: ab50a476bd2345f04b7e688abdfce186ca2aa583 [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
Jerome Forissiere45cdab2021-01-22 16:30:41 +0100385#if defined(MBEDTLS_ECP_DP_SM2_ENABLED)
386 /* https://tools.ietf.org/id/draft-yang-tls-tls13-sm-suites-05.html */
387 { MBEDTLS_ECP_DP_SM2, 41, 256, "sm2" },
388#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200389 { MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
390};
391
Jens Wiklander32b31802023-10-06 16:59:46 +0200392#define ECP_NB_CURVES sizeof(ecp_supported_curves) / \
393 sizeof(ecp_supported_curves[0])
Jens Wiklander817466c2018-05-22 13:49:31 +0200394
395static mbedtls_ecp_group_id ecp_supported_grp_id[ECP_NB_CURVES];
396
397/*
398 * List of supported curves and associated info
399 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200400const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list(void)
Jens Wiklander817466c2018-05-22 13:49:31 +0200401{
Jens Wiklander32b31802023-10-06 16:59:46 +0200402 return ecp_supported_curves;
Jens Wiklander817466c2018-05-22 13:49:31 +0200403}
404
405/*
406 * List of supported curves, group ID only
407 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200408const mbedtls_ecp_group_id *mbedtls_ecp_grp_id_list(void)
Jens Wiklander817466c2018-05-22 13:49:31 +0200409{
410 static int init_done = 0;
411
Jens Wiklander32b31802023-10-06 16:59:46 +0200412 if (!init_done) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200413 size_t i = 0;
414 const mbedtls_ecp_curve_info *curve_info;
415
Jens Wiklander32b31802023-10-06 16:59:46 +0200416 for (curve_info = mbedtls_ecp_curve_list();
Jens Wiklander817466c2018-05-22 13:49:31 +0200417 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Jens Wiklander32b31802023-10-06 16:59:46 +0200418 curve_info++) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200419 ecp_supported_grp_id[i++] = curve_info->grp_id;
420 }
421 ecp_supported_grp_id[i] = MBEDTLS_ECP_DP_NONE;
422
423 init_done = 1;
424 }
425
Jens Wiklander32b31802023-10-06 16:59:46 +0200426 return ecp_supported_grp_id;
Jens Wiklander817466c2018-05-22 13:49:31 +0200427}
428
429/*
430 * Get the curve info for the internal identifier
431 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200432const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_grp_id(mbedtls_ecp_group_id grp_id)
Jens Wiklander817466c2018-05-22 13:49:31 +0200433{
434 const mbedtls_ecp_curve_info *curve_info;
435
Jens Wiklander32b31802023-10-06 16:59:46 +0200436 for (curve_info = mbedtls_ecp_curve_list();
Jens Wiklander817466c2018-05-22 13:49:31 +0200437 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Jens Wiklander32b31802023-10-06 16:59:46 +0200438 curve_info++) {
439 if (curve_info->grp_id == grp_id) {
440 return curve_info;
441 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200442 }
443
Jens Wiklander32b31802023-10-06 16:59:46 +0200444 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200445}
446
447/*
448 * Get the curve info from the TLS identifier
449 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200450const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_tls_id(uint16_t tls_id)
Jens Wiklander817466c2018-05-22 13:49:31 +0200451{
452 const mbedtls_ecp_curve_info *curve_info;
453
Jens Wiklander32b31802023-10-06 16:59:46 +0200454 for (curve_info = mbedtls_ecp_curve_list();
Jens Wiklander817466c2018-05-22 13:49:31 +0200455 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Jens Wiklander32b31802023-10-06 16:59:46 +0200456 curve_info++) {
457 if (curve_info->tls_id == tls_id) {
458 return curve_info;
459 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200460 }
461
Jens Wiklander32b31802023-10-06 16:59:46 +0200462 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200463}
464
465/*
466 * Get the curve info from the name
467 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200468const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_name(const char *name)
Jens Wiklander817466c2018-05-22 13:49:31 +0200469{
470 const mbedtls_ecp_curve_info *curve_info;
471
Jens Wiklander32b31802023-10-06 16:59:46 +0200472 if (name == NULL) {
473 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200474 }
475
Jens Wiklander32b31802023-10-06 16:59:46 +0200476 for (curve_info = mbedtls_ecp_curve_list();
477 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
478 curve_info++) {
479 if (strcmp(curve_info->name, name) == 0) {
480 return curve_info;
481 }
482 }
483
484 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200485}
486
487/*
488 * Get the type of a curve
489 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200490mbedtls_ecp_curve_type mbedtls_ecp_get_type(const mbedtls_ecp_group *grp)
Jens Wiklander817466c2018-05-22 13:49:31 +0200491{
Jens Wiklander32b31802023-10-06 16:59:46 +0200492 if (grp->G.X.p == NULL) {
493 return MBEDTLS_ECP_TYPE_NONE;
494 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200495
Jens Wiklander32b31802023-10-06 16:59:46 +0200496 if (grp->G.Y.p == NULL) {
497 return MBEDTLS_ECP_TYPE_MONTGOMERY;
498 } else {
499 return MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS;
500 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200501}
502
503/*
504 * Initialize (the components of) a point
505 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200506void mbedtls_ecp_point_init(mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +0200507{
Jens Wiklander32b31802023-10-06 16:59:46 +0200508 mbedtls_mpi_init(&pt->X);
509 mbedtls_mpi_init(&pt->Y);
510 mbedtls_mpi_init(&pt->Z);
Jens Wiklander817466c2018-05-22 13:49:31 +0200511}
512
513/*
514 * Initialize (the components of) a group
515 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200516void mbedtls_ecp_group_init(mbedtls_ecp_group *grp)
Jens Wiklander817466c2018-05-22 13:49:31 +0200517{
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100518 grp->id = MBEDTLS_ECP_DP_NONE;
Jens Wiklander32b31802023-10-06 16:59:46 +0200519 mbedtls_mpi_init(&grp->P);
520 mbedtls_mpi_init(&grp->A);
521 mbedtls_mpi_init(&grp->B);
522 mbedtls_ecp_point_init(&grp->G);
523 mbedtls_mpi_init(&grp->N);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100524 grp->pbits = 0;
525 grp->nbits = 0;
526 grp->h = 0;
527 grp->modp = NULL;
528 grp->t_pre = NULL;
529 grp->t_post = NULL;
530 grp->t_data = NULL;
531 grp->T = NULL;
532 grp->T_size = 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200533}
534
535/*
536 * Initialize (the components of) a key pair
537 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200538void mbedtls_ecp_keypair_init(mbedtls_ecp_keypair *key)
Jens Wiklander817466c2018-05-22 13:49:31 +0200539{
Jens Wiklander32b31802023-10-06 16:59:46 +0200540 mbedtls_ecp_group_init(&key->grp);
541 mbedtls_mpi_init(&key->d);
542 mbedtls_ecp_point_init(&key->Q);
Jens Wiklander817466c2018-05-22 13:49:31 +0200543}
544
545/*
546 * Unallocate (the components of) a point
547 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200548void mbedtls_ecp_point_free(mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +0200549{
Jens Wiklander32b31802023-10-06 16:59:46 +0200550 if (pt == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200551 return;
Jens Wiklander32b31802023-10-06 16:59:46 +0200552 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200553
Jens Wiklander32b31802023-10-06 16:59:46 +0200554 mbedtls_mpi_free(&(pt->X));
555 mbedtls_mpi_free(&(pt->Y));
556 mbedtls_mpi_free(&(pt->Z));
557}
558
559/*
560 * Check that the comb table (grp->T) is static initialized.
561 */
562static int ecp_group_is_static_comb_table(const mbedtls_ecp_group *grp)
563{
564#if MBEDTLS_ECP_FIXED_POINT_OPTIM == 1
565 return grp->T != NULL && grp->T_size == 0;
566#else
567 (void) grp;
568 return 0;
569#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200570}
571
572/*
573 * Unallocate (the components of) a group
574 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200575void mbedtls_ecp_group_free(mbedtls_ecp_group *grp)
Jens Wiklander817466c2018-05-22 13:49:31 +0200576{
577 size_t i;
578
Jens Wiklander32b31802023-10-06 16:59:46 +0200579 if (grp == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200580 return;
Jens Wiklander817466c2018-05-22 13:49:31 +0200581 }
582
Jens Wiklander32b31802023-10-06 16:59:46 +0200583 if (grp->h != 1) {
584 mbedtls_mpi_free(&grp->A);
585 mbedtls_mpi_free(&grp->B);
586 mbedtls_ecp_point_free(&grp->G);
Tom Van Eyckc1633172024-04-09 18:44:13 +0200587
588#if !defined(MBEDTLS_ECP_WITH_MPI_UINT)
589 mbedtls_mpi_free(&grp->N);
590 mbedtls_mpi_free(&grp->P);
591#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200592 }
593
Jens Wiklander32b31802023-10-06 16:59:46 +0200594 if (!ecp_group_is_static_comb_table(grp) && grp->T != NULL) {
595 for (i = 0; i < grp->T_size; i++) {
596 mbedtls_ecp_point_free(&grp->T[i]);
597 }
598 mbedtls_free(grp->T);
599 }
600
601 mbedtls_platform_zeroize(grp, sizeof(mbedtls_ecp_group));
Jens Wiklander817466c2018-05-22 13:49:31 +0200602}
603
604/*
605 * Unallocate (the components of) a key pair
606 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200607void mbedtls_ecp_keypair_free(mbedtls_ecp_keypair *key)
Jens Wiklander817466c2018-05-22 13:49:31 +0200608{
Jens Wiklander32b31802023-10-06 16:59:46 +0200609 if (key == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200610 return;
Jens Wiklander32b31802023-10-06 16:59:46 +0200611 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200612
Jens Wiklander32b31802023-10-06 16:59:46 +0200613 mbedtls_ecp_group_free(&key->grp);
614 mbedtls_mpi_free(&key->d);
615 mbedtls_ecp_point_free(&key->Q);
Jens Wiklander817466c2018-05-22 13:49:31 +0200616}
617
618/*
619 * Copy the contents of a point
620 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200621int mbedtls_ecp_copy(mbedtls_ecp_point *P, const mbedtls_ecp_point *Q)
Jens Wiklander817466c2018-05-22 13:49:31 +0200622{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200623 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +0200624 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->X, &Q->X));
625 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->Y, &Q->Y));
626 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->Z, &Q->Z));
Jens Wiklander817466c2018-05-22 13:49:31 +0200627
628cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200629 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200630}
631
632/*
633 * Copy the contents of a group object
634 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200635int mbedtls_ecp_group_copy(mbedtls_ecp_group *dst, const mbedtls_ecp_group *src)
Jens Wiklander817466c2018-05-22 13:49:31 +0200636{
Jens Wiklander32b31802023-10-06 16:59:46 +0200637 return mbedtls_ecp_group_load(dst, src->id);
Jens Wiklander817466c2018-05-22 13:49:31 +0200638}
639
640/*
641 * Set point to zero
642 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200643int mbedtls_ecp_set_zero(mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +0200644{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200645 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +0200646 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->X, 1));
647 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Y, 1));
648 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 0));
Jens Wiklander817466c2018-05-22 13:49:31 +0200649
650cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200651 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200652}
653
654/*
655 * Tell if a point is zero
656 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200657int mbedtls_ecp_is_zero(mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +0200658{
Jens Wiklander32b31802023-10-06 16:59:46 +0200659 return mbedtls_mpi_cmp_int(&pt->Z, 0) == 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200660}
661
662/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100663 * Compare two points lazily
Jens Wiklander817466c2018-05-22 13:49:31 +0200664 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200665int mbedtls_ecp_point_cmp(const mbedtls_ecp_point *P,
666 const mbedtls_ecp_point *Q)
Jens Wiklander817466c2018-05-22 13:49:31 +0200667{
Jens Wiklander32b31802023-10-06 16:59:46 +0200668 if (mbedtls_mpi_cmp_mpi(&P->X, &Q->X) == 0 &&
669 mbedtls_mpi_cmp_mpi(&P->Y, &Q->Y) == 0 &&
670 mbedtls_mpi_cmp_mpi(&P->Z, &Q->Z) == 0) {
671 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200672 }
673
Jens Wiklander32b31802023-10-06 16:59:46 +0200674 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +0200675}
676
677/*
678 * Import a non-zero point from ASCII strings
679 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200680int mbedtls_ecp_point_read_string(mbedtls_ecp_point *P, int radix,
681 const char *x, const char *y)
Jens Wiklander817466c2018-05-22 13:49:31 +0200682{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200683 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +0200684 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(&P->X, radix, x));
685 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(&P->Y, radix, y));
686 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&P->Z, 1));
Jens Wiklander817466c2018-05-22 13:49:31 +0200687
688cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200689 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200690}
691
692/*
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200693 * Export a point into unsigned binary data (SEC1 2.3.3 and RFC7748)
Jens Wiklander817466c2018-05-22 13:49:31 +0200694 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200695int mbedtls_ecp_point_write_binary(const mbedtls_ecp_group *grp,
696 const mbedtls_ecp_point *P,
697 int format, size_t *olen,
698 unsigned char *buf, size_t buflen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200699{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200700 int ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +0200701 size_t plen;
Jens Wiklander32b31802023-10-06 16:59:46 +0200702 if (format != MBEDTLS_ECP_PF_UNCOMPRESSED &&
703 format != MBEDTLS_ECP_PF_COMPRESSED) {
704 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
705 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200706
Jens Wiklander32b31802023-10-06 16:59:46 +0200707 plen = mbedtls_mpi_size(&grp->P);
Jens Wiklander817466c2018-05-22 13:49:31 +0200708
Jerome Forissier79013242021-07-28 10:24:04 +0200709#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
710 (void) format; /* Montgomery curves always use the same point format */
Jens Wiklander32b31802023-10-06 16:59:46 +0200711 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200712 *olen = plen;
Jens Wiklander32b31802023-10-06 16:59:46 +0200713 if (buflen < *olen) {
714 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
715 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200716
Jens Wiklander32b31802023-10-06 16:59:46 +0200717 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary_le(&P->X, buf, plen));
Jens Wiklander817466c2018-05-22 13:49:31 +0200718 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200719#endif
Jerome Forissier79013242021-07-28 10:24:04 +0200720#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200721 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200722 /*
723 * Common case: P == 0
724 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200725 if (mbedtls_mpi_cmp_int(&P->Z, 0) == 0) {
726 if (buflen < 1) {
727 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
728 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200729
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200730 buf[0] = 0x00;
731 *olen = 1;
Jens Wiklander817466c2018-05-22 13:49:31 +0200732
Jens Wiklander32b31802023-10-06 16:59:46 +0200733 return 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200734 }
735
Jens Wiklander32b31802023-10-06 16:59:46 +0200736 if (format == MBEDTLS_ECP_PF_UNCOMPRESSED) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200737 *olen = 2 * plen + 1;
738
Jens Wiklander32b31802023-10-06 16:59:46 +0200739 if (buflen < *olen) {
740 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
741 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200742
743 buf[0] = 0x04;
Jens Wiklander32b31802023-10-06 16:59:46 +0200744 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->X, buf + 1, plen));
745 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->Y, buf + 1 + plen, plen));
746 } else if (format == MBEDTLS_ECP_PF_COMPRESSED) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200747 *olen = plen + 1;
748
Jens Wiklander32b31802023-10-06 16:59:46 +0200749 if (buflen < *olen) {
750 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
751 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200752
Jens Wiklander32b31802023-10-06 16:59:46 +0200753 buf[0] = 0x02 + mbedtls_mpi_get_bit(&P->Y, 0);
754 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->X, buf + 1, plen));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200755 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200756 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200757#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200758
759cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200760 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200761}
762
Jens Wiklander32b31802023-10-06 16:59:46 +0200763#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
764static int mbedtls_ecp_sw_derive_y(const mbedtls_ecp_group *grp,
765 const mbedtls_mpi *X,
766 mbedtls_mpi *Y,
767 int parity_bit);
768#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
769
Jens Wiklander817466c2018-05-22 13:49:31 +0200770/*
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200771 * Import a point from unsigned binary data (SEC1 2.3.4 and RFC7748)
Jens Wiklander817466c2018-05-22 13:49:31 +0200772 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200773int mbedtls_ecp_point_read_binary(const mbedtls_ecp_group *grp,
774 mbedtls_ecp_point *pt,
775 const unsigned char *buf, size_t ilen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200776{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200777 int ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +0200778 size_t plen;
Jens Wiklander32b31802023-10-06 16:59:46 +0200779 if (ilen < 1) {
780 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
781 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200782
Jens Wiklander32b31802023-10-06 16:59:46 +0200783 plen = mbedtls_mpi_size(&grp->P);
Jens Wiklander817466c2018-05-22 13:49:31 +0200784
Jerome Forissier79013242021-07-28 10:24:04 +0200785#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200786 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
787 if (plen != ilen) {
788 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
789 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200790
Jens Wiklander32b31802023-10-06 16:59:46 +0200791 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&pt->X, buf, plen));
792 mbedtls_mpi_free(&pt->Y);
Jens Wiklander817466c2018-05-22 13:49:31 +0200793
Jens Wiklander32b31802023-10-06 16:59:46 +0200794 if (grp->id == MBEDTLS_ECP_DP_CURVE25519) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200795 /* Set most significant bit to 0 as prescribed in RFC7748 §5 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200796 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&pt->X, plen * 8 - 1, 0));
797 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200798
Jens Wiklander32b31802023-10-06 16:59:46 +0200799 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 1));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200800 }
801#endif
Jerome Forissier79013242021-07-28 10:24:04 +0200802#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200803 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
804 if (buf[0] == 0x00) {
805 if (ilen == 1) {
806 return mbedtls_ecp_set_zero(pt);
807 } else {
808 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
809 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200810 }
811
Jens Wiklander32b31802023-10-06 16:59:46 +0200812 if (ilen < 1 + plen) {
813 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
814 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200815
Jens Wiklander32b31802023-10-06 16:59:46 +0200816 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&pt->X, buf + 1, plen));
817 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 1));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200818
Jens Wiklander32b31802023-10-06 16:59:46 +0200819 if (buf[0] == 0x04) {
820 /* format == MBEDTLS_ECP_PF_UNCOMPRESSED */
821 if (ilen != 1 + plen * 2) {
822 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
823 }
824 return mbedtls_mpi_read_binary(&pt->Y, buf + 1 + plen, plen);
825 } else if (buf[0] == 0x02 || buf[0] == 0x03) {
826 /* format == MBEDTLS_ECP_PF_COMPRESSED */
827 if (ilen != 1 + plen) {
828 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
829 }
830 return mbedtls_ecp_sw_derive_y(grp, &pt->X, &pt->Y,
831 (buf[0] & 1));
832 } else {
833 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
834 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200835 }
836#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200837
838cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +0200839 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200840}
841
842/*
843 * Import a point from a TLS ECPoint record (RFC 4492)
844 * struct {
845 * opaque point <1..2^8-1>;
846 * } ECPoint;
847 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200848int mbedtls_ecp_tls_read_point(const mbedtls_ecp_group *grp,
849 mbedtls_ecp_point *pt,
850 const unsigned char **buf, size_t buf_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200851{
852 unsigned char data_len;
853 const unsigned char *buf_start;
Jens Wiklander817466c2018-05-22 13:49:31 +0200854 /*
855 * We must have at least two bytes (1 for length, at least one for data)
856 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200857 if (buf_len < 2) {
858 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
859 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200860
861 data_len = *(*buf)++;
Jens Wiklander32b31802023-10-06 16:59:46 +0200862 if (data_len < 1 || data_len > buf_len - 1) {
863 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
864 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200865
866 /*
867 * Save buffer start for read_binary and update buf
868 */
869 buf_start = *buf;
870 *buf += data_len;
871
Jens Wiklander32b31802023-10-06 16:59:46 +0200872 return mbedtls_ecp_point_read_binary(grp, pt, buf_start, data_len);
Jens Wiklander817466c2018-05-22 13:49:31 +0200873}
874
875/*
876 * Export a point as a TLS ECPoint record (RFC 4492)
877 * struct {
878 * opaque point <1..2^8-1>;
879 * } ECPoint;
880 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200881int mbedtls_ecp_tls_write_point(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt,
882 int format, size_t *olen,
883 unsigned char *buf, size_t blen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200884{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200885 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +0200886 if (format != MBEDTLS_ECP_PF_UNCOMPRESSED &&
887 format != MBEDTLS_ECP_PF_COMPRESSED) {
888 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
889 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200890
891 /*
892 * buffer length must be at least one, for our length byte
893 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200894 if (blen < 1) {
895 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
896 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200897
Jens Wiklander32b31802023-10-06 16:59:46 +0200898 if ((ret = mbedtls_ecp_point_write_binary(grp, pt, format,
899 olen, buf + 1, blen - 1)) != 0) {
900 return ret;
901 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200902
903 /*
904 * write length to the first byte and update total length
905 */
906 buf[0] = (unsigned char) *olen;
907 ++*olen;
908
Jens Wiklander32b31802023-10-06 16:59:46 +0200909 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200910}
911
912/*
913 * Set a group from an ECParameters record (RFC 4492)
914 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200915int mbedtls_ecp_tls_read_group(mbedtls_ecp_group *grp,
916 const unsigned char **buf, size_t len)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100917{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200918 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100919 mbedtls_ecp_group_id grp_id;
Jens Wiklander32b31802023-10-06 16:59:46 +0200920 if ((ret = mbedtls_ecp_tls_read_group_id(&grp_id, buf, len)) != 0) {
921 return ret;
922 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100923
Jens Wiklander32b31802023-10-06 16:59:46 +0200924 return mbedtls_ecp_group_load(grp, grp_id);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100925}
926
927/*
928 * Read a group id from an ECParameters record (RFC 4492) and convert it to
929 * mbedtls_ecp_group_id.
930 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200931int mbedtls_ecp_tls_read_group_id(mbedtls_ecp_group_id *grp,
932 const unsigned char **buf, size_t len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200933{
934 uint16_t tls_id;
935 const mbedtls_ecp_curve_info *curve_info;
Jens Wiklander817466c2018-05-22 13:49:31 +0200936 /*
937 * We expect at least three bytes (see below)
938 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200939 if (len < 3) {
940 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
941 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200942
943 /*
944 * First byte is curve_type; only named_curve is handled
945 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200946 if (*(*buf)++ != MBEDTLS_ECP_TLS_NAMED_CURVE) {
947 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
948 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200949
950 /*
951 * Next two bytes are the namedcurve value
952 */
Tom Van Eyckc1633172024-04-09 18:44:13 +0200953 tls_id = MBEDTLS_GET_UINT16_BE(*buf, 0);
954 *buf += 2;
Jens Wiklander817466c2018-05-22 13:49:31 +0200955
Jens Wiklander32b31802023-10-06 16:59:46 +0200956 if ((curve_info = mbedtls_ecp_curve_info_from_tls_id(tls_id)) == NULL) {
957 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
958 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200959
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100960 *grp = curve_info->grp_id;
961
Jens Wiklander32b31802023-10-06 16:59:46 +0200962 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200963}
964
965/*
966 * Write the ECParameters record corresponding to a group (RFC 4492)
967 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200968int mbedtls_ecp_tls_write_group(const mbedtls_ecp_group *grp, size_t *olen,
969 unsigned char *buf, size_t blen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200970{
971 const mbedtls_ecp_curve_info *curve_info;
Jens Wiklander32b31802023-10-06 16:59:46 +0200972 if ((curve_info = mbedtls_ecp_curve_info_from_grp_id(grp->id)) == NULL) {
973 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
974 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200975
976 /*
977 * We are going to write 3 bytes (see below)
978 */
979 *olen = 3;
Jens Wiklander32b31802023-10-06 16:59:46 +0200980 if (blen < *olen) {
981 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
982 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200983
984 /*
985 * First byte is curve_type, always named_curve
986 */
987 *buf++ = MBEDTLS_ECP_TLS_NAMED_CURVE;
988
989 /*
990 * Next two bytes are the namedcurve value
991 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200992 MBEDTLS_PUT_UINT16_BE(curve_info->tls_id, buf, 0);
Jens Wiklander817466c2018-05-22 13:49:31 +0200993
Jens Wiklander32b31802023-10-06 16:59:46 +0200994 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200995}
996
997/*
998 * Wrapper around fast quasi-modp functions, with fall-back to mbedtls_mpi_mod_mpi.
999 * See the documentation of struct mbedtls_ecp_group.
1000 *
1001 * This function is in the critial loop for mbedtls_ecp_mul, so pay attention to perf.
1002 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001003static int ecp_modp(mbedtls_mpi *N, const mbedtls_ecp_group *grp)
Jens Wiklander817466c2018-05-22 13:49:31 +02001004{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001006
Jens Wiklander32b31802023-10-06 16:59:46 +02001007 if (grp->modp == NULL) {
1008 return mbedtls_mpi_mod_mpi(N, N, &grp->P);
Jens Wiklander817466c2018-05-22 13:49:31 +02001009 }
1010
Jens Wiklander32b31802023-10-06 16:59:46 +02001011 /* N->s < 0 is a much faster test, which fails only if N is 0 */
1012 if ((N->s < 0 && mbedtls_mpi_cmp_int(N, 0) != 0) ||
1013 mbedtls_mpi_bitlen(N) > 2 * grp->pbits) {
1014 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1015 }
1016
1017 MBEDTLS_MPI_CHK(grp->modp(N));
Jens Wiklander817466c2018-05-22 13:49:31 +02001018
1019 /* N->s < 0 is a much faster test, which fails only if N is 0 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001020 while (N->s < 0 && mbedtls_mpi_cmp_int(N, 0) != 0) {
1021 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(N, N, &grp->P));
1022 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001023
Jens Wiklander32b31802023-10-06 16:59:46 +02001024 while (mbedtls_mpi_cmp_mpi(N, &grp->P) >= 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001025 /* we known P, N and the result are positive */
Jens Wiklander32b31802023-10-06 16:59:46 +02001026 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_abs(N, N, &grp->P));
1027 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001028
1029cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001030 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001031}
1032
1033/*
1034 * Fast mod-p functions expect their argument to be in the 0..p^2 range.
1035 *
1036 * In order to guarantee that, we need to ensure that operands of
1037 * mbedtls_mpi_mul_mpi are in the 0..p range. So, after each operation we will
1038 * bring the result back to this range.
1039 *
1040 * The following macros are shortcuts for doing that.
1041 */
1042
1043/*
1044 * Reduce a mbedtls_mpi mod p in-place, general case, to use after mbedtls_mpi_mul_mpi
1045 */
1046#if defined(MBEDTLS_SELF_TEST)
1047#define INC_MUL_COUNT mul_count++;
1048#else
1049#define INC_MUL_COUNT
1050#endif
1051
Jens Wiklander32b31802023-10-06 16:59:46 +02001052#define MOD_MUL(N) \
Jerome Forissier5b25c762020-04-07 11:18:49 +02001053 do \
1054 { \
Jens Wiklander32b31802023-10-06 16:59:46 +02001055 MBEDTLS_MPI_CHK(ecp_modp(&(N), grp)); \
Jerome Forissier5b25c762020-04-07 11:18:49 +02001056 INC_MUL_COUNT \
Jens Wiklander32b31802023-10-06 16:59:46 +02001057 } while (0)
Jens Wiklander817466c2018-05-22 13:49:31 +02001058
Jens Wiklander32b31802023-10-06 16:59:46 +02001059static inline int mbedtls_mpi_mul_mod(const mbedtls_ecp_group *grp,
1060 mbedtls_mpi *X,
1061 const mbedtls_mpi *A,
1062 const mbedtls_mpi *B)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001063{
1064 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001065 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mpi(X, A, B));
1066 MOD_MUL(*X);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001067cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001068 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001069}
1070
Jens Wiklander817466c2018-05-22 13:49:31 +02001071/*
1072 * Reduce a mbedtls_mpi mod p in-place, to use after mbedtls_mpi_sub_mpi
1073 * N->s < 0 is a very fast test, which fails only if N is 0
1074 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001075#define MOD_SUB(N) \
1076 do { \
1077 while ((N)->s < 0 && mbedtls_mpi_cmp_int((N), 0) != 0) \
1078 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi((N), (N), &grp->P)); \
1079 } while (0)
Jens Wiklander817466c2018-05-22 13:49:31 +02001080
Tom Van Eyckc1633172024-04-09 18:44:13 +02001081MBEDTLS_MAYBE_UNUSED
Jens Wiklander32b31802023-10-06 16:59:46 +02001082static inline int mbedtls_mpi_sub_mod(const mbedtls_ecp_group *grp,
1083 mbedtls_mpi *X,
1084 const mbedtls_mpi *A,
1085 const mbedtls_mpi *B)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001086{
1087 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001088 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(X, A, B));
1089 MOD_SUB(X);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001090cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001091 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001092}
1093
Jens Wiklander817466c2018-05-22 13:49:31 +02001094/*
1095 * Reduce a mbedtls_mpi mod p in-place, to use after mbedtls_mpi_add_mpi and mbedtls_mpi_mul_int.
1096 * We known P, N and the result are positive, so sub_abs is correct, and
1097 * a bit faster.
1098 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001099#define MOD_ADD(N) \
1100 while (mbedtls_mpi_cmp_mpi((N), &grp->P) >= 0) \
1101 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_abs((N), (N), &grp->P))
Jens Wiklander817466c2018-05-22 13:49:31 +02001102
Jens Wiklander32b31802023-10-06 16:59:46 +02001103static inline int mbedtls_mpi_add_mod(const mbedtls_ecp_group *grp,
1104 mbedtls_mpi *X,
1105 const mbedtls_mpi *A,
1106 const mbedtls_mpi *B)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001107{
1108 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001109 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(X, A, B));
1110 MOD_ADD(X);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001111cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001112 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001113}
1114
Tom Van Eyckc1633172024-04-09 18:44:13 +02001115MBEDTLS_MAYBE_UNUSED
Jens Wiklander32b31802023-10-06 16:59:46 +02001116static inline int mbedtls_mpi_mul_int_mod(const mbedtls_ecp_group *grp,
1117 mbedtls_mpi *X,
1118 const mbedtls_mpi *A,
1119 mbedtls_mpi_uint c)
1120{
1121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1122
1123 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_int(X, A, c));
1124 MOD_ADD(X);
1125cleanup:
1126 return ret;
1127}
1128
Tom Van Eyckc1633172024-04-09 18:44:13 +02001129MBEDTLS_MAYBE_UNUSED
Jens Wiklander32b31802023-10-06 16:59:46 +02001130static inline int mbedtls_mpi_sub_int_mod(const mbedtls_ecp_group *grp,
1131 mbedtls_mpi *X,
1132 const mbedtls_mpi *A,
1133 mbedtls_mpi_uint c)
1134{
1135 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1136
1137 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(X, A, c));
1138 MOD_SUB(X);
1139cleanup:
1140 return ret;
1141}
1142
1143#define MPI_ECP_SUB_INT(X, A, c) \
1144 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int_mod(grp, X, A, c))
1145
Tom Van Eyckc1633172024-04-09 18:44:13 +02001146MBEDTLS_MAYBE_UNUSED
Jens Wiklander32b31802023-10-06 16:59:46 +02001147static inline int mbedtls_mpi_shift_l_mod(const mbedtls_ecp_group *grp,
1148 mbedtls_mpi *X,
1149 size_t count)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001150{
1151 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001152 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_l(X, count));
1153 MOD_ADD(X);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001154cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001155 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001156}
Jens Wiklander32b31802023-10-06 16:59:46 +02001157
1158/*
1159 * Macro wrappers around ECP modular arithmetic
1160 *
1161 * Currently, these wrappers are defined via the bignum module.
1162 */
1163
1164#define MPI_ECP_ADD(X, A, B) \
1165 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mod(grp, X, A, B))
1166
1167#define MPI_ECP_SUB(X, A, B) \
1168 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mod(grp, X, A, B))
1169
1170#define MPI_ECP_MUL(X, A, B) \
1171 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mod(grp, X, A, B))
1172
1173#define MPI_ECP_SQR(X, A) \
1174 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mod(grp, X, A, A))
1175
1176#define MPI_ECP_MUL_INT(X, A, c) \
1177 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_int_mod(grp, X, A, c))
1178
1179#define MPI_ECP_INV(dst, src) \
1180 MBEDTLS_MPI_CHK(mbedtls_mpi_inv_mod((dst), (src), &grp->P))
1181
1182#define MPI_ECP_MOV(X, A) \
1183 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(X, A))
1184
1185#define MPI_ECP_SHIFT_L(X, count) \
1186 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_l_mod(grp, X, count))
1187
1188#define MPI_ECP_LSET(X, c) \
1189 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(X, c))
1190
1191#define MPI_ECP_CMP_INT(X, c) \
1192 mbedtls_mpi_cmp_int(X, c)
1193
1194#define MPI_ECP_CMP(X, Y) \
1195 mbedtls_mpi_cmp_mpi(X, Y)
1196
1197/* Needs f_rng, p_rng to be defined. */
1198#define MPI_ECP_RAND(X) \
1199 MBEDTLS_MPI_CHK(mbedtls_mpi_random((X), 2, &grp->P, f_rng, p_rng))
1200
1201/* Conditional negation
1202 * Needs grp and a temporary MPI tmp to be defined. */
1203#define MPI_ECP_COND_NEG(X, cond) \
1204 do \
1205 { \
1206 unsigned char nonzero = mbedtls_mpi_cmp_int((X), 0) != 0; \
1207 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&tmp, &grp->P, (X))); \
1208 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign((X), &tmp, \
1209 nonzero & cond)); \
1210 } while (0)
1211
1212#define MPI_ECP_NEG(X) MPI_ECP_COND_NEG((X), 1)
1213
1214#define MPI_ECP_VALID(X) \
1215 ((X)->p != NULL)
1216
1217#define MPI_ECP_COND_ASSIGN(X, Y, cond) \
1218 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign((X), (Y), (cond)))
1219
1220#define MPI_ECP_COND_SWAP(X, Y, cond) \
1221 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_swap((X), (Y), (cond)))
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001222
Jerome Forissier79013242021-07-28 10:24:04 +02001223#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001224
1225/*
1226 * Computes the right-hand side of the Short Weierstrass equation
1227 * RHS = X^3 + A X + B
1228 */
1229static int ecp_sw_rhs(const mbedtls_ecp_group *grp,
1230 mbedtls_mpi *rhs,
1231 const mbedtls_mpi *X)
1232{
1233 int ret;
1234
1235 /* Compute X^3 + A X + B as X (X^2 + A) + B */
1236 MPI_ECP_SQR(rhs, X);
1237
1238 /* Special case for A = -3 */
Tom Van Eyckc1633172024-04-09 18:44:13 +02001239 if (mbedtls_ecp_group_a_is_minus_3(grp)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001240 MPI_ECP_SUB_INT(rhs, rhs, 3);
1241 } else {
1242 MPI_ECP_ADD(rhs, rhs, &grp->A);
1243 }
1244
1245 MPI_ECP_MUL(rhs, rhs, X);
1246 MPI_ECP_ADD(rhs, rhs, &grp->B);
1247
1248cleanup:
1249 return ret;
1250}
1251
1252/*
1253 * Derive Y from X and a parity bit
1254 */
1255static int mbedtls_ecp_sw_derive_y(const mbedtls_ecp_group *grp,
1256 const mbedtls_mpi *X,
1257 mbedtls_mpi *Y,
1258 int parity_bit)
1259{
1260 /* w = y^2 = x^3 + ax + b
1261 * y = sqrt(w) = w^((p+1)/4) mod p (for prime p where p = 3 mod 4)
1262 *
1263 * Note: this method for extracting square root does not validate that w
1264 * was indeed a square so this function will return garbage in Y if X
1265 * does not correspond to a point on the curve.
1266 */
1267
1268 /* Check prerequisite p = 3 mod 4 */
1269 if (mbedtls_mpi_get_bit(&grp->P, 0) != 1 ||
1270 mbedtls_mpi_get_bit(&grp->P, 1) != 1) {
1271 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
1272 }
1273
1274 int ret;
1275 mbedtls_mpi exp;
1276 mbedtls_mpi_init(&exp);
1277
1278 /* use Y to store intermediate result, actually w above */
1279 MBEDTLS_MPI_CHK(ecp_sw_rhs(grp, Y, X));
1280
1281 /* w = y^2 */ /* Y contains y^2 intermediate result */
1282 /* exp = ((p+1)/4) */
1283 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&exp, &grp->P, 1));
1284 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_r(&exp, 2));
1285 /* sqrt(w) = w^((p+1)/4) mod p (for prime p where p = 3 mod 4) */
1286 MBEDTLS_MPI_CHK(mbedtls_mpi_exp_mod(Y, Y /*y^2*/, &exp, &grp->P, NULL));
1287
1288 /* check parity bit match or else invert Y */
1289 /* This quick inversion implementation is valid because Y != 0 for all
1290 * Short Weierstrass curves supported by mbedtls, as each supported curve
1291 * has an order that is a large prime, so each supported curve does not
1292 * have any point of order 2, and a point with Y == 0 would be of order 2 */
1293 if (mbedtls_mpi_get_bit(Y, 0) != parity_bit) {
1294 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(Y, &grp->P, Y));
1295 }
1296
1297cleanup:
1298
1299 mbedtls_mpi_free(&exp);
1300 return ret;
1301}
Tom Van Eyckc1633172024-04-09 18:44:13 +02001302#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander32b31802023-10-06 16:59:46 +02001303
Tom Van Eyckc1633172024-04-09 18:44:13 +02001304#if defined(MBEDTLS_ECP_C)
1305#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02001306/*
1307 * For curves in short Weierstrass form, we do all the internal operations in
1308 * Jacobian coordinates.
1309 *
Jerome Forissier039e02d2022-08-09 17:10:15 +02001310 * For multiplication, we'll use a comb method with countermeasures against
Jens Wiklander817466c2018-05-22 13:49:31 +02001311 * SPA, hence timing attacks.
1312 */
1313
1314/*
1315 * Normalize jacobian coordinates so that Z == 0 || Z == 1 (GECC 3.2.1)
1316 * Cost: 1N := 1I + 3M + 1S
1317 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001318static int ecp_normalize_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +02001319{
Jens Wiklander32b31802023-10-06 16:59:46 +02001320 if (MPI_ECP_CMP_INT(&pt->Z, 0) == 0) {
1321 return 0;
1322 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001323
1324#if defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001325 if (mbedtls_internal_ecp_grp_capable(grp)) {
1326 return mbedtls_internal_ecp_normalize_jac(grp, pt);
1327 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001328#endif /* MBEDTLS_ECP_NORMALIZE_JAC_ALT */
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001329
Jerome Forissier79013242021-07-28 10:24:04 +02001330#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001331 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001332#else
1333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001334 mbedtls_mpi T;
1335 mbedtls_mpi_init(&T);
Jens Wiklander817466c2018-05-22 13:49:31 +02001336
Jens Wiklander32b31802023-10-06 16:59:46 +02001337 MPI_ECP_INV(&T, &pt->Z); /* T <- 1 / Z */
1338 MPI_ECP_MUL(&pt->Y, &pt->Y, &T); /* Y' <- Y*T = Y / Z */
1339 MPI_ECP_SQR(&T, &T); /* T <- T^2 = 1 / Z^2 */
1340 MPI_ECP_MUL(&pt->X, &pt->X, &T); /* X <- X * T = X / Z^2 */
1341 MPI_ECP_MUL(&pt->Y, &pt->Y, &T); /* Y'' <- Y' * T = Y / Z^3 */
Jens Wiklander817466c2018-05-22 13:49:31 +02001342
Jens Wiklander32b31802023-10-06 16:59:46 +02001343 MPI_ECP_LSET(&pt->Z, 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001344
1345cleanup:
1346
Jens Wiklander32b31802023-10-06 16:59:46 +02001347 mbedtls_mpi_free(&T);
Jens Wiklander817466c2018-05-22 13:49:31 +02001348
Jens Wiklander32b31802023-10-06 16:59:46 +02001349 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001350#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001351}
1352
1353/*
1354 * Normalize jacobian coordinates of an array of (pointers to) points,
1355 * using Montgomery's trick to perform only one inversion mod P.
1356 * (See for example Cohen's "A Course in Computational Algebraic Number
1357 * Theory", Algorithm 10.3.4.)
1358 *
1359 * Warning: fails (returning an error) if one of the points is zero!
1360 * This should never happen, see choice of w in ecp_mul_comb().
1361 *
1362 * Cost: 1N(t) := 1I + (6t - 3)M + 1S
1363 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001364static int ecp_normalize_jac_many(const mbedtls_ecp_group *grp,
1365 mbedtls_ecp_point *T[], size_t T_size)
Jens Wiklander817466c2018-05-22 13:49:31 +02001366{
Jens Wiklander32b31802023-10-06 16:59:46 +02001367 if (T_size < 2) {
1368 return ecp_normalize_jac(grp, *T);
1369 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001370
1371#if defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001372 if (mbedtls_internal_ecp_grp_capable(grp)) {
1373 return mbedtls_internal_ecp_normalize_jac_many(grp, T, T_size);
1374 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001375#endif
1376
Jerome Forissier79013242021-07-28 10:24:04 +02001377#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001378 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001379#else
1380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1381 size_t i;
Jens Wiklander32b31802023-10-06 16:59:46 +02001382 mbedtls_mpi *c, t;
Jerome Forissier79013242021-07-28 10:24:04 +02001383
Jens Wiklander32b31802023-10-06 16:59:46 +02001384 if ((c = mbedtls_calloc(T_size, sizeof(mbedtls_mpi))) == NULL) {
1385 return MBEDTLS_ERR_ECP_ALLOC_FAILED;
1386 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001387
Jens Wiklander32b31802023-10-06 16:59:46 +02001388 mbedtls_mpi_init(&t);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001389
Jens Wiklander32b31802023-10-06 16:59:46 +02001390 mpi_init_many(c, T_size);
Jens Wiklander817466c2018-05-22 13:49:31 +02001391 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02001392 * c[i] = Z_0 * ... * Z_i, i = 0,..,n := T_size-1
Jens Wiklander817466c2018-05-22 13:49:31 +02001393 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001394 MPI_ECP_MOV(&c[0], &T[0]->Z);
1395 for (i = 1; i < T_size; i++) {
1396 MPI_ECP_MUL(&c[i], &c[i-1], &T[i]->Z);
Jens Wiklander817466c2018-05-22 13:49:31 +02001397 }
1398
1399 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02001400 * c[n] = 1 / (Z_0 * ... * Z_n) mod P
Jens Wiklander817466c2018-05-22 13:49:31 +02001401 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001402 MPI_ECP_INV(&c[T_size-1], &c[T_size-1]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001403
Jens Wiklander32b31802023-10-06 16:59:46 +02001404 for (i = T_size - 1;; i--) {
1405 /* At the start of iteration i (note that i decrements), we have
1406 * - c[j] = Z_0 * .... * Z_j for j < i,
1407 * - c[j] = 1 / (Z_0 * .... * Z_j) for j == i,
1408 *
1409 * This is maintained via
1410 * - c[i-1] <- c[i] * Z_i
1411 *
1412 * We also derive 1/Z_i = c[i] * c[i-1] for i>0 and use that
1413 * to do the actual normalization. For i==0, we already have
1414 * c[0] = 1 / Z_0.
Jens Wiklander817466c2018-05-22 13:49:31 +02001415 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001416
1417 if (i > 0) {
1418 /* Compute 1/Z_i and establish invariant for the next iteration. */
1419 MPI_ECP_MUL(&t, &c[i], &c[i-1]);
1420 MPI_ECP_MUL(&c[i-1], &c[i], &T[i]->Z);
1421 } else {
1422 MPI_ECP_MOV(&t, &c[0]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001423 }
1424
Jens Wiklander32b31802023-10-06 16:59:46 +02001425 /* Now t holds 1 / Z_i; normalize as in ecp_normalize_jac() */
1426 MPI_ECP_MUL(&T[i]->Y, &T[i]->Y, &t);
1427 MPI_ECP_SQR(&t, &t);
1428 MPI_ECP_MUL(&T[i]->X, &T[i]->X, &t);
1429 MPI_ECP_MUL(&T[i]->Y, &T[i]->Y, &t);
Jens Wiklander817466c2018-05-22 13:49:31 +02001430
1431 /*
1432 * Post-precessing: reclaim some memory by shrinking coordinates
1433 * - not storing Z (always 1)
1434 * - shrinking other coordinates, but still keeping the same number of
1435 * limbs as P, as otherwise it will too likely be regrown too fast.
1436 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001437 MBEDTLS_MPI_CHK(mbedtls_mpi_shrink(&T[i]->X, grp->P.n));
1438 MBEDTLS_MPI_CHK(mbedtls_mpi_shrink(&T[i]->Y, grp->P.n));
Jens Wiklander817466c2018-05-22 13:49:31 +02001439
Jens Wiklander32b31802023-10-06 16:59:46 +02001440 MPI_ECP_LSET(&T[i]->Z, 1);
1441
1442 if (i == 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001443 break;
Jens Wiklander32b31802023-10-06 16:59:46 +02001444 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001445 }
1446
1447cleanup:
1448
Jens Wiklander32b31802023-10-06 16:59:46 +02001449 mbedtls_mpi_free(&t);
1450 mpi_free_many(c, T_size);
1451 mbedtls_free(c);
Jens Wiklander817466c2018-05-22 13:49:31 +02001452
Jens Wiklander32b31802023-10-06 16:59:46 +02001453 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001454#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001455}
1456
1457/*
1458 * Conditional point inversion: Q -> -Q = (Q.X, -Q.Y, Q.Z) without leak.
1459 * "inv" must be 0 (don't invert) or 1 (invert) or the result will be invalid
1460 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001461static int ecp_safe_invert_jac(const mbedtls_ecp_group *grp,
1462 mbedtls_ecp_point *Q,
1463 unsigned char inv)
Jens Wiklander817466c2018-05-22 13:49:31 +02001464{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001465 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001466 mbedtls_mpi tmp;
1467 mbedtls_mpi_init(&tmp);
Jens Wiklander817466c2018-05-22 13:49:31 +02001468
Jens Wiklander32b31802023-10-06 16:59:46 +02001469 MPI_ECP_COND_NEG(&Q->Y, inv);
Jens Wiklander817466c2018-05-22 13:49:31 +02001470
1471cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001472 mbedtls_mpi_free(&tmp);
1473 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001474}
1475
1476/*
1477 * Point doubling R = 2 P, Jacobian coordinates
1478 *
1479 * Based on http://www.hyperelliptic.org/EFD/g1p/auto-shortw-jacobian.html#doubling-dbl-1998-cmo-2 .
1480 *
1481 * We follow the variable naming fairly closely. The formula variations that trade a MUL for a SQR
1482 * (plus a few ADDs) aren't useful as our bignum implementation doesn't distinguish squaring.
1483 *
1484 * Standard optimizations are applied when curve parameter A is one of { 0, -3 }.
1485 *
1486 * Cost: 1D := 3M + 4S (A == 0)
1487 * 4M + 4S (A == -3)
1488 * 3M + 6S + 1a otherwise
1489 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001490static int ecp_double_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
1491 const mbedtls_ecp_point *P,
1492 mbedtls_mpi tmp[4])
Jens Wiklander817466c2018-05-22 13:49:31 +02001493{
Jens Wiklander817466c2018-05-22 13:49:31 +02001494#if defined(MBEDTLS_SELF_TEST)
1495 dbl_count++;
1496#endif
1497
1498#if defined(MBEDTLS_ECP_DOUBLE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001499 if (mbedtls_internal_ecp_grp_capable(grp)) {
1500 return mbedtls_internal_ecp_double_jac(grp, R, P);
1501 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001502#endif /* MBEDTLS_ECP_DOUBLE_JAC_ALT */
1503
Jerome Forissier79013242021-07-28 10:24:04 +02001504#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_DOUBLE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001505 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001506#else
1507 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001508
1509 /* Special case for A = -3 */
Tom Van Eyckc1633172024-04-09 18:44:13 +02001510 if (mbedtls_ecp_group_a_is_minus_3(grp)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001511 /* tmp[0] <- M = 3(X + Z^2)(X - Z^2) */
1512 MPI_ECP_SQR(&tmp[1], &P->Z);
1513 MPI_ECP_ADD(&tmp[2], &P->X, &tmp[1]);
1514 MPI_ECP_SUB(&tmp[3], &P->X, &tmp[1]);
1515 MPI_ECP_MUL(&tmp[1], &tmp[2], &tmp[3]);
1516 MPI_ECP_MUL_INT(&tmp[0], &tmp[1], 3);
1517 } else {
1518 /* tmp[0] <- M = 3.X^2 + A.Z^4 */
1519 MPI_ECP_SQR(&tmp[1], &P->X);
1520 MPI_ECP_MUL_INT(&tmp[0], &tmp[1], 3);
Jens Wiklander817466c2018-05-22 13:49:31 +02001521
1522 /* Optimize away for "koblitz" curves with A = 0 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001523 if (MPI_ECP_CMP_INT(&grp->A, 0) != 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001524 /* M += A.Z^4 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001525 MPI_ECP_SQR(&tmp[1], &P->Z);
1526 MPI_ECP_SQR(&tmp[2], &tmp[1]);
1527 MPI_ECP_MUL(&tmp[1], &tmp[2], &grp->A);
1528 MPI_ECP_ADD(&tmp[0], &tmp[0], &tmp[1]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001529 }
1530 }
1531
Jens Wiklander32b31802023-10-06 16:59:46 +02001532 /* tmp[1] <- S = 4.X.Y^2 */
1533 MPI_ECP_SQR(&tmp[2], &P->Y);
1534 MPI_ECP_SHIFT_L(&tmp[2], 1);
1535 MPI_ECP_MUL(&tmp[1], &P->X, &tmp[2]);
1536 MPI_ECP_SHIFT_L(&tmp[1], 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001537
Jens Wiklander32b31802023-10-06 16:59:46 +02001538 /* tmp[3] <- U = 8.Y^4 */
1539 MPI_ECP_SQR(&tmp[3], &tmp[2]);
1540 MPI_ECP_SHIFT_L(&tmp[3], 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001541
Jens Wiklander32b31802023-10-06 16:59:46 +02001542 /* tmp[2] <- T = M^2 - 2.S */
1543 MPI_ECP_SQR(&tmp[2], &tmp[0]);
1544 MPI_ECP_SUB(&tmp[2], &tmp[2], &tmp[1]);
1545 MPI_ECP_SUB(&tmp[2], &tmp[2], &tmp[1]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001546
Jens Wiklander32b31802023-10-06 16:59:46 +02001547 /* tmp[1] <- S = M(S - T) - U */
1548 MPI_ECP_SUB(&tmp[1], &tmp[1], &tmp[2]);
1549 MPI_ECP_MUL(&tmp[1], &tmp[1], &tmp[0]);
1550 MPI_ECP_SUB(&tmp[1], &tmp[1], &tmp[3]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001551
Jens Wiklander32b31802023-10-06 16:59:46 +02001552 /* tmp[3] <- U = 2.Y.Z */
1553 MPI_ECP_MUL(&tmp[3], &P->Y, &P->Z);
1554 MPI_ECP_SHIFT_L(&tmp[3], 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001555
Jens Wiklander32b31802023-10-06 16:59:46 +02001556 /* Store results */
1557 MPI_ECP_MOV(&R->X, &tmp[2]);
1558 MPI_ECP_MOV(&R->Y, &tmp[1]);
1559 MPI_ECP_MOV(&R->Z, &tmp[3]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001560
1561cleanup:
Jens Wiklander817466c2018-05-22 13:49:31 +02001562
Jens Wiklander32b31802023-10-06 16:59:46 +02001563 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001564#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_DOUBLE_JAC_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001565}
1566
1567/*
1568 * Addition: R = P + Q, mixed affine-Jacobian coordinates (GECC 3.22)
1569 *
1570 * The coordinates of Q must be normalized (= affine),
1571 * but those of P don't need to. R is not normalized.
1572 *
Jens Wiklander32b31802023-10-06 16:59:46 +02001573 * P,Q,R may alias, but only at the level of EC points: they must be either
1574 * equal as pointers, or disjoint (including the coordinate data buffers).
1575 * Fine-grained aliasing at the level of coordinates is not supported.
1576 *
Jens Wiklander817466c2018-05-22 13:49:31 +02001577 * Special cases: (1) P or Q is zero, (2) R is zero, (3) P == Q.
1578 * None of these cases can happen as intermediate step in ecp_mul_comb():
1579 * - at each step, P, Q and R are multiples of the base point, the factor
1580 * being less than its order, so none of them is zero;
1581 * - Q is an odd multiple of the base point, P an even multiple,
1582 * due to the choice of precomputed points in the modified comb method.
1583 * So branches for these cases do not leak secret information.
1584 *
Jens Wiklander817466c2018-05-22 13:49:31 +02001585 * Cost: 1A := 8M + 3S
1586 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001587static int ecp_add_mixed(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
1588 const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q,
1589 mbedtls_mpi tmp[4])
Jens Wiklander817466c2018-05-22 13:49:31 +02001590{
Jens Wiklander817466c2018-05-22 13:49:31 +02001591#if defined(MBEDTLS_SELF_TEST)
1592 add_count++;
1593#endif
1594
1595#if defined(MBEDTLS_ECP_ADD_MIXED_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001596 if (mbedtls_internal_ecp_grp_capable(grp)) {
1597 return mbedtls_internal_ecp_add_mixed(grp, R, P, Q);
1598 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001599#endif /* MBEDTLS_ECP_ADD_MIXED_ALT */
1600
Jerome Forissier79013242021-07-28 10:24:04 +02001601#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_ADD_MIXED_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001602 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001603#else
1604 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001605
1606 /* NOTE: Aliasing between input and output is allowed, so one has to make
1607 * sure that at the point X,Y,Z are written, {P,Q}->{X,Y,Z} are no
1608 * longer read from. */
1609 mbedtls_mpi * const X = &R->X;
1610 mbedtls_mpi * const Y = &R->Y;
1611 mbedtls_mpi * const Z = &R->Z;
1612
1613 if (!MPI_ECP_VALID(&Q->Z)) {
1614 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1615 }
Jerome Forissier79013242021-07-28 10:24:04 +02001616
Jens Wiklander817466c2018-05-22 13:49:31 +02001617 /*
1618 * Trivial cases: P == 0 or Q == 0 (case 1)
1619 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001620 if (MPI_ECP_CMP_INT(&P->Z, 0) == 0) {
1621 return mbedtls_ecp_copy(R, Q);
1622 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001623
Jens Wiklander32b31802023-10-06 16:59:46 +02001624 if (MPI_ECP_CMP_INT(&Q->Z, 0) == 0) {
1625 return mbedtls_ecp_copy(R, P);
1626 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001627
1628 /*
1629 * Make sure Q coordinates are normalized
1630 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001631 if (MPI_ECP_CMP_INT(&Q->Z, 1) != 0) {
1632 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1633 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001634
Jens Wiklander32b31802023-10-06 16:59:46 +02001635 MPI_ECP_SQR(&tmp[0], &P->Z);
1636 MPI_ECP_MUL(&tmp[1], &tmp[0], &P->Z);
1637 MPI_ECP_MUL(&tmp[0], &tmp[0], &Q->X);
1638 MPI_ECP_MUL(&tmp[1], &tmp[1], &Q->Y);
1639 MPI_ECP_SUB(&tmp[0], &tmp[0], &P->X);
1640 MPI_ECP_SUB(&tmp[1], &tmp[1], &P->Y);
Jens Wiklander817466c2018-05-22 13:49:31 +02001641
1642 /* Special cases (2) and (3) */
Jens Wiklander32b31802023-10-06 16:59:46 +02001643 if (MPI_ECP_CMP_INT(&tmp[0], 0) == 0) {
1644 if (MPI_ECP_CMP_INT(&tmp[1], 0) == 0) {
1645 ret = ecp_double_jac(grp, R, P, tmp);
Jens Wiklander817466c2018-05-22 13:49:31 +02001646 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +02001647 } else {
1648 ret = mbedtls_ecp_set_zero(R);
Jens Wiklander817466c2018-05-22 13:49:31 +02001649 goto cleanup;
1650 }
1651 }
1652
Jens Wiklander32b31802023-10-06 16:59:46 +02001653 /* {P,Q}->Z no longer used, so OK to write to Z even if there's aliasing. */
1654 MPI_ECP_MUL(Z, &P->Z, &tmp[0]);
1655 MPI_ECP_SQR(&tmp[2], &tmp[0]);
1656 MPI_ECP_MUL(&tmp[3], &tmp[2], &tmp[0]);
1657 MPI_ECP_MUL(&tmp[2], &tmp[2], &P->X);
Jens Wiklander817466c2018-05-22 13:49:31 +02001658
Jens Wiklander32b31802023-10-06 16:59:46 +02001659 MPI_ECP_MOV(&tmp[0], &tmp[2]);
1660 MPI_ECP_SHIFT_L(&tmp[0], 1);
1661
1662 /* {P,Q}->X no longer used, so OK to write to X even if there's aliasing. */
1663 MPI_ECP_SQR(X, &tmp[1]);
1664 MPI_ECP_SUB(X, X, &tmp[0]);
1665 MPI_ECP_SUB(X, X, &tmp[3]);
1666 MPI_ECP_SUB(&tmp[2], &tmp[2], X);
1667 MPI_ECP_MUL(&tmp[2], &tmp[2], &tmp[1]);
1668 MPI_ECP_MUL(&tmp[3], &tmp[3], &P->Y);
1669 /* {P,Q}->Y no longer used, so OK to write to Y even if there's aliasing. */
1670 MPI_ECP_SUB(Y, &tmp[2], &tmp[3]);
Jens Wiklander817466c2018-05-22 13:49:31 +02001671
1672cleanup:
1673
Jens Wiklander32b31802023-10-06 16:59:46 +02001674 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001675#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_ADD_MIXED_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001676}
1677
1678/*
1679 * Randomize jacobian coordinates:
1680 * (X, Y, Z) -> (l^2 X, l^3 Y, l Z) for random l
1681 * This is sort of the reverse operation of ecp_normalize_jac().
1682 *
1683 * This countermeasure was first suggested in [2].
1684 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001685static int ecp_randomize_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt,
1686 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02001687{
Jens Wiklander817466c2018-05-22 13:49:31 +02001688#if defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001689 if (mbedtls_internal_ecp_grp_capable(grp)) {
1690 return mbedtls_internal_ecp_randomize_jac(grp, pt, f_rng, p_rng);
1691 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001692#endif /* MBEDTLS_ECP_RANDOMIZE_JAC_ALT */
1693
Jerome Forissier79013242021-07-28 10:24:04 +02001694#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02001695 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001696#else
1697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001698 mbedtls_mpi l;
Jerome Forissier79013242021-07-28 10:24:04 +02001699
Jens Wiklander32b31802023-10-06 16:59:46 +02001700 mbedtls_mpi_init(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001701
1702 /* Generate l such that 1 < l < p */
Jens Wiklander32b31802023-10-06 16:59:46 +02001703 MPI_ECP_RAND(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001704
Jens Wiklander32b31802023-10-06 16:59:46 +02001705 /* Z' = l * Z */
1706 MPI_ECP_MUL(&pt->Z, &pt->Z, &l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001707
Jens Wiklander32b31802023-10-06 16:59:46 +02001708 /* Y' = l * Y */
1709 MPI_ECP_MUL(&pt->Y, &pt->Y, &l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001710
Jens Wiklander32b31802023-10-06 16:59:46 +02001711 /* X' = l^2 * X */
1712 MPI_ECP_SQR(&l, &l);
1713 MPI_ECP_MUL(&pt->X, &pt->X, &l);
1714
1715 /* Y'' = l^2 * Y' = l^3 * Y */
1716 MPI_ECP_MUL(&pt->Y, &pt->Y, &l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001717
1718cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001719 mbedtls_mpi_free(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02001720
Jens Wiklander32b31802023-10-06 16:59:46 +02001721 if (ret == MBEDTLS_ERR_MPI_NOT_ACCEPTABLE) {
Jerome Forissier79013242021-07-28 10:24:04 +02001722 ret = MBEDTLS_ERR_ECP_RANDOM_FAILED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001723 }
1724 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001725#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02001726}
1727
1728/*
1729 * Check and define parameters used by the comb method (see below for details)
1730 */
1731#if MBEDTLS_ECP_WINDOW_SIZE < 2 || MBEDTLS_ECP_WINDOW_SIZE > 7
1732#error "MBEDTLS_ECP_WINDOW_SIZE out of bounds"
1733#endif
1734
1735/* d = ceil( n / w ) */
Jens Wiklander32b31802023-10-06 16:59:46 +02001736#define COMB_MAX_D (MBEDTLS_ECP_MAX_BITS + 1) / 2
Jens Wiklander817466c2018-05-22 13:49:31 +02001737
1738/* number of precomputed points */
Jens Wiklander32b31802023-10-06 16:59:46 +02001739#define COMB_MAX_PRE (1 << (MBEDTLS_ECP_WINDOW_SIZE - 1))
Jens Wiklander817466c2018-05-22 13:49:31 +02001740
1741/*
1742 * Compute the representation of m that will be used with our comb method.
1743 *
1744 * The basic comb method is described in GECC 3.44 for example. We use a
1745 * modified version that provides resistance to SPA by avoiding zero
1746 * digits in the representation as in [3]. We modify the method further by
1747 * requiring that all K_i be odd, which has the small cost that our
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001748 * representation uses one more K_i, due to carries, but saves on the size of
1749 * the precomputed table.
Jens Wiklander817466c2018-05-22 13:49:31 +02001750 *
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001751 * Summary of the comb method and its modifications:
1752 *
1753 * - The goal is to compute m*P for some w*d-bit integer m.
1754 *
1755 * - The basic comb method splits m into the w-bit integers
1756 * x[0] .. x[d-1] where x[i] consists of the bits in m whose
1757 * index has residue i modulo d, and computes m * P as
1758 * S[x[0]] + 2 * S[x[1]] + .. + 2^(d-1) S[x[d-1]], where
1759 * S[i_{w-1} .. i_0] := i_{w-1} 2^{(w-1)d} P + ... + i_1 2^d P + i_0 P.
1760 *
1761 * - If it happens that, say, x[i+1]=0 (=> S[x[i+1]]=0), one can replace the sum by
1762 * .. + 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]] ..,
1763 * thereby successively converting it into a form where all summands
1764 * are nonzero, at the cost of negative summands. This is the basic idea of [3].
1765 *
1766 * - More generally, even if x[i+1] != 0, we can first transform the sum as
1767 * .. - 2^i S[x[i]] + 2^{i+1} ( S[x[i]] + S[x[i+1]] ) + 2^{i+2} S[x[i+2]] ..,
1768 * and then replace S[x[i]] + S[x[i+1]] = S[x[i] ^ x[i+1]] + 2 S[x[i] & x[i+1]].
1769 * Performing and iterating this procedure for those x[i] that are even
1770 * (keeping track of carry), we can transform the original sum into one of the form
1771 * S[x'[0]] +- 2 S[x'[1]] +- .. +- 2^{d-1} S[x'[d-1]] + 2^d S[x'[d]]
1772 * with all x'[i] odd. It is therefore only necessary to know S at odd indices,
1773 * which is why we are only computing half of it in the first place in
1774 * ecp_precompute_comb and accessing it with index abs(i) / 2 in ecp_select_comb.
1775 *
1776 * - For the sake of compactness, only the seven low-order bits of x[i]
1777 * are used to represent its absolute value (K_i in the paper), and the msb
1778 * of x[i] encodes the sign (s_i in the paper): it is set if and only if
1779 * if s_i == -1;
Jens Wiklander817466c2018-05-22 13:49:31 +02001780 *
1781 * Calling conventions:
1782 * - x is an array of size d + 1
1783 * - w is the size, ie number of teeth, of the comb, and must be between
1784 * 2 and 7 (in practice, between 2 and MBEDTLS_ECP_WINDOW_SIZE)
1785 * - m is the MPI, expected to be odd and such that bitlength(m) <= w * d
1786 * (the result will be incorrect if these assumptions are not satisfied)
1787 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001788static void ecp_comb_recode_core(unsigned char x[], size_t d,
1789 unsigned char w, const mbedtls_mpi *m)
Jens Wiklander817466c2018-05-22 13:49:31 +02001790{
1791 size_t i, j;
1792 unsigned char c, cc, adjust;
1793
Jens Wiklander32b31802023-10-06 16:59:46 +02001794 memset(x, 0, d+1);
Jens Wiklander817466c2018-05-22 13:49:31 +02001795
1796 /* First get the classical comb values (except for x_d = 0) */
Jens Wiklander32b31802023-10-06 16:59:46 +02001797 for (i = 0; i < d; i++) {
1798 for (j = 0; j < w; j++) {
1799 x[i] |= mbedtls_mpi_get_bit(m, i + d * j) << j;
1800 }
1801 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001802
1803 /* Now make sure x_1 .. x_d are odd */
1804 c = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02001805 for (i = 1; i <= d; i++) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001806 /* Add carry and update it */
1807 cc = x[i] & c;
1808 x[i] = x[i] ^ c;
1809 c = cc;
1810
1811 /* Adjust if needed, avoiding branches */
Jens Wiklander32b31802023-10-06 16:59:46 +02001812 adjust = 1 - (x[i] & 0x01);
1813 c |= x[i] & (x[i-1] * adjust);
1814 x[i] = x[i] ^ (x[i-1] * adjust);
Jens Wiklander817466c2018-05-22 13:49:31 +02001815 x[i-1] |= adjust << 7;
1816 }
1817}
1818
1819/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001820 * Precompute points for the adapted comb method
Jens Wiklander817466c2018-05-22 13:49:31 +02001821 *
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001822 * Assumption: T must be able to hold 2^{w - 1} elements.
Jens Wiklander817466c2018-05-22 13:49:31 +02001823 *
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001824 * Operation: If i = i_{w-1} ... i_1 is the binary representation of i,
1825 * sets T[i] = i_{w-1} 2^{(w-1)d} P + ... + i_1 2^d P + P.
Jens Wiklander817466c2018-05-22 13:49:31 +02001826 *
1827 * 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 +01001828 *
1829 * Note: Even comb values (those where P would be omitted from the
1830 * sum defining T[i] above) are not needed in our adaption
1831 * the comb method. See ecp_comb_recode_core().
1832 *
1833 * This function currently works in four steps:
1834 * (1) [dbl] Computation of intermediate T[i] for 2-power values of i
1835 * (2) [norm_dbl] Normalization of coordinates of these T[i]
1836 * (3) [add] Computation of all T[i]
1837 * (4) [norm_add] Normalization of all T[i]
1838 *
1839 * Step 1 can be interrupted but not the others; together with the final
1840 * coordinate normalization they are the largest steps done at once, depending
1841 * on the window size. Here are operation counts for P-256:
1842 *
1843 * step (2) (3) (4)
1844 * w = 5 142 165 208
1845 * w = 4 136 77 160
1846 * w = 3 130 33 136
1847 * w = 2 124 11 124
1848 *
1849 * So if ECC operations are blocking for too long even with a low max_ops
1850 * value, it's useful to set MBEDTLS_ECP_WINDOW_SIZE to a lower value in order
1851 * to minimize maximum blocking time.
Jens Wiklander817466c2018-05-22 13:49:31 +02001852 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001853static int ecp_precompute_comb(const mbedtls_ecp_group *grp,
1854 mbedtls_ecp_point T[], const mbedtls_ecp_point *P,
1855 unsigned char w, size_t d,
1856 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +02001857{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001858 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001859 unsigned char i;
1860 size_t j = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02001861 const unsigned char T_size = 1U << (w - 1);
1862 mbedtls_ecp_point *cur, *TT[COMB_MAX_PRE - 1] = { NULL };
1863
1864 mbedtls_mpi tmp[4];
1865
1866 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander817466c2018-05-22 13:49:31 +02001867
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001868#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001869 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
1870 if (rs_ctx->rsm->state == ecp_rsm_pre_dbl) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001871 goto dbl;
Jens Wiklander32b31802023-10-06 16:59:46 +02001872 }
1873 if (rs_ctx->rsm->state == ecp_rsm_pre_norm_dbl) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001874 goto norm_dbl;
Jens Wiklander32b31802023-10-06 16:59:46 +02001875 }
1876 if (rs_ctx->rsm->state == ecp_rsm_pre_add) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001877 goto add;
Jens Wiklander32b31802023-10-06 16:59:46 +02001878 }
1879 if (rs_ctx->rsm->state == ecp_rsm_pre_norm_add) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001880 goto norm_add;
Jens Wiklander32b31802023-10-06 16:59:46 +02001881 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001882 }
1883#else
1884 (void) rs_ctx;
1885#endif
1886
1887#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001888 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001889 rs_ctx->rsm->state = ecp_rsm_pre_dbl;
1890
1891 /* initial state for the loop */
1892 rs_ctx->rsm->i = 0;
1893 }
1894
1895dbl:
1896#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02001897 /*
1898 * Set T[0] = P and
1899 * T[2^{l-1}] = 2^{dl} P for l = 1 .. w-1 (this is not the final value)
1900 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001901 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(&T[0], P));
Jens Wiklander817466c2018-05-22 13:49:31 +02001902
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001903#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001904 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->i != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001905 j = rs_ctx->rsm->i;
Jens Wiklander32b31802023-10-06 16:59:46 +02001906 } else
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001907#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02001908 j = 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001909
Jens Wiklander32b31802023-10-06 16:59:46 +02001910 for (; j < d * (w - 1); j++) {
1911 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_DBL);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001912
Jens Wiklander32b31802023-10-06 16:59:46 +02001913 i = 1U << (j / d);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001914 cur = T + i;
1915
Jens Wiklander32b31802023-10-06 16:59:46 +02001916 if (j % d == 0) {
1917 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(cur, T + (i >> 1)));
1918 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001919
Jens Wiklander32b31802023-10-06 16:59:46 +02001920 MBEDTLS_MPI_CHK(ecp_double_jac(grp, cur, cur, tmp));
Jens Wiklander817466c2018-05-22 13:49:31 +02001921 }
1922
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001923#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001924 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001925 rs_ctx->rsm->state = ecp_rsm_pre_norm_dbl;
Jens Wiklander32b31802023-10-06 16:59:46 +02001926 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001927
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001928norm_dbl:
1929#endif
1930 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02001931 * Normalize current elements in T to allow them to be used in
1932 * ecp_add_mixed() below, which requires one normalized input.
1933 *
1934 * As T has holes, use an auxiliary array of pointers to elements in T.
1935 *
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001936 */
1937 j = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02001938 for (i = 1; i < T_size; i <<= 1) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001939 TT[j++] = T + i;
Jens Wiklander32b31802023-10-06 16:59:46 +02001940 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001941
Jens Wiklander32b31802023-10-06 16:59:46 +02001942 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV + 6 * j - 2);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001943
Jens Wiklander32b31802023-10-06 16:59:46 +02001944 MBEDTLS_MPI_CHK(ecp_normalize_jac_many(grp, TT, j));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001945
1946#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001947 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001948 rs_ctx->rsm->state = ecp_rsm_pre_add;
Jens Wiklander32b31802023-10-06 16:59:46 +02001949 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001950
1951add:
1952#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02001953 /*
1954 * Compute the remaining ones using the minimal number of additions
1955 * Be careful to update T[2^l] only after using it!
1956 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001957 MBEDTLS_ECP_BUDGET((T_size - 1) * MBEDTLS_ECP_OPS_ADD);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001958
Jens Wiklander32b31802023-10-06 16:59:46 +02001959 for (i = 1; i < T_size; i <<= 1) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001960 j = i;
Jens Wiklander32b31802023-10-06 16:59:46 +02001961 while (j--) {
1962 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, &T[i + j], &T[j], &T[i], tmp));
1963 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001964 }
1965
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001966#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02001967 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001968 rs_ctx->rsm->state = ecp_rsm_pre_norm_add;
Jens Wiklander32b31802023-10-06 16:59:46 +02001969 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001970
1971norm_add:
1972#endif
1973 /*
1974 * Normalize final elements in T. Even though there are no holes now, we
1975 * still need the auxiliary array for homogeneity with the previous
1976 * call. Also, skip T[0] which is already normalised, being a copy of P.
1977 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001978 for (j = 0; j + 1 < T_size; j++) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001979 TT[j] = T + j + 1;
Jens Wiklander32b31802023-10-06 16:59:46 +02001980 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001981
Jens Wiklander32b31802023-10-06 16:59:46 +02001982 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV + 6 * j - 2);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001983
Jens Wiklander32b31802023-10-06 16:59:46 +02001984 MBEDTLS_MPI_CHK(ecp_normalize_jac_many(grp, TT, j));
1985
1986 /* Free Z coordinate (=1 after normalization) to save RAM.
1987 * This makes T[i] invalid as mbedtls_ecp_points, but this is OK
1988 * since from this point onwards, they are only accessed indirectly
1989 * via the getter function ecp_select_comb() which does set the
1990 * target's Z coordinate to 1. */
1991 for (i = 0; i < T_size; i++) {
1992 mbedtls_mpi_free(&T[i].Z);
1993 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001994
1995cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02001996
1997 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
1998
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001999#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002000 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2001 ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
2002 if (rs_ctx->rsm->state == ecp_rsm_pre_dbl) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002003 rs_ctx->rsm->i = j;
Jens Wiklander32b31802023-10-06 16:59:46 +02002004 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002005 }
2006#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02002007
Jens Wiklander32b31802023-10-06 16:59:46 +02002008 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002009}
2010
2011/*
2012 * Select precomputed point: R = sign(i) * T[ abs(i) / 2 ]
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002013 *
2014 * See ecp_comb_recode_core() for background
Jens Wiklander817466c2018-05-22 13:49:31 +02002015 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002016static int ecp_select_comb(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2017 const mbedtls_ecp_point T[], unsigned char T_size,
2018 unsigned char i)
Jens Wiklander817466c2018-05-22 13:49:31 +02002019{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002020 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002021 unsigned char ii, j;
2022
2023 /* Ignore the "sign" bit and scale down */
Jens Wiklander32b31802023-10-06 16:59:46 +02002024 ii = (i & 0x7Fu) >> 1;
Jens Wiklander817466c2018-05-22 13:49:31 +02002025
2026 /* Read the whole table to thwart cache-based timing attacks */
Jens Wiklander32b31802023-10-06 16:59:46 +02002027 for (j = 0; j < T_size; j++) {
2028 MPI_ECP_COND_ASSIGN(&R->X, &T[j].X, j == ii);
2029 MPI_ECP_COND_ASSIGN(&R->Y, &T[j].Y, j == ii);
Jens Wiklander817466c2018-05-22 13:49:31 +02002030 }
2031
2032 /* Safely invert result if i is "negative" */
Jens Wiklander32b31802023-10-06 16:59:46 +02002033 MBEDTLS_MPI_CHK(ecp_safe_invert_jac(grp, R, i >> 7));
2034
2035 MPI_ECP_LSET(&R->Z, 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02002036
2037cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002038 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002039}
2040
2041/*
2042 * Core multiplication algorithm for the (modified) comb method.
2043 * This part is actually common with the basic comb method (GECC 3.44)
2044 *
2045 * Cost: d A + d D + 1 R
2046 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002047static int ecp_mul_comb_core(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2048 const mbedtls_ecp_point T[], unsigned char T_size,
2049 const unsigned char x[], size_t d,
2050 int (*f_rng)(void *, unsigned char *, size_t),
2051 void *p_rng,
2052 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +02002053{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002054 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002055 mbedtls_ecp_point Txi;
Jens Wiklander32b31802023-10-06 16:59:46 +02002056 mbedtls_mpi tmp[4];
Jens Wiklander817466c2018-05-22 13:49:31 +02002057 size_t i;
2058
Jens Wiklander32b31802023-10-06 16:59:46 +02002059 mbedtls_ecp_point_init(&Txi);
2060 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander817466c2018-05-22 13:49:31 +02002061
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002062#if !defined(MBEDTLS_ECP_RESTARTABLE)
2063 (void) rs_ctx;
2064#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02002065
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002066#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002067 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2068 rs_ctx->rsm->state != ecp_rsm_comb_core) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002069 rs_ctx->rsm->i = 0;
2070 rs_ctx->rsm->state = ecp_rsm_comb_core;
2071 }
2072
2073 /* new 'if' instead of nested for the sake of the 'else' branch */
Jens Wiklander32b31802023-10-06 16:59:46 +02002074 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->i != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002075 /* restore current index (R already pointing to rs_ctx->rsm->R) */
2076 i = rs_ctx->rsm->i;
Jens Wiklander32b31802023-10-06 16:59:46 +02002077 } else
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002078#endif
2079 {
2080 /* Start with a non-zero point and randomize its coordinates */
2081 i = d;
Jens Wiklander32b31802023-10-06 16:59:46 +02002082 MBEDTLS_MPI_CHK(ecp_select_comb(grp, R, T, T_size, x[i]));
2083 if (f_rng != 0) {
2084 MBEDTLS_MPI_CHK(ecp_randomize_jac(grp, R, f_rng, p_rng));
2085 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002086 }
2087
Jens Wiklander32b31802023-10-06 16:59:46 +02002088 while (i != 0) {
2089 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_DBL + MBEDTLS_ECP_OPS_ADD);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002090 --i;
2091
Jens Wiklander32b31802023-10-06 16:59:46 +02002092 MBEDTLS_MPI_CHK(ecp_double_jac(grp, R, R, tmp));
2093 MBEDTLS_MPI_CHK(ecp_select_comb(grp, &Txi, T, T_size, x[i]));
2094 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, R, R, &Txi, tmp));
Jens Wiklander817466c2018-05-22 13:49:31 +02002095 }
2096
2097cleanup:
2098
Jens Wiklander32b31802023-10-06 16:59:46 +02002099 mbedtls_ecp_point_free(&Txi);
2100 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander817466c2018-05-22 13:49:31 +02002101
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002102#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002103 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2104 ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002105 rs_ctx->rsm->i = i;
2106 /* no need to save R, already pointing to rs_ctx->rsm->R */
2107 }
2108#endif
2109
Jens Wiklander32b31802023-10-06 16:59:46 +02002110 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002111}
2112
2113/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002114 * Recode the scalar to get constant-time comb multiplication
2115 *
2116 * As the actual scalar recoding needs an odd scalar as a starting point,
2117 * this wrapper ensures that by replacing m by N - m if necessary, and
2118 * informs the caller that the result of multiplication will be negated.
2119 *
2120 * This works because we only support large prime order for Short Weierstrass
2121 * curves, so N is always odd hence either m or N - m is.
2122 *
2123 * See ecp_comb_recode_core() for background.
Jens Wiklander817466c2018-05-22 13:49:31 +02002124 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002125static int ecp_comb_recode_scalar(const mbedtls_ecp_group *grp,
2126 const mbedtls_mpi *m,
2127 unsigned char k[COMB_MAX_D + 1],
2128 size_t d,
2129 unsigned char w,
2130 unsigned char *parity_trick)
Jens Wiklander817466c2018-05-22 13:49:31 +02002131{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002133 mbedtls_mpi M, mm;
2134
Jens Wiklander32b31802023-10-06 16:59:46 +02002135 mbedtls_mpi_init(&M);
2136 mbedtls_mpi_init(&mm);
Jens Wiklander817466c2018-05-22 13:49:31 +02002137
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002138 /* N is always odd (see above), just make extra sure */
Jens Wiklander32b31802023-10-06 16:59:46 +02002139 if (mbedtls_mpi_get_bit(&grp->N, 0) != 1) {
2140 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2141 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002142
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002143 /* do we need the parity trick? */
Jens Wiklander32b31802023-10-06 16:59:46 +02002144 *parity_trick = (mbedtls_mpi_get_bit(m, 0) == 0);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002145
2146 /* execute parity fix in constant time */
Jens Wiklander32b31802023-10-06 16:59:46 +02002147 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&M, m));
2148 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&mm, &grp->N, m));
2149 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign(&M, &mm, *parity_trick));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002150
2151 /* actual scalar recoding */
Jens Wiklander32b31802023-10-06 16:59:46 +02002152 ecp_comb_recode_core(k, d, w, &M);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002153
2154cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002155 mbedtls_mpi_free(&mm);
2156 mbedtls_mpi_free(&M);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002157
Jens Wiklander32b31802023-10-06 16:59:46 +02002158 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002159}
2160
2161/*
2162 * Perform comb multiplication (for short Weierstrass curves)
2163 * once the auxiliary table has been pre-computed.
2164 *
2165 * Scalar recoding may use a parity trick that makes us compute -m * P,
2166 * if that is the case we'll need to recover m * P at the end.
2167 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002168static int ecp_mul_comb_after_precomp(const mbedtls_ecp_group *grp,
2169 mbedtls_ecp_point *R,
2170 const mbedtls_mpi *m,
2171 const mbedtls_ecp_point *T,
2172 unsigned char T_size,
2173 unsigned char w,
2174 size_t d,
2175 int (*f_rng)(void *, unsigned char *, size_t),
2176 void *p_rng,
2177 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002178{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002179 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002180 unsigned char parity_trick;
2181 unsigned char k[COMB_MAX_D + 1];
2182 mbedtls_ecp_point *RR = R;
2183
2184#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002185 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002186 RR = &rs_ctx->rsm->R;
2187
Jens Wiklander32b31802023-10-06 16:59:46 +02002188 if (rs_ctx->rsm->state == ecp_rsm_final_norm) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002189 goto final_norm;
Jens Wiklander32b31802023-10-06 16:59:46 +02002190 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002191 }
2192#endif
2193
Jens Wiklander32b31802023-10-06 16:59:46 +02002194 MBEDTLS_MPI_CHK(ecp_comb_recode_scalar(grp, m, k, d, w,
2195 &parity_trick));
2196 MBEDTLS_MPI_CHK(ecp_mul_comb_core(grp, RR, T, T_size, k, d,
2197 f_rng, p_rng, rs_ctx));
2198 MBEDTLS_MPI_CHK(ecp_safe_invert_jac(grp, RR, parity_trick));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002199
2200#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002201 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002202 rs_ctx->rsm->state = ecp_rsm_final_norm;
Jens Wiklander32b31802023-10-06 16:59:46 +02002203 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002204
2205final_norm:
Jens Wiklander32b31802023-10-06 16:59:46 +02002206 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002207#endif
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002208 /*
2209 * Knowledge of the jacobian coordinates may leak the last few bits of the
2210 * scalar [1], and since our MPI implementation isn't constant-flow,
2211 * inversion (used for coordinate normalization) may leak the full value
2212 * of its input via side-channels [2].
2213 *
2214 * [1] https://eprint.iacr.org/2003/191
2215 * [2] https://eprint.iacr.org/2020/055
2216 *
2217 * Avoid the leak by randomizing coordinates before we normalize them.
2218 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002219 if (f_rng != 0) {
2220 MBEDTLS_MPI_CHK(ecp_randomize_jac(grp, RR, f_rng, p_rng));
2221 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002222
Jens Wiklander32b31802023-10-06 16:59:46 +02002223 MBEDTLS_MPI_CHK(ecp_normalize_jac(grp, RR));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002224
2225#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002226 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
2227 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, RR));
2228 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002229#endif
2230
2231cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002232 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002233}
2234
2235/*
2236 * Pick window size based on curve size and whether we optimize for base point
2237 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002238static unsigned char ecp_pick_window_size(const mbedtls_ecp_group *grp,
2239 unsigned char p_eq_g)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002240{
2241 unsigned char w;
2242
Jens Wiklander817466c2018-05-22 13:49:31 +02002243 /*
2244 * Minimize the number of multiplications, that is minimize
2245 * 10 * d * w + 18 * 2^(w-1) + 11 * d + 7 * w, with d = ceil( nbits / w )
2246 * (see costs of the various parts, with 1S = 1M)
2247 */
2248 w = grp->nbits >= 384 ? 5 : 4;
2249
2250 /*
2251 * If P == G, pre-compute a bit more, since this may be re-used later.
2252 * Just adding one avoids upping the cost of the first mul too much,
2253 * and the memory cost too.
2254 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002255 if (p_eq_g) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002256 w++;
Jens Wiklander32b31802023-10-06 16:59:46 +02002257 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002258
2259 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02002260 * If static comb table may not be used (!p_eq_g) or static comb table does
2261 * not exists, make sure w is within bounds.
Jens Wiklander817466c2018-05-22 13:49:31 +02002262 * (The last test is useful only for very small curves in the test suite.)
Jens Wiklander32b31802023-10-06 16:59:46 +02002263 *
2264 * The user reduces MBEDTLS_ECP_WINDOW_SIZE does not changes the size of
2265 * static comb table, because the size of static comb table is fixed when
2266 * it is generated.
Jens Wiklander817466c2018-05-22 13:49:31 +02002267 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002268#if (MBEDTLS_ECP_WINDOW_SIZE < 6)
2269 if ((!p_eq_g || !ecp_group_is_static_comb_table(grp)) && w > MBEDTLS_ECP_WINDOW_SIZE) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002270 w = MBEDTLS_ECP_WINDOW_SIZE;
Jens Wiklander32b31802023-10-06 16:59:46 +02002271 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002272#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002273 if (w >= grp->nbits) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002274 w = 2;
Jens Wiklander32b31802023-10-06 16:59:46 +02002275 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002276
Jens Wiklander32b31802023-10-06 16:59:46 +02002277 return w;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002278}
2279
2280/*
2281 * Multiplication using the comb method - for curves in short Weierstrass form
2282 *
2283 * This function is mainly responsible for administrative work:
2284 * - managing the restart context if enabled
2285 * - managing the table of precomputed points (passed between the below two
Jerome Forissier039e02d2022-08-09 17:10:15 +02002286 * functions): allocation, computation, ownership transfer, freeing.
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002287 *
2288 * It delegates the actual arithmetic work to:
2289 * ecp_precompute_comb() and ecp_mul_comb_with_precomp()
2290 *
2291 * See comments on ecp_comb_recode_core() regarding the computation strategy.
2292 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002293static int ecp_mul_comb(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2294 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2295 int (*f_rng)(void *, unsigned char *, size_t),
2296 void *p_rng,
2297 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002298{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002299 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002300 unsigned char w, p_eq_g, i;
2301 size_t d;
Jerome Forissier79013242021-07-28 10:24:04 +02002302 unsigned char T_size = 0, T_ok = 0;
2303 mbedtls_ecp_point *T = NULL;
Jerome Forissier79013242021-07-28 10:24:04 +02002304
Jens Wiklander32b31802023-10-06 16:59:46 +02002305 ECP_RS_ENTER(rsm);
Jerome Forissier79013242021-07-28 10:24:04 +02002306
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002307 /* Is P the base point ? */
2308#if MBEDTLS_ECP_FIXED_POINT_OPTIM == 1
Jens Wiklander32b31802023-10-06 16:59:46 +02002309 p_eq_g = (MPI_ECP_CMP(&P->Y, &grp->G.Y) == 0 &&
2310 MPI_ECP_CMP(&P->X, &grp->G.X) == 0);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002311#else
2312 p_eq_g = 0;
2313#endif
2314
2315 /* Pick window size and deduce related sizes */
Jens Wiklander32b31802023-10-06 16:59:46 +02002316 w = ecp_pick_window_size(grp, p_eq_g);
2317 T_size = 1U << (w - 1);
2318 d = (grp->nbits + w - 1) / w;
Jens Wiklander817466c2018-05-22 13:49:31 +02002319
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002320 /* Pre-computed table: do we have it already for the base point? */
Jens Wiklander32b31802023-10-06 16:59:46 +02002321 if (p_eq_g && grp->T != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002322 /* second pointer to the same table, will be deleted on exit */
2323 T = grp->T;
2324 T_ok = 1;
Jens Wiklander32b31802023-10-06 16:59:46 +02002325 } else
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002326#if defined(MBEDTLS_ECP_RESTARTABLE)
2327 /* Pre-computed table: do we have one in progress? complete? */
Jens Wiklander32b31802023-10-06 16:59:46 +02002328 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->T != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002329 /* transfer ownership of T from rsm to local function */
2330 T = rs_ctx->rsm->T;
2331 rs_ctx->rsm->T = NULL;
2332 rs_ctx->rsm->T_size = 0;
2333
2334 /* This effectively jumps to the call to mul_comb_after_precomp() */
2335 T_ok = rs_ctx->rsm->state >= ecp_rsm_comb_core;
Jens Wiklander32b31802023-10-06 16:59:46 +02002336 } else
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002337#endif
2338 /* Allocate table if we didn't have any */
2339 {
Jens Wiklander32b31802023-10-06 16:59:46 +02002340 T = mbedtls_calloc(T_size, sizeof(mbedtls_ecp_point));
2341 if (T == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002342 ret = MBEDTLS_ERR_ECP_ALLOC_FAILED;
2343 goto cleanup;
2344 }
2345
Jens Wiklander32b31802023-10-06 16:59:46 +02002346 for (i = 0; i < T_size; i++) {
2347 mbedtls_ecp_point_init(&T[i]);
2348 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002349
2350 T_ok = 0;
2351 }
2352
2353 /* Compute table (or finish computing it) if not done already */
Jens Wiklander32b31802023-10-06 16:59:46 +02002354 if (!T_ok) {
2355 MBEDTLS_MPI_CHK(ecp_precompute_comb(grp, T, P, w, d, rs_ctx));
Jens Wiklander817466c2018-05-22 13:49:31 +02002356
Jens Wiklander32b31802023-10-06 16:59:46 +02002357 if (p_eq_g) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002358 /* almost transfer ownership of T to the group, but keep a copy of
2359 * the pointer to use for calling the next function more easily */
Jens Wiklander817466c2018-05-22 13:49:31 +02002360 grp->T = T;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002361 grp->T_size = T_size;
Jens Wiklander817466c2018-05-22 13:49:31 +02002362 }
2363 }
2364
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002365 /* Actual comb multiplication using precomputed points */
Jens Wiklander32b31802023-10-06 16:59:46 +02002366 MBEDTLS_MPI_CHK(ecp_mul_comb_after_precomp(grp, R, m,
2367 T, T_size, w, d,
2368 f_rng, p_rng, rs_ctx));
Jens Wiklander817466c2018-05-22 13:49:31 +02002369
2370cleanup:
2371
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002372 /* does T belong to the group? */
Jens Wiklander32b31802023-10-06 16:59:46 +02002373 if (T == grp->T) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002374 T = NULL;
Jens Wiklander32b31802023-10-06 16:59:46 +02002375 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002376
2377 /* does T belong to the restart context? */
2378#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002379 if (rs_ctx != NULL && rs_ctx->rsm != NULL && ret == MBEDTLS_ERR_ECP_IN_PROGRESS && T != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002380 /* transfer ownership of T from local function to rsm */
2381 rs_ctx->rsm->T_size = T_size;
2382 rs_ctx->rsm->T = T;
2383 T = NULL;
2384 }
2385#endif
2386
2387 /* did T belong to us? then let's destroy it! */
Jens Wiklander32b31802023-10-06 16:59:46 +02002388 if (T != NULL) {
2389 for (i = 0; i < T_size; i++) {
2390 mbedtls_ecp_point_free(&T[i]);
2391 }
2392 mbedtls_free(T);
Jens Wiklander817466c2018-05-22 13:49:31 +02002393 }
2394
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002395 /* prevent caller from using invalid value */
Jens Wiklander32b31802023-10-06 16:59:46 +02002396 int should_free_R = (ret != 0);
2397#if defined(MBEDTLS_ECP_RESTARTABLE)
2398 /* don't free R while in progress in case R == P */
2399 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
2400 should_free_R = 0;
2401 }
2402#endif
2403 if (should_free_R) {
2404 mbedtls_ecp_point_free(R);
2405 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002406
Jens Wiklander32b31802023-10-06 16:59:46 +02002407 ECP_RS_LEAVE(rsm);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002408
Jens Wiklander32b31802023-10-06 16:59:46 +02002409 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002410}
2411
Jerome Forissier79013242021-07-28 10:24:04 +02002412#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02002413
Jerome Forissier79013242021-07-28 10:24:04 +02002414#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02002415/*
2416 * For Montgomery curves, we do all the internal arithmetic in projective
2417 * coordinates. Import/export of points uses only the x coordinates, which is
Jerome Forissier039e02d2022-08-09 17:10:15 +02002418 * internally represented as X / Z.
Jens Wiklander817466c2018-05-22 13:49:31 +02002419 *
2420 * For scalar multiplication, we'll use a Montgomery ladder.
2421 */
2422
2423/*
2424 * Normalize Montgomery x/z coordinates: X = X/Z, Z = 1
2425 * Cost: 1M + 1I
2426 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002427static int ecp_normalize_mxz(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P)
Jens Wiklander817466c2018-05-22 13:49:31 +02002428{
Jens Wiklander817466c2018-05-22 13:49:31 +02002429#if defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002430 if (mbedtls_internal_ecp_grp_capable(grp)) {
2431 return mbedtls_internal_ecp_normalize_mxz(grp, P);
2432 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002433#endif /* MBEDTLS_ECP_NORMALIZE_MXZ_ALT */
2434
Jerome Forissier79013242021-07-28 10:24:04 +02002435#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002436 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02002437#else
2438 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02002439 MPI_ECP_INV(&P->Z, &P->Z);
2440 MPI_ECP_MUL(&P->X, &P->X, &P->Z);
2441 MPI_ECP_LSET(&P->Z, 1);
Jens Wiklander817466c2018-05-22 13:49:31 +02002442
2443cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002444 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02002445#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02002446}
2447
2448/*
2449 * Randomize projective x/z coordinates:
2450 * (X, Z) -> (l X, l Z) for random l
2451 * This is sort of the reverse operation of ecp_normalize_mxz().
2452 *
2453 * This countermeasure was first suggested in [2].
2454 * Cost: 2M
2455 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002456static int ecp_randomize_mxz(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P,
2457 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02002458{
Jens Wiklander817466c2018-05-22 13:49:31 +02002459#if defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002460 if (mbedtls_internal_ecp_grp_capable(grp)) {
2461 return mbedtls_internal_ecp_randomize_mxz(grp, P, f_rng, p_rng);
2462 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002463#endif /* MBEDTLS_ECP_RANDOMIZE_MXZ_ALT */
2464
Jerome Forissier79013242021-07-28 10:24:04 +02002465#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002466 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02002467#else
2468 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2469 mbedtls_mpi l;
Jens Wiklander32b31802023-10-06 16:59:46 +02002470 mbedtls_mpi_init(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02002471
2472 /* Generate l such that 1 < l < p */
Jens Wiklander32b31802023-10-06 16:59:46 +02002473 MPI_ECP_RAND(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02002474
Jens Wiklander32b31802023-10-06 16:59:46 +02002475 MPI_ECP_MUL(&P->X, &P->X, &l);
2476 MPI_ECP_MUL(&P->Z, &P->Z, &l);
Jens Wiklander817466c2018-05-22 13:49:31 +02002477
2478cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002479 mbedtls_mpi_free(&l);
Jens Wiklander817466c2018-05-22 13:49:31 +02002480
Jens Wiklander32b31802023-10-06 16:59:46 +02002481 if (ret == MBEDTLS_ERR_MPI_NOT_ACCEPTABLE) {
Jerome Forissier79013242021-07-28 10:24:04 +02002482 ret = MBEDTLS_ERR_ECP_RANDOM_FAILED;
Jens Wiklander32b31802023-10-06 16:59:46 +02002483 }
2484 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02002485#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02002486}
2487
2488/*
2489 * Double-and-add: R = 2P, S = P + Q, with d = X(P - Q),
2490 * for Montgomery curves in x/z coordinates.
2491 *
2492 * http://www.hyperelliptic.org/EFD/g1p/auto-code/montgom/xz/ladder/mladd-1987-m.op3
2493 * with
2494 * d = X1
2495 * P = (X2, Z2)
2496 * Q = (X3, Z3)
2497 * R = (X4, Z4)
2498 * S = (X5, Z5)
2499 * and eliminating temporary variables tO, ..., t4.
2500 *
2501 * Cost: 5M + 4S
2502 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002503static int ecp_double_add_mxz(const mbedtls_ecp_group *grp,
2504 mbedtls_ecp_point *R, mbedtls_ecp_point *S,
2505 const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q,
2506 const mbedtls_mpi *d,
2507 mbedtls_mpi T[4])
Jens Wiklander817466c2018-05-22 13:49:31 +02002508{
Jens Wiklander817466c2018-05-22 13:49:31 +02002509#if defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002510 if (mbedtls_internal_ecp_grp_capable(grp)) {
2511 return mbedtls_internal_ecp_double_add_mxz(grp, R, S, P, Q, d);
2512 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002513#endif /* MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT */
2514
Jerome Forissier79013242021-07-28 10:24:04 +02002515#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002516 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02002517#else
2518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerome Forissier79013242021-07-28 10:24:04 +02002519
Jens Wiklander32b31802023-10-06 16:59:46 +02002520 MPI_ECP_ADD(&T[0], &P->X, &P->Z); /* Pp := PX + PZ */
2521 MPI_ECP_SUB(&T[1], &P->X, &P->Z); /* Pm := PX - PZ */
2522 MPI_ECP_ADD(&T[2], &Q->X, &Q->Z); /* Qp := QX + XZ */
2523 MPI_ECP_SUB(&T[3], &Q->X, &Q->Z); /* Qm := QX - QZ */
2524 MPI_ECP_MUL(&T[3], &T[3], &T[0]); /* Qm * Pp */
2525 MPI_ECP_MUL(&T[2], &T[2], &T[1]); /* Qp * Pm */
2526 MPI_ECP_SQR(&T[0], &T[0]); /* Pp^2 */
2527 MPI_ECP_SQR(&T[1], &T[1]); /* Pm^2 */
2528 MPI_ECP_MUL(&R->X, &T[0], &T[1]); /* Pp^2 * Pm^2 */
2529 MPI_ECP_SUB(&T[0], &T[0], &T[1]); /* Pp^2 - Pm^2 */
2530 MPI_ECP_MUL(&R->Z, &grp->A, &T[0]); /* A * (Pp^2 - Pm^2) */
2531 MPI_ECP_ADD(&R->Z, &T[1], &R->Z); /* [ A * (Pp^2-Pm^2) ] + Pm^2 */
2532 MPI_ECP_ADD(&S->X, &T[3], &T[2]); /* Qm*Pp + Qp*Pm */
2533 MPI_ECP_SQR(&S->X, &S->X); /* (Qm*Pp + Qp*Pm)^2 */
2534 MPI_ECP_SUB(&S->Z, &T[3], &T[2]); /* Qm*Pp - Qp*Pm */
2535 MPI_ECP_SQR(&S->Z, &S->Z); /* (Qm*Pp - Qp*Pm)^2 */
2536 MPI_ECP_MUL(&S->Z, d, &S->Z); /* d * ( Qm*Pp - Qp*Pm )^2 */
2537 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 +02002538
2539cleanup:
Jens Wiklander817466c2018-05-22 13:49:31 +02002540
Jens Wiklander32b31802023-10-06 16:59:46 +02002541 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02002542#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT) */
Jens Wiklander817466c2018-05-22 13:49:31 +02002543}
2544
2545/*
2546 * Multiplication with Montgomery ladder in x/z coordinates,
2547 * for curves in Montgomery form
2548 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002549static int ecp_mul_mxz(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2550 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2551 int (*f_rng)(void *, unsigned char *, size_t),
2552 void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02002553{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002555 size_t i;
2556 unsigned char b;
2557 mbedtls_ecp_point RP;
2558 mbedtls_mpi PX;
Jens Wiklander32b31802023-10-06 16:59:46 +02002559 mbedtls_mpi tmp[4];
2560 mbedtls_ecp_point_init(&RP); mbedtls_mpi_init(&PX);
Jens Wiklander817466c2018-05-22 13:49:31 +02002561
Jens Wiklander32b31802023-10-06 16:59:46 +02002562 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander817466c2018-05-22 13:49:31 +02002563
Jens Wiklander32b31802023-10-06 16:59:46 +02002564 if (f_rng == NULL) {
2565 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jerome Forissier79013242021-07-28 10:24:04 +02002566 }
Jerome Forissier79013242021-07-28 10:24:04 +02002567
Jens Wiklander817466c2018-05-22 13:49:31 +02002568 /* Save PX and read from P before writing to R, in case P == R */
Jens Wiklander32b31802023-10-06 16:59:46 +02002569 MPI_ECP_MOV(&PX, &P->X);
2570 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(&RP, P));
Jens Wiklander817466c2018-05-22 13:49:31 +02002571
2572 /* Set R to zero in modified x/z coordinates */
Jens Wiklander32b31802023-10-06 16:59:46 +02002573 MPI_ECP_LSET(&R->X, 1);
2574 MPI_ECP_LSET(&R->Z, 0);
2575 mbedtls_mpi_free(&R->Y);
Jens Wiklander817466c2018-05-22 13:49:31 +02002576
Jerome Forissier039e02d2022-08-09 17:10:15 +02002577 /* RP.X might be slightly larger than P, so reduce it */
Jens Wiklander32b31802023-10-06 16:59:46 +02002578 MOD_ADD(&RP.X);
Jens Wiklander817466c2018-05-22 13:49:31 +02002579
2580 /* Randomize coordinates of the starting point */
Jens Wiklander32b31802023-10-06 16:59:46 +02002581 MBEDTLS_MPI_CHK(ecp_randomize_mxz(grp, &RP, f_rng, p_rng));
Jens Wiklander817466c2018-05-22 13:49:31 +02002582
2583 /* Loop invariant: R = result so far, RP = R + P */
Jens Wiklander32b31802023-10-06 16:59:46 +02002584 i = grp->nbits + 1; /* one past the (zero-based) required msb for private keys */
2585 while (i-- > 0) {
2586 b = mbedtls_mpi_get_bit(m, i);
Jens Wiklander817466c2018-05-22 13:49:31 +02002587 /*
2588 * if (b) R = 2R + P else R = 2R,
2589 * which is:
2590 * if (b) double_add( RP, R, RP, R )
2591 * else double_add( R, RP, R, RP )
2592 * but using safe conditional swaps to avoid leaks
2593 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002594 MPI_ECP_COND_SWAP(&R->X, &RP.X, b);
2595 MPI_ECP_COND_SWAP(&R->Z, &RP.Z, b);
2596 MBEDTLS_MPI_CHK(ecp_double_add_mxz(grp, R, &RP, R, &RP, &PX, tmp));
2597 MPI_ECP_COND_SWAP(&R->X, &RP.X, b);
2598 MPI_ECP_COND_SWAP(&R->Z, &RP.Z, b);
Jens Wiklander817466c2018-05-22 13:49:31 +02002599 }
2600
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002601 /*
2602 * Knowledge of the projective coordinates may leak the last few bits of the
2603 * scalar [1], and since our MPI implementation isn't constant-flow,
2604 * inversion (used for coordinate normalization) may leak the full value
2605 * of its input via side-channels [2].
2606 *
2607 * [1] https://eprint.iacr.org/2003/191
2608 * [2] https://eprint.iacr.org/2020/055
2609 *
2610 * Avoid the leak by randomizing coordinates before we normalize them.
2611 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002612 MBEDTLS_MPI_CHK(ecp_randomize_mxz(grp, R, f_rng, p_rng));
2613 MBEDTLS_MPI_CHK(ecp_normalize_mxz(grp, R));
Jens Wiklander817466c2018-05-22 13:49:31 +02002614
2615cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002616 mbedtls_ecp_point_free(&RP); mbedtls_mpi_free(&PX);
Jerome Forissier79013242021-07-28 10:24:04 +02002617
Jens Wiklander32b31802023-10-06 16:59:46 +02002618 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
2619 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002620}
2621
Jerome Forissier79013242021-07-28 10:24:04 +02002622#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02002623
2624/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002625 * Restartable multiplication R = m * P
Jens Wiklander32b31802023-10-06 16:59:46 +02002626 *
2627 * This internal function can be called without an RNG in case where we know
2628 * the inputs are not sensitive.
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002629 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002630static int ecp_mul_restartable_internal(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2631 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2632 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
2633 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002634{
2635 int ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2636#if defined(MBEDTLS_ECP_INTERNAL_ALT)
2637 char is_grp_capable = 0;
2638#endif
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002639
2640#if defined(MBEDTLS_ECP_RESTARTABLE)
2641 /* reset ops count for this call if top-level */
Jens Wiklander32b31802023-10-06 16:59:46 +02002642 if (rs_ctx != NULL && rs_ctx->depth++ == 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002643 rs_ctx->ops_done = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02002644 }
Jerome Forissier79013242021-07-28 10:24:04 +02002645#else
2646 (void) rs_ctx;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002647#endif
2648
2649#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002650 if ((is_grp_capable = mbedtls_internal_ecp_grp_capable(grp))) {
2651 MBEDTLS_MPI_CHK(mbedtls_internal_ecp_init(grp));
2652 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002653#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2654
Jens Wiklander32b31802023-10-06 16:59:46 +02002655 int restarting = 0;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002656#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002657 restarting = (rs_ctx != NULL && rs_ctx->rsm != NULL);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002658#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002659 /* skip argument check when restarting */
2660 if (!restarting) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002661 /* check_privkey is free */
Jens Wiklander32b31802023-10-06 16:59:46 +02002662 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_CHK);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002663
2664 /* Common sanity checks */
Jens Wiklander32b31802023-10-06 16:59:46 +02002665 MBEDTLS_MPI_CHK(mbedtls_ecp_check_privkey(grp, m));
2666 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002667 }
2668
2669 ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jerome Forissier79013242021-07-28 10:24:04 +02002670#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02002671 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
2672 MBEDTLS_MPI_CHK(ecp_mul_mxz(grp, R, m, P, f_rng, p_rng));
2673 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002674#endif
Jerome Forissier79013242021-07-28 10:24:04 +02002675#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02002676 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
2677 MBEDTLS_MPI_CHK(ecp_mul_comb(grp, R, m, P, f_rng, p_rng, rs_ctx));
2678 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002679#endif
2680
2681cleanup:
2682
2683#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002684 if (is_grp_capable) {
2685 mbedtls_internal_ecp_free(grp);
2686 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002687#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2688
2689#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002690 if (rs_ctx != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002691 rs_ctx->depth--;
Jens Wiklander32b31802023-10-06 16:59:46 +02002692 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002693#endif
2694
Jens Wiklander32b31802023-10-06 16:59:46 +02002695 return ret;
2696}
2697
2698/*
2699 * Restartable multiplication R = m * P
2700 */
2701int mbedtls_ecp_mul_restartable(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2702 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2703 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
2704 mbedtls_ecp_restart_ctx *rs_ctx)
2705{
2706 if (f_rng == NULL) {
2707 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2708 }
2709
2710 return ecp_mul_restartable_internal(grp, R, m, P, f_rng, p_rng, rs_ctx);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002711}
2712
2713/*
Jens Wiklander817466c2018-05-22 13:49:31 +02002714 * Multiplication R = m * P
2715 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002716int mbedtls_ecp_mul(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2717 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2718 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02002719{
Jens Wiklander32b31802023-10-06 16:59:46 +02002720 return mbedtls_ecp_mul_restartable(grp, R, m, P, f_rng, p_rng, NULL);
Jens Wiklander817466c2018-05-22 13:49:31 +02002721}
Tom Van Eyckc1633172024-04-09 18:44:13 +02002722#endif /* MBEDTLS_ECP_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02002723
Jerome Forissier79013242021-07-28 10:24:04 +02002724#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02002725/*
2726 * Check that an affine point is valid as a public key,
2727 * short weierstrass curves (SEC1 3.2.3.1)
2728 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002729static int ecp_check_pubkey_sw(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +02002730{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002731 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02002732 mbedtls_mpi YY, RHS;
2733
2734 /* pt coordinates must be normalized for our checks */
Jens Wiklander32b31802023-10-06 16:59:46 +02002735 if (mbedtls_mpi_cmp_int(&pt->X, 0) < 0 ||
2736 mbedtls_mpi_cmp_int(&pt->Y, 0) < 0 ||
2737 mbedtls_mpi_cmp_mpi(&pt->X, &grp->P) >= 0 ||
2738 mbedtls_mpi_cmp_mpi(&pt->Y, &grp->P) >= 0) {
2739 return MBEDTLS_ERR_ECP_INVALID_KEY;
2740 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002741
Jens Wiklander32b31802023-10-06 16:59:46 +02002742 mbedtls_mpi_init(&YY); mbedtls_mpi_init(&RHS);
Jens Wiklander817466c2018-05-22 13:49:31 +02002743
2744 /*
2745 * YY = Y^2
Jens Wiklander32b31802023-10-06 16:59:46 +02002746 * RHS = X^3 + A X + B
Jens Wiklander817466c2018-05-22 13:49:31 +02002747 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002748 MPI_ECP_SQR(&YY, &pt->Y);
2749 MBEDTLS_MPI_CHK(ecp_sw_rhs(grp, &RHS, &pt->X));
Jens Wiklander817466c2018-05-22 13:49:31 +02002750
Jens Wiklander32b31802023-10-06 16:59:46 +02002751 if (MPI_ECP_CMP(&YY, &RHS) != 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +02002752 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
Jens Wiklander32b31802023-10-06 16:59:46 +02002753 }
Jens Wiklander817466c2018-05-22 13:49:31 +02002754
2755cleanup:
2756
Jens Wiklander32b31802023-10-06 16:59:46 +02002757 mbedtls_mpi_free(&YY); mbedtls_mpi_free(&RHS);
Jens Wiklander817466c2018-05-22 13:49:31 +02002758
Jens Wiklander32b31802023-10-06 16:59:46 +02002759 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002760}
Jerome Forissier79013242021-07-28 10:24:04 +02002761#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02002762
Tom Van Eyckc1633172024-04-09 18:44:13 +02002763#if defined(MBEDTLS_ECP_C)
Jerome Forissier79013242021-07-28 10:24:04 +02002764#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02002765/*
Jerome Forissier79013242021-07-28 10:24:04 +02002766 * R = m * P with shortcuts for m == 0, m == 1 and m == -1
Jens Wiklander817466c2018-05-22 13:49:31 +02002767 * NOT constant-time - ONLY for short Weierstrass!
2768 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002769static int mbedtls_ecp_mul_shortcuts(mbedtls_ecp_group *grp,
2770 mbedtls_ecp_point *R,
2771 const mbedtls_mpi *m,
2772 const mbedtls_ecp_point *P,
2773 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +02002774{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002775 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02002776 mbedtls_mpi tmp;
2777 mbedtls_mpi_init(&tmp);
Jens Wiklander817466c2018-05-22 13:49:31 +02002778
Jens Wiklander32b31802023-10-06 16:59:46 +02002779 if (mbedtls_mpi_cmp_int(m, 0) == 0) {
2780 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2781 MBEDTLS_MPI_CHK(mbedtls_ecp_set_zero(R));
2782 } else if (mbedtls_mpi_cmp_int(m, 1) == 0) {
2783 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2784 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, P));
2785 } else if (mbedtls_mpi_cmp_int(m, -1) == 0) {
2786 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2787 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, P));
2788 MPI_ECP_NEG(&R->Y);
2789 } else {
2790 MBEDTLS_MPI_CHK(ecp_mul_restartable_internal(grp, R, m, P,
2791 NULL, NULL, rs_ctx));
Jens Wiklander817466c2018-05-22 13:49:31 +02002792 }
2793
2794cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002795 mbedtls_mpi_free(&tmp);
2796
2797 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02002798}
2799
2800/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002801 * Restartable linear combination
2802 * NOT constant-time
2803 */
2804int mbedtls_ecp_muladd_restartable(
Jens Wiklander32b31802023-10-06 16:59:46 +02002805 mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2806 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2807 const mbedtls_mpi *n, const mbedtls_ecp_point *Q,
2808 mbedtls_ecp_restart_ctx *rs_ctx)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002809{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02002810 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002811 mbedtls_ecp_point mP;
2812 mbedtls_ecp_point *pmP = &mP;
2813 mbedtls_ecp_point *pR = R;
Jens Wiklander32b31802023-10-06 16:59:46 +02002814 mbedtls_mpi tmp[4];
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002815#if defined(MBEDTLS_ECP_INTERNAL_ALT)
2816 char is_grp_capable = 0;
2817#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002818 if (mbedtls_ecp_get_type(grp) != MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
2819 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
2820 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002821
Jens Wiklander32b31802023-10-06 16:59:46 +02002822 mbedtls_ecp_point_init(&mP);
2823 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002824
Jens Wiklander32b31802023-10-06 16:59:46 +02002825 ECP_RS_ENTER(ma);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002826
2827#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002828 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002829 /* redirect intermediate results to restart context */
2830 pmP = &rs_ctx->ma->mP;
2831 pR = &rs_ctx->ma->R;
2832
2833 /* jump to next operation */
Jens Wiklander32b31802023-10-06 16:59:46 +02002834 if (rs_ctx->ma->state == ecp_rsma_mul2) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002835 goto mul2;
Jens Wiklander32b31802023-10-06 16:59:46 +02002836 }
2837 if (rs_ctx->ma->state == ecp_rsma_add) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002838 goto add;
Jens Wiklander32b31802023-10-06 16:59:46 +02002839 }
2840 if (rs_ctx->ma->state == ecp_rsma_norm) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002841 goto norm;
Jens Wiklander32b31802023-10-06 16:59:46 +02002842 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002843 }
2844#endif /* MBEDTLS_ECP_RESTARTABLE */
2845
Jens Wiklander32b31802023-10-06 16:59:46 +02002846 MBEDTLS_MPI_CHK(mbedtls_ecp_mul_shortcuts(grp, pmP, m, P, rs_ctx));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002847#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002848 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002849 rs_ctx->ma->state = ecp_rsma_mul2;
Jens Wiklander32b31802023-10-06 16:59:46 +02002850 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002851
2852mul2:
2853#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002854 MBEDTLS_MPI_CHK(mbedtls_ecp_mul_shortcuts(grp, pR, n, Q, rs_ctx));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002855
2856#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002857 if ((is_grp_capable = mbedtls_internal_ecp_grp_capable(grp))) {
2858 MBEDTLS_MPI_CHK(mbedtls_internal_ecp_init(grp));
2859 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002860#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2861
2862#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002863 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002864 rs_ctx->ma->state = ecp_rsma_add;
Jens Wiklander32b31802023-10-06 16:59:46 +02002865 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002866
2867add:
2868#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002869 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_ADD);
2870 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, pR, pmP, pR, tmp));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002871#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002872 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002873 rs_ctx->ma->state = ecp_rsma_norm;
Jens Wiklander32b31802023-10-06 16:59:46 +02002874 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002875
2876norm:
2877#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02002878 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV);
2879 MBEDTLS_MPI_CHK(ecp_normalize_jac(grp, pR));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002880
2881#if defined(MBEDTLS_ECP_RESTARTABLE)
Jens Wiklander32b31802023-10-06 16:59:46 +02002882 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
2883 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, pR));
2884 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002885#endif
2886
2887cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02002888
2889 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
2890
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002891#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Jens Wiklander32b31802023-10-06 16:59:46 +02002892 if (is_grp_capable) {
2893 mbedtls_internal_ecp_free(grp);
2894 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002895#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2896
Jens Wiklander32b31802023-10-06 16:59:46 +02002897 mbedtls_ecp_point_free(&mP);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002898
Jens Wiklander32b31802023-10-06 16:59:46 +02002899 ECP_RS_LEAVE(ma);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002900
Jens Wiklander32b31802023-10-06 16:59:46 +02002901 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01002902}
2903
2904/*
Jens Wiklander817466c2018-05-22 13:49:31 +02002905 * Linear combination
2906 * NOT constant-time
2907 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002908int mbedtls_ecp_muladd(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2909 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2910 const mbedtls_mpi *n, const mbedtls_ecp_point *Q)
Jens Wiklander817466c2018-05-22 13:49:31 +02002911{
Jens Wiklander32b31802023-10-06 16:59:46 +02002912 return mbedtls_ecp_muladd_restartable(grp, R, m, P, n, Q, NULL);
Jens Wiklander817466c2018-05-22 13:49:31 +02002913}
Jerome Forissier79013242021-07-28 10:24:04 +02002914#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Tom Van Eyckc1633172024-04-09 18:44:13 +02002915#endif /* MBEDTLS_ECP_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02002916
Jerome Forissier79013242021-07-28 10:24:04 +02002917#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
2918#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Jens Wiklander8eaf6922018-11-08 11:18:22 +01002919#define ECP_MPI_INIT(_p, _n) { .p = (mbedtls_mpi_uint *) (_p), .s = 1, .n = (_n), .use_mempool = 0 }
Jerome Forissier79013242021-07-28 10:24:04 +02002920#define ECP_MPI_INIT_ARRAY(x) \
Tom Van Eyckc1633172024-04-09 18:44:13 +02002921 ECP_MPI_INIT(x, sizeof(x) / sizeof(mbedtls_mpi_uint))
Jerome Forissier79013242021-07-28 10:24:04 +02002922/*
2923 * Constants for the two points other than 0, 1, -1 (mod p) in
2924 * https://cr.yp.to/ecdh.html#validate
2925 * See ecp_check_pubkey_x25519().
2926 */
2927static const mbedtls_mpi_uint x25519_bad_point_1[] = {
Jens Wiklander32b31802023-10-06 16:59:46 +02002928 MBEDTLS_BYTES_TO_T_UINT_8(0xe0, 0xeb, 0x7a, 0x7c, 0x3b, 0x41, 0xb8, 0xae),
2929 MBEDTLS_BYTES_TO_T_UINT_8(0x16, 0x56, 0xe3, 0xfa, 0xf1, 0x9f, 0xc4, 0x6a),
2930 MBEDTLS_BYTES_TO_T_UINT_8(0xda, 0x09, 0x8d, 0xeb, 0x9c, 0x32, 0xb1, 0xfd),
2931 MBEDTLS_BYTES_TO_T_UINT_8(0x86, 0x62, 0x05, 0x16, 0x5f, 0x49, 0xb8, 0x00),
Jerome Forissier79013242021-07-28 10:24:04 +02002932};
2933static const mbedtls_mpi_uint x25519_bad_point_2[] = {
Jens Wiklander32b31802023-10-06 16:59:46 +02002934 MBEDTLS_BYTES_TO_T_UINT_8(0x5f, 0x9c, 0x95, 0xbc, 0xa3, 0x50, 0x8c, 0x24),
2935 MBEDTLS_BYTES_TO_T_UINT_8(0xb1, 0xd0, 0xb1, 0x55, 0x9c, 0x83, 0xef, 0x5b),
2936 MBEDTLS_BYTES_TO_T_UINT_8(0x04, 0x44, 0x5c, 0xc4, 0x58, 0x1c, 0x8e, 0x86),
2937 MBEDTLS_BYTES_TO_T_UINT_8(0xd8, 0x22, 0x4e, 0xdd, 0xd0, 0x9f, 0x11, 0x57),
Jerome Forissier79013242021-07-28 10:24:04 +02002938};
2939static const mbedtls_mpi ecp_x25519_bad_point_1 = ECP_MPI_INIT_ARRAY(
Jens Wiklander32b31802023-10-06 16:59:46 +02002940 x25519_bad_point_1);
Jerome Forissier79013242021-07-28 10:24:04 +02002941static const mbedtls_mpi ecp_x25519_bad_point_2 = ECP_MPI_INIT_ARRAY(
Jens Wiklander32b31802023-10-06 16:59:46 +02002942 x25519_bad_point_2);
Jerome Forissier79013242021-07-28 10:24:04 +02002943#endif /* MBEDTLS_ECP_DP_CURVE25519_ENABLED */
2944
2945/*
2946 * Check that the input point is not one of the low-order points.
2947 * This is recommended by the "May the Fourth" paper:
2948 * https://eprint.iacr.org/2017/806.pdf
2949 * Those points are never sent by an honest peer.
2950 */
Jens Wiklander32b31802023-10-06 16:59:46 +02002951static int ecp_check_bad_points_mx(const mbedtls_mpi *X, const mbedtls_mpi *P,
2952 const mbedtls_ecp_group_id grp_id)
Jerome Forissier79013242021-07-28 10:24:04 +02002953{
2954 int ret;
2955 mbedtls_mpi XmP;
2956
Jens Wiklander32b31802023-10-06 16:59:46 +02002957 mbedtls_mpi_init(&XmP);
Jerome Forissier79013242021-07-28 10:24:04 +02002958
2959 /* Reduce X mod P so that we only need to check values less than P.
2960 * We know X < 2^256 so we can proceed by subtraction. */
Jens Wiklander32b31802023-10-06 16:59:46 +02002961 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&XmP, X));
2962 while (mbedtls_mpi_cmp_mpi(&XmP, P) >= 0) {
2963 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&XmP, &XmP, P));
2964 }
Jerome Forissier79013242021-07-28 10:24:04 +02002965
2966 /* Check against the known bad values that are less than P. For Curve448
2967 * these are 0, 1 and -1. For Curve25519 we check the values less than P
2968 * from the following list: https://cr.yp.to/ecdh.html#validate */
Jens Wiklander32b31802023-10-06 16:59:46 +02002969 if (mbedtls_mpi_cmp_int(&XmP, 1) <= 0) { /* takes care of 0 and 1 */
Jerome Forissier79013242021-07-28 10:24:04 +02002970 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2971 goto cleanup;
2972 }
2973
2974#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02002975 if (grp_id == MBEDTLS_ECP_DP_CURVE25519) {
2976 if (mbedtls_mpi_cmp_mpi(&XmP, &ecp_x25519_bad_point_1) == 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02002977 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2978 goto cleanup;
2979 }
2980
Jens Wiklander32b31802023-10-06 16:59:46 +02002981 if (mbedtls_mpi_cmp_mpi(&XmP, &ecp_x25519_bad_point_2) == 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02002982 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2983 goto cleanup;
2984 }
2985 }
2986#else
2987 (void) grp_id;
2988#endif
2989
2990 /* Final check: check if XmP + 1 is P (final because it changes XmP!) */
Jens Wiklander32b31802023-10-06 16:59:46 +02002991 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&XmP, &XmP, 1));
2992 if (mbedtls_mpi_cmp_mpi(&XmP, P) == 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02002993 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2994 goto cleanup;
2995 }
2996
2997 ret = 0;
2998
2999cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003000 mbedtls_mpi_free(&XmP);
Jerome Forissier79013242021-07-28 10:24:04 +02003001
Jens Wiklander32b31802023-10-06 16:59:46 +02003002 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003003}
3004
Jens Wiklander817466c2018-05-22 13:49:31 +02003005/*
3006 * Check validity of a public key for Montgomery curves with x-only schemes
3007 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003008static int ecp_check_pubkey_mx(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +02003009{
3010 /* [Curve25519 p. 5] Just check X is the correct number of bytes */
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003011 /* Allow any public value, if it's too big then we'll just reduce it mod p
3012 * (RFC 7748 sec. 5 para. 3). */
Jens Wiklander32b31802023-10-06 16:59:46 +02003013 if (mbedtls_mpi_size(&pt->X) > (grp->nbits + 7) / 8) {
3014 return MBEDTLS_ERR_ECP_INVALID_KEY;
3015 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003016
Jerome Forissier79013242021-07-28 10:24:04 +02003017 /* Implicit in all standards (as they don't consider negative numbers):
3018 * X must be non-negative. This is normally ensured by the way it's
3019 * encoded for transmission, but let's be extra sure. */
Jens Wiklander32b31802023-10-06 16:59:46 +02003020 if (mbedtls_mpi_cmp_int(&pt->X, 0) < 0) {
3021 return MBEDTLS_ERR_ECP_INVALID_KEY;
3022 }
Jerome Forissier79013242021-07-28 10:24:04 +02003023
Jens Wiklander32b31802023-10-06 16:59:46 +02003024 return ecp_check_bad_points_mx(&pt->X, &grp->P, grp->id);
Jens Wiklander817466c2018-05-22 13:49:31 +02003025}
Jerome Forissier79013242021-07-28 10:24:04 +02003026#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003027
3028/*
3029 * Check that a point is valid as a public key
3030 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003031int mbedtls_ecp_check_pubkey(const mbedtls_ecp_group *grp,
3032 const mbedtls_ecp_point *pt)
Jens Wiklander817466c2018-05-22 13:49:31 +02003033{
3034 /* Must use affine coordinates */
Jens Wiklander32b31802023-10-06 16:59:46 +02003035 if (mbedtls_mpi_cmp_int(&pt->Z, 1) != 0) {
3036 return MBEDTLS_ERR_ECP_INVALID_KEY;
3037 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003038
Jerome Forissier79013242021-07-28 10:24:04 +02003039#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003040 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3041 return ecp_check_pubkey_mx(grp, pt);
3042 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003043#endif
Jerome Forissier79013242021-07-28 10:24:04 +02003044#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003045 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3046 return ecp_check_pubkey_sw(grp, pt);
3047 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003048#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02003049 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +02003050}
3051
3052/*
3053 * Check that an mbedtls_mpi is valid as a private key
3054 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003055int mbedtls_ecp_check_privkey(const mbedtls_ecp_group *grp,
3056 const mbedtls_mpi *d)
Jens Wiklander817466c2018-05-22 13:49:31 +02003057{
Jerome Forissier79013242021-07-28 10:24:04 +02003058#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003059 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003060 /* see RFC 7748 sec. 5 para. 5 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003061 if (mbedtls_mpi_get_bit(d, 0) != 0 ||
3062 mbedtls_mpi_get_bit(d, 1) != 0 ||
3063 mbedtls_mpi_bitlen(d) - 1 != grp->nbits) { /* mbedtls_mpi_bitlen is one-based! */
3064 return MBEDTLS_ERR_ECP_INVALID_KEY;
3065 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003066
3067 /* see [Curve25519] page 5 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003068 if (grp->nbits == 254 && mbedtls_mpi_get_bit(d, 2) != 0) {
3069 return MBEDTLS_ERR_ECP_INVALID_KEY;
3070 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003071
Jens Wiklander32b31802023-10-06 16:59:46 +02003072 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02003073 }
Jerome Forissier79013242021-07-28 10:24:04 +02003074#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
3075#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003076 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
Jens Wiklander817466c2018-05-22 13:49:31 +02003077 /* see SEC1 3.2 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003078 if (mbedtls_mpi_cmp_int(d, 1) < 0 ||
3079 mbedtls_mpi_cmp_mpi(d, &grp->N) >= 0) {
3080 return MBEDTLS_ERR_ECP_INVALID_KEY;
3081 } else {
3082 return 0;
3083 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003084 }
Jerome Forissier79013242021-07-28 10:24:04 +02003085#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003086
Jens Wiklander32b31802023-10-06 16:59:46 +02003087 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +02003088}
3089
Jerome Forissier79013242021-07-28 10:24:04 +02003090#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3091MBEDTLS_STATIC_TESTABLE
Jens Wiklander32b31802023-10-06 16:59:46 +02003092int mbedtls_ecp_gen_privkey_mx(size_t high_bit,
3093 mbedtls_mpi *d,
3094 int (*f_rng)(void *, unsigned char *, size_t),
3095 void *p_rng)
Jerome Forissier79013242021-07-28 10:24:04 +02003096{
3097 int ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3098 size_t n_random_bytes = high_bit / 8 + 1;
3099
3100 /* [Curve25519] page 5 */
3101 /* Generate a (high_bit+1)-bit random number by generating just enough
3102 * random bytes, then shifting out extra bits from the top (necessary
3103 * when (high_bit+1) is not a multiple of 8). */
Jens Wiklander32b31802023-10-06 16:59:46 +02003104 MBEDTLS_MPI_CHK(mbedtls_mpi_fill_random(d, n_random_bytes,
3105 f_rng, p_rng));
3106 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_r(d, 8 * n_random_bytes - high_bit - 1));
Jerome Forissier79013242021-07-28 10:24:04 +02003107
Jens Wiklander32b31802023-10-06 16:59:46 +02003108 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, high_bit, 1));
Jerome Forissier79013242021-07-28 10:24:04 +02003109
3110 /* Make sure the last two bits are unset for Curve448, three bits for
3111 Curve25519 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003112 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 0, 0));
3113 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 1, 0));
3114 if (high_bit == 254) {
3115 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 2, 0));
Jerome Forissier79013242021-07-28 10:24:04 +02003116 }
3117
3118cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003119 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003120}
3121#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
3122
3123#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3124static int mbedtls_ecp_gen_privkey_sw(
3125 const mbedtls_mpi *N, mbedtls_mpi *d,
Jens Wiklander32b31802023-10-06 16:59:46 +02003126 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jerome Forissier79013242021-07-28 10:24:04 +02003127{
Jens Wiklander32b31802023-10-06 16:59:46 +02003128 int ret = mbedtls_mpi_random(d, 1, N, f_rng, p_rng);
3129 switch (ret) {
Jerome Forissier79013242021-07-28 10:24:04 +02003130 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Jens Wiklander32b31802023-10-06 16:59:46 +02003131 return MBEDTLS_ERR_ECP_RANDOM_FAILED;
Jerome Forissier79013242021-07-28 10:24:04 +02003132 default:
Jens Wiklander32b31802023-10-06 16:59:46 +02003133 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003134 }
3135}
3136#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3137
Jens Wiklander817466c2018-05-22 13:49:31 +02003138/*
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003139 * Generate a private key
Jens Wiklander817466c2018-05-22 13:49:31 +02003140 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003141int mbedtls_ecp_gen_privkey(const mbedtls_ecp_group *grp,
3142 mbedtls_mpi *d,
3143 int (*f_rng)(void *, unsigned char *, size_t),
3144 void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02003145{
Jerome Forissier79013242021-07-28 10:24:04 +02003146#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003147 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3148 return mbedtls_ecp_gen_privkey_mx(grp->nbits, d, f_rng, p_rng);
3149 }
Jerome Forissier79013242021-07-28 10:24:04 +02003150#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003151
Jerome Forissier79013242021-07-28 10:24:04 +02003152#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003153 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3154 return mbedtls_ecp_gen_privkey_sw(&grp->N, d, f_rng, p_rng);
3155 }
Jerome Forissier79013242021-07-28 10:24:04 +02003156#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003157
Jens Wiklander32b31802023-10-06 16:59:46 +02003158 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003159}
Jens Wiklander817466c2018-05-22 13:49:31 +02003160
Tom Van Eyckc1633172024-04-09 18:44:13 +02003161#if defined(MBEDTLS_ECP_C)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003162/*
3163 * Generate a keypair with configurable base point
3164 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003165int mbedtls_ecp_gen_keypair_base(mbedtls_ecp_group *grp,
3166 const mbedtls_ecp_point *G,
3167 mbedtls_mpi *d, mbedtls_ecp_point *Q,
3168 int (*f_rng)(void *, unsigned char *, size_t),
3169 void *p_rng)
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003170{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02003172 MBEDTLS_MPI_CHK(mbedtls_ecp_gen_privkey(grp, d, f_rng, p_rng));
3173 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, Q, d, G, f_rng, p_rng));
Jens Wiklander3d3b0592019-03-20 15:30:29 +01003174
3175cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003176 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02003177}
3178
3179/*
3180 * Generate key pair, wrapper for conventional base point
3181 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003182int mbedtls_ecp_gen_keypair(mbedtls_ecp_group *grp,
3183 mbedtls_mpi *d, mbedtls_ecp_point *Q,
3184 int (*f_rng)(void *, unsigned char *, size_t),
3185 void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02003186{
Jens Wiklander32b31802023-10-06 16:59:46 +02003187 return mbedtls_ecp_gen_keypair_base(grp, &grp->G, d, Q, f_rng, p_rng);
Jens Wiklander817466c2018-05-22 13:49:31 +02003188}
3189
3190/*
3191 * Generate a keypair, prettier wrapper
3192 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003193int mbedtls_ecp_gen_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
3194 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02003195{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander32b31802023-10-06 16:59:46 +02003197 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3198 return ret;
3199 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003200
Jens Wiklander32b31802023-10-06 16:59:46 +02003201 return mbedtls_ecp_gen_keypair(&key->grp, &key->d, &key->Q, f_rng, p_rng);
Jens Wiklander817466c2018-05-22 13:49:31 +02003202}
Tom Van Eyckc1633172024-04-09 18:44:13 +02003203#endif /* MBEDTLS_ECP_C */
3204
3205int mbedtls_ecp_set_public_key(mbedtls_ecp_group_id grp_id,
3206 mbedtls_ecp_keypair *key,
3207 const mbedtls_ecp_point *Q)
3208{
3209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3210
3211 if (key->grp.id == MBEDTLS_ECP_DP_NONE) {
3212 /* Group not set yet */
3213 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3214 return ret;
3215 }
3216 } else if (key->grp.id != grp_id) {
3217 /* Group mismatch */
3218 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3219 }
3220 return mbedtls_ecp_copy(&key->Q, Q);
3221}
3222
Jens Wiklander817466c2018-05-22 13:49:31 +02003223
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003224#define ECP_CURVE25519_KEY_SIZE 32
Jens Wiklander32b31802023-10-06 16:59:46 +02003225#define ECP_CURVE448_KEY_SIZE 56
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003226/*
3227 * Read a private key.
3228 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003229int mbedtls_ecp_read_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
3230 const unsigned char *buf, size_t buflen)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003231{
3232 int ret = 0;
3233
Jens Wiklander32b31802023-10-06 16:59:46 +02003234 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3235 return ret;
3236 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003237
3238 ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
3239
Jerome Forissier79013242021-07-28 10:24:04 +02003240#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003241 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003242 /*
Jens Wiklander32b31802023-10-06 16:59:46 +02003243 * Mask the key as mandated by RFC7748 for Curve25519 and Curve448.
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003244 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003245 if (grp_id == MBEDTLS_ECP_DP_CURVE25519) {
3246 if (buflen != ECP_CURVE25519_KEY_SIZE) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003247 return MBEDTLS_ERR_ECP_INVALID_KEY;
Jens Wiklander32b31802023-10-06 16:59:46 +02003248 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003249
Jens Wiklander32b31802023-10-06 16:59:46 +02003250 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&key->d, buf, buflen));
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003251
3252 /* Set the three least significant bits to 0 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003253 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 0, 0));
3254 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 1, 0));
3255 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 2, 0));
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003256
3257 /* Set the most significant bit to 0 */
3258 MBEDTLS_MPI_CHK(
Jens Wiklander32b31802023-10-06 16:59:46 +02003259 mbedtls_mpi_set_bit(&key->d,
3260 ECP_CURVE25519_KEY_SIZE * 8 - 1, 0)
3261 );
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003262
3263 /* Set the second most significant bit to 1 */
3264 MBEDTLS_MPI_CHK(
Jens Wiklander32b31802023-10-06 16:59:46 +02003265 mbedtls_mpi_set_bit(&key->d,
3266 ECP_CURVE25519_KEY_SIZE * 8 - 2, 1)
3267 );
3268 } else if (grp_id == MBEDTLS_ECP_DP_CURVE448) {
3269 if (buflen != ECP_CURVE448_KEY_SIZE) {
3270 return MBEDTLS_ERR_ECP_INVALID_KEY;
3271 }
3272
3273 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&key->d, buf, buflen));
3274
3275 /* Set the two least significant bits to 0 */
3276 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 0, 0));
3277 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 1, 0));
3278
3279 /* Set the most significant bit to 1 */
3280 MBEDTLS_MPI_CHK(
3281 mbedtls_mpi_set_bit(&key->d,
3282 ECP_CURVE448_KEY_SIZE * 8 - 1, 1)
3283 );
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003284 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003285 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003286#endif
Jerome Forissier79013242021-07-28 10:24:04 +02003287#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003288 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3289 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&key->d, buf, buflen));
Tom Van Eyckc1633172024-04-09 18:44:13 +02003290 }
3291#endif
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003292
Tom Van Eyckc1633172024-04-09 18:44:13 +02003293 if (ret == 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +02003294 MBEDTLS_MPI_CHK(mbedtls_ecp_check_privkey(&key->grp, &key->d));
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003295 }
3296
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003297cleanup:
3298
Jens Wiklander32b31802023-10-06 16:59:46 +02003299 if (ret != 0) {
3300 mbedtls_mpi_free(&key->d);
3301 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003302
Jens Wiklander32b31802023-10-06 16:59:46 +02003303 return ret;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003304}
3305
Jens Wiklander817466c2018-05-22 13:49:31 +02003306/*
Jerome Forissier79013242021-07-28 10:24:04 +02003307 * Write a private key.
3308 */
Tom Van Eyckc1633172024-04-09 18:44:13 +02003309#if !defined MBEDTLS_DEPRECATED_REMOVED
Jens Wiklander32b31802023-10-06 16:59:46 +02003310int mbedtls_ecp_write_key(mbedtls_ecp_keypair *key,
3311 unsigned char *buf, size_t buflen)
Jerome Forissier79013242021-07-28 10:24:04 +02003312{
Tom Van Eyckc1633172024-04-09 18:44:13 +02003313 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerome Forissier79013242021-07-28 10:24:04 +02003314
Jerome Forissier79013242021-07-28 10:24:04 +02003315#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003316 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3317 if (key->grp.id == MBEDTLS_ECP_DP_CURVE25519) {
3318 if (buflen < ECP_CURVE25519_KEY_SIZE) {
Jerome Forissier79013242021-07-28 10:24:04 +02003319 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
Jens Wiklander32b31802023-10-06 16:59:46 +02003320 }
Jerome Forissier79013242021-07-28 10:24:04 +02003321
Jens Wiklander32b31802023-10-06 16:59:46 +02003322 } else if (key->grp.id == MBEDTLS_ECP_DP_CURVE448) {
3323 if (buflen < ECP_CURVE448_KEY_SIZE) {
3324 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3325 }
Jerome Forissier79013242021-07-28 10:24:04 +02003326 }
Jens Wiklander32b31802023-10-06 16:59:46 +02003327 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary_le(&key->d, buf, buflen));
Jerome Forissier79013242021-07-28 10:24:04 +02003328 }
Jerome Forissier79013242021-07-28 10:24:04 +02003329#endif
3330#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003331 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3332 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&key->d, buf, buflen));
Jerome Forissier79013242021-07-28 10:24:04 +02003333 }
3334
3335#endif
3336cleanup:
3337
Jens Wiklander32b31802023-10-06 16:59:46 +02003338 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003339}
Tom Van Eyckc1633172024-04-09 18:44:13 +02003340#endif /* MBEDTLS_DEPRECATED_REMOVED */
3341
3342int mbedtls_ecp_write_key_ext(const mbedtls_ecp_keypair *key,
3343 size_t *olen, unsigned char *buf, size_t buflen)
3344{
3345 size_t len = (key->grp.nbits + 7) / 8;
3346 if (len > buflen) {
3347 /* For robustness, ensure *olen <= buflen even on error. */
3348 *olen = 0;
3349 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3350 }
3351 *olen = len;
3352
3353 /* Private key not set */
3354 if (key->d.n == 0) {
3355 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3356 }
3357
3358#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3359 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3360 return mbedtls_mpi_write_binary_le(&key->d, buf, len);
3361 }
3362#endif
3363
3364#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3365 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3366 return mbedtls_mpi_write_binary(&key->d, buf, len);
3367 }
3368#endif
3369
3370 /* Private key set but no recognized curve type? This shouldn't happen. */
3371 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3372}
3373
3374/*
3375 * Write a public key.
3376 */
3377int mbedtls_ecp_write_public_key(const mbedtls_ecp_keypair *key,
3378 int format, size_t *olen,
3379 unsigned char *buf, size_t buflen)
3380{
3381 return mbedtls_ecp_point_write_binary(&key->grp, &key->Q,
3382 format, olen, buf, buflen);
3383}
Jerome Forissier79013242021-07-28 10:24:04 +02003384
3385
Tom Van Eyckc1633172024-04-09 18:44:13 +02003386#if defined(MBEDTLS_ECP_C)
Jerome Forissier79013242021-07-28 10:24:04 +02003387/*
Jens Wiklander817466c2018-05-22 13:49:31 +02003388 * Check a public-private key pair
3389 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003390int mbedtls_ecp_check_pub_priv(
3391 const mbedtls_ecp_keypair *pub, const mbedtls_ecp_keypair *prv,
3392 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Jens Wiklander817466c2018-05-22 13:49:31 +02003393{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003394 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02003395 mbedtls_ecp_point Q;
3396 mbedtls_ecp_group grp;
Jens Wiklander32b31802023-10-06 16:59:46 +02003397 if (pub->grp.id == MBEDTLS_ECP_DP_NONE ||
Jens Wiklander817466c2018-05-22 13:49:31 +02003398 pub->grp.id != prv->grp.id ||
Jens Wiklander32b31802023-10-06 16:59:46 +02003399 mbedtls_mpi_cmp_mpi(&pub->Q.X, &prv->Q.X) ||
3400 mbedtls_mpi_cmp_mpi(&pub->Q.Y, &prv->Q.Y) ||
3401 mbedtls_mpi_cmp_mpi(&pub->Q.Z, &prv->Q.Z)) {
3402 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +02003403 }
3404
Jens Wiklander32b31802023-10-06 16:59:46 +02003405 mbedtls_ecp_point_init(&Q);
3406 mbedtls_ecp_group_init(&grp);
Jens Wiklander817466c2018-05-22 13:49:31 +02003407
3408 /* mbedtls_ecp_mul() needs a non-const group... */
Jens Wiklander32b31802023-10-06 16:59:46 +02003409 mbedtls_ecp_group_copy(&grp, &prv->grp);
Jens Wiklander817466c2018-05-22 13:49:31 +02003410
3411 /* Also checks d is valid */
Jens Wiklander32b31802023-10-06 16:59:46 +02003412 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(&grp, &Q, &prv->d, &prv->grp.G, f_rng, p_rng));
Jens Wiklander817466c2018-05-22 13:49:31 +02003413
Jens Wiklander32b31802023-10-06 16:59:46 +02003414 if (mbedtls_mpi_cmp_mpi(&Q.X, &prv->Q.X) ||
3415 mbedtls_mpi_cmp_mpi(&Q.Y, &prv->Q.Y) ||
3416 mbedtls_mpi_cmp_mpi(&Q.Z, &prv->Q.Z)) {
Jens Wiklander817466c2018-05-22 13:49:31 +02003417 ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3418 goto cleanup;
3419 }
3420
3421cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003422 mbedtls_ecp_point_free(&Q);
3423 mbedtls_ecp_group_free(&grp);
Jens Wiklander817466c2018-05-22 13:49:31 +02003424
Jens Wiklander32b31802023-10-06 16:59:46 +02003425 return ret;
3426}
3427
Tom Van Eyckc1633172024-04-09 18:44:13 +02003428int mbedtls_ecp_keypair_calc_public(mbedtls_ecp_keypair *key,
3429 int (*f_rng)(void *, unsigned char *, size_t),
3430 void *p_rng)
3431{
3432 return mbedtls_ecp_mul(&key->grp, &key->Q, &key->d, &key->grp.G,
3433 f_rng, p_rng);
3434}
3435#endif /* MBEDTLS_ECP_C */
3436
3437mbedtls_ecp_group_id mbedtls_ecp_keypair_get_group_id(
3438 const mbedtls_ecp_keypair *key)
3439{
3440 return key->grp.id;
3441}
3442
Jens Wiklander32b31802023-10-06 16:59:46 +02003443/*
3444 * Export generic key-pair parameters.
3445 */
3446int mbedtls_ecp_export(const mbedtls_ecp_keypair *key, mbedtls_ecp_group *grp,
3447 mbedtls_mpi *d, mbedtls_ecp_point *Q)
3448{
3449 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3450
Tom Van Eyckc1633172024-04-09 18:44:13 +02003451 if (grp != NULL && (ret = mbedtls_ecp_group_copy(grp, &key->grp)) != 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +02003452 return ret;
3453 }
3454
Tom Van Eyckc1633172024-04-09 18:44:13 +02003455 if (d != NULL && (ret = mbedtls_mpi_copy(d, &key->d)) != 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +02003456 return ret;
3457 }
3458
Tom Van Eyckc1633172024-04-09 18:44:13 +02003459 if (Q != NULL && (ret = mbedtls_ecp_copy(Q, &key->Q)) != 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +02003460 return ret;
3461 }
3462
3463 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02003464}
3465
3466#if defined(MBEDTLS_SELF_TEST)
3467
Tom Van Eyckc1633172024-04-09 18:44:13 +02003468#if defined(MBEDTLS_ECP_C)
Jens Wiklander32b31802023-10-06 16:59:46 +02003469/*
3470 * PRNG for test - !!!INSECURE NEVER USE IN PRODUCTION!!!
3471 *
3472 * This is the linear congruential generator from numerical recipes,
3473 * except we only use the low byte as the output. See
3474 * https://en.wikipedia.org/wiki/Linear_congruential_generator#Parameters_in_common_use
3475 */
3476static int self_test_rng(void *ctx, unsigned char *out, size_t len)
3477{
3478 static uint32_t state = 42;
3479
3480 (void) ctx;
3481
3482 for (size_t i = 0; i < len; i++) {
3483 state = state * 1664525u + 1013904223u;
3484 out[i] = (unsigned char) state;
3485 }
3486
3487 return 0;
3488}
3489
Jerome Forissier79013242021-07-28 10:24:04 +02003490/* Adjust the exponent to be a valid private point for the specified curve.
3491 * This is sometimes necessary because we use a single set of exponents
3492 * for all curves but the validity of values depends on the curve. */
Jens Wiklander32b31802023-10-06 16:59:46 +02003493static int self_test_adjust_exponent(const mbedtls_ecp_group *grp,
3494 mbedtls_mpi *m)
Jerome Forissier79013242021-07-28 10:24:04 +02003495{
3496 int ret = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +02003497 switch (grp->id) {
3498 /* If Curve25519 is available, then that's what we use for the
3499 * Montgomery test, so we don't need the adjustment code. */
3500#if !defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Jerome Forissier79013242021-07-28 10:24:04 +02003501#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
3502 case MBEDTLS_ECP_DP_CURVE448:
3503 /* Move highest bit from 254 to N-1. Setting bit N-1 is
3504 * necessary to enforce the highest-bit-set constraint. */
Jens Wiklander32b31802023-10-06 16:59:46 +02003505 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(m, 254, 0));
3506 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(m, grp->nbits, 1));
Jerome Forissier79013242021-07-28 10:24:04 +02003507 /* Copy second-highest bit from 253 to N-2. This is not
3508 * necessary but improves the test variety a bit. */
3509 MBEDTLS_MPI_CHK(
Jens Wiklander32b31802023-10-06 16:59:46 +02003510 mbedtls_mpi_set_bit(m, grp->nbits - 1,
3511 mbedtls_mpi_get_bit(m, 253)));
Jerome Forissier79013242021-07-28 10:24:04 +02003512 break;
3513#endif
3514#endif /* ! defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) */
3515 default:
3516 /* Non-Montgomery curves and Curve25519 need no adjustment. */
3517 (void) grp;
3518 (void) m;
3519 goto cleanup;
3520 }
3521cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003522 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003523}
3524
3525/* Calculate R = m.P for each m in exponents. Check that the number of
3526 * basic operations doesn't depend on the value of m. */
Jens Wiklander32b31802023-10-06 16:59:46 +02003527static int self_test_point(int verbose,
3528 mbedtls_ecp_group *grp,
3529 mbedtls_ecp_point *R,
3530 mbedtls_mpi *m,
3531 const mbedtls_ecp_point *P,
3532 const char *const *exponents,
3533 size_t n_exponents)
Jerome Forissier79013242021-07-28 10:24:04 +02003534{
3535 int ret = 0;
3536 size_t i = 0;
3537 unsigned long add_c_prev, dbl_c_prev, mul_c_prev;
3538 add_count = 0;
3539 dbl_count = 0;
3540 mul_count = 0;
3541
Jens Wiklander32b31802023-10-06 16:59:46 +02003542 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(m, 16, exponents[0]));
3543 MBEDTLS_MPI_CHK(self_test_adjust_exponent(grp, m));
3544 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, R, m, P, self_test_rng, NULL));
Jerome Forissier79013242021-07-28 10:24:04 +02003545
Jens Wiklander32b31802023-10-06 16:59:46 +02003546 for (i = 1; i < n_exponents; i++) {
Jerome Forissier79013242021-07-28 10:24:04 +02003547 add_c_prev = add_count;
3548 dbl_c_prev = dbl_count;
3549 mul_c_prev = mul_count;
3550 add_count = 0;
3551 dbl_count = 0;
3552 mul_count = 0;
3553
Jens Wiklander32b31802023-10-06 16:59:46 +02003554 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(m, 16, exponents[i]));
3555 MBEDTLS_MPI_CHK(self_test_adjust_exponent(grp, m));
3556 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, R, m, P, self_test_rng, NULL));
Jerome Forissier79013242021-07-28 10:24:04 +02003557
Jens Wiklander32b31802023-10-06 16:59:46 +02003558 if (add_count != add_c_prev ||
Jerome Forissier79013242021-07-28 10:24:04 +02003559 dbl_count != dbl_c_prev ||
Jens Wiklander32b31802023-10-06 16:59:46 +02003560 mul_count != mul_c_prev) {
Jerome Forissier79013242021-07-28 10:24:04 +02003561 ret = 1;
3562 break;
3563 }
3564 }
3565
3566cleanup:
Jens Wiklander32b31802023-10-06 16:59:46 +02003567 if (verbose != 0) {
3568 if (ret != 0) {
3569 mbedtls_printf("failed (%u)\n", (unsigned int) i);
3570 } else {
3571 mbedtls_printf("passed\n");
3572 }
Jerome Forissier79013242021-07-28 10:24:04 +02003573 }
Jens Wiklander32b31802023-10-06 16:59:46 +02003574 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02003575}
Tom Van Eyckc1633172024-04-09 18:44:13 +02003576#endif /* MBEDTLS_ECP_C */
Jerome Forissier79013242021-07-28 10:24:04 +02003577
Jens Wiklander817466c2018-05-22 13:49:31 +02003578/*
3579 * Checkup routine
3580 */
Jens Wiklander32b31802023-10-06 16:59:46 +02003581int mbedtls_ecp_self_test(int verbose)
Jens Wiklander817466c2018-05-22 13:49:31 +02003582{
Tom Van Eyckc1633172024-04-09 18:44:13 +02003583#if defined(MBEDTLS_ECP_C)
Jerome Forissier11fa71b2020-04-20 17:17:56 +02003584 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02003585 mbedtls_ecp_group grp;
3586 mbedtls_ecp_point R, P;
3587 mbedtls_mpi m;
Jerome Forissier79013242021-07-28 10:24:04 +02003588
3589#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3590 /* Exponents especially adapted for secp192k1, which has the lowest
3591 * order n of all supported curves (secp192r1 is in a slightly larger
3592 * field but the order of its base point is slightly smaller). */
3593 const char *sw_exponents[] =
Jens Wiklander817466c2018-05-22 13:49:31 +02003594 {
3595 "000000000000000000000000000000000000000000000001", /* one */
Jerome Forissier79013242021-07-28 10:24:04 +02003596 "FFFFFFFFFFFFFFFFFFFFFFFE26F2FC170F69466A74DEFD8C", /* n - 1 */
Jens Wiklander817466c2018-05-22 13:49:31 +02003597 "5EA6F389A38B8BC81E767753B15AA5569E1782E30ABE7D25", /* random */
3598 "400000000000000000000000000000000000000000000000", /* one and zeros */
3599 "7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", /* all ones */
3600 "555555555555555555555555555555555555555555555555", /* 101010... */
3601 };
Jerome Forissier79013242021-07-28 10:24:04 +02003602#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3603#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3604 const char *m_exponents[] =
3605 {
3606 /* Valid private values for Curve25519. In a build with Curve448
3607 * but not Curve25519, they will be adjusted in
3608 * self_test_adjust_exponent(). */
3609 "4000000000000000000000000000000000000000000000000000000000000000",
3610 "5C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C30",
3611 "5715ECCE24583F7A7023C24164390586842E816D7280A49EF6DF4EAE6B280BF8",
3612 "41A2B017516F6D254E1F002BCCBADD54BE30F8CEC737A0E912B4963B6BA74460",
3613 "5555555555555555555555555555555555555555555555555555555555555550",
3614 "7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF8",
3615 };
3616#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003617
Jens Wiklander32b31802023-10-06 16:59:46 +02003618 mbedtls_ecp_group_init(&grp);
3619 mbedtls_ecp_point_init(&R);
3620 mbedtls_ecp_point_init(&P);
3621 mbedtls_mpi_init(&m);
Jens Wiklander817466c2018-05-22 13:49:31 +02003622
Jerome Forissier79013242021-07-28 10:24:04 +02003623#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Jens Wiklander817466c2018-05-22 13:49:31 +02003624 /* Use secp192r1 if available, or any available curve */
3625#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003626 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_SECP192R1));
Jens Wiklander817466c2018-05-22 13:49:31 +02003627#else
Jens Wiklander32b31802023-10-06 16:59:46 +02003628 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, mbedtls_ecp_curve_list()->grp_id));
Jens Wiklander817466c2018-05-22 13:49:31 +02003629#endif
3630
Jens Wiklander32b31802023-10-06 16:59:46 +02003631 if (verbose != 0) {
3632 mbedtls_printf(" ECP SW test #1 (constant op_count, base point G): ");
3633 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003634 /* Do a dummy multiplication first to trigger precomputation */
Jens Wiklander32b31802023-10-06 16:59:46 +02003635 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&m, 2));
3636 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(&grp, &P, &m, &grp.G, self_test_rng, NULL));
3637 ret = self_test_point(verbose,
3638 &grp, &R, &m, &grp.G,
3639 sw_exponents,
3640 sizeof(sw_exponents) / sizeof(sw_exponents[0]));
3641 if (ret != 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02003642 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +02003643 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003644
Jens Wiklander32b31802023-10-06 16:59:46 +02003645 if (verbose != 0) {
3646 mbedtls_printf(" ECP SW test #2 (constant op_count, other point): ");
3647 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003648 /* We computed P = 2G last time, use it */
Jens Wiklander32b31802023-10-06 16:59:46 +02003649 ret = self_test_point(verbose,
3650 &grp, &R, &m, &P,
3651 sw_exponents,
3652 sizeof(sw_exponents) / sizeof(sw_exponents[0]));
3653 if (ret != 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02003654 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +02003655 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003656
Jens Wiklander32b31802023-10-06 16:59:46 +02003657 mbedtls_ecp_group_free(&grp);
3658 mbedtls_ecp_point_free(&R);
Jerome Forissier79013242021-07-28 10:24:04 +02003659#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003660
Jerome Forissier79013242021-07-28 10:24:04 +02003661#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003662 if (verbose != 0) {
3663 mbedtls_printf(" ECP Montgomery test (constant op_count): ");
3664 }
Jerome Forissier79013242021-07-28 10:24:04 +02003665#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003666 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_CURVE25519));
Jerome Forissier79013242021-07-28 10:24:04 +02003667#elif defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Jens Wiklander32b31802023-10-06 16:59:46 +02003668 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_CURVE448));
Jerome Forissier79013242021-07-28 10:24:04 +02003669#else
3670#error "MBEDTLS_ECP_MONTGOMERY_ENABLED is defined, but no curve is supported for self-test"
3671#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02003672 ret = self_test_point(verbose,
3673 &grp, &R, &m, &grp.G,
3674 m_exponents,
3675 sizeof(m_exponents) / sizeof(m_exponents[0]));
3676 if (ret != 0) {
Jerome Forissier79013242021-07-28 10:24:04 +02003677 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +02003678 }
Jerome Forissier79013242021-07-28 10:24:04 +02003679#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Jens Wiklander817466c2018-05-22 13:49:31 +02003680
3681cleanup:
3682
Jens Wiklander32b31802023-10-06 16:59:46 +02003683 if (ret < 0 && verbose != 0) {
3684 mbedtls_printf("Unexpected error, return code = %08X\n", (unsigned int) ret);
3685 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003686
Jens Wiklander32b31802023-10-06 16:59:46 +02003687 mbedtls_ecp_group_free(&grp);
3688 mbedtls_ecp_point_free(&R);
3689 mbedtls_ecp_point_free(&P);
3690 mbedtls_mpi_free(&m);
Jens Wiklander817466c2018-05-22 13:49:31 +02003691
Jens Wiklander32b31802023-10-06 16:59:46 +02003692 if (verbose != 0) {
3693 mbedtls_printf("\n");
3694 }
Jens Wiklander817466c2018-05-22 13:49:31 +02003695
Jens Wiklander32b31802023-10-06 16:59:46 +02003696 return ret;
Tom Van Eyckc1633172024-04-09 18:44:13 +02003697#else /* MBEDTLS_ECP_C */
3698 (void) verbose;
3699 return 0;
3700#endif /* MBEDTLS_ECP_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02003701}
3702
3703#endif /* MBEDTLS_SELF_TEST */
3704
3705#endif /* !MBEDTLS_ECP_ALT */
3706
Tom Van Eyckc1633172024-04-09 18:44:13 +02003707#endif /* MBEDTLS_ECP_LIGHT */