blob: fdd00a59c591a200b5c15dfce27c63a0ab12c4fc [file] [log] [blame]
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001/*
Manuel Pégourié-Gonnard32b04c12013-12-02 15:49:09 +01002 * Elliptic curves over GF(p): generic functions
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01006 */
7
8/*
9 * References:
10 *
Xiaokang Qian669c7c32023-04-10 07:36:04 +000011 * SEC1 https://www.secg.org/sec1-v2.pdf
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +010012 * GECC = Guide to Elliptic Curve Cryptography - Hankerson, Menezes, Vanstone
Manuel Pégourié-Gonnard62aad142012-11-10 00:27:12 +010013 * FIPS 186-3 http://csrc.nist.gov/publications/fips/fips186-3/fips_186-3.pdf
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +010014 * RFC 4492 for the related TLS structures and constants
Xiaokang Qian50fe3632023-04-12 06:08:45 +000015 * - https://www.rfc-editor.org/rfc/rfc4492
Nicholas Wilson08f3ef12015-11-10 13:10:01 +000016 * RFC 7748 for the Curve448 and Curve25519 curve definitions
Xiaokang Qian50fe3632023-04-12 06:08:45 +000017 * - https://www.rfc-editor.org/rfc/rfc7748
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +020018 *
Xiaokang Qian50fe3632023-04-12 06:08:45 +000019 * [Curve25519] https://cr.yp.to/ecdh/curve25519-20060209.pdf
Manuel Pégourié-Gonnardfe0af402013-12-04 18:14:55 +010020 *
Manuel Pégourié-Gonnard998930a2015-04-03 13:48:06 +020021 * [2] CORON, Jean-S'ebastien. Resistance against differential power analysis
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +020022 * 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>
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +010025 *
Manuel Pégourié-Gonnard998930a2015-04-03 13:48:06 +020026 * [3] HEDABOU, Mustapha, PINEL, Pierre, et B'EN'ETEAU, Lucien. A comb method to
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +010027 * 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>
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010030 */
31
Gilles Peskinedb09ef62020-06-03 01:43:33 +020032#include "common.h"
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010033
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050034/**
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
Valerio Settifd122f42023-04-05 18:15:32 +020063#if defined(MBEDTLS_ECP_LIGHT)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010064
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000065#include "mbedtls/ecp.h"
Janos Follath430d3372016-11-03 14:25:37 +000066#include "mbedtls/threading.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050067#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000068#include "mbedtls/error.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020069
Janos Follath8c70e812021-06-24 14:48:38 +010070#include "bn_mul.h"
Gabor Mezei2a7bcaf2023-07-06 10:37:51 +020071#include "ecp_invasive.h"
Gilles Peskine80ba8502021-04-03 20:36:37 +020072
Rich Evans00ab4702015-02-06 13:43:58 +000073#include <string.h>
74
Janos Follathb0697532016-08-18 12:38:46 +010075#if !defined(MBEDTLS_ECP_ALT)
76
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000077#include "mbedtls/platform.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020078
Gilles Peskine6a2fb612021-05-24 22:25:04 +020079#include "ecp_internal_alt.h"
Janos Follathb0697532016-08-18 12:38:46 +010080
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +010082/*
Manuel Pégourié-Gonnard91814812013-11-21 20:23:55 +010083 * Counts of point addition and doubling, and field multiplications.
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +020084 * Used to test resistance of point multiplication to simple timing attacks.
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +010085 */
Valerio Settifd122f42023-04-05 18:15:32 +020086#if defined(MBEDTLS_ECP_C)
87static unsigned long add_count, dbl_count;
88#endif /* MBEDTLS_ECP_C */
89static unsigned long mul_count;
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +010090#endif
91
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +020092#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +010093/*
94 * Maximum number of "basic operations" to be done in a row.
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +020095 *
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.
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100102 */
103static unsigned ecp_max_ops = 0;
104
105/*
106 * Set ecp_max_ops
107 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100108void mbedtls_ecp_set_max_ops(unsigned max_ops)
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100109{
110 ecp_max_ops = max_ops;
111}
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +0100112
113/*
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200114 * Check if restart is enabled
115 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100116int mbedtls_ecp_restart_is_enabled(void)
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200117{
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 return ecp_max_ops != 0;
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200119}
120
121/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200122 * Restart sub-context for ecp_mul_comb()
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +0100123 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100124struct mbedtls_ecp_restart_mul {
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +0100125 mbedtls_ecp_point R; /* current intermediate result */
Manuel Pégourié-Gonnardc5d844b2017-03-15 13:06:28 +0100126 size_t i; /* current index in various loops, 0 outside */
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +0100127 mbedtls_ecp_point *T; /* table for precomputed points */
128 unsigned char T_size; /* number of points in table T */
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +0200129 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 */
Manuel Pégourié-Gonnard45fd0162017-03-22 08:24:42 +0100132 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 */
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +0200135 ecp_rsm_comb_core, /* ecp_mul_comb_core() */
Manuel Pégourié-Gonnard45fd0162017-03-22 08:24:42 +0100136 ecp_rsm_final_norm, /* do the final normalization */
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100137 } state;
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100138};
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +0100139
140/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200141 * Init restart_mul sub-context
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +0100142 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100143static void ecp_restart_rsm_init(mbedtls_ecp_restart_mul_ctx *ctx)
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100144{
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 mbedtls_ecp_point_init(&ctx->R);
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200146 ctx->i = 0;
147 ctx->T = NULL;
148 ctx->T_size = 0;
149 ctx->state = ecp_rsm_init;
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100150}
151
152/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200153 * Free the components of a restart_mul sub-context
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100154 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100155static void ecp_restart_rsm_free(mbedtls_ecp_restart_mul_ctx *ctx)
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100156{
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +0100157 unsigned char i;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 if (ctx == NULL) {
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100160 return;
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +0100161 }
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163 mbedtls_ecp_point_free(&ctx->R);
164
165 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);
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100173}
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100174
175/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200176 * Restart context for ecp_muladd()
177 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178struct mbedtls_ecp_restart_muladd {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +0200179 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;
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200187};
188
189/*
190 * Init restart_muladd sub-context
191 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100192static void ecp_restart_ma_init(mbedtls_ecp_restart_muladd_ctx *ctx)
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200193{
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 mbedtls_ecp_point_init(&ctx->mP);
195 mbedtls_ecp_point_init(&ctx->R);
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200196 ctx->state = ecp_rsma_mul1;
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200197}
198
199/*
200 * Free the components of a restart_muladd sub-context
201 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100202static void ecp_restart_ma_free(mbedtls_ecp_restart_muladd_ctx *ctx)
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200203{
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 if (ctx == NULL) {
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200205 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 }
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200207
Gilles Peskine449bd832023-01-11 14:50:10 +0100208 mbedtls_ecp_point_free(&ctx->mP);
209 mbedtls_ecp_point_free(&ctx->R);
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +0200210
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 ecp_restart_ma_init(ctx);
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200212}
213
214/*
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200215 * Initialize a restart context
216 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100217void mbedtls_ecp_restart_init(mbedtls_ecp_restart_ctx *ctx)
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200218{
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200219 ctx->ops_done = 0;
220 ctx->depth = 0;
221 ctx->rsm = NULL;
222 ctx->ma = NULL;
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200223}
224
225/*
226 * Free the components of a restart context
227 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100228void mbedtls_ecp_restart_free(mbedtls_ecp_restart_ctx *ctx)
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 if (ctx == NULL) {
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200231 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 }
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200233
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 ecp_restart_rsm_free(ctx->rsm);
235 mbedtls_free(ctx->rsm);
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +0200236
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 ecp_restart_ma_free(ctx->ma);
238 mbedtls_free(ctx->ma);
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200239
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 mbedtls_ecp_restart_init(ctx);
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200241}
242
243/*
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100244 * Check if we can do the next step
245 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100246int mbedtls_ecp_check_budget(const mbedtls_ecp_group *grp,
247 mbedtls_ecp_restart_ctx *rs_ctx,
248 unsigned ops)
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100249{
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 if (rs_ctx != NULL && ecp_max_ops != 0) {
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100251 /* scale depending on curve size: the chosen reference is 256-bit,
252 * and multiplication is quadratic. Round to the closest integer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 if (grp->pbits >= 512) {
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100254 ops *= 4;
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 } else if (grp->pbits >= 384) {
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100256 ops *= 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 }
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100258
Hanno Beckerb10c6602018-10-26 13:50:13 +0100259 /* 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. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 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;
Hanno Beckerb10c6602018-10-26 13:50:13 +0100267 }
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100268
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100269 /* update running count */
Manuel Pégourié-Gonnard646393b2017-04-20 10:03:45 +0200270 rs_ctx->ops_done += ops;
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100271 }
272
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 return 0;
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100274}
275
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +0200276/* Call this when entering a function that needs its own sub-context */
Gilles Peskine449bd832023-01-11 14:50:10 +0100277#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) \
Manuel Pégourié-Gonnarda58e0112018-10-16 10:42:47 +0200280 rs_ctx->ops_done = 0; \
281 \
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 /* 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)
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +0200293
294/* Call this when leaving a function that needs its own sub-context */
Gilles Peskine449bd832023-01-11 14:50:10 +0100295#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 } \
Manuel Pégourié-Gonnarda58e0112018-10-16 10:42:47 +0200304 \
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 if (rs_ctx != NULL) \
Manuel Pégourié-Gonnarda58e0112018-10-16 10:42:47 +0200306 rs_ctx->depth--; \
Gilles Peskine449bd832023-01-11 14:50:10 +0100307} while (0)
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +0200308
309#else /* MBEDTLS_ECP_RESTARTABLE */
310
Gilles Peskine449bd832023-01-11 14:50:10 +0100311#define ECP_RS_ENTER(sub) (void) rs_ctx;
312#define ECP_RS_LEAVE(sub) (void) rs_ctx;
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +0200313
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200314#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100315
Valerio Settifd122f42023-04-05 18:15:32 +0200316#if defined(MBEDTLS_ECP_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100317static void mpi_init_many(mbedtls_mpi *arr, size_t size)
Hanno Becker466df6e2022-01-10 11:16:51 +0000318{
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 while (size--) {
320 mbedtls_mpi_init(arr++);
321 }
Hanno Becker466df6e2022-01-10 11:16:51 +0000322}
323
Gilles Peskine449bd832023-01-11 14:50:10 +0100324static void mpi_free_many(mbedtls_mpi *arr, size_t size)
Hanno Becker466df6e2022-01-10 11:16:51 +0000325{
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 while (size--) {
327 mbedtls_mpi_free(arr++);
328 }
Hanno Becker466df6e2022-01-10 11:16:51 +0000329}
Valerio Settifd122f42023-04-05 18:15:32 +0200330#endif /* MBEDTLS_ECP_C */
Hanno Becker466df6e2022-01-10 11:16:51 +0000331
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +0100332/*
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200333 * List of supported curves:
334 * - internal ID
Christoph M. Wintersteigercb310732019-02-15 15:50:38 +0000335 * - TLS NamedCurve ID (RFC 4492 sec. 5.1.1, RFC 7071 sec. 2, RFC 8446 sec. 4.2.7)
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200336 * - size in bits
Manuel Pégourié-Gonnard8195c1a2013-10-07 19:40:41 +0200337 * - readable name
Gergely Budaie40c4692014-01-22 11:22:20 +0100338 *
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100339 * Curves are listed in order: largest curves first, and for a given size,
Gilles Peskineae270bf2021-06-02 00:05:29 +0200340 * fastest curves first.
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +0200341 *
Gilles Peskineae270bf2021-06-02 00:05:29 +0200342 * Reminder: update profiles in x509_crt.c and ssl_tls.c when adding a new curve!
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200344static const mbedtls_ecp_curve_info ecp_supported_curves[] =
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200345{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
347 { MBEDTLS_ECP_DP_SECP521R1, 25, 521, "secp521r1" },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200348#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200349#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
350 { MBEDTLS_ECP_DP_BP512R1, 28, 512, "brainpoolP512r1" },
Gergely Budaie40c4692014-01-22 11:22:20 +0100351#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
353 { MBEDTLS_ECP_DP_SECP384R1, 24, 384, "secp384r1" },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200354#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200355#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
356 { MBEDTLS_ECP_DP_BP384R1, 27, 384, "brainpoolP384r1" },
Gergely Budaie40c4692014-01-22 11:22:20 +0100357#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
359 { MBEDTLS_ECP_DP_SECP256R1, 23, 256, "secp256r1" },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200360#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED)
362 { MBEDTLS_ECP_DP_SECP256K1, 22, 256, "secp256k1" },
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100363#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
365 { MBEDTLS_ECP_DP_BP256R1, 26, 256, "brainpoolP256r1" },
Gergely Budaie40c4692014-01-22 11:22:20 +0100366#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200367#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED)
368 { MBEDTLS_ECP_DP_SECP224R1, 21, 224, "secp224r1" },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200369#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200370#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED)
371 { MBEDTLS_ECP_DP_SECP224K1, 20, 224, "secp224k1" },
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100372#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED)
374 { MBEDTLS_ECP_DP_SECP192R1, 19, 192, "secp192r1" },
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100375#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED)
377 { MBEDTLS_ECP_DP_SECP192K1, 18, 192, "secp192k1" },
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100378#endif
Gilles Peskine360e2c42020-07-24 02:03:20 +0200379#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Christoph M. Wintersteiger86e36c42018-12-06 17:27:31 +0000380 { MBEDTLS_ECP_DP_CURVE25519, 29, 256, "x25519" },
Christoph M. Wintersteigerc9f737b2018-10-25 13:03:05 +0100381#endif
Gilles Peskine360e2c42020-07-24 02:03:20 +0200382#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
383 { MBEDTLS_ECP_DP_CURVE448, 30, 448, "x448" },
384#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385 { MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200386};
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100387
Gilles Peskine449bd832023-01-11 14:50:10 +0100388#define ECP_NB_CURVES sizeof(ecp_supported_curves) / \
389 sizeof(ecp_supported_curves[0])
Manuel Pégourié-Gonnardba782bb2014-07-08 13:31:34 +0200390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391static mbedtls_ecp_group_id ecp_supported_grp_id[ECP_NB_CURVES];
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200392
393/*
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200394 * List of supported curves and associated info
395 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100396const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list(void)
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200397{
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 return ecp_supported_curves;
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200399}
400
401/*
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100402 * List of supported curves, group ID only
403 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100404const mbedtls_ecp_group_id *mbedtls_ecp_grp_id_list(void)
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100405{
406 static int init_done = 0;
407
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 if (!init_done) {
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100409 size_t i = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200410 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100411
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 for (curve_info = mbedtls_ecp_curve_list();
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200413 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 curve_info++) {
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100415 ecp_supported_grp_id[i++] = curve_info->grp_id;
416 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417 ecp_supported_grp_id[i] = MBEDTLS_ECP_DP_NONE;
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100418
419 init_done = 1;
420 }
421
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 return ecp_supported_grp_id;
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100423}
424
425/*
426 * Get the curve info for the internal identifier
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200427 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100428const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_grp_id(mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200429{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200431
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 for (curve_info = mbedtls_ecp_curve_list();
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 curve_info++) {
435 if (curve_info->grp_id == grp_id) {
436 return curve_info;
437 }
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200438 }
439
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 return NULL;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200441}
442
443/*
444 * Get the curve info from the TLS identifier
445 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100446const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_tls_id(uint16_t tls_id)
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200447{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 for (curve_info = mbedtls_ecp_curve_list();
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 curve_info++) {
453 if (curve_info->tls_id == tls_id) {
454 return curve_info;
455 }
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200456 }
457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return NULL;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200459}
460
461/*
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100462 * Get the curve info from the name
463 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100464const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_name(const char *name)
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100465{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200466 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100467
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 if (name == NULL) {
469 return NULL;
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100470 }
471
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 for (curve_info = mbedtls_ecp_curve_list();
473 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
474 curve_info++) {
475 if (strcmp(curve_info->name, name) == 0) {
476 return curve_info;
477 }
478 }
479
480 return NULL;
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100481}
482
483/*
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +0100484 * Get the type of a curve
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +0100485 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100486mbedtls_ecp_curve_type mbedtls_ecp_get_type(const mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +0100487{
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 if (grp->G.X.p == NULL) {
489 return MBEDTLS_ECP_TYPE_NONE;
490 }
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +0100491
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 if (grp->G.Y.p == NULL) {
493 return MBEDTLS_ECP_TYPE_MONTGOMERY;
494 } else {
495 return MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS;
496 }
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +0100497}
498
499/*
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100500 * Initialize (the components of) a point
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100501 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100502void mbedtls_ecp_point_init(mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100503{
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 mbedtls_mpi_init(&pt->X);
505 mbedtls_mpi_init(&pt->Y);
506 mbedtls_mpi_init(&pt->Z);
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100507}
508
509/*
510 * Initialize (the components of) a group
511 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100512void mbedtls_ecp_group_init(mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100513{
Manuel Pégourié-Gonnard95e2eca2018-06-20 10:29:47 +0200514 grp->id = MBEDTLS_ECP_DP_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 mbedtls_mpi_init(&grp->P);
516 mbedtls_mpi_init(&grp->A);
517 mbedtls_mpi_init(&grp->B);
518 mbedtls_ecp_point_init(&grp->G);
519 mbedtls_mpi_init(&grp->N);
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200520 grp->pbits = 0;
521 grp->nbits = 0;
522 grp->h = 0;
523 grp->modp = NULL;
524 grp->t_pre = NULL;
525 grp->t_post = NULL;
526 grp->t_data = NULL;
527 grp->T = NULL;
528 grp->T_size = 0;
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100529}
530
531/*
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200532 * Initialize (the components of) a key pair
533 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100534void mbedtls_ecp_keypair_init(mbedtls_ecp_keypair *key)
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200535{
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 mbedtls_ecp_group_init(&key->grp);
537 mbedtls_mpi_init(&key->d);
538 mbedtls_ecp_point_init(&key->Q);
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200539}
540
541/*
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100542 * Unallocate (the components of) a point
543 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100544void mbedtls_ecp_point_free(mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100545{
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 if (pt == NULL) {
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100547 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 }
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100549
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 mbedtls_mpi_free(&(pt->X));
551 mbedtls_mpi_free(&(pt->Y));
552 mbedtls_mpi_free(&(pt->Z));
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100553}
554
555/*
kXuanba9cb762021-04-08 14:32:06 +0800556 * Check that the comb table (grp->T) is static initialized.
557 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100558static int ecp_group_is_static_comb_table(const mbedtls_ecp_group *grp)
559{
kXuanba9cb762021-04-08 14:32:06 +0800560#if MBEDTLS_ECP_FIXED_POINT_OPTIM == 1
561 return grp->T != NULL && grp->T_size == 0;
562#else
563 (void) grp;
564 return 0;
565#endif
566}
567
568/*
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100569 * Unallocate (the components of) a group
570 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100571void mbedtls_ecp_group_free(mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100572{
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +0200573 size_t i;
574
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 if (grp == NULL) {
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100576 return;
Manuel Pégourié-Gonnard1f82b042013-12-06 12:51:50 +0100577 }
Manuel Pégourié-Gonnardc9727702013-09-16 18:56:28 +0200578
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 if (grp->h != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 mbedtls_mpi_free(&grp->A);
581 mbedtls_mpi_free(&grp->B);
582 mbedtls_ecp_point_free(&grp->G);
Janos Follathd8cb3d72023-07-31 12:54:59 +0100583
584#if !defined(MBEDTLS_ECP_WITH_MPI_UINT)
Xiaokang Qianb903f4e2023-07-20 05:51:53 +0000585 mbedtls_mpi_free(&grp->N);
Janos Follathd8cb3d72023-07-31 12:54:59 +0100586 mbedtls_mpi_free(&grp->P);
587#endif
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +0200588 }
589
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 if (!ecp_group_is_static_comb_table(grp) && grp->T != NULL) {
591 for (i = 0; i < grp->T_size; i++) {
592 mbedtls_ecp_point_free(&grp->T[i]);
593 }
594 mbedtls_free(grp->T);
595 }
596
597 mbedtls_platform_zeroize(grp, sizeof(mbedtls_ecp_group));
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100598}
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100599
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100600/*
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200601 * Unallocate (the components of) a key pair
602 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100603void mbedtls_ecp_keypair_free(mbedtls_ecp_keypair *key)
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200604{
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 if (key == NULL) {
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200606 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 }
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200608
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 mbedtls_ecp_group_free(&key->grp);
610 mbedtls_mpi_free(&key->d);
611 mbedtls_ecp_point_free(&key->Q);
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200612}
613
614/*
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200615 * Copy the contents of a point
616 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100617int mbedtls_ecp_copy(mbedtls_ecp_point *P, const mbedtls_ecp_point *Q)
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200618{
Janos Follath24eed8d2019-11-22 13:21:35 +0000619 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->X, &Q->X));
621 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->Y, &Q->Y));
622 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&P->Z, &Q->Z));
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200623
624cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 return ret;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200626}
627
628/*
629 * Copy the contents of a group object
630 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100631int mbedtls_ecp_group_copy(mbedtls_ecp_group *dst, const mbedtls_ecp_group *src)
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200632{
Gilles Peskine449bd832023-01-11 14:50:10 +0100633 return mbedtls_ecp_group_load(dst, src->id);
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200634}
635
636/*
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100637 * Set point to zero
638 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100639int mbedtls_ecp_set_zero(mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100640{
Janos Follath24eed8d2019-11-22 13:21:35 +0000641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100642 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->X, 1));
643 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Y, 1));
644 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 0));
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +0100645
646cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 return ret;
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100648}
649
650/*
Manuel Pégourié-Gonnard6545ca72013-01-26 16:05:22 +0100651 * Tell if a point is zero
652 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100653int mbedtls_ecp_is_zero(mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnard6545ca72013-01-26 16:05:22 +0100654{
Gilles Peskine449bd832023-01-11 14:50:10 +0100655 return mbedtls_mpi_cmp_int(&pt->Z, 0) == 0;
Manuel Pégourié-Gonnard6545ca72013-01-26 16:05:22 +0100656}
657
658/*
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500659 * Compare two points lazily
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200660 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100661int mbedtls_ecp_point_cmp(const mbedtls_ecp_point *P,
662 const mbedtls_ecp_point *Q)
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200663{
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 if (mbedtls_mpi_cmp_mpi(&P->X, &Q->X) == 0 &&
665 mbedtls_mpi_cmp_mpi(&P->Y, &Q->Y) == 0 &&
666 mbedtls_mpi_cmp_mpi(&P->Z, &Q->Z) == 0) {
667 return 0;
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200668 }
669
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200671}
672
673/*
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100674 * Import a non-zero point from ASCII strings
675 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100676int mbedtls_ecp_point_read_string(mbedtls_ecp_point *P, int radix,
677 const char *x, const char *y)
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100678{
Janos Follath24eed8d2019-11-22 13:21:35 +0000679 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(&P->X, radix, x));
681 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(&P->Y, radix, y));
682 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&P->Z, 1));
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100683
684cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return ret;
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100686}
687
688/*
Janos Follath7caf8e42019-02-20 12:00:22 +0000689 * Export a point into unsigned binary data (SEC1 2.3.3 and RFC7748)
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100690 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100691int mbedtls_ecp_point_write_binary(const mbedtls_ecp_group *grp,
692 const mbedtls_ecp_point *P,
693 int format, size_t *olen,
694 unsigned char *buf, size_t buflen)
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100695{
Janos Follath28eb06d2019-02-26 10:53:34 +0000696 int ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100697 size_t plen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (format != MBEDTLS_ECP_PF_UNCOMPRESSED &&
699 format != MBEDTLS_ECP_PF_COMPRESSED) {
700 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
701 }
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 plen = mbedtls_mpi_size(&grp->P);
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100704
Gilles Peskinee8c04fe2018-09-14 17:44:21 +0200705#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine59970052019-02-28 13:12:06 +0100706 (void) format; /* Montgomery curves always use the same point format */
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Janos Follath7caf8e42019-02-20 12:00:22 +0000708 *olen = plen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 if (buflen < *olen) {
710 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
711 }
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary_le(&P->X, buf, plen));
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100714 }
Janos Follath7caf8e42019-02-20 12:00:22 +0000715#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +0200716#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
Janos Follath7caf8e42019-02-20 12:00:22 +0000718 /*
719 * Common case: P == 0
720 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if (mbedtls_mpi_cmp_int(&P->Z, 0) == 0) {
722 if (buflen < 1) {
723 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
724 }
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100725
Janos Follath7caf8e42019-02-20 12:00:22 +0000726 buf[0] = 0x00;
727 *olen = 1;
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 return 0;
Janos Follath7caf8e42019-02-20 12:00:22 +0000730 }
731
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (format == MBEDTLS_ECP_PF_UNCOMPRESSED) {
Janos Follath7caf8e42019-02-20 12:00:22 +0000733 *olen = 2 * plen + 1;
734
Gilles Peskine449bd832023-01-11 14:50:10 +0100735 if (buflen < *olen) {
736 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
737 }
Janos Follath7caf8e42019-02-20 12:00:22 +0000738
739 buf[0] = 0x04;
Gilles Peskine449bd832023-01-11 14:50:10 +0100740 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->X, buf + 1, plen));
741 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->Y, buf + 1 + plen, plen));
742 } else if (format == MBEDTLS_ECP_PF_COMPRESSED) {
Janos Follath7caf8e42019-02-20 12:00:22 +0000743 *olen = plen + 1;
744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 if (buflen < *olen) {
746 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
747 }
Janos Follath7caf8e42019-02-20 12:00:22 +0000748
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 buf[0] = 0x02 + mbedtls_mpi_get_bit(&P->Y, 0);
750 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&P->X, buf + 1, plen));
Janos Follath7caf8e42019-02-20 12:00:22 +0000751 }
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100752 }
Janos Follath7caf8e42019-02-20 12:00:22 +0000753#endif
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100754
755cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 return ret;
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100757}
758
Glenn Strauss2ff77112022-09-14 23:27:50 -0400759#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100760static int mbedtls_ecp_sw_derive_y(const mbedtls_ecp_group *grp,
761 const mbedtls_mpi *X,
762 mbedtls_mpi *Y,
763 int parity_bit);
Glenn Strauss2ff77112022-09-14 23:27:50 -0400764#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
765
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100766/*
Janos Follath59b813c2019-02-13 10:44:06 +0000767 * Import a point from unsigned binary data (SEC1 2.3.4 and RFC7748)
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100768 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769int mbedtls_ecp_point_read_binary(const mbedtls_ecp_group *grp,
770 mbedtls_ecp_point *pt,
771 const unsigned char *buf, size_t ilen)
Manuel Pégourié-Gonnard5246ee52014-03-19 16:18:38 +0100772{
Janos Follath28eb06d2019-02-26 10:53:34 +0000773 int ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100774 size_t plen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (ilen < 1) {
776 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
777 }
Manuel Pégourié-Gonnard67dbe1e2014-07-08 13:09:24 +0200778
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 plen = mbedtls_mpi_size(&grp->P);
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100780
Gilles Peskinee8c04fe2018-09-14 17:44:21 +0200781#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
783 if (plen != ilen) {
784 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
785 }
Manuel Pégourié-Gonnard5246ee52014-03-19 16:18:38 +0100786
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&pt->X, buf, plen));
788 mbedtls_mpi_free(&pt->Y);
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100789
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (grp->id == MBEDTLS_ECP_DP_CURVE25519) {
Janos Follathffbd7e82019-02-25 11:35:20 +0000791 /* Set most significant bit to 0 as prescribed in RFC7748 §5 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&pt->X, plen * 8 - 1, 0));
793 }
Janos Follath28eb06d2019-02-26 10:53:34 +0000794
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 1));
Janos Follath59b813c2019-02-13 10:44:06 +0000796 }
797#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +0200798#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
800 if (buf[0] == 0x00) {
801 if (ilen == 1) {
802 return mbedtls_ecp_set_zero(pt);
803 } else {
804 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
805 }
Janos Follath59b813c2019-02-13 10:44:06 +0000806 }
807
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 if (ilen < 1 + plen) {
809 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
810 }
Janos Follath59b813c2019-02-13 10:44:06 +0000811
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&pt->X, buf + 1, plen));
813 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&pt->Z, 1));
Glenn Strauss2ff77112022-09-14 23:27:50 -0400814
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 if (buf[0] == 0x04) {
Glenn Strauss2ff77112022-09-14 23:27:50 -0400816 /* format == MBEDTLS_ECP_PF_UNCOMPRESSED */
Gilles Peskine449bd832023-01-11 14:50:10 +0100817 if (ilen != 1 + plen * 2) {
818 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
819 }
820 return mbedtls_mpi_read_binary(&pt->Y, buf + 1 + plen, plen);
821 } else if (buf[0] == 0x02 || buf[0] == 0x03) {
Glenn Strauss2ff77112022-09-14 23:27:50 -0400822 /* format == MBEDTLS_ECP_PF_COMPRESSED */
Gilles Peskine449bd832023-01-11 14:50:10 +0100823 if (ilen != 1 + plen) {
824 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
825 }
826 return mbedtls_ecp_sw_derive_y(grp, &pt->X, &pt->Y,
827 (buf[0] & 1));
828 } else {
829 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Glenn Strauss2ff77112022-09-14 23:27:50 -0400830 }
Janos Follath59b813c2019-02-13 10:44:06 +0000831 }
832#endif
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100833
834cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100835 return ret;
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100836}
837
838/*
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100839 * Import a point from a TLS ECPoint record (RFC 4492)
840 * struct {
841 * opaque point <1..2^8-1>;
842 * } ECPoint;
843 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100844int mbedtls_ecp_tls_read_point(const mbedtls_ecp_group *grp,
845 mbedtls_ecp_point *pt,
846 const unsigned char **buf, size_t buf_len)
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100847{
848 unsigned char data_len;
Manuel Pégourié-Gonnard98f51812013-02-10 13:38:29 +0100849 const unsigned char *buf_start;
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100850 /*
Manuel Pégourié-Gonnard67dbe1e2014-07-08 13:09:24 +0200851 * We must have at least two bytes (1 for length, at least one for data)
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100852 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 if (buf_len < 2) {
854 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
855 }
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100856
Manuel Pégourié-Gonnard98f51812013-02-10 13:38:29 +0100857 data_len = *(*buf)++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100858 if (data_len < 1 || data_len > buf_len - 1) {
859 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
860 }
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100861
Manuel Pégourié-Gonnard98f51812013-02-10 13:38:29 +0100862 /*
863 * Save buffer start for read_binary and update buf
864 */
865 buf_start = *buf;
866 *buf += data_len;
867
Gilles Peskine449bd832023-01-11 14:50:10 +0100868 return mbedtls_ecp_point_read_binary(grp, pt, buf_start, data_len);
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100869}
870
871/*
872 * Export a point as a TLS ECPoint record (RFC 4492)
873 * struct {
874 * opaque point <1..2^8-1>;
875 * } ECPoint;
876 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100877int mbedtls_ecp_tls_write_point(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt,
878 int format, size_t *olen,
879 unsigned char *buf, size_t blen)
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100880{
Janos Follath24eed8d2019-11-22 13:21:35 +0000881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 if (format != MBEDTLS_ECP_PF_UNCOMPRESSED &&
883 format != MBEDTLS_ECP_PF_COMPRESSED) {
884 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
885 }
Manuel Pégourié-Gonnard420f1eb2013-02-10 12:22:46 +0100886
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100887 /*
Manuel Pégourié-Gonnard420f1eb2013-02-10 12:22:46 +0100888 * buffer length must be at least one, for our length byte
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100889 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 if (blen < 1) {
891 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
892 }
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100893
Gilles Peskine449bd832023-01-11 14:50:10 +0100894 if ((ret = mbedtls_ecp_point_write_binary(grp, pt, format,
895 olen, buf + 1, blen - 1)) != 0) {
896 return ret;
897 }
Manuel Pégourié-Gonnard420f1eb2013-02-10 12:22:46 +0100898
899 /*
900 * write length to the first byte and update total length
901 */
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200902 buf[0] = (unsigned char) *olen;
Manuel Pégourié-Gonnard420f1eb2013-02-10 12:22:46 +0100903 ++*olen;
904
Gilles Peskine449bd832023-01-11 14:50:10 +0100905 return 0;
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100906}
907
908/*
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100909 * Set a group from an ECParameters record (RFC 4492)
910 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100911int mbedtls_ecp_tls_read_group(mbedtls_ecp_group *grp,
912 const unsigned char **buf, size_t len)
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500913{
Janos Follath24eed8d2019-11-22 13:21:35 +0000914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500915 mbedtls_ecp_group_id grp_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 if ((ret = mbedtls_ecp_tls_read_group_id(&grp_id, buf, len)) != 0) {
917 return ret;
918 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500919
Gilles Peskine449bd832023-01-11 14:50:10 +0100920 return mbedtls_ecp_group_load(grp, grp_id);
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500921}
922
923/*
924 * Read a group id from an ECParameters record (RFC 4492) and convert it to
925 * mbedtls_ecp_group_id.
926 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100927int mbedtls_ecp_tls_read_group_id(mbedtls_ecp_group_id *grp,
928 const unsigned char **buf, size_t len)
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100929{
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +0200930 uint16_t tls_id;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100932 /*
933 * We expect at least three bytes (see below)
934 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 if (len < 3) {
936 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
937 }
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100938
939 /*
940 * First byte is curve_type; only named_curve is handled
941 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 if (*(*buf)++ != MBEDTLS_ECP_TLS_NAMED_CURVE) {
943 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
944 }
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100945
946 /*
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100947 * Next two bytes are the namedcurve value
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100948 */
Dave Rodgman6a9fb932023-08-16 17:50:36 +0100949 tls_id = MBEDTLS_GET_UINT16_BE(*buf, 0);
950 *buf += 2;
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +0200951
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 if ((curve_info = mbedtls_ecp_curve_info_from_tls_id(tls_id)) == NULL) {
953 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
954 }
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +0200955
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500956 *grp = curve_info->grp_id;
957
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 return 0;
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100959}
960
961/*
962 * Write the ECParameters record corresponding to a group (RFC 4492)
963 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100964int mbedtls_ecp_tls_write_group(const mbedtls_ecp_group *grp, size_t *olen,
965 unsigned char *buf, size_t blen)
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100966{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 const mbedtls_ecp_curve_info *curve_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 if ((curve_info = mbedtls_ecp_curve_info_from_grp_id(grp->id)) == NULL) {
969 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
970 }
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +0200971
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100972 /*
973 * We are going to write 3 bytes (see below)
974 */
975 *olen = 3;
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 if (blen < *olen) {
977 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
978 }
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100979
980 /*
981 * First byte is curve_type, always named_curve
982 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983 *buf++ = MBEDTLS_ECP_TLS_NAMED_CURVE;
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100984
985 /*
986 * Next two bytes are the namedcurve value
987 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 MBEDTLS_PUT_UINT16_BE(curve_info->tls_id, buf, 0);
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 return 0;
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100991}
Manuel Pégourié-Gonnardab38b702012-11-05 17:34:55 +0100992
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200993/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994 * Wrapper around fast quasi-modp functions, with fall-back to mbedtls_mpi_mod_mpi.
995 * See the documentation of struct mbedtls_ecp_group.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200996 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 * This function is in the critial loop for mbedtls_ecp_mul, so pay attention to perf.
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200998 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100999static int ecp_modp(mbedtls_mpi *N, const mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +02001000{
Janos Follath24eed8d2019-11-22 13:21:35 +00001001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001002
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 if (grp->modp == NULL) {
1004 return mbedtls_mpi_mod_mpi(N, N, &grp->P);
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +02001005 }
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001006
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 /* N->s < 0 is a much faster test, which fails only if N is 0 */
1008 if ((N->s < 0 && mbedtls_mpi_cmp_int(N, 0) != 0) ||
1009 mbedtls_mpi_bitlen(N) > 2 * grp->pbits) {
1010 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1011 }
1012
1013 MBEDTLS_MPI_CHK(grp->modp(N));
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +02001014
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +02001015 /* N->s < 0 is a much faster test, which fails only if N is 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 while (N->s < 0 && mbedtls_mpi_cmp_int(N, 0) != 0) {
1017 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(N, N, &grp->P));
1018 }
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 while (mbedtls_mpi_cmp_mpi(N, &grp->P) >= 0) {
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +02001021 /* we known P, N and the result are positive */
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_abs(N, N, &grp->P));
1023 }
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001024
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +02001025cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 return ret;
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +02001027}
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001028
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +01001029/*
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +01001030 * Fast mod-p functions expect their argument to be in the 0..p^2 range.
Manuel Pégourié-Gonnarddada4da2012-11-10 14:23:17 +01001031 *
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +01001032 * In order to guarantee that, we need to ensure that operands of
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * mbedtls_mpi_mul_mpi are in the 0..p range. So, after each operation we will
Manuel Pégourié-Gonnarddada4da2012-11-10 14:23:17 +01001034 * bring the result back to this range.
1035 *
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +01001036 * The following macros are shortcuts for doing that.
Manuel Pégourié-Gonnarddada4da2012-11-10 14:23:17 +01001037 */
1038
1039/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * Reduce a mbedtls_mpi mod p in-place, general case, to use after mbedtls_mpi_mul_mpi
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnard91814812013-11-21 20:23:55 +01001043#define INC_MUL_COUNT mul_count++;
1044#else
1045#define INC_MUL_COUNT
1046#endif
1047
Gilles Peskine449bd832023-01-11 14:50:10 +01001048#define MOD_MUL(N) \
Hanno Becker1eeca412018-10-15 12:01:35 +01001049 do \
1050 { \
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 MBEDTLS_MPI_CHK(ecp_modp(&(N), grp)); \
Hanno Becker1eeca412018-10-15 12:01:35 +01001052 INC_MUL_COUNT \
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 } while (0)
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001054
Gilles Peskine449bd832023-01-11 14:50:10 +01001055static inline int mbedtls_mpi_mul_mod(const mbedtls_ecp_group *grp,
1056 mbedtls_mpi *X,
1057 const mbedtls_mpi *A,
1058 const mbedtls_mpi *B)
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001059{
Janos Follath24eed8d2019-11-22 13:21:35 +00001060 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mpi(X, A, B));
1062 MOD_MUL(*X);
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001063cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 return ret;
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001065}
1066
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001067/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * Reduce a mbedtls_mpi mod p in-place, to use after mbedtls_mpi_sub_mpi
Manuel Pégourié-Gonnardc9e387c2013-10-17 17:15:35 +02001069 * N->s < 0 is a very fast test, which fails only if N is 0
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071#define MOD_SUB(N) \
Hanno Beckerce29ae82022-01-04 04:55:11 +00001072 do { \
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 while ((N)->s < 0 && mbedtls_mpi_cmp_int((N), 0) != 0) \
1074 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi((N), (N), &grp->P)); \
1075 } while (0)
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001076
Dave Rodgman815b2402023-12-14 20:51:21 +00001077MBEDTLS_MAYBE_UNUSED
Gilles Peskine449bd832023-01-11 14:50:10 +01001078static inline int mbedtls_mpi_sub_mod(const mbedtls_ecp_group *grp,
1079 mbedtls_mpi *X,
1080 const mbedtls_mpi *A,
1081 const mbedtls_mpi *B)
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001082{
Janos Follath24eed8d2019-11-22 13:21:35 +00001083 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(X, A, B));
1085 MOD_SUB(X);
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001086cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 return ret;
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001088}
1089
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001090/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * Reduce a mbedtls_mpi mod p in-place, to use after mbedtls_mpi_add_mpi and mbedtls_mpi_mul_int.
Manuel Pégourié-Gonnardc9e387c2013-10-17 17:15:35 +02001092 * We known P, N and the result are positive, so sub_abs is correct, and
1093 * a bit faster.
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001094 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001095#define MOD_ADD(N) \
1096 while (mbedtls_mpi_cmp_mpi((N), &grp->P) >= 0) \
1097 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_abs((N), (N), &grp->P))
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099static inline int mbedtls_mpi_add_mod(const mbedtls_ecp_group *grp,
1100 mbedtls_mpi *X,
1101 const mbedtls_mpi *A,
1102 const mbedtls_mpi *B)
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001103{
Janos Follath24eed8d2019-11-22 13:21:35 +00001104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(X, A, B));
1106 MOD_ADD(X);
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001107cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 return ret;
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001109}
1110
Dave Rodgman815b2402023-12-14 20:51:21 +00001111MBEDTLS_MAYBE_UNUSED
Gilles Peskine449bd832023-01-11 14:50:10 +01001112static inline int mbedtls_mpi_mul_int_mod(const mbedtls_ecp_group *grp,
1113 mbedtls_mpi *X,
1114 const mbedtls_mpi *A,
1115 mbedtls_mpi_uint c)
Hanno Becker02b35bd2022-01-01 06:54:25 +00001116{
1117 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_int(X, A, c));
1120 MOD_ADD(X);
Hanno Becker02b35bd2022-01-01 06:54:25 +00001121cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 return ret;
Hanno Becker02b35bd2022-01-01 06:54:25 +00001123}
1124
Dave Rodgman815b2402023-12-14 20:51:21 +00001125MBEDTLS_MAYBE_UNUSED
Gilles Peskine449bd832023-01-11 14:50:10 +01001126static inline int mbedtls_mpi_sub_int_mod(const mbedtls_ecp_group *grp,
1127 mbedtls_mpi *X,
1128 const mbedtls_mpi *A,
1129 mbedtls_mpi_uint c)
Hanno Beckerce29ae82022-01-04 04:55:11 +00001130{
1131 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(X, A, c));
1134 MOD_SUB(X);
Hanno Beckerce29ae82022-01-04 04:55:11 +00001135cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 return ret;
Hanno Beckerce29ae82022-01-04 04:55:11 +00001137}
1138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139#define MPI_ECP_SUB_INT(X, A, c) \
1140 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int_mod(grp, X, A, c))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001141
Dave Rodgman815b2402023-12-14 20:51:21 +00001142MBEDTLS_MAYBE_UNUSED
Gilles Peskine449bd832023-01-11 14:50:10 +01001143static inline int mbedtls_mpi_shift_l_mod(const mbedtls_ecp_group *grp,
1144 mbedtls_mpi *X,
1145 size_t count)
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001146{
Janos Follath24eed8d2019-11-22 13:21:35 +00001147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_l(X, count));
1149 MOD_ADD(X);
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001150cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 return ret;
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001152}
1153
Hanno Becker595616e2022-01-05 08:28:24 +00001154/*
1155 * Macro wrappers around ECP modular arithmetic
1156 *
1157 * Currently, these wrappers are defined via the bignum module.
1158 */
1159
Gilles Peskine449bd832023-01-11 14:50:10 +01001160#define MPI_ECP_ADD(X, A, B) \
1161 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mod(grp, X, A, B))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001162
Gilles Peskine449bd832023-01-11 14:50:10 +01001163#define MPI_ECP_SUB(X, A, B) \
1164 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mod(grp, X, A, B))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166#define MPI_ECP_MUL(X, A, B) \
1167 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mod(grp, X, A, B))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169#define MPI_ECP_SQR(X, A) \
1170 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mod(grp, X, A, A))
Hanno Becker885ed402022-01-04 06:43:50 +00001171
Gilles Peskine449bd832023-01-11 14:50:10 +01001172#define MPI_ECP_MUL_INT(X, A, c) \
1173 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_int_mod(grp, X, A, c))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001174
Gilles Peskine449bd832023-01-11 14:50:10 +01001175#define MPI_ECP_INV(dst, src) \
1176 MBEDTLS_MPI_CHK(mbedtls_mpi_inv_mod((dst), (src), &grp->P))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178#define MPI_ECP_MOV(X, A) \
1179 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(X, A))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001180
Gilles Peskine449bd832023-01-11 14:50:10 +01001181#define MPI_ECP_SHIFT_L(X, count) \
1182 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_l_mod(grp, X, count))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001183
Gilles Peskine449bd832023-01-11 14:50:10 +01001184#define MPI_ECP_LSET(X, c) \
1185 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(X, c))
Hanno Becker595616e2022-01-05 08:28:24 +00001186
Gilles Peskine449bd832023-01-11 14:50:10 +01001187#define MPI_ECP_CMP_INT(X, c) \
1188 mbedtls_mpi_cmp_int(X, c)
Hanno Becker595616e2022-01-05 08:28:24 +00001189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190#define MPI_ECP_CMP(X, Y) \
1191 mbedtls_mpi_cmp_mpi(X, Y)
Hanno Becker595616e2022-01-05 08:28:24 +00001192
1193/* Needs f_rng, p_rng to be defined. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001194#define MPI_ECP_RAND(X) \
1195 MBEDTLS_MPI_CHK(mbedtls_mpi_random((X), 2, &grp->P, f_rng, p_rng))
Hanno Becker595616e2022-01-05 08:28:24 +00001196
1197/* Conditional negation
1198 * Needs grp and a temporary MPI tmp to be defined. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001199#define MPI_ECP_COND_NEG(X, cond) \
Hanno Becker595616e2022-01-05 08:28:24 +00001200 do \
1201 { \
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 unsigned char nonzero = mbedtls_mpi_cmp_int((X), 0) != 0; \
1203 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&tmp, &grp->P, (X))); \
1204 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign((X), &tmp, \
1205 nonzero & cond)); \
1206 } while (0)
Hanno Becker595616e2022-01-05 08:28:24 +00001207
Gilles Peskine449bd832023-01-11 14:50:10 +01001208#define MPI_ECP_NEG(X) MPI_ECP_COND_NEG((X), 1)
Hanno Beckerc27a0e02022-01-06 05:56:34 +00001209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210#define MPI_ECP_VALID(X) \
1211 ((X)->p != NULL)
Hanno Beckerc27a0e02022-01-06 05:56:34 +00001212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213#define MPI_ECP_COND_ASSIGN(X, Y, cond) \
1214 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign((X), (Y), (cond)))
Hanno Beckerc27a0e02022-01-06 05:56:34 +00001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216#define MPI_ECP_COND_SWAP(X, Y, cond) \
1217 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_swap((X), (Y), (cond)))
Hanno Beckerc27a0e02022-01-06 05:56:34 +00001218
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02001219#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Glenn Straussefde9d52022-12-20 04:20:12 -05001220
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001221/*
1222 * Computes the right-hand side of the Short Weierstrass equation
1223 * RHS = X^3 + A X + B
1224 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001225static int ecp_sw_rhs(const mbedtls_ecp_group *grp,
1226 mbedtls_mpi *rhs,
1227 const mbedtls_mpi *X)
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001228{
1229 int ret;
1230
1231 /* Compute X^3 + A X + B as X (X^2 + A) + B */
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 MPI_ECP_SQR(rhs, X);
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001233
1234 /* Special case for A = -3 */
Chien Wong153ae462023-01-31 23:27:03 +08001235 if (mbedtls_ecp_group_a_is_minus_3(grp)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 MPI_ECP_SUB_INT(rhs, rhs, 3);
1237 } else {
1238 MPI_ECP_ADD(rhs, rhs, &grp->A);
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001239 }
1240
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 MPI_ECP_MUL(rhs, rhs, X);
1242 MPI_ECP_ADD(rhs, rhs, &grp->B);
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001243
1244cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 return ret;
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001246}
1247
1248/*
1249 * Derive Y from X and a parity bit
1250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251static int mbedtls_ecp_sw_derive_y(const mbedtls_ecp_group *grp,
1252 const mbedtls_mpi *X,
1253 mbedtls_mpi *Y,
1254 int parity_bit)
Glenn Strauss45241612022-12-19 19:37:07 -05001255{
1256 /* w = y^2 = x^3 + ax + b
1257 * y = sqrt(w) = w^((p+1)/4) mod p (for prime p where p = 3 mod 4)
1258 *
1259 * Note: this method for extracting square root does not validate that w
1260 * was indeed a square so this function will return garbage in Y if X
1261 * does not correspond to a point on the curve.
1262 */
1263
1264 /* Check prerequisite p = 3 mod 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 if (mbedtls_mpi_get_bit(&grp->P, 0) != 1 ||
1266 mbedtls_mpi_get_bit(&grp->P, 1) != 1) {
1267 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
1268 }
Glenn Strauss45241612022-12-19 19:37:07 -05001269
1270 int ret;
1271 mbedtls_mpi exp;
Gilles Peskine449bd832023-01-11 14:50:10 +01001272 mbedtls_mpi_init(&exp);
Glenn Strauss45241612022-12-19 19:37:07 -05001273
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001274 /* use Y to store intermediate result, actually w above */
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 MBEDTLS_MPI_CHK(ecp_sw_rhs(grp, Y, X));
Glenn Strauss45241612022-12-19 19:37:07 -05001276
1277 /* w = y^2 */ /* Y contains y^2 intermediate result */
1278 /* exp = ((p+1)/4) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&exp, &grp->P, 1));
1280 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_r(&exp, 2));
Glenn Strauss45241612022-12-19 19:37:07 -05001281 /* sqrt(w) = w^((p+1)/4) mod p (for prime p where p = 3 mod 4) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001282 MBEDTLS_MPI_CHK(mbedtls_mpi_exp_mod(Y, Y /*y^2*/, &exp, &grp->P, NULL));
Glenn Strauss45241612022-12-19 19:37:07 -05001283
1284 /* check parity bit match or else invert Y */
1285 /* This quick inversion implementation is valid because Y != 0 for all
1286 * Short Weierstrass curves supported by mbedtls, as each supported curve
1287 * has an order that is a large prime, so each supported curve does not
1288 * have any point of order 2, and a point with Y == 0 would be of order 2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 if (mbedtls_mpi_get_bit(Y, 0) != parity_bit) {
1290 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(Y, &grp->P, Y));
1291 }
Glenn Strauss45241612022-12-19 19:37:07 -05001292
1293cleanup:
1294
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 mbedtls_mpi_free(&exp);
1296 return ret;
Glenn Strauss45241612022-12-19 19:37:07 -05001297}
Valerio Settifd122f42023-04-05 18:15:32 +02001298#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Glenn Strauss45241612022-12-19 19:37:07 -05001299
Valerio Settifd122f42023-04-05 18:15:32 +02001300#if defined(MBEDTLS_ECP_C)
1301#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01001302/*
1303 * For curves in short Weierstrass form, we do all the internal operations in
1304 * Jacobian coordinates.
1305 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001306 * For multiplication, we'll use a comb method with countermeasures against
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01001307 * SPA, hence timing attacks.
1308 */
1309
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001310/*
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +01001311 * Normalize jacobian coordinates so that Z == 0 || Z == 1 (GECC 3.2.1)
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01001312 * Cost: 1N := 1I + 3M + 1S
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001313 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001314static int ecp_normalize_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001315{
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (MPI_ECP_CMP_INT(&pt->Z, 0) == 0) {
1317 return 0;
1318 }
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001319
Janos Follathb0697532016-08-18 12:38:46 +01001320#if defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 if (mbedtls_internal_ecp_grp_capable(grp)) {
1322 return mbedtls_internal_ecp_normalize_jac(grp, pt);
1323 }
Janos Follath372697b2016-10-28 16:53:11 +01001324#endif /* MBEDTLS_ECP_NORMALIZE_JAC_ALT */
Manuel Pégourié-Gonnardebac5d32017-08-23 16:23:36 +02001325
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001326#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001328#else
1329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker76f897d2022-01-02 12:47:34 +00001330 mbedtls_mpi T;
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 mbedtls_mpi_init(&T);
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MPI_ECP_INV(&T, &pt->Z); /* T <- 1 / Z */
1334 MPI_ECP_MUL(&pt->Y, &pt->Y, &T); /* Y' <- Y*T = Y / Z */
1335 MPI_ECP_SQR(&T, &T); /* T <- T^2 = 1 / Z^2 */
1336 MPI_ECP_MUL(&pt->X, &pt->X, &T); /* X <- X * T = X / Z^2 */
1337 MPI_ECP_MUL(&pt->Y, &pt->Y, &T); /* Y'' <- Y' * T = Y / Z^3 */
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MPI_ECP_LSET(&pt->Z, 1);
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001340
1341cleanup:
1342
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 mbedtls_mpi_free(&T);
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001346#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT) */
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001347}
1348
1349/*
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001350 * Normalize jacobian coordinates of an array of (pointers to) points,
Manuel Pégourié-Gonnard3680c822012-11-21 18:49:45 +01001351 * using Montgomery's trick to perform only one inversion mod P.
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001352 * (See for example Cohen's "A Course in Computational Algebraic Number
1353 * Theory", Algorithm 10.3.4.)
1354 *
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001355 * Warning: fails (returning an error) if one of the points is zero!
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +01001356 * This should never happen, see choice of w in ecp_mul_comb().
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01001357 *
1358 * Cost: 1N(t) := 1I + (6t - 3)M + 1S
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001359 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001360static int ecp_normalize_jac_many(const mbedtls_ecp_group *grp,
1361 mbedtls_ecp_point *T[], size_t T_size)
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001362{
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 if (T_size < 2) {
1364 return ecp_normalize_jac(grp, *T);
1365 }
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001366
Janos Follathb0697532016-08-18 12:38:46 +01001367#if defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 if (mbedtls_internal_ecp_grp_capable(grp)) {
1369 return mbedtls_internal_ecp_normalize_jac_many(grp, T, T_size);
1370 }
Janos Follathb0697532016-08-18 12:38:46 +01001371#endif
1372
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001373#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001375#else
1376 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1377 size_t i;
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001378 mbedtls_mpi *c, t;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if ((c = mbedtls_calloc(T_size, sizeof(mbedtls_mpi))) == NULL) {
1381 return MBEDTLS_ERR_ECP_ALLOC_FAILED;
1382 }
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001383
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 mbedtls_mpi_init(&t);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001385
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 mpi_init_many(c, T_size);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001387 /*
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001388 * c[i] = Z_0 * ... * Z_i, i = 0,..,n := T_size-1
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001389 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 MPI_ECP_MOV(&c[0], &T[0]->Z);
1391 for (i = 1; i < T_size; i++) {
1392 MPI_ECP_MUL(&c[i], &c[i-1], &T[i]->Z);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001393 }
1394
1395 /*
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001396 * c[n] = 1 / (Z_0 * ... * Z_n) mod P
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 MPI_ECP_INV(&c[T_size-1], &c[T_size-1]);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001399
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 for (i = T_size - 1;; i--) {
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001401 /* At the start of iteration i (note that i decrements), we have
1402 * - c[j] = Z_0 * .... * Z_j for j < i,
1403 * - c[j] = 1 / (Z_0 * .... * Z_j) for j == i,
1404 *
1405 * This is maintained via
1406 * - c[i-1] <- c[i] * Z_i
1407 *
1408 * We also derive 1/Z_i = c[i] * c[i-1] for i>0 and use that
1409 * to do the actual normalization. For i==0, we already have
1410 * c[0] = 1 / Z_0.
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001411 */
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 if (i > 0) {
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001414 /* Compute 1/Z_i and establish invariant for the next iteration. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 MPI_ECP_MUL(&t, &c[i], &c[i-1]);
1416 MPI_ECP_MUL(&c[i-1], &c[i], &T[i]->Z);
1417 } else {
1418 MPI_ECP_MOV(&t, &c[0]);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001419 }
1420
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001421 /* Now t holds 1 / Z_i; normalize as in ecp_normalize_jac() */
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 MPI_ECP_MUL(&T[i]->Y, &T[i]->Y, &t);
1423 MPI_ECP_SQR(&t, &t);
1424 MPI_ECP_MUL(&T[i]->X, &T[i]->X, &t);
1425 MPI_ECP_MUL(&T[i]->Y, &T[i]->Y, &t);
Manuel Pégourié-Gonnard1f789b82013-12-30 17:31:56 +01001426
1427 /*
1428 * Post-precessing: reclaim some memory by shrinking coordinates
1429 * - not storing Z (always 1)
1430 * - shrinking other coordinates, but still keeping the same number of
1431 * limbs as P, as otherwise it will too likely be regrown too fast.
1432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 MBEDTLS_MPI_CHK(mbedtls_mpi_shrink(&T[i]->X, grp->P.n));
1434 MBEDTLS_MPI_CHK(mbedtls_mpi_shrink(&T[i]->Y, grp->P.n));
Hanno Beckeree95f6c2022-01-09 05:46:18 +00001435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 MPI_ECP_LSET(&T[i]->Z, 1);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001437
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 if (i == 0) {
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001439 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 }
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001441 }
1442
1443cleanup:
1444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 mbedtls_mpi_free(&t);
1446 mpi_free_many(c, T_size);
1447 mbedtls_free(c);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001450#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT) */
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001451}
1452
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001453/*
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001454 * Conditional point inversion: Q -> -Q = (Q.X, -Q.Y, Q.Z) without leak.
1455 * "inv" must be 0 (don't invert) or 1 (invert) or the result will be invalid
1456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001457static int ecp_safe_invert_jac(const mbedtls_ecp_group *grp,
1458 mbedtls_ecp_point *Q,
1459 unsigned char inv)
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001460{
Janos Follath24eed8d2019-11-22 13:21:35 +00001461 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker595616e2022-01-05 08:28:24 +00001462 mbedtls_mpi tmp;
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 mbedtls_mpi_init(&tmp);
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001464
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 MPI_ECP_COND_NEG(&Q->Y, inv);
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001466
1467cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 mbedtls_mpi_free(&tmp);
1469 return ret;
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001470}
1471
1472/*
Manuel Pégourié-Gonnard0cd6f982013-10-10 15:55:39 +02001473 * Point doubling R = 2 P, Jacobian coordinates
Manuel Pégourié-Gonnard0ace4b32013-10-10 12:44:27 +02001474 *
Peter Dettmance661b22015-02-07 14:43:51 +07001475 * Based on http://www.hyperelliptic.org/EFD/g1p/auto-shortw-jacobian.html#doubling-dbl-1998-cmo-2 .
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01001476 *
Peter Dettmance661b22015-02-07 14:43:51 +07001477 * We follow the variable naming fairly closely. The formula variations that trade a MUL for a SQR
1478 * (plus a few ADDs) aren't useful as our bignum implementation doesn't distinguish squaring.
1479 *
1480 * Standard optimizations are applied when curve parameter A is one of { 0, -3 }.
1481 *
1482 * Cost: 1D := 3M + 4S (A == 0)
1483 * 4M + 4S (A == -3)
1484 * 3M + 6S + 1a otherwise
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001486static int ecp_double_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
1487 const mbedtls_ecp_point *P,
1488 mbedtls_mpi tmp[4])
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001489{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnard0cd6f982013-10-10 15:55:39 +02001491 dbl_count++;
1492#endif
1493
Janos Follathb0697532016-08-18 12:38:46 +01001494#if defined(MBEDTLS_ECP_DOUBLE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 if (mbedtls_internal_ecp_grp_capable(grp)) {
1496 return mbedtls_internal_ecp_double_jac(grp, R, P);
1497 }
Janos Follath372697b2016-10-28 16:53:11 +01001498#endif /* MBEDTLS_ECP_DOUBLE_JAC_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01001499
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001500#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_DOUBLE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001502#else
1503 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard73cc01d2013-12-06 12:41:30 +01001504
1505 /* Special case for A = -3 */
Chien Wong153ae462023-01-31 23:27:03 +08001506 if (mbedtls_ecp_group_a_is_minus_3(grp)) {
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001507 /* tmp[0] <- M = 3(X + Z^2)(X - Z^2) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 MPI_ECP_SQR(&tmp[1], &P->Z);
1509 MPI_ECP_ADD(&tmp[2], &P->X, &tmp[1]);
1510 MPI_ECP_SUB(&tmp[3], &P->X, &tmp[1]);
1511 MPI_ECP_MUL(&tmp[1], &tmp[2], &tmp[3]);
1512 MPI_ECP_MUL_INT(&tmp[0], &tmp[1], 3);
1513 } else {
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001514 /* tmp[0] <- M = 3.X^2 + A.Z^4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 MPI_ECP_SQR(&tmp[1], &P->X);
1516 MPI_ECP_MUL_INT(&tmp[0], &tmp[1], 3);
Peter Dettmance661b22015-02-07 14:43:51 +07001517
1518 /* Optimize away for "koblitz" curves with A = 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 if (MPI_ECP_CMP_INT(&grp->A, 0) != 0) {
Peter Dettmance661b22015-02-07 14:43:51 +07001520 /* M += A.Z^4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 MPI_ECP_SQR(&tmp[1], &P->Z);
1522 MPI_ECP_SQR(&tmp[2], &tmp[1]);
1523 MPI_ECP_MUL(&tmp[1], &tmp[2], &grp->A);
1524 MPI_ECP_ADD(&tmp[0], &tmp[0], &tmp[1]);
Peter Dettmance661b22015-02-07 14:43:51 +07001525 }
Peter Vaskovica676acf2014-08-06 00:48:39 +02001526 }
Manuel Pégourié-Gonnard73cc01d2013-12-06 12:41:30 +01001527
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001528 /* tmp[1] <- S = 4.X.Y^2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 MPI_ECP_SQR(&tmp[2], &P->Y);
1530 MPI_ECP_SHIFT_L(&tmp[2], 1);
1531 MPI_ECP_MUL(&tmp[1], &P->X, &tmp[2]);
1532 MPI_ECP_SHIFT_L(&tmp[1], 1);
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001533
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001534 /* tmp[3] <- U = 8.Y^4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 MPI_ECP_SQR(&tmp[3], &tmp[2]);
1536 MPI_ECP_SHIFT_L(&tmp[3], 1);
Peter Dettmance661b22015-02-07 14:43:51 +07001537
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001538 /* tmp[2] <- T = M^2 - 2.S */
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 MPI_ECP_SQR(&tmp[2], &tmp[0]);
1540 MPI_ECP_SUB(&tmp[2], &tmp[2], &tmp[1]);
1541 MPI_ECP_SUB(&tmp[2], &tmp[2], &tmp[1]);
Peter Dettmance661b22015-02-07 14:43:51 +07001542
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001543 /* tmp[1] <- S = M(S - T) - U */
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 MPI_ECP_SUB(&tmp[1], &tmp[1], &tmp[2]);
1545 MPI_ECP_MUL(&tmp[1], &tmp[1], &tmp[0]);
1546 MPI_ECP_SUB(&tmp[1], &tmp[1], &tmp[3]);
Peter Dettmance661b22015-02-07 14:43:51 +07001547
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001548 /* tmp[3] <- U = 2.Y.Z */
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 MPI_ECP_MUL(&tmp[3], &P->Y, &P->Z);
1550 MPI_ECP_SHIFT_L(&tmp[3], 1);
Peter Dettmance661b22015-02-07 14:43:51 +07001551
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001552 /* Store results */
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 MPI_ECP_MOV(&R->X, &tmp[2]);
1554 MPI_ECP_MOV(&R->Y, &tmp[1]);
1555 MPI_ECP_MOV(&R->Z, &tmp[3]);
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001556
1557cleanup:
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001558
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001560#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_DOUBLE_JAC_ALT) */
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001561}
1562
1563/*
Manuel Pégourié-Gonnard469a2092013-11-21 18:20:43 +01001564 * Addition: R = P + Q, mixed affine-Jacobian coordinates (GECC 3.22)
Manuel Pégourié-Gonnard9674fd02012-11-19 21:23:27 +01001565 *
1566 * The coordinates of Q must be normalized (= affine),
1567 * but those of P don't need to. R is not normalized.
1568 *
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001569 * P,Q,R may alias, but only at the level of EC points: they must be either
1570 * equal as pointers, or disjoint (including the coordinate data buffers).
1571 * Fine-grained aliasing at the level of coordinates is not supported.
1572 *
Manuel Pégourié-Gonnardaade42f2013-11-21 19:19:54 +01001573 * Special cases: (1) P or Q is zero, (2) R is zero, (3) P == Q.
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +01001574 * None of these cases can happen as intermediate step in ecp_mul_comb():
Manuel Pégourié-Gonnardaade42f2013-11-21 19:19:54 +01001575 * - at each step, P, Q and R are multiples of the base point, the factor
1576 * being less than its order, so none of them is zero;
1577 * - Q is an odd multiple of the base point, P an even multiple,
1578 * due to the choice of precomputed points in the modified comb method.
1579 * So branches for these cases do not leak secret information.
1580 *
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01001581 * Cost: 1A := 8M + 3S
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001583static int ecp_add_mixed(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
1584 const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q,
1585 mbedtls_mpi tmp[4])
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001586{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001587#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01001588 add_count++;
1589#endif
1590
Janos Follathb0697532016-08-18 12:38:46 +01001591#if defined(MBEDTLS_ECP_ADD_MIXED_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if (mbedtls_internal_ecp_grp_capable(grp)) {
1593 return mbedtls_internal_ecp_add_mixed(grp, R, P, Q);
1594 }
Janos Follath372697b2016-10-28 16:53:11 +01001595#endif /* MBEDTLS_ECP_ADD_MIXED_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01001596
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001597#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_ADD_MIXED_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001599#else
1600 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker838b7152022-01-04 05:01:53 +00001601
1602 /* NOTE: Aliasing between input and output is allowed, so one has to make
1603 * sure that at the point X,Y,Z are written, {P,Q}->{X,Y,Z} are no
1604 * longer read from. */
Hanno Becker5c8ea302022-01-01 06:01:45 +00001605 mbedtls_mpi * const X = &R->X;
1606 mbedtls_mpi * const Y = &R->Y;
1607 mbedtls_mpi * const Z = &R->Z;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 if (!MPI_ECP_VALID(&Q->Z)) {
1610 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1611 }
Hanno Beckeree95f6c2022-01-09 05:46:18 +00001612
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001613 /*
Manuel Pégourié-Gonnardaade42f2013-11-21 19:19:54 +01001614 * Trivial cases: P == 0 or Q == 0 (case 1)
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001616 if (MPI_ECP_CMP_INT(&P->Z, 0) == 0) {
1617 return mbedtls_ecp_copy(R, Q);
1618 }
Manuel Pégourié-Gonnard469a2092013-11-21 18:20:43 +01001619
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 if (MPI_ECP_CMP_INT(&Q->Z, 0) == 0) {
1621 return mbedtls_ecp_copy(R, P);
1622 }
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +01001623
1624 /*
1625 * Make sure Q coordinates are normalized
1626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 if (MPI_ECP_CMP_INT(&Q->Z, 1) != 0) {
1628 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1629 }
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 MPI_ECP_SQR(&tmp[0], &P->Z);
1632 MPI_ECP_MUL(&tmp[1], &tmp[0], &P->Z);
1633 MPI_ECP_MUL(&tmp[0], &tmp[0], &Q->X);
1634 MPI_ECP_MUL(&tmp[1], &tmp[1], &Q->Y);
1635 MPI_ECP_SUB(&tmp[0], &tmp[0], &P->X);
1636 MPI_ECP_SUB(&tmp[1], &tmp[1], &P->Y);
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001637
Manuel Pégourié-Gonnardaade42f2013-11-21 19:19:54 +01001638 /* Special cases (2) and (3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001639 if (MPI_ECP_CMP_INT(&tmp[0], 0) == 0) {
1640 if (MPI_ECP_CMP_INT(&tmp[1], 0) == 0) {
1641 ret = ecp_double_jac(grp, R, P, tmp);
Manuel Pégourié-Gonnard7e0adfb2012-11-08 23:21:46 +01001642 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 } else {
1644 ret = mbedtls_ecp_set_zero(R);
Manuel Pégourié-Gonnard7e0adfb2012-11-08 23:21:46 +01001645 goto cleanup;
1646 }
1647 }
1648
Hanno Becker838b7152022-01-04 05:01:53 +00001649 /* {P,Q}->Z no longer used, so OK to write to Z even if there's aliasing. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 MPI_ECP_MUL(Z, &P->Z, &tmp[0]);
1651 MPI_ECP_SQR(&tmp[2], &tmp[0]);
1652 MPI_ECP_MUL(&tmp[3], &tmp[2], &tmp[0]);
1653 MPI_ECP_MUL(&tmp[2], &tmp[2], &P->X);
Hanno Beckerce29ae82022-01-04 04:55:11 +00001654
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 MPI_ECP_MOV(&tmp[0], &tmp[2]);
1656 MPI_ECP_SHIFT_L(&tmp[0], 1);
Hanno Beckerce29ae82022-01-04 04:55:11 +00001657
Hanno Becker838b7152022-01-04 05:01:53 +00001658 /* {P,Q}->X no longer used, so OK to write to X even if there's aliasing. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 MPI_ECP_SQR(X, &tmp[1]);
1660 MPI_ECP_SUB(X, X, &tmp[0]);
1661 MPI_ECP_SUB(X, X, &tmp[3]);
1662 MPI_ECP_SUB(&tmp[2], &tmp[2], X);
1663 MPI_ECP_MUL(&tmp[2], &tmp[2], &tmp[1]);
1664 MPI_ECP_MUL(&tmp[3], &tmp[3], &P->Y);
Hanno Becker838b7152022-01-04 05:01:53 +00001665 /* {P,Q}->Y no longer used, so OK to write to Y even if there's aliasing. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 MPI_ECP_SUB(Y, &tmp[2], &tmp[3]);
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001667
1668cleanup:
1669
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001671#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_ADD_MIXED_ALT) */
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001672}
1673
1674/*
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001675 * Randomize jacobian coordinates:
1676 * (X, Y, Z) -> (l^2 X, l^3 Y, l Z) for random l
Manuel Pégourié-Gonnard3c0b4ea2013-12-02 19:44:41 +01001677 * This is sort of the reverse operation of ecp_normalize_jac().
Manuel Pégourié-Gonnard44aab792013-11-21 10:53:59 +01001678 *
1679 * This countermeasure was first suggested in [2].
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001680 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001681static int ecp_randomize_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt,
1682 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001683{
Janos Follathb0697532016-08-18 12:38:46 +01001684#if defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 if (mbedtls_internal_ecp_grp_capable(grp)) {
1686 return mbedtls_internal_ecp_randomize_jac(grp, pt, f_rng, p_rng);
1687 }
Janos Follath372697b2016-10-28 16:53:11 +01001688#endif /* MBEDTLS_ECP_RANDOMIZE_JAC_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01001689
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001690#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001692#else
1693 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0d629792022-01-04 06:45:49 +00001694 mbedtls_mpi l;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001695
Gilles Peskine449bd832023-01-11 14:50:10 +01001696 mbedtls_mpi_init(&l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001697
1698 /* Generate l such that 1 < l < p */
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 MPI_ECP_RAND(&l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001700
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001701 /* Z' = l * Z */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 MPI_ECP_MUL(&pt->Z, &pt->Z, &l);
Hanno Becker0d629792022-01-04 06:45:49 +00001703
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001704 /* Y' = l * Y */
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 MPI_ECP_MUL(&pt->Y, &pt->Y, &l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001706
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001707 /* X' = l^2 * X */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 MPI_ECP_SQR(&l, &l);
1709 MPI_ECP_MUL(&pt->X, &pt->X, &l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001710
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001711 /* Y'' = l^2 * Y' = l^3 * Y */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 MPI_ECP_MUL(&pt->Y, &pt->Y, &l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001713
1714cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 mbedtls_mpi_free(&l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001716
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 if (ret == MBEDTLS_ERR_MPI_NOT_ACCEPTABLE) {
Gilles Peskine59215172021-03-29 22:28:50 +02001718 ret = MBEDTLS_ERR_ECP_RANDOM_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 }
1720 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001721#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT) */
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001722}
1723
1724/*
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001725 * Check and define parameters used by the comb method (see below for details)
1726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#if MBEDTLS_ECP_WINDOW_SIZE < 2 || MBEDTLS_ECP_WINDOW_SIZE > 7
1728#error "MBEDTLS_ECP_WINDOW_SIZE out of bounds"
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001729#endif
1730
1731/* d = ceil( n / w ) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001732#define COMB_MAX_D (MBEDTLS_ECP_MAX_BITS + 1) / 2
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001733
1734/* number of precomputed points */
Gilles Peskine449bd832023-01-11 14:50:10 +01001735#define COMB_MAX_PRE (1 << (MBEDTLS_ECP_WINDOW_SIZE - 1))
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001736
1737/*
1738 * Compute the representation of m that will be used with our comb method.
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001739 *
1740 * The basic comb method is described in GECC 3.44 for example. We use a
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001741 * modified version that provides resistance to SPA by avoiding zero
1742 * digits in the representation as in [3]. We modify the method further by
1743 * requiring that all K_i be odd, which has the small cost that our
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001744 * representation uses one more K_i, due to carries, but saves on the size of
1745 * the precomputed table.
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001746 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001747 * Summary of the comb method and its modifications:
1748 *
1749 * - The goal is to compute m*P for some w*d-bit integer m.
1750 *
1751 * - The basic comb method splits m into the w-bit integers
1752 * x[0] .. x[d-1] where x[i] consists of the bits in m whose
1753 * index has residue i modulo d, and computes m * P as
1754 * S[x[0]] + 2 * S[x[1]] + .. + 2^(d-1) S[x[d-1]], where
1755 * S[i_{w-1} .. i_0] := i_{w-1} 2^{(w-1)d} P + ... + i_1 2^d P + i_0 P.
1756 *
1757 * - If it happens that, say, x[i+1]=0 (=> S[x[i+1]]=0), one can replace the sum by
1758 * .. + 2^{i-1} S[x[i-1]] - 2^i S[x[i]] + 2^{i+1} S[x[i]] + 2^{i+2} S[x[i+2]] ..,
1759 * thereby successively converting it into a form where all summands
1760 * are nonzero, at the cost of negative summands. This is the basic idea of [3].
1761 *
1762 * - More generally, even if x[i+1] != 0, we can first transform the sum as
1763 * .. - 2^i S[x[i]] + 2^{i+1} ( S[x[i]] + S[x[i+1]] ) + 2^{i+2} S[x[i+2]] ..,
1764 * and then replace S[x[i]] + S[x[i+1]] = S[x[i] ^ x[i+1]] + 2 S[x[i] & x[i+1]].
1765 * Performing and iterating this procedure for those x[i] that are even
1766 * (keeping track of carry), we can transform the original sum into one of the form
1767 * S[x'[0]] +- 2 S[x'[1]] +- .. +- 2^{d-1} S[x'[d-1]] + 2^d S[x'[d]]
1768 * with all x'[i] odd. It is therefore only necessary to know S at odd indices,
1769 * which is why we are only computing half of it in the first place in
1770 * ecp_precompute_comb and accessing it with index abs(i) / 2 in ecp_select_comb.
1771 *
1772 * - For the sake of compactness, only the seven low-order bits of x[i]
1773 * are used to represent its absolute value (K_i in the paper), and the msb
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001774 * of x[i] encodes the sign (s_i in the paper): it is set if and only if
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001775 * if s_i == -1;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001776 *
1777 * Calling conventions:
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001778 * - x is an array of size d + 1
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001779 * - w is the size, ie number of teeth, of the comb, and must be between
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780 * 2 and 7 (in practice, between 2 and MBEDTLS_ECP_WINDOW_SIZE)
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001781 * - m is the MPI, expected to be odd and such that bitlength(m) <= w * d
1782 * (the result will be incorrect if these assumptions are not satisfied)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001783 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001784static void ecp_comb_recode_core(unsigned char x[], size_t d,
1785 unsigned char w, const mbedtls_mpi *m)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001786{
1787 size_t i, j;
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001788 unsigned char c, cc, adjust;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001789
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 memset(x, 0, d+1);
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001791
Manuel Pégourié-Gonnardedc1a1f2013-11-21 09:50:00 +01001792 /* First get the classical comb values (except for x_d = 0) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 for (i = 0; i < d; i++) {
1794 for (j = 0; j < w; j++) {
1795 x[i] |= mbedtls_mpi_get_bit(m, i + d * j) << j;
1796 }
1797 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001798
Manuel Pégourié-Gonnardedc1a1f2013-11-21 09:50:00 +01001799 /* Now make sure x_1 .. x_d are odd */
1800 c = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 for (i = 1; i <= d; i++) {
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001802 /* Add carry and update it */
1803 cc = x[i] & c;
1804 x[i] = x[i] ^ c;
1805 c = cc;
1806
Manuel Pégourié-Gonnardedc1a1f2013-11-21 09:50:00 +01001807 /* Adjust if needed, avoiding branches */
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 adjust = 1 - (x[i] & 0x01);
1809 c |= x[i] & (x[i-1] * adjust);
1810 x[i] = x[i] ^ (x[i-1] * adjust);
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001811 x[i-1] |= adjust << 7;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001812 }
1813}
1814
1815/*
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001816 * Precompute points for the adapted comb method
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001817 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001818 * Assumption: T must be able to hold 2^{w - 1} elements.
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001819 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001820 * Operation: If i = i_{w-1} ... i_1 is the binary representation of i,
1821 * sets T[i] = i_{w-1} 2^{(w-1)d} P + ... + i_1 2^d P + P.
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01001822 *
1823 * Cost: d(w-1) D + (2^{w-1} - 1) A + 1 N(w-1) + 1 N(2^{w-1} - 1)
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001824 *
1825 * Note: Even comb values (those where P would be omitted from the
1826 * sum defining T[i] above) are not needed in our adaption
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001827 * the comb method. See ecp_comb_recode_core().
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001828 *
1829 * This function currently works in four steps:
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001830 * (1) [dbl] Computation of intermediate T[i] for 2-power values of i
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001831 * (2) [norm_dbl] Normalization of coordinates of these T[i]
1832 * (3) [add] Computation of all T[i]
1833 * (4) [norm_add] Normalization of all T[i]
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001834 *
1835 * Step 1 can be interrupted but not the others; together with the final
1836 * coordinate normalization they are the largest steps done at once, depending
1837 * on the window size. Here are operation counts for P-256:
1838 *
1839 * step (2) (3) (4)
1840 * w = 5 142 165 208
1841 * w = 4 136 77 160
1842 * w = 3 130 33 136
1843 * w = 2 124 11 124
1844 *
1845 * So if ECC operations are blocking for too long even with a low max_ops
1846 * value, it's useful to set MBEDTLS_ECP_WINDOW_SIZE to a lower value in order
1847 * to minimize maximum blocking time.
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001849static int ecp_precompute_comb(const mbedtls_ecp_group *grp,
1850 mbedtls_ecp_point T[], const mbedtls_ecp_point *P,
1851 unsigned char w, size_t d,
1852 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001853{
Janos Follath24eed8d2019-11-22 13:21:35 +00001854 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001855 unsigned char i;
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01001856 size_t j = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 const unsigned char T_size = 1U << (w - 1);
1858 mbedtls_ecp_point *cur, *TT[COMB_MAX_PRE - 1] = { NULL };
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001859
Hanno Beckera7f8edd2022-01-04 07:29:46 +00001860 mbedtls_mpi tmp[4];
1861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Beckera7f8edd2022-01-04 07:29:46 +00001863
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001864#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
1866 if (rs_ctx->rsm->state == ecp_rsm_pre_dbl) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001867 goto dbl;
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 }
1869 if (rs_ctx->rsm->state == ecp_rsm_pre_norm_dbl) {
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001870 goto norm_dbl;
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 }
1872 if (rs_ctx->rsm->state == ecp_rsm_pre_add) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001873 goto add;
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 }
1875 if (rs_ctx->rsm->state == ecp_rsm_pre_norm_add) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001876 goto norm_add;
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 }
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01001878 }
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001879#else
1880 (void) rs_ctx;
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01001881#endif
1882
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001883#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001885 rs_ctx->rsm->state = ecp_rsm_pre_dbl;
1886
1887 /* initial state for the loop */
1888 rs_ctx->rsm->i = 0;
1889 }
1890
1891dbl:
1892#endif
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001893 /*
1894 * Set T[0] = P and
1895 * T[2^{l-1}] = 2^{dl} P for l = 1 .. w-1 (this is not the final value)
1896 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(&T[0], P));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001898
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001899#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->i != 0) {
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02001901 j = rs_ctx->rsm->i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 } else
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01001903#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 j = 0;
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01001905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 for (; j < d * (w - 1); j++) {
1907 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_DBL);
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01001908
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 i = 1U << (j / d);
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001910 cur = T + i;
Manuel Pégourié-Gonnardae557072017-03-20 12:21:24 +01001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 if (j % d == 0) {
1913 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(cur, T + (i >> 1)));
1914 }
Manuel Pégourié-Gonnardae557072017-03-20 12:21:24 +01001915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 MBEDTLS_MPI_CHK(ecp_double_jac(grp, cur, cur, tmp));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001917 }
1918
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001919#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001921 rs_ctx->rsm->state = ecp_rsm_pre_norm_dbl;
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 }
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001923
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001924norm_dbl:
1925#endif
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001926 /*
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001927 * Normalize current elements in T to allow them to be used in
1928 * ecp_add_mixed() below, which requires one normalized input.
1929 *
1930 * As T has holes, use an auxiliary array of pointers to elements in T.
1931 *
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001932 */
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001933 j = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 for (i = 1; i < T_size; i <<= 1) {
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001935 TT[j++] = T + i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 }
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV + 6 * j - 2);
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001939
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 MBEDTLS_MPI_CHK(ecp_normalize_jac_many(grp, TT, j));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001941
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001942#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001944 rs_ctx->rsm->state = ecp_rsm_pre_add;
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 }
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001946
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001947add:
1948#endif
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001949 /*
1950 * Compute the remaining ones using the minimal number of additions
1951 * Be careful to update T[2^l] only after using it!
1952 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 MBEDTLS_ECP_BUDGET((T_size - 1) * MBEDTLS_ECP_OPS_ADD);
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001954
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 for (i = 1; i < T_size; i <<= 1) {
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001956 j = i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 while (j--) {
1958 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, &T[i + j], &T[j], &T[i], tmp));
1959 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001960 }
1961
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001962#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001964 rs_ctx->rsm->state = ecp_rsm_pre_norm_add;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 }
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001966
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001967norm_add:
1968#endif
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001969 /*
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02001970 * Normalize final elements in T. Even though there are no holes now, we
1971 * still need the auxiliary array for homogeneity with the previous
1972 * call. Also, skip T[0] which is already normalised, being a copy of P.
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001973 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 for (j = 0; j + 1 < T_size; j++) {
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001975 TT[j] = T + j + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 }
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001977
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV + 6 * j - 2);
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 MBEDTLS_MPI_CHK(ecp_normalize_jac_many(grp, TT, j));
Manuel Pégourié-Gonnarde2820122013-11-21 10:08:50 +01001981
Hanno Beckeree95f6c2022-01-09 05:46:18 +00001982 /* Free Z coordinate (=1 after normalization) to save RAM.
1983 * This makes T[i] invalid as mbedtls_ecp_points, but this is OK
1984 * since from this point onwards, they are only accessed indirectly
1985 * via the getter function ecp_select_comb() which does set the
1986 * target's Z coordinate to 1. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 for (i = 0; i < T_size; i++) {
1988 mbedtls_mpi_free(&T[i].Z);
1989 }
Hanno Beckeree95f6c2022-01-09 05:46:18 +00001990
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001991cleanup:
Hanno Beckera7f8edd2022-01-04 07:29:46 +00001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Beckera7f8edd2022-01-04 07:29:46 +00001994
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001995#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
1997 ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
1998 if (rs_ctx->rsm->state == ecp_rsm_pre_dbl) {
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02001999 rs_ctx->rsm->i = j;
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 }
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01002001 }
2002#endif
Janos Follathb0697532016-08-18 12:38:46 +01002003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 return ret;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002005}
2006
2007/*
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01002008 * Select precomputed point: R = sign(i) * T[ abs(i) / 2 ]
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002009 *
2010 * See ecp_comb_recode_core() for background
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002011 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002012static int ecp_select_comb(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2013 const mbedtls_ecp_point T[], unsigned char T_size,
2014 unsigned char i)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002015{
Janos Follath24eed8d2019-11-22 13:21:35 +00002016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002017 unsigned char ii, j;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002018
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002019 /* Ignore the "sign" bit and scale down */
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 ii = (i & 0x7Fu) >> 1;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002021
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002022 /* Read the whole table to thwart cache-based timing attacks */
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 for (j = 0; j < T_size; j++) {
2024 MPI_ECP_COND_ASSIGN(&R->X, &T[j].X, j == ii);
2025 MPI_ECP_COND_ASSIGN(&R->Y, &T[j].Y, j == ii);
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002026 }
2027
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01002028 /* Safely invert result if i is "negative" */
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 MBEDTLS_MPI_CHK(ecp_safe_invert_jac(grp, R, i >> 7));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002030
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 MPI_ECP_LSET(&R->Z, 1);
Hanno Becker6a288702022-01-05 05:19:48 +00002032
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002033cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 return ret;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002035}
2036
2037/*
2038 * Core multiplication algorithm for the (modified) comb method.
2039 * This part is actually common with the basic comb method (GECC 3.44)
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01002040 *
2041 * Cost: d A + d D + 1 R
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002043static int ecp_mul_comb_core(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2044 const mbedtls_ecp_point T[], unsigned char T_size,
2045 const unsigned char x[], size_t d,
2046 int (*f_rng)(void *, unsigned char *, size_t),
2047 void *p_rng,
2048 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002049{
Janos Follath24eed8d2019-11-22 13:21:35 +00002050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 mbedtls_ecp_point Txi;
Hanno Beckera7f8edd2022-01-04 07:29:46 +00002052 mbedtls_mpi tmp[4];
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002053 size_t i;
2054
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 mbedtls_ecp_point_init(&Txi);
2056 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002057
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002058#if !defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002059 (void) rs_ctx;
2060#endif
2061
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002062#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2064 rs_ctx->rsm->state != ecp_rsm_comb_core) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002065 rs_ctx->rsm->i = 0;
2066 rs_ctx->rsm->state = ecp_rsm_comb_core;
2067 }
2068
2069 /* new 'if' instead of nested for the sake of the 'else' branch */
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->i != 0) {
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002071 /* restore current index (R already pointing to rs_ctx->rsm->R) */
2072 i = rs_ctx->rsm->i;
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 } else
Manuel Pégourié-Gonnardc5d844b2017-03-15 13:06:28 +01002074#endif
2075 {
2076 /* Start with a non-zero point and randomize its coordinates */
2077 i = d;
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 MBEDTLS_MPI_CHK(ecp_select_comb(grp, R, T, T_size, x[i]));
2079 if (f_rng != 0) {
2080 MBEDTLS_MPI_CHK(ecp_randomize_jac(grp, R, f_rng, p_rng));
2081 }
Manuel Pégourié-Gonnardc5d844b2017-03-15 13:06:28 +01002082 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 while (i != 0) {
2085 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_DBL + MBEDTLS_ECP_OPS_ADD);
Manuel Pégourié-Gonnard90f31b72018-10-16 10:45:24 +02002086 --i;
2087
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 MBEDTLS_MPI_CHK(ecp_double_jac(grp, R, R, tmp));
2089 MBEDTLS_MPI_CHK(ecp_select_comb(grp, &Txi, T, T_size, x[i]));
2090 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, R, R, &Txi, tmp));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002091 }
2092
2093cleanup:
Janos Follathb0697532016-08-18 12:38:46 +01002094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 mbedtls_ecp_point_free(&Txi);
2096 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Beckera7f8edd2022-01-04 07:29:46 +00002097
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002098#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2100 ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
Manuel Pégourié-Gonnard90f31b72018-10-16 10:45:24 +02002101 rs_ctx->rsm->i = i;
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002102 /* no need to save R, already pointing to rs_ctx->rsm->R */
Manuel Pégourié-Gonnardc5d844b2017-03-15 13:06:28 +01002103 }
2104#endif
2105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 return ret;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002107}
2108
2109/*
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002110 * Recode the scalar to get constant-time comb multiplication
2111 *
2112 * As the actual scalar recoding needs an odd scalar as a starting point,
2113 * this wrapper ensures that by replacing m by N - m if necessary, and
2114 * informs the caller that the result of multiplication will be negated.
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002115 *
Manuel Pégourié-Gonnardfd87e352017-08-24 14:21:05 +02002116 * This works because we only support large prime order for Short Weierstrass
2117 * curves, so N is always odd hence either m or N - m is.
2118 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002119 * See ecp_comb_recode_core() for background.
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002120 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002121static int ecp_comb_recode_scalar(const mbedtls_ecp_group *grp,
2122 const mbedtls_mpi *m,
2123 unsigned char k[COMB_MAX_D + 1],
2124 size_t d,
2125 unsigned char w,
2126 unsigned char *parity_trick)
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002127{
Janos Follath24eed8d2019-11-22 13:21:35 +00002128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002129 mbedtls_mpi M, mm;
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 mbedtls_mpi_init(&M);
2132 mbedtls_mpi_init(&mm);
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002133
Manuel Pégourié-Gonnardfd87e352017-08-24 14:21:05 +02002134 /* N is always odd (see above), just make extra sure */
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if (mbedtls_mpi_get_bit(&grp->N, 0) != 1) {
2136 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2137 }
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002138
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002139 /* do we need the parity trick? */
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 *parity_trick = (mbedtls_mpi_get_bit(m, 0) == 0);
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002141
2142 /* execute parity fix in constant time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&M, m));
2144 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&mm, &grp->N, m));
2145 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign(&M, &mm, *parity_trick));
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002146
2147 /* actual scalar recoding */
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 ecp_comb_recode_core(k, d, w, &M);
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002149
2150cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 mbedtls_mpi_free(&mm);
2152 mbedtls_mpi_free(&M);
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 return ret;
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002155}
2156
2157/*
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002158 * Perform comb multiplication (for short Weierstrass curves)
2159 * once the auxiliary table has been pre-computed.
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002160 *
2161 * Scalar recoding may use a parity trick that makes us compute -m * P,
2162 * if that is the case we'll need to recover m * P at the end.
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002163 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002164static int ecp_mul_comb_after_precomp(const mbedtls_ecp_group *grp,
2165 mbedtls_ecp_point *R,
2166 const mbedtls_mpi *m,
2167 const mbedtls_ecp_point *T,
2168 unsigned char T_size,
2169 unsigned char w,
2170 size_t d,
2171 int (*f_rng)(void *, unsigned char *, size_t),
2172 void *p_rng,
2173 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002174{
Janos Follath24eed8d2019-11-22 13:21:35 +00002175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002176 unsigned char parity_trick;
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002177 unsigned char k[COMB_MAX_D + 1];
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +01002178 mbedtls_ecp_point *RR = R;
2179
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002180#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002182 RR = &rs_ctx->rsm->R;
2183
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 if (rs_ctx->rsm->state == ecp_rsm_final_norm) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002185 goto final_norm;
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 }
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002187 }
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +01002188#endif
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 MBEDTLS_MPI_CHK(ecp_comb_recode_scalar(grp, m, k, d, w,
2191 &parity_trick));
2192 MBEDTLS_MPI_CHK(ecp_mul_comb_core(grp, RR, T, T_size, k, d,
2193 f_rng, p_rng, rs_ctx));
2194 MBEDTLS_MPI_CHK(ecp_safe_invert_jac(grp, RR, parity_trick));
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002195
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002196#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002198 rs_ctx->rsm->state = ecp_rsm_final_norm;
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 }
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002200
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002201final_norm:
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV);
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +01002203#endif
Manuel Pégourié-Gonnarda4aa89b2020-03-25 12:41:29 +01002204 /*
2205 * Knowledge of the jacobian coordinates may leak the last few bits of the
2206 * scalar [1], and since our MPI implementation isn't constant-flow,
2207 * inversion (used for coordinate normalization) may leak the full value
2208 * of its input via side-channels [2].
2209 *
2210 * [1] https://eprint.iacr.org/2003/191
2211 * [2] https://eprint.iacr.org/2020/055
2212 *
2213 * Avoid the leak by randomizing coordinates before we normalize them.
2214 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 if (f_rng != 0) {
2216 MBEDTLS_MPI_CHK(ecp_randomize_jac(grp, RR, f_rng, p_rng));
2217 }
Manuel Pégourié-Gonnarda4aa89b2020-03-25 12:41:29 +01002218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 MBEDTLS_MPI_CHK(ecp_normalize_jac(grp, RR));
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +01002220
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002221#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
2223 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, RR));
2224 }
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +01002225#endif
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002226
2227cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 return ret;
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002229}
2230
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002231/*
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002232 * Pick window size based on curve size and whether we optimize for base point
2233 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002234static unsigned char ecp_pick_window_size(const mbedtls_ecp_group *grp,
2235 unsigned char p_eq_g)
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002236{
2237 unsigned char w;
2238
2239 /*
2240 * Minimize the number of multiplications, that is minimize
2241 * 10 * d * w + 18 * 2^(w-1) + 11 * d + 7 * w, with d = ceil( nbits / w )
2242 * (see costs of the various parts, with 1S = 1M)
2243 */
2244 w = grp->nbits >= 384 ? 5 : 4;
2245
2246 /*
2247 * If P == G, pre-compute a bit more, since this may be re-used later.
2248 * Just adding one avoids upping the cost of the first mul too much,
2249 * and the memory cost too.
2250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (p_eq_g) {
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002252 w++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 }
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002254
2255 /*
kXuanba9cb762021-04-08 14:32:06 +08002256 * If static comb table may not be used (!p_eq_g) or static comb table does
2257 * not exists, make sure w is within bounds.
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002258 * (The last test is useful only for very small curves in the test suite.)
kXuanba9cb762021-04-08 14:32:06 +08002259 *
2260 * The user reduces MBEDTLS_ECP_WINDOW_SIZE does not changes the size of
2261 * static comb table, because the size of static comb table is fixed when
2262 * it is generated.
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002264#if (MBEDTLS_ECP_WINDOW_SIZE < 6)
2265 if ((!p_eq_g || !ecp_group_is_static_comb_table(grp)) && w > MBEDTLS_ECP_WINDOW_SIZE) {
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002266 w = MBEDTLS_ECP_WINDOW_SIZE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 }
k-stachowiak653a4a22019-07-03 14:31:09 +02002268#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 if (w >= grp->nbits) {
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002270 w = 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 }
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 return w;
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002274}
2275
2276/*
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002277 * Multiplication using the comb method - for curves in short Weierstrass form
2278 *
2279 * This function is mainly responsible for administrative work:
2280 * - managing the restart context if enabled
Manuel Pégourié-Gonnard11556e22017-08-24 13:41:19 +02002281 * - managing the table of precomputed points (passed between the below two
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002282 * functions): allocation, computation, ownership transfer, freeing.
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002283 *
2284 * It delegates the actual arithmetic work to:
2285 * ecp_precompute_comb() and ecp_mul_comb_with_precomp()
2286 *
2287 * See comments on ecp_comb_recode_core() regarding the computation strategy.
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002289static int ecp_mul_comb(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2290 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2291 int (*f_rng)(void *, unsigned char *, size_t),
2292 void *p_rng,
2293 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002294{
Janos Follath24eed8d2019-11-22 13:21:35 +00002295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard11556e22017-08-24 13:41:19 +02002296 unsigned char w, p_eq_g, i;
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002297 size_t d;
Manuel Pégourié-Gonnardf2a9fcf2020-06-03 12:11:56 +02002298 unsigned char T_size = 0, T_ok = 0;
2299 mbedtls_ecp_point *T = NULL;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 ECP_RS_ENTER(rsm);
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +01002302
Manuel Pégourié-Gonnard22be6352017-03-09 13:02:35 +01002303 /* Is P the base point ? */
2304#if MBEDTLS_ECP_FIXED_POINT_OPTIM == 1
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 p_eq_g = (MPI_ECP_CMP(&P->Y, &grp->G.Y) == 0 &&
2306 MPI_ECP_CMP(&P->X, &grp->G.X) == 0);
Manuel Pégourié-Gonnard196d1332017-08-28 13:14:27 +02002307#else
2308 p_eq_g = 0;
Manuel Pégourié-Gonnard22be6352017-03-09 13:02:35 +01002309#endif
2310
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002311 /* Pick window size and deduce related sizes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 w = ecp_pick_window_size(grp, p_eq_g);
2313 T_size = 1U << (w - 1);
2314 d = (grp->nbits + w - 1) / w;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002315
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002316 /* Pre-computed table: do we have it already for the base point? */
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 if (p_eq_g && grp->T != NULL) {
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002318 /* second pointer to the same table, will be deleted on exit */
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002319 T = grp->T;
2320 T_ok = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 } else
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002322#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002323 /* Pre-computed table: do we have one in progress? complete? */
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->T != NULL) {
Manuel Pégourié-Gonnard45fd0162017-03-22 08:24:42 +01002325 /* transfer ownership of T from rsm to local function */
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002326 T = rs_ctx->rsm->T;
2327 rs_ctx->rsm->T = NULL;
2328 rs_ctx->rsm->T_size = 0;
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002329
Manuel Pégourié-Gonnardb25cb602018-10-16 11:48:09 +02002330 /* This effectively jumps to the call to mul_comb_after_precomp() */
Manuel Pégourié-Gonnard11556e22017-08-24 13:41:19 +02002331 T_ok = rs_ctx->rsm->state >= ecp_rsm_comb_core;
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 } else
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +01002333#endif
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002334 /* Allocate table if we didn't have any */
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002335 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 T = mbedtls_calloc(T_size, sizeof(mbedtls_ecp_point));
2337 if (T == NULL) {
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002338 ret = MBEDTLS_ERR_ECP_ALLOC_FAILED;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002339 goto cleanup;
2340 }
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +02002341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 for (i = 0; i < T_size; i++) {
2343 mbedtls_ecp_point_init(&T[i]);
2344 }
Manuel Pégourié-Gonnard11556e22017-08-24 13:41:19 +02002345
2346 T_ok = 0;
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002347 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002348
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002349 /* Compute table (or finish computing it) if not done already */
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 if (!T_ok) {
2351 MBEDTLS_MPI_CHK(ecp_precompute_comb(grp, T, P, w, d, rs_ctx));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (p_eq_g) {
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002354 /* almost transfer ownership of T to the group, but keep a copy of
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02002355 * the pointer to use for calling the next function more easily */
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002356 grp->T = T;
Manuel Pégourié-Gonnard92cceb22017-08-23 16:27:29 +02002357 grp->T_size = T_size;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002358 }
2359 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002360
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002361 /* Actual comb multiplication using precomputed points */
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 MBEDTLS_MPI_CHK(ecp_mul_comb_after_precomp(grp, R, m,
2363 T, T_size, w, d,
2364 f_rng, p_rng, rs_ctx));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002365
2366cleanup:
2367
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002368 /* does T belong to the group? */
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (T == grp->T) {
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002370 T = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 }
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002372
2373 /* does T belong to the restart context? */
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002374#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (rs_ctx != NULL && rs_ctx->rsm != NULL && ret == MBEDTLS_ERR_ECP_IN_PROGRESS && T != NULL) {
Manuel Pégourié-Gonnard45fd0162017-03-22 08:24:42 +01002376 /* transfer ownership of T from local function to rsm */
Manuel Pégourié-Gonnard92cceb22017-08-23 16:27:29 +02002377 rs_ctx->rsm->T_size = T_size;
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002378 rs_ctx->rsm->T = T;
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +01002379 T = NULL;
2380 }
2381#endif
2382
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002383 /* did T belong to us? then let's destroy it! */
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 if (T != NULL) {
2385 for (i = 0; i < T_size; i++) {
2386 mbedtls_ecp_point_free(&T[i]);
2387 }
2388 mbedtls_free(T);
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002389 }
2390
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002391 /* prevent caller from using invalid value */
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 int should_free_R = (ret != 0);
David Horstmannfc735df2022-10-06 19:11:04 +01002393#if defined(MBEDTLS_ECP_RESTARTABLE)
2394 /* don't free R while in progress in case R == P */
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
David Horstmann6e116872022-10-25 10:32:08 +01002396 should_free_R = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 }
David Horstmannfc735df2022-10-06 19:11:04 +01002398#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 if (should_free_R) {
2400 mbedtls_ecp_point_free(R);
2401 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 ECP_RS_LEAVE(rsm);
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +01002404
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 return ret;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002406}
2407
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002408#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01002409
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002410#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01002411/*
2412 * For Montgomery curves, we do all the internal arithmetic in projective
2413 * coordinates. Import/export of points uses only the x coordinates, which is
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002414 * internally represented as X / Z.
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01002415 *
2416 * For scalar multiplication, we'll use a Montgomery ladder.
2417 */
2418
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002419/*
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002420 * Normalize Montgomery x/z coordinates: X = X/Z, Z = 1
2421 * Cost: 1M + 1I
2422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002423static int ecp_normalize_mxz(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P)
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002424{
Janos Follathb0697532016-08-18 12:38:46 +01002425#if defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (mbedtls_internal_ecp_grp_capable(grp)) {
2427 return mbedtls_internal_ecp_normalize_mxz(grp, P);
2428 }
Janos Follath372697b2016-10-28 16:53:11 +01002429#endif /* MBEDTLS_ECP_NORMALIZE_MXZ_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01002430
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002431#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002433#else
2434 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 MPI_ECP_INV(&P->Z, &P->Z);
2436 MPI_ECP_MUL(&P->X, &P->X, &P->Z);
2437 MPI_ECP_LSET(&P->Z, 1);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002438
2439cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002441#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT) */
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002442}
2443
2444/*
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002445 * Randomize projective x/z coordinates:
2446 * (X, Z) -> (l X, l Z) for random l
2447 * This is sort of the reverse operation of ecp_normalize_mxz().
2448 *
2449 * This countermeasure was first suggested in [2].
2450 * Cost: 2M
2451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002452static int ecp_randomize_mxz(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P,
2453 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002454{
Janos Follathb0697532016-08-18 12:38:46 +01002455#if defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 if (mbedtls_internal_ecp_grp_capable(grp)) {
2457 return mbedtls_internal_ecp_randomize_mxz(grp, P, f_rng, p_rng);
2458 }
Janos Follath372697b2016-10-28 16:53:11 +01002459#endif /* MBEDTLS_ECP_RANDOMIZE_MXZ_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01002460
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002461#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002463#else
2464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2465 mbedtls_mpi l;
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 mbedtls_mpi_init(&l);
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002467
2468 /* Generate l such that 1 < l < p */
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 MPI_ECP_RAND(&l);
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 MPI_ECP_MUL(&P->X, &P->X, &l);
2472 MPI_ECP_MUL(&P->Z, &P->Z, &l);
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002473
2474cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 mbedtls_mpi_free(&l);
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 if (ret == MBEDTLS_ERR_MPI_NOT_ACCEPTABLE) {
Gilles Peskine59215172021-03-29 22:28:50 +02002478 ret = MBEDTLS_ERR_ECP_RANDOM_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 }
2480 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002481#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT) */
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002482}
2483
2484/*
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002485 * Double-and-add: R = 2P, S = P + Q, with d = X(P - Q),
2486 * for Montgomery curves in x/z coordinates.
2487 *
2488 * http://www.hyperelliptic.org/EFD/g1p/auto-code/montgom/xz/ladder/mladd-1987-m.op3
2489 * with
2490 * d = X1
2491 * P = (X2, Z2)
2492 * Q = (X3, Z3)
2493 * R = (X4, Z4)
2494 * S = (X5, Z5)
2495 * and eliminating temporary variables tO, ..., t4.
2496 *
2497 * Cost: 5M + 4S
2498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002499static int ecp_double_add_mxz(const mbedtls_ecp_group *grp,
2500 mbedtls_ecp_point *R, mbedtls_ecp_point *S,
2501 const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q,
2502 const mbedtls_mpi *d,
2503 mbedtls_mpi T[4])
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002504{
Janos Follathb0697532016-08-18 12:38:46 +01002505#if defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (mbedtls_internal_ecp_grp_capable(grp)) {
2507 return mbedtls_internal_ecp_double_add_mxz(grp, R, S, P, Q, d);
2508 }
Janos Follath372697b2016-10-28 16:53:11 +01002509#endif /* MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01002510
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002511#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002513#else
2514 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 MPI_ECP_ADD(&T[0], &P->X, &P->Z); /* Pp := PX + PZ */
2517 MPI_ECP_SUB(&T[1], &P->X, &P->Z); /* Pm := PX - PZ */
2518 MPI_ECP_ADD(&T[2], &Q->X, &Q->Z); /* Qp := QX + XZ */
2519 MPI_ECP_SUB(&T[3], &Q->X, &Q->Z); /* Qm := QX - QZ */
2520 MPI_ECP_MUL(&T[3], &T[3], &T[0]); /* Qm * Pp */
2521 MPI_ECP_MUL(&T[2], &T[2], &T[1]); /* Qp * Pm */
2522 MPI_ECP_SQR(&T[0], &T[0]); /* Pp^2 */
2523 MPI_ECP_SQR(&T[1], &T[1]); /* Pm^2 */
2524 MPI_ECP_MUL(&R->X, &T[0], &T[1]); /* Pp^2 * Pm^2 */
2525 MPI_ECP_SUB(&T[0], &T[0], &T[1]); /* Pp^2 - Pm^2 */
2526 MPI_ECP_MUL(&R->Z, &grp->A, &T[0]); /* A * (Pp^2 - Pm^2) */
2527 MPI_ECP_ADD(&R->Z, &T[1], &R->Z); /* [ A * (Pp^2-Pm^2) ] + Pm^2 */
2528 MPI_ECP_ADD(&S->X, &T[3], &T[2]); /* Qm*Pp + Qp*Pm */
2529 MPI_ECP_SQR(&S->X, &S->X); /* (Qm*Pp + Qp*Pm)^2 */
2530 MPI_ECP_SUB(&S->Z, &T[3], &T[2]); /* Qm*Pp - Qp*Pm */
2531 MPI_ECP_SQR(&S->Z, &S->Z); /* (Qm*Pp - Qp*Pm)^2 */
2532 MPI_ECP_MUL(&S->Z, d, &S->Z); /* d * ( Qm*Pp - Qp*Pm )^2 */
2533 MPI_ECP_MUL(&R->Z, &T[0], &R->Z); /* [A*(Pp^2-Pm^2)+Pm^2]*(Pp^2-Pm^2) */
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002534
2535cleanup:
Hanno Becker28ccb1c2022-01-04 07:15:04 +00002536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002538#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT) */
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002539}
2540
2541/*
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002542 * Multiplication with Montgomery ladder in x/z coordinates,
2543 * for curves in Montgomery form
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002544 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002545static int ecp_mul_mxz(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2546 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2547 int (*f_rng)(void *, unsigned char *, size_t),
2548 void *p_rng)
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002549{
Janos Follath24eed8d2019-11-22 13:21:35 +00002550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002551 size_t i;
Manuel Pégourié-Gonnardb6f45a62013-12-04 21:54:36 +01002552 unsigned char b;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553 mbedtls_ecp_point RP;
2554 mbedtls_mpi PX;
Hanno Becker30838862022-01-04 13:25:59 +00002555 mbedtls_mpi tmp[4];
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 mbedtls_ecp_point_init(&RP); mbedtls_mpi_init(&PX);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Becker30838862022-01-04 13:25:59 +00002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 if (f_rng == NULL) {
2561 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2562 }
Manuel Pégourié-Gonnard02b57052021-06-15 11:29:26 +02002563
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002564 /* Save PX and read from P before writing to R, in case P == R */
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 MPI_ECP_MOV(&PX, &P->X);
2566 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(&RP, P));
Manuel Pégourié-Gonnard357ff652013-12-04 18:39:17 +01002567
2568 /* Set R to zero in modified x/z coordinates */
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 MPI_ECP_LSET(&R->X, 1);
2570 MPI_ECP_LSET(&R->Z, 0);
2571 mbedtls_mpi_free(&R->Y);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002572
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002573 /* RP.X might be slightly larger than P, so reduce it */
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 MOD_ADD(&RP.X);
Manuel Pégourié-Gonnard93f41db2013-12-05 10:48:42 +01002575
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002576 /* Randomize coordinates of the starting point */
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 MBEDTLS_MPI_CHK(ecp_randomize_mxz(grp, &RP, f_rng, p_rng));
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002578
Manuel Pégourié-Gonnardb6f45a62013-12-04 21:54:36 +01002579 /* Loop invariant: R = result so far, RP = R + P */
Aurelien Jarnoc79ce882022-05-15 13:24:05 +02002580 i = grp->nbits + 1; /* one past the (zero-based) required msb for private keys */
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 while (i-- > 0) {
2582 b = mbedtls_mpi_get_bit(m, i);
Manuel Pégourié-Gonnardb6f45a62013-12-04 21:54:36 +01002583 /*
2584 * if (b) R = 2R + P else R = 2R,
2585 * which is:
2586 * if (b) double_add( RP, R, RP, R )
2587 * else double_add( R, RP, R, RP )
2588 * but using safe conditional swaps to avoid leaks
2589 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 MPI_ECP_COND_SWAP(&R->X, &RP.X, b);
2591 MPI_ECP_COND_SWAP(&R->Z, &RP.Z, b);
2592 MBEDTLS_MPI_CHK(ecp_double_add_mxz(grp, R, &RP, R, &RP, &PX, tmp));
2593 MPI_ECP_COND_SWAP(&R->X, &RP.X, b);
2594 MPI_ECP_COND_SWAP(&R->Z, &RP.Z, b);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002595 }
2596
Manuel Pégourié-Gonnarda4aa89b2020-03-25 12:41:29 +01002597 /*
2598 * Knowledge of the projective coordinates may leak the last few bits of the
2599 * scalar [1], and since our MPI implementation isn't constant-flow,
2600 * inversion (used for coordinate normalization) may leak the full value
2601 * of its input via side-channels [2].
2602 *
2603 * [1] https://eprint.iacr.org/2003/191
2604 * [2] https://eprint.iacr.org/2020/055
2605 *
2606 * Avoid the leak by randomizing coordinates before we normalize them.
2607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 MBEDTLS_MPI_CHK(ecp_randomize_mxz(grp, R, f_rng, p_rng));
2609 MBEDTLS_MPI_CHK(ecp_normalize_mxz(grp, R));
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002610
2611cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 mbedtls_ecp_point_free(&RP); mbedtls_mpi_free(&PX);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
2615 return ret;
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002616}
2617
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002618#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01002619
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002620/*
Manuel Pégourié-Gonnard884569c2017-04-20 10:10:59 +02002621 * Restartable multiplication R = m * P
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002622 *
2623 * This internal function can be called without an RNG in case where we know
2624 * the inputs are not sensitive.
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002625 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626static int ecp_mul_restartable_internal(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2627 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2628 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
2629 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002630{
Janos Follathb0697532016-08-18 12:38:46 +01002631 int ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Janos Follathc44ab972016-11-18 16:38:23 +00002632#if defined(MBEDTLS_ECP_INTERNAL_ALT)
2633 char is_grp_capable = 0;
2634#endif
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02002635
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002636#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002637 /* reset ops count for this call if top-level */
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 if (rs_ctx != NULL && rs_ctx->depth++ == 0) {
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002639 rs_ctx->ops_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 }
Gilles Peskine59970052019-02-28 13:12:06 +01002641#else
2642 (void) rs_ctx;
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002643#endif
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002644
Janos Follathc44ab972016-11-18 16:38:23 +00002645#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if ((is_grp_capable = mbedtls_internal_ecp_grp_capable(grp))) {
2647 MBEDTLS_MPI_CHK(mbedtls_internal_ecp_init(grp));
2648 }
Janos Follathc44ab972016-11-18 16:38:23 +00002649#endif /* MBEDTLS_ECP_INTERNAL_ALT */
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002650
David Horstmannfc735df2022-10-06 19:11:04 +01002651 int restarting = 0;
Manuel Pégourié-Gonnard95aedfe2017-08-24 13:47:04 +02002652#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 restarting = (rs_ctx != NULL && rs_ctx->rsm != NULL);
Manuel Pégourié-Gonnarda08cd1a2017-04-20 11:29:43 +02002654#endif
David Horstmannfc735df2022-10-06 19:11:04 +01002655 /* skip argument check when restarting */
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 if (!restarting) {
Manuel Pégourié-Gonnard5314f232017-04-21 12:36:59 +02002657 /* check_privkey is free */
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_CHK);
Manuel Pégourié-Gonnard5314f232017-04-21 12:36:59 +02002659
Manuel Pégourié-Gonnarda08cd1a2017-04-20 11:29:43 +02002660 /* Common sanity checks */
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 MBEDTLS_MPI_CHK(mbedtls_ecp_check_privkey(grp, m));
2662 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
Manuel Pégourié-Gonnarda08cd1a2017-04-20 11:29:43 +02002663 }
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002664
2665 ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002666#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
2668 MBEDTLS_MPI_CHK(ecp_mul_mxz(grp, R, m, P, f_rng, p_rng));
2669 }
Janos Follath430d3372016-11-03 14:25:37 +00002670#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002671#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
2673 MBEDTLS_MPI_CHK(ecp_mul_comb(grp, R, m, P, f_rng, p_rng, rs_ctx));
2674 }
Janos Follath430d3372016-11-03 14:25:37 +00002675#endif
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002676
Janos Follath6c8ccd52016-11-29 15:37:09 +00002677cleanup:
Janos Follathb0697532016-08-18 12:38:46 +01002678
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002679#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (is_grp_capable) {
2681 mbedtls_internal_ecp_free(grp);
2682 }
Janos Follathc44ab972016-11-18 16:38:23 +00002683#endif /* MBEDTLS_ECP_INTERNAL_ALT */
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002684
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002685#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 if (rs_ctx != NULL) {
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002687 rs_ctx->depth--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 }
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002689#endif
2690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 return ret;
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002692}
2693
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002694/*
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002695 * Restartable multiplication R = m * P
2696 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002697int mbedtls_ecp_mul_restartable(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2698 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2699 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
2700 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002701{
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 if (f_rng == NULL) {
2703 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2704 }
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 return ecp_mul_restartable_internal(grp, R, m, P, f_rng, p_rng, rs_ctx);
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002707}
2708
2709/*
Manuel Pégourié-Gonnard884569c2017-04-20 10:10:59 +02002710 * Multiplication R = m * P
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002711 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002712int mbedtls_ecp_mul(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2713 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2714 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002715{
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 return mbedtls_ecp_mul_restartable(grp, R, m, P, f_rng, p_rng, NULL);
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002717}
Valerio Settifd122f42023-04-05 18:15:32 +02002718#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002719
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002720#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002721/*
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01002722 * Check that an affine point is valid as a public key,
2723 * short weierstrass curves (SEC1 3.2.3.1)
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002724 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002725static int ecp_check_pubkey_sw(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002726{
Janos Follath24eed8d2019-11-22 13:21:35 +00002727 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728 mbedtls_mpi YY, RHS;
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002729
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +01002730 /* pt coordinates must be normalized for our checks */
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 if (mbedtls_mpi_cmp_int(&pt->X, 0) < 0 ||
2732 mbedtls_mpi_cmp_int(&pt->Y, 0) < 0 ||
2733 mbedtls_mpi_cmp_mpi(&pt->X, &grp->P) >= 0 ||
2734 mbedtls_mpi_cmp_mpi(&pt->Y, &grp->P) >= 0) {
2735 return MBEDTLS_ERR_ECP_INVALID_KEY;
2736 }
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 mbedtls_mpi_init(&YY); mbedtls_mpi_init(&RHS);
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002739
2740 /*
2741 * YY = Y^2
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01002742 * RHS = X^3 + A X + B
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002743 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 MPI_ECP_SQR(&YY, &pt->Y);
2745 MBEDTLS_MPI_CHK(ecp_sw_rhs(grp, &RHS, &pt->X));
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002746
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 if (MPI_ECP_CMP(&YY, &RHS) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 }
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002750
2751cleanup:
2752
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 mbedtls_mpi_free(&YY); mbedtls_mpi_free(&RHS);
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 return ret;
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002756}
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002757#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01002758
Valerio Settifd122f42023-04-05 18:15:32 +02002759#if defined(MBEDTLS_ECP_C)
Gilles Peskine9b99a892018-09-14 18:32:19 +02002760#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002761/*
TRodziewicz9edff742021-03-04 17:59:39 +01002762 * R = m * P with shortcuts for m == 0, m == 1 and m == -1
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002763 * NOT constant-time - ONLY for short Weierstrass!
2764 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002765static int mbedtls_ecp_mul_shortcuts(mbedtls_ecp_group *grp,
2766 mbedtls_ecp_point *R,
2767 const mbedtls_mpi *m,
2768 const mbedtls_ecp_point *P,
2769 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002770{
Janos Follath24eed8d2019-11-22 13:21:35 +00002771 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerc27a0e02022-01-06 05:56:34 +00002772 mbedtls_mpi tmp;
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 mbedtls_mpi_init(&tmp);
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (mbedtls_mpi_cmp_int(m, 0) == 0) {
2776 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2777 MBEDTLS_MPI_CHK(mbedtls_ecp_set_zero(R));
2778 } else if (mbedtls_mpi_cmp_int(m, 1) == 0) {
2779 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2780 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, P));
2781 } else if (mbedtls_mpi_cmp_int(m, -1) == 0) {
2782 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2783 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, P));
2784 MPI_ECP_NEG(&R->Y);
2785 } else {
2786 MBEDTLS_MPI_CHK(ecp_mul_restartable_internal(grp, R, m, P,
2787 NULL, NULL, rs_ctx));
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002788 }
2789
2790cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 mbedtls_mpi_free(&tmp);
Hanno Beckerc27a0e02022-01-06 05:56:34 +00002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 return ret;
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002794}
2795
2796/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002797 * Restartable linear combination
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002798 * NOT constant-time
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002799 */
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002800int mbedtls_ecp_muladd_restartable(
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2802 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2803 const mbedtls_mpi *n, const mbedtls_ecp_point *Q,
2804 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002805{
Janos Follath24eed8d2019-11-22 13:21:35 +00002806 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002807 mbedtls_ecp_point mP;
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002808 mbedtls_ecp_point *pmP = &mP;
2809 mbedtls_ecp_point *pR = R;
Hanno Becker3b29f212022-01-04 07:34:14 +00002810 mbedtls_mpi tmp[4];
Janos Follathc44ab972016-11-18 16:38:23 +00002811#if defined(MBEDTLS_ECP_INTERNAL_ALT)
2812 char is_grp_capable = 0;
2813#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (mbedtls_ecp_get_type(grp) != MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
2815 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
2816 }
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 mbedtls_ecp_point_init(&mP);
2819 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Becker3b29f212022-01-04 07:34:14 +00002820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 ECP_RS_ENTER(ma);
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +02002822
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002823#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002825 /* redirect intermediate results to restart context */
2826 pmP = &rs_ctx->ma->mP;
2827 pR = &rs_ctx->ma->R;
2828
2829 /* jump to next operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 if (rs_ctx->ma->state == ecp_rsma_mul2) {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002831 goto mul2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 }
2833 if (rs_ctx->ma->state == ecp_rsma_add) {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002834 goto add;
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 }
2836 if (rs_ctx->ma->state == ecp_rsma_norm) {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002837 goto norm;
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 }
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002839 }
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002840#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002841
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 MBEDTLS_MPI_CHK(mbedtls_ecp_mul_shortcuts(grp, pmP, m, P, rs_ctx));
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002843#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Manuel Pégourié-Gonnardc9efa002017-08-24 10:25:06 +02002845 rs_ctx->ma->state = ecp_rsma_mul2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 }
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002847
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002848mul2:
2849#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 MBEDTLS_MPI_CHK(mbedtls_ecp_mul_shortcuts(grp, pR, n, Q, rs_ctx));
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002851
2852#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 if ((is_grp_capable = mbedtls_internal_ecp_grp_capable(grp))) {
2854 MBEDTLS_MPI_CHK(mbedtls_internal_ecp_init(grp));
2855 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002856#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2857
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002858#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Manuel Pégourié-Gonnardc9efa002017-08-24 10:25:06 +02002860 rs_ctx->ma->state = ecp_rsma_add;
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 }
Manuel Pégourié-Gonnard1a7c5ef2015-08-13 10:19:09 +02002862
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002863add:
2864#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_ADD);
2866 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, pR, pmP, pR, tmp));
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002867#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Manuel Pégourié-Gonnardc9efa002017-08-24 10:25:06 +02002869 rs_ctx->ma->state = ecp_rsma_norm;
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 }
Janos Follath430d3372016-11-03 14:25:37 +00002871
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002872norm:
2873#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV);
2875 MBEDTLS_MPI_CHK(ecp_normalize_jac(grp, pR));
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002876
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002877#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
2879 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, pR));
2880 }
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002881#endif
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002882
2883cleanup:
Hanno Becker3b29f212022-01-04 07:34:14 +00002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Becker3b29f212022-01-04 07:34:14 +00002886
Janos Follathc44ab972016-11-18 16:38:23 +00002887#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 if (is_grp_capable) {
2889 mbedtls_internal_ecp_free(grp);
2890 }
Janos Follathc44ab972016-11-18 16:38:23 +00002891#endif /* MBEDTLS_ECP_INTERNAL_ALT */
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 mbedtls_ecp_point_free(&mP);
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 ECP_RS_LEAVE(ma);
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 return ret;
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002898}
2899
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002900/*
2901 * Linear combination
2902 * NOT constant-time
2903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904int mbedtls_ecp_muladd(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2905 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2906 const mbedtls_mpi *n, const mbedtls_ecp_point *Q)
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002907{
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 return mbedtls_ecp_muladd_restartable(grp, R, m, P, n, Q, NULL);
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002909}
Gilles Peskine9b99a892018-09-14 18:32:19 +02002910#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Valerio Settifd122f42023-04-05 18:15:32 +02002911#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01002912
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002913#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002914#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Dave Rodgmanb8f18852023-07-18 12:45:17 +01002915#define ECP_MPI_INIT(_p, _n) { .p = (mbedtls_mpi_uint *) (_p), .s = 1, .n = (_n) }
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002916#define ECP_MPI_INIT_ARRAY(x) \
Dave Rodgmanb8f18852023-07-18 12:45:17 +01002917 ECP_MPI_INIT(x, sizeof(x) / sizeof(mbedtls_mpi_uint))
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002918/*
2919 * Constants for the two points other than 0, 1, -1 (mod p) in
2920 * https://cr.yp.to/ecdh.html#validate
2921 * See ecp_check_pubkey_x25519().
2922 */
2923static const mbedtls_mpi_uint x25519_bad_point_1[] = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 MBEDTLS_BYTES_TO_T_UINT_8(0xe0, 0xeb, 0x7a, 0x7c, 0x3b, 0x41, 0xb8, 0xae),
2925 MBEDTLS_BYTES_TO_T_UINT_8(0x16, 0x56, 0xe3, 0xfa, 0xf1, 0x9f, 0xc4, 0x6a),
2926 MBEDTLS_BYTES_TO_T_UINT_8(0xda, 0x09, 0x8d, 0xeb, 0x9c, 0x32, 0xb1, 0xfd),
2927 MBEDTLS_BYTES_TO_T_UINT_8(0x86, 0x62, 0x05, 0x16, 0x5f, 0x49, 0xb8, 0x00),
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002928};
2929static const mbedtls_mpi_uint x25519_bad_point_2[] = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 MBEDTLS_BYTES_TO_T_UINT_8(0x5f, 0x9c, 0x95, 0xbc, 0xa3, 0x50, 0x8c, 0x24),
2931 MBEDTLS_BYTES_TO_T_UINT_8(0xb1, 0xd0, 0xb1, 0x55, 0x9c, 0x83, 0xef, 0x5b),
2932 MBEDTLS_BYTES_TO_T_UINT_8(0x04, 0x44, 0x5c, 0xc4, 0x58, 0x1c, 0x8e, 0x86),
2933 MBEDTLS_BYTES_TO_T_UINT_8(0xd8, 0x22, 0x4e, 0xdd, 0xd0, 0x9f, 0x11, 0x57),
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002934};
2935static const mbedtls_mpi ecp_x25519_bad_point_1 = ECP_MPI_INIT_ARRAY(
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 x25519_bad_point_1);
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002937static const mbedtls_mpi ecp_x25519_bad_point_2 = ECP_MPI_INIT_ARRAY(
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 x25519_bad_point_2);
Janos Follath865a75e2021-06-24 15:34:59 +01002939#endif /* MBEDTLS_ECP_DP_CURVE25519_ENABLED */
Manuel Pégourié-Gonnard2389a602021-06-23 12:25:48 +02002940
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002941/*
2942 * Check that the input point is not one of the low-order points.
2943 * This is recommended by the "May the Fourth" paper:
2944 * https://eprint.iacr.org/2017/806.pdf
2945 * Those points are never sent by an honest peer.
2946 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002947static int ecp_check_bad_points_mx(const mbedtls_mpi *X, const mbedtls_mpi *P,
2948 const mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002949{
2950 int ret;
Manuel Pégourié-Gonnard2389a602021-06-23 12:25:48 +02002951 mbedtls_mpi XmP;
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002952
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 mbedtls_mpi_init(&XmP);
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002954
2955 /* Reduce X mod P so that we only need to check values less than P.
2956 * We know X < 2^256 so we can proceed by subtraction. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&XmP, X));
2958 while (mbedtls_mpi_cmp_mpi(&XmP, P) >= 0) {
2959 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&XmP, &XmP, P));
2960 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002961
Janos Follath865a75e2021-06-24 15:34:59 +01002962 /* Check against the known bad values that are less than P. For Curve448
2963 * these are 0, 1 and -1. For Curve25519 we check the values less than P
2964 * from the following list: https://cr.yp.to/ecdh.html#validate */
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 if (mbedtls_mpi_cmp_int(&XmP, 1) <= 0) { /* takes care of 0 and 1 */
Janos Follath8081ced2021-06-24 14:24:13 +01002966 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2967 goto cleanup;
2968 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002969
Janos Follath865a75e2021-06-24 15:34:59 +01002970#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 if (grp_id == MBEDTLS_ECP_DP_CURVE25519) {
2972 if (mbedtls_mpi_cmp_mpi(&XmP, &ecp_x25519_bad_point_1) == 0) {
Janos Follath865a75e2021-06-24 15:34:59 +01002973 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2974 goto cleanup;
2975 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 if (mbedtls_mpi_cmp_mpi(&XmP, &ecp_x25519_bad_point_2) == 0) {
Janos Follath865a75e2021-06-24 15:34:59 +01002978 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2979 goto cleanup;
2980 }
Janos Follath8081ced2021-06-24 14:24:13 +01002981 }
Janos Follath83e384d2021-06-25 15:29:56 +01002982#else
2983 (void) grp_id;
Janos Follath865a75e2021-06-24 15:34:59 +01002984#endif
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002985
Manuel Pégourié-Gonnard2389a602021-06-23 12:25:48 +02002986 /* Final check: check if XmP + 1 is P (final because it changes XmP!) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&XmP, &XmP, 1));
2988 if (mbedtls_mpi_cmp_mpi(&XmP, P) == 0) {
Janos Follath8081ced2021-06-24 14:24:13 +01002989 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2990 goto cleanup;
2991 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002992
2993 ret = 0;
2994
2995cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 mbedtls_mpi_free(&XmP);
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 return ret;
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002999}
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02003000
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003001/*
3002 * Check validity of a public key for Montgomery curves with x-only schemes
3003 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003004static int ecp_check_pubkey_mx(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003005{
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +02003006 /* [Curve25519 p. 5] Just check X is the correct number of bytes */
Nicholas Wilson08f3ef12015-11-10 13:10:01 +00003007 /* Allow any public value, if it's too big then we'll just reduce it mod p
3008 * (RFC 7748 sec. 5 para. 3). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 if (mbedtls_mpi_size(&pt->X) > (grp->nbits + 7) / 8) {
3010 return MBEDTLS_ERR_ECP_INVALID_KEY;
3011 }
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003012
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02003013 /* Implicit in all standards (as they don't consider negative numbers):
3014 * X must be non-negative. This is normally ensured by the way it's
3015 * encoded for transmission, but let's be extra sure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 if (mbedtls_mpi_cmp_int(&pt->X, 0) < 0) {
3017 return MBEDTLS_ERR_ECP_INVALID_KEY;
3018 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02003019
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 return ecp_check_bad_points_mx(&pt->X, &grp->P, grp->id);
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003021}
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003022#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003023
3024/*
3025 * Check that a point is valid as a public key
3026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003027int mbedtls_ecp_check_pubkey(const mbedtls_ecp_group *grp,
3028 const mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003029{
3030 /* Must use affine coordinates */
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 if (mbedtls_mpi_cmp_int(&pt->Z, 1) != 0) {
3032 return MBEDTLS_ERR_ECP_INVALID_KEY;
3033 }
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003034
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003035#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3037 return ecp_check_pubkey_mx(grp, pt);
3038 }
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003039#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003040#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3042 return ecp_check_pubkey_sw(grp, pt);
3043 }
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003044#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003046}
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003047
3048/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049 * Check that an mbedtls_mpi is valid as a private key
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003051int mbedtls_ecp_check_privkey(const mbedtls_ecp_group *grp,
3052 const mbedtls_mpi *d)
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003053{
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003054#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Nicholas Wilson08f3ef12015-11-10 13:10:01 +00003056 /* see RFC 7748 sec. 5 para. 5 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 if (mbedtls_mpi_get_bit(d, 0) != 0 ||
3058 mbedtls_mpi_get_bit(d, 1) != 0 ||
minosgalanakis48477652024-08-22 13:22:26 +01003059 mbedtls_mpi_bitlen(d) != grp->nbits + 1) { /* mbedtls_mpi_bitlen is one-based! */
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 return MBEDTLS_ERR_ECP_INVALID_KEY;
3061 }
Nicholas Wilson08f3ef12015-11-10 13:10:01 +00003062
3063 /* see [Curve25519] page 5 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (grp->nbits == 254 && mbedtls_mpi_get_bit(d, 2) != 0) {
3065 return MBEDTLS_ERR_ECP_INVALID_KEY;
3066 }
Nicholas Wilson08f3ef12015-11-10 13:10:01 +00003067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 return 0;
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +01003069 }
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003070#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
3071#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +01003073 /* see SEC1 3.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 if (mbedtls_mpi_cmp_int(d, 1) < 0 ||
3075 mbedtls_mpi_cmp_mpi(d, &grp->N) >= 0) {
3076 return MBEDTLS_ERR_ECP_INVALID_KEY;
3077 } else {
3078 return 0;
3079 }
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +01003080 }
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003081#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003084}
3085
Gilles Peskine72fcc982021-03-23 22:31:31 +01003086#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3087MBEDTLS_STATIC_TESTABLE
Gilles Peskine449bd832023-01-11 14:50:10 +01003088int mbedtls_ecp_gen_privkey_mx(size_t high_bit,
3089 mbedtls_mpi *d,
3090 int (*f_rng)(void *, unsigned char *, size_t),
3091 void *p_rng)
Gilles Peskine72fcc982021-03-23 22:31:31 +01003092{
3093 int ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Gilles Peskine61f1f5f2021-03-24 12:46:46 +01003094 size_t n_random_bytes = high_bit / 8 + 1;
Gilles Peskine72fcc982021-03-23 22:31:31 +01003095
3096 /* [Curve25519] page 5 */
Gilles Peskine61f1f5f2021-03-24 12:46:46 +01003097 /* Generate a (high_bit+1)-bit random number by generating just enough
3098 * random bytes, then shifting out extra bits from the top (necessary
3099 * when (high_bit+1) is not a multiple of 8). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 MBEDTLS_MPI_CHK(mbedtls_mpi_fill_random(d, n_random_bytes,
3101 f_rng, p_rng));
3102 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_r(d, 8 * n_random_bytes - high_bit - 1));
Gilles Peskine72fcc982021-03-23 22:31:31 +01003103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, high_bit, 1));
Gilles Peskine72fcc982021-03-23 22:31:31 +01003105
3106 /* Make sure the last two bits are unset for Curve448, three bits for
3107 Curve25519 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 0, 0));
3109 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 1, 0));
3110 if (high_bit == 254) {
3111 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 2, 0));
Gilles Peskine72fcc982021-03-23 22:31:31 +01003112 }
3113
3114cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 return ret;
Gilles Peskine72fcc982021-03-23 22:31:31 +01003116}
3117#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
3118
Gilles Peskine60d8b982021-03-29 22:28:21 +02003119#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3120static int mbedtls_ecp_gen_privkey_sw(
3121 const mbedtls_mpi *N, mbedtls_mpi *d,
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Gilles Peskine60d8b982021-03-29 22:28:21 +02003123{
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 int ret = mbedtls_mpi_random(d, 1, N, f_rng, p_rng);
3125 switch (ret) {
Gilles Peskine60d8b982021-03-29 22:28:21 +02003126 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return MBEDTLS_ERR_ECP_RANDOM_FAILED;
Gilles Peskine60d8b982021-03-29 22:28:21 +02003128 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 return ret;
Gilles Peskine60d8b982021-03-29 22:28:21 +02003130 }
3131}
3132#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3133
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003134/*
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003135 * Generate a private key
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01003136 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003137int mbedtls_ecp_gen_privkey(const mbedtls_ecp_group *grp,
3138 mbedtls_mpi *d,
3139 int (*f_rng)(void *, unsigned char *, size_t),
3140 void *p_rng)
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01003141{
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003142#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3144 return mbedtls_ecp_gen_privkey_mx(grp->nbits, d, f_rng, p_rng);
3145 }
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003146#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003147
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003148#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3150 return mbedtls_ecp_gen_privkey_sw(&grp->N, d, f_rng, p_rng);
3151 }
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003152#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01003153
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003155}
Manuel Pégourié-Gonnardc9573992014-01-03 12:54:00 +01003156
Valerio Settifd122f42023-04-05 18:15:32 +02003157#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003158/*
3159 * Generate a keypair with configurable base point
3160 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003161int mbedtls_ecp_gen_keypair_base(mbedtls_ecp_group *grp,
3162 const mbedtls_ecp_point *G,
3163 mbedtls_mpi *d, mbedtls_ecp_point *Q,
3164 int (*f_rng)(void *, unsigned char *, size_t),
3165 void *p_rng)
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003166{
Janos Follath24eed8d2019-11-22 13:21:35 +00003167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 MBEDTLS_MPI_CHK(mbedtls_ecp_gen_privkey(grp, d, f_rng, p_rng));
3169 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, Q, d, G, f_rng, p_rng));
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003170
3171cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 return ret;
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02003173}
3174
3175/*
3176 * Generate key pair, wrapper for conventional base point
3177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003178int mbedtls_ecp_gen_keypair(mbedtls_ecp_group *grp,
3179 mbedtls_mpi *d, mbedtls_ecp_point *Q,
3180 int (*f_rng)(void *, unsigned char *, size_t),
3181 void *p_rng)
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02003182{
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 return mbedtls_ecp_gen_keypair_base(grp, &grp->G, d, Q, f_rng, p_rng);
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01003184}
Manuel Pégourié-Gonnardefaa31e2012-11-06 21:34:35 +01003185
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003186/*
3187 * Generate a keypair, prettier wrapper
3188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003189int mbedtls_ecp_gen_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
3190 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003191{
Janos Follath24eed8d2019-11-22 13:21:35 +00003192 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3194 return ret;
3195 }
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003196
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 return mbedtls_ecp_gen_keypair(&key->grp, &key->d, &key->Q, f_rng, p_rng);
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003198}
Valerio Settifd122f42023-04-05 18:15:32 +02003199#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003200
Gilles Peskine28240322023-06-21 19:52:11 +02003201int mbedtls_ecp_set_public_key(mbedtls_ecp_group_id grp_id,
3202 mbedtls_ecp_keypair *key,
3203 const mbedtls_ecp_point *Q)
3204{
3205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3206
3207 if (key->grp.id == MBEDTLS_ECP_DP_NONE) {
3208 /* Group not set yet */
3209 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3210 return ret;
3211 }
3212 } else if (key->grp.id != grp_id) {
3213 /* Group mismatch */
3214 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3215 }
3216 return mbedtls_ecp_copy(&key->Q, Q);
3217}
3218
3219
Janos Follath77800962019-02-25 16:32:08 +00003220#define ECP_CURVE25519_KEY_SIZE 32
Archana1d2e2bb2021-06-07 06:13:16 +05303221#define ECP_CURVE448_KEY_SIZE 56
Janos Follath171a7ef2019-02-15 16:17:45 +00003222/*
3223 * Read a private key.
3224 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003225int mbedtls_ecp_read_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
3226 const unsigned char *buf, size_t buflen)
Janos Follath171a7ef2019-02-15 16:17:45 +00003227{
3228 int ret = 0;
3229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3231 return ret;
3232 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003233
Janos Follath28eb06d2019-02-26 10:53:34 +00003234 ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
3235
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003236#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Janos Follath28eb06d2019-02-26 10:53:34 +00003238 /*
Archana1d2e2bb2021-06-07 06:13:16 +05303239 * Mask the key as mandated by RFC7748 for Curve25519 and Curve448.
Janos Follath28eb06d2019-02-26 10:53:34 +00003240 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 if (grp_id == MBEDTLS_ECP_DP_CURVE25519) {
3242 if (buflen != ECP_CURVE25519_KEY_SIZE) {
3243 return MBEDTLS_ERR_ECP_INVALID_KEY;
3244 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&key->d, buf, buflen));
Janos Follath171a7ef2019-02-15 16:17:45 +00003247
Janos Follath28eb06d2019-02-26 10:53:34 +00003248 /* Set the three least significant bits to 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 0, 0));
3250 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 1, 0));
3251 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 2, 0));
Janos Follath171a7ef2019-02-15 16:17:45 +00003252
Janos Follath28eb06d2019-02-26 10:53:34 +00003253 /* Set the most significant bit to 0 */
3254 MBEDTLS_MPI_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 mbedtls_mpi_set_bit(&key->d,
3256 ECP_CURVE25519_KEY_SIZE * 8 - 1, 0)
3257 );
Janos Follath171a7ef2019-02-15 16:17:45 +00003258
Janos Follath28eb06d2019-02-26 10:53:34 +00003259 /* Set the second most significant bit to 1 */
3260 MBEDTLS_MPI_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 mbedtls_mpi_set_bit(&key->d,
3262 ECP_CURVE25519_KEY_SIZE * 8 - 2, 1)
3263 );
3264 } else if (grp_id == MBEDTLS_ECP_DP_CURVE448) {
3265 if (buflen != ECP_CURVE448_KEY_SIZE) {
3266 return MBEDTLS_ERR_ECP_INVALID_KEY;
3267 }
Archana1d2e2bb2021-06-07 06:13:16 +05303268
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&key->d, buf, buflen));
Archana1d2e2bb2021-06-07 06:13:16 +05303270
3271 /* Set the two least significant bits to 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 0, 0));
3273 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 1, 0));
Archana1d2e2bb2021-06-07 06:13:16 +05303274
3275 /* Set the most significant bit to 1 */
3276 MBEDTLS_MPI_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 mbedtls_mpi_set_bit(&key->d,
3278 ECP_CURVE448_KEY_SIZE * 8 - 1, 1)
3279 );
Archana1d2e2bb2021-06-07 06:13:16 +05303280 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003281 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003282#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003283#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3285 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&key->d, buf, buflen));
Janos Follath171a7ef2019-02-15 16:17:45 +00003286 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003287#endif
Manuel Pégourié-Gonnard745ec5d2023-10-17 10:13:45 +02003288
3289 if (ret == 0) {
3290 MBEDTLS_MPI_CHK(mbedtls_ecp_check_privkey(&key->grp, &key->d));
3291 }
Valerio Setti41b08182023-07-04 12:14:21 +02003292
Janos Follath171a7ef2019-02-15 16:17:45 +00003293cleanup:
3294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 if (ret != 0) {
3296 mbedtls_mpi_free(&key->d);
3297 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003298
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 return ret;
Janos Follath171a7ef2019-02-15 16:17:45 +00003300}
3301
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003302/*
Steven Cooremande8593f2020-06-09 19:55:26 +02003303 * Write a private key.
3304 */
Gilles Peskinec0f7a862024-02-19 16:50:39 +01003305#if !defined MBEDTLS_DEPRECATED_REMOVED
Gilles Peskine449bd832023-01-11 14:50:10 +01003306int mbedtls_ecp_write_key(mbedtls_ecp_keypair *key,
3307 unsigned char *buf, size_t buflen)
Steven Cooremande8593f2020-06-09 19:55:26 +02003308{
Gilles Peskine5bb04e02024-02-19 13:24:41 +01003309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremande8593f2020-06-09 19:55:26 +02003310
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003311#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3313 if (key->grp.id == MBEDTLS_ECP_DP_CURVE25519) {
3314 if (buflen < ECP_CURVE25519_KEY_SIZE) {
3315 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3316 }
Steven Cooremande8593f2020-06-09 19:55:26 +02003317
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 } else if (key->grp.id == MBEDTLS_ECP_DP_CURVE448) {
3319 if (buflen < ECP_CURVE448_KEY_SIZE) {
3320 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3321 }
Steven Cooremande8593f2020-06-09 19:55:26 +02003322 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary_le(&key->d, buf, buflen));
Steven Cooremande8593f2020-06-09 19:55:26 +02003324 }
Steven Cooremande8593f2020-06-09 19:55:26 +02003325#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003326#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003327 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3328 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&key->d, buf, buflen));
Steven Cooremande8593f2020-06-09 19:55:26 +02003329 }
3330
3331#endif
3332cleanup:
3333
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 return ret;
Steven Cooremande8593f2020-06-09 19:55:26 +02003335}
Gilles Peskinec0f7a862024-02-19 16:50:39 +01003336#endif /* MBEDTLS_DEPRECATED_REMOVED */
Steven Cooremande8593f2020-06-09 19:55:26 +02003337
Gilles Peskineb395e742024-02-28 14:18:28 +01003338int mbedtls_ecp_write_key_ext(const mbedtls_ecp_keypair *key,
Gilles Peskinee3fb4cc2024-02-19 16:27:35 +01003339 size_t *olen, unsigned char *buf, size_t buflen)
3340{
3341 size_t len = (key->grp.nbits + 7) / 8;
3342 if (len > buflen) {
3343 /* For robustness, ensure *olen <= buflen even on error. */
3344 *olen = 0;
3345 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3346 }
3347 *olen = len;
3348
3349 /* Private key not set */
3350 if (key->d.n == 0) {
3351 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
3352 }
3353
3354#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3355 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3356 return mbedtls_mpi_write_binary_le(&key->d, buf, len);
3357 }
3358#endif
3359
3360#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3361 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3362 return mbedtls_mpi_write_binary(&key->d, buf, len);
3363 }
3364#endif
3365
3366 /* Private key set but no recognized curve type? This shouldn't happen. */
3367 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3368}
3369
Gilles Peskine62e33bc2023-06-22 22:27:32 +02003370/*
3371 * Write a public key.
3372 */
Gilles Peskine39b7bba2024-01-02 17:56:54 +01003373int mbedtls_ecp_write_public_key(const mbedtls_ecp_keypair *key,
Gilles Peskine62e33bc2023-06-22 22:27:32 +02003374 int format, size_t *olen,
3375 unsigned char *buf, size_t buflen)
3376{
3377 return mbedtls_ecp_point_write_binary(&key->grp, &key->Q,
3378 format, olen, buf, buflen);
3379}
3380
3381
Valerio Settifd122f42023-04-05 18:15:32 +02003382#if defined(MBEDTLS_ECP_C)
Steven Cooremande8593f2020-06-09 19:55:26 +02003383/*
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003384 * Check a public-private key pair
3385 */
Manuel Pégourié-Gonnardf8c24bf2021-06-15 11:29:26 +02003386int mbedtls_ecp_check_pub_priv(
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 const mbedtls_ecp_keypair *pub, const mbedtls_ecp_keypair *prv,
3388 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003389{
Janos Follath24eed8d2019-11-22 13:21:35 +00003390 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391 mbedtls_ecp_point Q;
3392 mbedtls_ecp_group grp;
Gilles Peskine449bd832023-01-11 14:50:10 +01003393 if (pub->grp.id == MBEDTLS_ECP_DP_NONE ||
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003394 pub->grp.id != prv->grp.id ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003395 mbedtls_mpi_cmp_mpi(&pub->Q.X, &prv->Q.X) ||
3396 mbedtls_mpi_cmp_mpi(&pub->Q.Y, &prv->Q.Y) ||
3397 mbedtls_mpi_cmp_mpi(&pub->Q.Z, &prv->Q.Z)) {
3398 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003399 }
3400
Gilles Peskine449bd832023-01-11 14:50:10 +01003401 mbedtls_ecp_point_init(&Q);
3402 mbedtls_ecp_group_init(&grp);
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 /* mbedtls_ecp_mul() needs a non-const group... */
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 mbedtls_ecp_group_copy(&grp, &prv->grp);
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003406
3407 /* Also checks d is valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(&grp, &Q, &prv->d, &prv->grp.G, f_rng, p_rng));
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003409
Gilles Peskine449bd832023-01-11 14:50:10 +01003410 if (mbedtls_mpi_cmp_mpi(&Q.X, &prv->Q.X) ||
3411 mbedtls_mpi_cmp_mpi(&Q.Y, &prv->Q.Y) ||
3412 mbedtls_mpi_cmp_mpi(&Q.Z, &prv->Q.Z)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413 ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003414 goto cleanup;
3415 }
3416
3417cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 mbedtls_ecp_point_free(&Q);
3419 mbedtls_ecp_group_free(&grp);
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003420
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 return ret;
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003422}
Gilles Peskine7ea72022023-06-21 20:39:08 +02003423
3424int mbedtls_ecp_keypair_calc_public(mbedtls_ecp_keypair *key,
3425 int (*f_rng)(void *, unsigned char *, size_t),
3426 void *p_rng)
3427{
3428 return mbedtls_ecp_mul(&key->grp, &key->Q, &key->d, &key->grp.G,
3429 f_rng, p_rng);
3430}
Valerio Settifd122f42023-04-05 18:15:32 +02003431#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003432
Gilles Peskinee6886102023-06-21 18:22:06 +02003433mbedtls_ecp_group_id mbedtls_ecp_keypair_get_group_id(
3434 const mbedtls_ecp_keypair *key)
3435{
3436 return key->grp.id;
3437}
3438
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003439/*
3440 * Export generic key-pair parameters.
3441 */
3442int mbedtls_ecp_export(const mbedtls_ecp_keypair *key, mbedtls_ecp_group *grp,
3443 mbedtls_mpi *d, mbedtls_ecp_point *Q)
3444{
3445 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003446
Gilles Peskineba5b5d62023-06-21 18:24:04 +02003447 if (grp != NULL && (ret = mbedtls_ecp_group_copy(grp, &key->grp)) != 0) {
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003448 return ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 }
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003450
Gilles Peskineba5b5d62023-06-21 18:24:04 +02003451 if (d != NULL && (ret = mbedtls_mpi_copy(d, &key->d)) != 0) {
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003452 return ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 }
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003454
Gilles Peskineba5b5d62023-06-21 18:24:04 +02003455 if (Q != NULL && (ret = mbedtls_ecp_copy(Q, &key->Q)) != 0) {
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003456 return ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 }
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003458
3459 return 0;
3460}
3461
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003463
Valerio Settifd122f42023-04-05 18:15:32 +02003464#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02003465/*
3466 * PRNG for test - !!!INSECURE NEVER USE IN PRODUCTION!!!
3467 *
3468 * This is the linear congruential generator from numerical recipes,
3469 * except we only use the low byte as the output. See
3470 * https://en.wikipedia.org/wiki/Linear_congruential_generator#Parameters_in_common_use
3471 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003472static int self_test_rng(void *ctx, unsigned char *out, size_t len)
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02003473{
3474 static uint32_t state = 42;
3475
3476 (void) ctx;
3477
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 for (size_t i = 0; i < len; i++) {
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02003479 state = state * 1664525u + 1013904223u;
3480 out[i] = (unsigned char) state;
3481 }
3482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 return 0;
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02003484}
3485
Gilles Peskine6d9c8d72020-07-22 01:26:25 +02003486/* Adjust the exponent to be a valid private point for the specified curve.
3487 * This is sometimes necessary because we use a single set of exponents
3488 * for all curves but the validity of values depends on the curve. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003489static int self_test_adjust_exponent(const mbedtls_ecp_group *grp,
3490 mbedtls_mpi *m)
Gilles Peskinea088c812018-09-17 18:31:15 +02003491{
3492 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003493 switch (grp->id) {
3494 /* If Curve25519 is available, then that's what we use for the
3495 * Montgomery test, so we don't need the adjustment code. */
3496#if !defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Gilles Peskinea088c812018-09-17 18:31:15 +02003497#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
3498 case MBEDTLS_ECP_DP_CURVE448:
3499 /* Move highest bit from 254 to N-1. Setting bit N-1 is
3500 * necessary to enforce the highest-bit-set constraint. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003501 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(m, 254, 0));
3502 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(m, grp->nbits, 1));
Gilles Peskinea088c812018-09-17 18:31:15 +02003503 /* Copy second-highest bit from 253 to N-2. This is not
3504 * necessary but improves the test variety a bit. */
3505 MBEDTLS_MPI_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01003506 mbedtls_mpi_set_bit(m, grp->nbits - 1,
3507 mbedtls_mpi_get_bit(m, 253)));
Gilles Peskinea088c812018-09-17 18:31:15 +02003508 break;
3509#endif
3510#endif /* ! defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) */
3511 default:
3512 /* Non-Montgomery curves and Curve25519 need no adjustment. */
3513 (void) grp;
3514 (void) m;
3515 goto cleanup;
3516 }
3517cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 return ret;
Gilles Peskinea088c812018-09-17 18:31:15 +02003519}
3520
Gilles Peskine6d9c8d72020-07-22 01:26:25 +02003521/* Calculate R = m.P for each m in exponents. Check that the number of
3522 * basic operations doesn't depend on the value of m. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003523static int self_test_point(int verbose,
3524 mbedtls_ecp_group *grp,
3525 mbedtls_ecp_point *R,
3526 mbedtls_mpi *m,
3527 const mbedtls_ecp_point *P,
3528 const char *const *exponents,
3529 size_t n_exponents)
Gilles Peskinec95696f2018-09-17 15:59:01 +02003530{
3531 int ret = 0;
Gilles Peskine24666792018-09-17 18:29:49 +02003532 size_t i = 0;
Gilles Peskinec95696f2018-09-17 15:59:01 +02003533 unsigned long add_c_prev, dbl_c_prev, mul_c_prev;
3534 add_count = 0;
3535 dbl_count = 0;
3536 mul_count = 0;
Gilles Peskinea088c812018-09-17 18:31:15 +02003537
Gilles Peskine449bd832023-01-11 14:50:10 +01003538 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(m, 16, exponents[0]));
3539 MBEDTLS_MPI_CHK(self_test_adjust_exponent(grp, m));
3540 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, R, m, P, self_test_rng, NULL));
Gilles Peskinec95696f2018-09-17 15:59:01 +02003541
Gilles Peskine449bd832023-01-11 14:50:10 +01003542 for (i = 1; i < n_exponents; i++) {
Gilles Peskinec95696f2018-09-17 15:59:01 +02003543 add_c_prev = add_count;
3544 dbl_c_prev = dbl_count;
3545 mul_c_prev = mul_count;
3546 add_count = 0;
3547 dbl_count = 0;
3548 mul_count = 0;
3549
Gilles Peskine449bd832023-01-11 14:50:10 +01003550 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(m, 16, exponents[i]));
3551 MBEDTLS_MPI_CHK(self_test_adjust_exponent(grp, m));
3552 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, R, m, P, self_test_rng, NULL));
Gilles Peskinec95696f2018-09-17 15:59:01 +02003553
Gilles Peskine449bd832023-01-11 14:50:10 +01003554 if (add_count != add_c_prev ||
Gilles Peskinec95696f2018-09-17 15:59:01 +02003555 dbl_count != dbl_c_prev ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003556 mul_count != mul_c_prev) {
Gilles Peskinec95696f2018-09-17 15:59:01 +02003557 ret = 1;
3558 break;
3559 }
3560 }
3561
3562cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003563 if (verbose != 0) {
3564 if (ret != 0) {
3565 mbedtls_printf("failed (%u)\n", (unsigned int) i);
3566 } else {
3567 mbedtls_printf("passed\n");
3568 }
Gilles Peskinec95696f2018-09-17 15:59:01 +02003569 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003570 return ret;
Gilles Peskinec95696f2018-09-17 15:59:01 +02003571}
Valerio Settifd122f42023-04-05 18:15:32 +02003572#endif /* MBEDTLS_ECP_C */
Gilles Peskinec95696f2018-09-17 15:59:01 +02003573
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +01003574/*
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003575 * Checkup routine
3576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003577int mbedtls_ecp_self_test(int verbose)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003578{
Valerio Settifd122f42023-04-05 18:15:32 +02003579#if defined(MBEDTLS_ECP_C)
Janos Follath24eed8d2019-11-22 13:21:35 +00003580 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581 mbedtls_ecp_group grp;
3582 mbedtls_ecp_point R, P;
3583 mbedtls_mpi m;
Gilles Peskine24666792018-09-17 18:29:49 +02003584
3585#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskined9767a52018-09-14 19:29:47 +02003586 /* Exponents especially adapted for secp192k1, which has the lowest
3587 * order n of all supported curves (secp192r1 is in a slightly larger
3588 * field but the order of its base point is slightly smaller). */
Gilles Peskine24666792018-09-17 18:29:49 +02003589 const char *sw_exponents[] =
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003590 {
Manuel Pégourié-Gonnardb63f9e92012-11-21 13:00:58 +01003591 "000000000000000000000000000000000000000000000001", /* one */
Gilles Peskined9767a52018-09-14 19:29:47 +02003592 "FFFFFFFFFFFFFFFFFFFFFFFE26F2FC170F69466A74DEFD8C", /* n - 1 */
Manuel Pégourié-Gonnardb63f9e92012-11-21 13:00:58 +01003593 "5EA6F389A38B8BC81E767753B15AA5569E1782E30ABE7D25", /* random */
Manuel Pégourié-Gonnardff27b7c2013-11-21 09:28:03 +01003594 "400000000000000000000000000000000000000000000000", /* one and zeros */
3595 "7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", /* all ones */
3596 "555555555555555555555555555555555555555555555555", /* 101010... */
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003597 };
Gilles Peskine24666792018-09-17 18:29:49 +02003598#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3599#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3600 const char *m_exponents[] =
3601 {
Gilles Peskine6d9c8d72020-07-22 01:26:25 +02003602 /* Valid private values for Curve25519. In a build with Curve448
3603 * but not Curve25519, they will be adjusted in
3604 * self_test_adjust_exponent(). */
Gilles Peskine24666792018-09-17 18:29:49 +02003605 "4000000000000000000000000000000000000000000000000000000000000000",
3606 "5C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C30",
3607 "5715ECCE24583F7A7023C24164390586842E816D7280A49EF6DF4EAE6B280BF8",
3608 "41A2B017516F6D254E1F002BCCBADD54BE30F8CEC737A0E912B4963B6BA74460",
3609 "5555555555555555555555555555555555555555555555555555555555555550",
3610 "7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF8",
3611 };
3612#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003613
Gilles Peskine449bd832023-01-11 14:50:10 +01003614 mbedtls_ecp_group_init(&grp);
3615 mbedtls_ecp_point_init(&R);
3616 mbedtls_ecp_point_init(&P);
3617 mbedtls_mpi_init(&m);
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003618
Gilles Peskine24666792018-09-17 18:29:49 +02003619#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Manuel Pégourié-Gonnardb8012fc2013-10-10 15:40:49 +02003620 /* Use secp192r1 if available, or any available curve */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003622 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_SECP192R1));
Paul Bakker5dc6b5f2013-06-29 23:26:34 +02003623#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003624 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, mbedtls_ecp_curve_list()->grp_id));
Manuel Pégourié-Gonnardb8012fc2013-10-10 15:40:49 +02003625#endif
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003626
Gilles Peskine449bd832023-01-11 14:50:10 +01003627 if (verbose != 0) {
3628 mbedtls_printf(" ECP SW test #1 (constant op_count, base point G): ");
3629 }
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +02003630 /* Do a dummy multiplication first to trigger precomputation */
Gilles Peskine449bd832023-01-11 14:50:10 +01003631 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&m, 2));
3632 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(&grp, &P, &m, &grp.G, self_test_rng, NULL));
3633 ret = self_test_point(verbose,
3634 &grp, &R, &m, &grp.G,
3635 sw_exponents,
3636 sizeof(sw_exponents) / sizeof(sw_exponents[0]));
3637 if (ret != 0) {
Gilles Peskinec95696f2018-09-17 15:59:01 +02003638 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003639 }
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003640
Gilles Peskine449bd832023-01-11 14:50:10 +01003641 if (verbose != 0) {
3642 mbedtls_printf(" ECP SW test #2 (constant op_count, other point): ");
3643 }
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +02003644 /* We computed P = 2G last time, use it */
Gilles Peskine449bd832023-01-11 14:50:10 +01003645 ret = self_test_point(verbose,
3646 &grp, &R, &m, &P,
3647 sw_exponents,
3648 sizeof(sw_exponents) / sizeof(sw_exponents[0]));
3649 if (ret != 0) {
Gilles Peskine24666792018-09-17 18:29:49 +02003650 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003651 }
Gilles Peskine24666792018-09-17 18:29:49 +02003652
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 mbedtls_ecp_group_free(&grp);
3654 mbedtls_ecp_point_free(&R);
Gilles Peskine24666792018-09-17 18:29:49 +02003655#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3656
3657#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003658 if (verbose != 0) {
3659 mbedtls_printf(" ECP Montgomery test (constant op_count): ");
3660 }
Gilles Peskine24666792018-09-17 18:29:49 +02003661#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003662 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_CURVE25519));
Gilles Peskine24666792018-09-17 18:29:49 +02003663#elif defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_CURVE448));
Gilles Peskine24666792018-09-17 18:29:49 +02003665#else
3666#error "MBEDTLS_ECP_MONTGOMERY_ENABLED is defined, but no curve is supported for self-test"
3667#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003668 ret = self_test_point(verbose,
3669 &grp, &R, &m, &grp.G,
3670 m_exponents,
3671 sizeof(m_exponents) / sizeof(m_exponents[0]));
3672 if (ret != 0) {
Gilles Peskine24666792018-09-17 18:29:49 +02003673 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003674 }
Gilles Peskine24666792018-09-17 18:29:49 +02003675#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +02003676
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003677cleanup:
3678
Gilles Peskine449bd832023-01-11 14:50:10 +01003679 if (ret < 0 && verbose != 0) {
3680 mbedtls_printf("Unexpected error, return code = %08X\n", (unsigned int) ret);
3681 }
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003682
Gilles Peskine449bd832023-01-11 14:50:10 +01003683 mbedtls_ecp_group_free(&grp);
3684 mbedtls_ecp_point_free(&R);
3685 mbedtls_ecp_point_free(&P);
3686 mbedtls_mpi_free(&m);
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003687
Gilles Peskine449bd832023-01-11 14:50:10 +01003688 if (verbose != 0) {
3689 mbedtls_printf("\n");
3690 }
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003691
Gilles Peskine449bd832023-01-11 14:50:10 +01003692 return ret;
Valerio Settifd122f42023-04-05 18:15:32 +02003693#else /* MBEDTLS_ECP_C */
3694 (void) verbose;
3695 return 0;
3696#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003697}
3698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003699#endif /* MBEDTLS_SELF_TEST */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003700
Janos Follathb0697532016-08-18 12:38:46 +01003701#endif /* !MBEDTLS_ECP_ALT */
3702
Valerio Settifd122f42023-04-05 18:15:32 +02003703#endif /* MBEDTLS_ECP_LIGHT */