blob: c8dd7f00802ba99592050d116c77c22fdbac1bb8 [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
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010018 */
19
20/*
21 * References:
22 *
Xiaokang Qian669c7c32023-04-10 07:36:04 +000023 * SEC1 https://www.secg.org/sec1-v2.pdf
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +010024 * GECC = Guide to Elliptic Curve Cryptography - Hankerson, Menezes, Vanstone
Manuel Pégourié-Gonnard62aad142012-11-10 00:27:12 +010025 * FIPS 186-3 http://csrc.nist.gov/publications/fips/fips186-3/fips_186-3.pdf
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +010026 * RFC 4492 for the related TLS structures and constants
Nicholas Wilson08f3ef12015-11-10 13:10:01 +000027 * RFC 7748 for the Curve448 and Curve25519 curve definitions
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +020028 *
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +020029 * [Curve25519] http://cr.yp.to/ecdh/curve25519-20060209.pdf
Manuel Pégourié-Gonnardfe0af402013-12-04 18:14:55 +010030 *
Manuel Pégourié-Gonnard998930a2015-04-03 13:48:06 +020031 * [2] CORON, Jean-S'ebastien. Resistance against differential power analysis
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +020032 * for elliptic curve cryptosystems. In : Cryptographic Hardware and
33 * Embedded Systems. Springer Berlin Heidelberg, 1999. p. 292-302.
34 * <http://link.springer.com/chapter/10.1007/3-540-48059-5_25>
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +010035 *
Manuel Pégourié-Gonnard998930a2015-04-03 13:48:06 +020036 * [3] HEDABOU, Mustapha, PINEL, Pierre, et B'EN'ETEAU, Lucien. A comb method to
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +010037 * render ECC resistant against Side Channel Attacks. IACR Cryptology
38 * ePrint Archive, 2004, vol. 2004, p. 342.
39 * <http://eprint.iacr.org/2004/342.pdf>
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010040 */
41
Gilles Peskinedb09ef62020-06-03 01:43:33 +020042#include "common.h"
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010043
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050044/**
45 * \brief Function level alternative implementation.
46 *
47 * The MBEDTLS_ECP_INTERNAL_ALT macro enables alternative implementations to
48 * replace certain functions in this module. The alternative implementations are
49 * typically hardware accelerators and need to activate the hardware before the
50 * computation starts and deactivate it after it finishes. The
51 * mbedtls_internal_ecp_init() and mbedtls_internal_ecp_free() functions serve
52 * this purpose.
53 *
54 * To preserve the correct functionality the following conditions must hold:
55 *
56 * - The alternative implementation must be activated by
57 * mbedtls_internal_ecp_init() before any of the replaceable functions is
58 * called.
59 * - mbedtls_internal_ecp_free() must \b only be called when the alternative
60 * implementation is activated.
61 * - mbedtls_internal_ecp_init() must \b not be called when the alternative
62 * implementation is activated.
63 * - Public functions must not return while the alternative implementation is
64 * activated.
65 * - Replaceable functions are guarded by \c MBEDTLS_ECP_XXX_ALT macros and
66 * before calling them an \code if( mbedtls_internal_ecp_grp_capable( grp ) )
67 * \endcode ensures that the alternative implementation supports the current
68 * group.
69 */
70#if defined(MBEDTLS_ECP_INTERNAL_ALT)
71#endif
72
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010074
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000075#include "mbedtls/ecp.h"
Janos Follath430d3372016-11-03 14:25:37 +000076#include "mbedtls/threading.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050077#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000078#include "mbedtls/error.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020079
Janos Follath8c70e812021-06-24 14:48:38 +010080#include "bn_mul.h"
Gilles Peskine80ba8502021-04-03 20:36:37 +020081#include "ecp_invasive.h"
82
Rich Evans00ab4702015-02-06 13:43:58 +000083#include <string.h>
84
Janos Follathb0697532016-08-18 12:38:46 +010085#if !defined(MBEDTLS_ECP_ALT)
86
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000087#include "mbedtls/platform.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020088
Gilles Peskine6a2fb612021-05-24 22:25:04 +020089#include "ecp_internal_alt.h"
Janos Follathb0697532016-08-18 12:38:46 +010090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020091#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +010092/*
Manuel Pégourié-Gonnard91814812013-11-21 20:23:55 +010093 * Counts of point addition and doubling, and field multiplications.
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +020094 * Used to test resistance of point multiplication to simple timing attacks.
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +010095 */
Manuel Pégourié-Gonnard43863ee2013-12-01 16:51:27 +010096static unsigned long add_count, dbl_count, mul_count;
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +010097#endif
98
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +020099#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100100/*
101 * Maximum number of "basic operations" to be done in a row.
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +0200102 *
103 * Default value 0 means that ECC operations will not yield.
104 * Note that regardless of the value of ecp_max_ops, always at
105 * least one step is performed before yielding.
106 *
107 * Setting ecp_max_ops=1 can be suitable for testing purposes
108 * as it will interrupt computation at all possible points.
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100109 */
110static unsigned ecp_max_ops = 0;
111
112/*
113 * Set ecp_max_ops
114 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100115void mbedtls_ecp_set_max_ops(unsigned max_ops)
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100116{
117 ecp_max_ops = max_ops;
118}
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +0100119
120/*
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200121 * Check if restart is enabled
122 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100123int mbedtls_ecp_restart_is_enabled(void)
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200124{
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 return ecp_max_ops != 0;
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200126}
127
128/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200129 * Restart sub-context for ecp_mul_comb()
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +0100130 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100131struct mbedtls_ecp_restart_mul {
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +0100132 mbedtls_ecp_point R; /* current intermediate result */
Manuel Pégourié-Gonnardc5d844b2017-03-15 13:06:28 +0100133 size_t i; /* current index in various loops, 0 outside */
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +0100134 mbedtls_ecp_point *T; /* table for precomputed points */
135 unsigned char T_size; /* number of points in table T */
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +0200136 enum { /* what were we doing last time we returned? */
137 ecp_rsm_init = 0, /* nothing so far, dummy initial state */
138 ecp_rsm_pre_dbl, /* precompute 2^n multiples */
Manuel Pégourié-Gonnard45fd0162017-03-22 08:24:42 +0100139 ecp_rsm_pre_norm_dbl, /* normalize precomputed 2^n multiples */
140 ecp_rsm_pre_add, /* precompute remaining points by adding */
141 ecp_rsm_pre_norm_add, /* normalize all precomputed points */
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +0200142 ecp_rsm_comb_core, /* ecp_mul_comb_core() */
Manuel Pégourié-Gonnard45fd0162017-03-22 08:24:42 +0100143 ecp_rsm_final_norm, /* do the final normalization */
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100144 } state;
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100145};
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +0100146
147/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200148 * Init restart_mul sub-context
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +0100149 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100150static void ecp_restart_rsm_init(mbedtls_ecp_restart_mul_ctx *ctx)
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100151{
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 mbedtls_ecp_point_init(&ctx->R);
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200153 ctx->i = 0;
154 ctx->T = NULL;
155 ctx->T_size = 0;
156 ctx->state = ecp_rsm_init;
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100157}
158
159/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200160 * Free the components of a restart_mul sub-context
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100161 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100162static void ecp_restart_rsm_free(mbedtls_ecp_restart_mul_ctx *ctx)
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100163{
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +0100164 unsigned char i;
165
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 if (ctx == NULL) {
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100167 return;
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +0100168 }
169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 mbedtls_ecp_point_free(&ctx->R);
171
172 if (ctx->T != NULL) {
173 for (i = 0; i < ctx->T_size; i++) {
174 mbedtls_ecp_point_free(ctx->T + i);
175 }
176 mbedtls_free(ctx->T);
177 }
178
179 ecp_restart_rsm_init(ctx);
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +0100180}
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100181
182/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200183 * Restart context for ecp_muladd()
184 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100185struct mbedtls_ecp_restart_muladd {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +0200186 mbedtls_ecp_point mP; /* mP value */
187 mbedtls_ecp_point R; /* R intermediate result */
188 enum { /* what should we do next? */
189 ecp_rsma_mul1 = 0, /* first multiplication */
190 ecp_rsma_mul2, /* second multiplication */
191 ecp_rsma_add, /* addition */
192 ecp_rsma_norm, /* normalization */
193 } state;
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200194};
195
196/*
197 * Init restart_muladd sub-context
198 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100199static void ecp_restart_ma_init(mbedtls_ecp_restart_muladd_ctx *ctx)
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200200{
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 mbedtls_ecp_point_init(&ctx->mP);
202 mbedtls_ecp_point_init(&ctx->R);
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200203 ctx->state = ecp_rsma_mul1;
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200204}
205
206/*
207 * Free the components of a restart_muladd sub-context
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static void ecp_restart_ma_free(mbedtls_ecp_restart_muladd_ctx *ctx)
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 if (ctx == NULL) {
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200212 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100213 }
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200214
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 mbedtls_ecp_point_free(&ctx->mP);
216 mbedtls_ecp_point_free(&ctx->R);
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +0200217
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 ecp_restart_ma_init(ctx);
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200219}
220
221/*
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200222 * Initialize a restart context
223 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100224void mbedtls_ecp_restart_init(mbedtls_ecp_restart_ctx *ctx)
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200225{
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200226 ctx->ops_done = 0;
227 ctx->depth = 0;
228 ctx->rsm = NULL;
229 ctx->ma = NULL;
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200230}
231
232/*
233 * Free the components of a restart context
234 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100235void mbedtls_ecp_restart_free(mbedtls_ecp_restart_ctx *ctx)
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200236{
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 if (ctx == NULL) {
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200238 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 }
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200240
Gilles Peskine449bd832023-01-11 14:50:10 +0100241 ecp_restart_rsm_free(ctx->rsm);
242 mbedtls_free(ctx->rsm);
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +0200243
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 ecp_restart_ma_free(ctx->ma);
245 mbedtls_free(ctx->ma);
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 mbedtls_ecp_restart_init(ctx);
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200248}
249
250/*
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100251 * Check if we can do the next step
252 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100253int mbedtls_ecp_check_budget(const mbedtls_ecp_group *grp,
254 mbedtls_ecp_restart_ctx *rs_ctx,
255 unsigned ops)
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100256{
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 if (rs_ctx != NULL && ecp_max_ops != 0) {
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100258 /* scale depending on curve size: the chosen reference is 256-bit,
259 * and multiplication is quadratic. Round to the closest integer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100260 if (grp->pbits >= 512) {
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100261 ops *= 4;
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 } else if (grp->pbits >= 384) {
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100263 ops *= 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 }
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100265
Hanno Beckerb10c6602018-10-26 13:50:13 +0100266 /* Avoid infinite loops: always allow first step.
267 * Because of that, however, it's not generally true
268 * that ops_done <= ecp_max_ops, so the check
269 * ops_done > ecp_max_ops below is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 if ((rs_ctx->ops_done != 0) &&
271 (rs_ctx->ops_done > ecp_max_ops ||
272 ops > ecp_max_ops - rs_ctx->ops_done)) {
273 return MBEDTLS_ERR_ECP_IN_PROGRESS;
Hanno Beckerb10c6602018-10-26 13:50:13 +0100274 }
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100275
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100276 /* update running count */
Manuel Pégourié-Gonnard646393b2017-04-20 10:03:45 +0200277 rs_ctx->ops_done += ops;
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100278 }
279
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 return 0;
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +0100281}
282
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +0200283/* Call this when entering a function that needs its own sub-context */
Gilles Peskine449bd832023-01-11 14:50:10 +0100284#define ECP_RS_ENTER(SUB) do { \
285 /* reset ops count for this call if top-level */ \
286 if (rs_ctx != NULL && rs_ctx->depth++ == 0) \
Manuel Pégourié-Gonnarda58e0112018-10-16 10:42:47 +0200287 rs_ctx->ops_done = 0; \
288 \
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 /* set up our own sub-context if needed */ \
290 if (mbedtls_ecp_restart_is_enabled() && \
291 rs_ctx != NULL && rs_ctx->SUB == NULL) \
292 { \
293 rs_ctx->SUB = mbedtls_calloc(1, sizeof(*rs_ctx->SUB)); \
294 if (rs_ctx->SUB == NULL) \
295 return MBEDTLS_ERR_ECP_ALLOC_FAILED; \
296 \
297 ecp_restart_## SUB ##_init(rs_ctx->SUB); \
298 } \
299} while (0)
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +0200300
301/* Call this when leaving a function that needs its own sub-context */
Gilles Peskine449bd832023-01-11 14:50:10 +0100302#define ECP_RS_LEAVE(SUB) do { \
303 /* clear our sub-context when not in progress (done or error) */ \
304 if (rs_ctx != NULL && rs_ctx->SUB != NULL && \
305 ret != MBEDTLS_ERR_ECP_IN_PROGRESS) \
306 { \
307 ecp_restart_## SUB ##_free(rs_ctx->SUB); \
308 mbedtls_free(rs_ctx->SUB); \
309 rs_ctx->SUB = NULL; \
310 } \
Manuel Pégourié-Gonnarda58e0112018-10-16 10:42:47 +0200311 \
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 if (rs_ctx != NULL) \
Manuel Pégourié-Gonnarda58e0112018-10-16 10:42:47 +0200313 rs_ctx->depth--; \
Gilles Peskine449bd832023-01-11 14:50:10 +0100314} while (0)
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +0200315
316#else /* MBEDTLS_ECP_RESTARTABLE */
317
Gilles Peskine449bd832023-01-11 14:50:10 +0100318#define ECP_RS_ENTER(sub) (void) rs_ctx;
319#define ECP_RS_LEAVE(sub) (void) rs_ctx;
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +0200320
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200321#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100322
Gilles Peskine449bd832023-01-11 14:50:10 +0100323static void mpi_init_many(mbedtls_mpi *arr, size_t size)
Hanno Becker466df6e2022-01-10 11:16:51 +0000324{
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 while (size--) {
326 mbedtls_mpi_init(arr++);
327 }
Hanno Becker466df6e2022-01-10 11:16:51 +0000328}
329
Gilles Peskine449bd832023-01-11 14:50:10 +0100330static void mpi_free_many(mbedtls_mpi *arr, size_t size)
Hanno Becker466df6e2022-01-10 11:16:51 +0000331{
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 while (size--) {
333 mbedtls_mpi_free(arr++);
334 }
Hanno Becker466df6e2022-01-10 11:16:51 +0000335}
336
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +0100337/*
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200338 * List of supported curves:
339 * - internal ID
Christoph M. Wintersteigercb310732019-02-15 15:50:38 +0000340 * - 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 +0200341 * - size in bits
Manuel Pégourié-Gonnard8195c1a2013-10-07 19:40:41 +0200342 * - readable name
Gergely Budaie40c4692014-01-22 11:22:20 +0100343 *
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100344 * Curves are listed in order: largest curves first, and for a given size,
Gilles Peskineae270bf2021-06-02 00:05:29 +0200345 * fastest curves first.
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +0200346 *
Gilles Peskineae270bf2021-06-02 00:05:29 +0200347 * 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 +0200348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200349static const mbedtls_ecp_curve_info ecp_supported_curves[] =
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200350{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
352 { MBEDTLS_ECP_DP_SECP521R1, 25, 521, "secp521r1" },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200353#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
355 { MBEDTLS_ECP_DP_BP512R1, 28, 512, "brainpoolP512r1" },
Gergely Budaie40c4692014-01-22 11:22:20 +0100356#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
358 { MBEDTLS_ECP_DP_SECP384R1, 24, 384, "secp384r1" },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200359#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
361 { MBEDTLS_ECP_DP_BP384R1, 27, 384, "brainpoolP384r1" },
Gergely Budaie40c4692014-01-22 11:22:20 +0100362#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
364 { MBEDTLS_ECP_DP_SECP256R1, 23, 256, "secp256r1" },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200365#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200366#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED)
367 { MBEDTLS_ECP_DP_SECP256K1, 22, 256, "secp256k1" },
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100368#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200369#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
370 { MBEDTLS_ECP_DP_BP256R1, 26, 256, "brainpoolP256r1" },
Gergely Budaie40c4692014-01-22 11:22:20 +0100371#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED)
373 { MBEDTLS_ECP_DP_SECP224R1, 21, 224, "secp224r1" },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200374#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED)
376 { MBEDTLS_ECP_DP_SECP224K1, 20, 224, "secp224k1" },
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100377#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED)
379 { MBEDTLS_ECP_DP_SECP192R1, 19, 192, "secp192r1" },
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100380#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED)
382 { MBEDTLS_ECP_DP_SECP192K1, 18, 192, "secp192k1" },
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100383#endif
Gilles Peskine360e2c42020-07-24 02:03:20 +0200384#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Christoph M. Wintersteiger86e36c42018-12-06 17:27:31 +0000385 { MBEDTLS_ECP_DP_CURVE25519, 29, 256, "x25519" },
Christoph M. Wintersteigerc9f737b2018-10-25 13:03:05 +0100386#endif
Gilles Peskine360e2c42020-07-24 02:03:20 +0200387#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
388 { MBEDTLS_ECP_DP_CURVE448, 30, 448, "x448" },
389#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390 { MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200391};
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100392
Gilles Peskine449bd832023-01-11 14:50:10 +0100393#define ECP_NB_CURVES sizeof(ecp_supported_curves) / \
394 sizeof(ecp_supported_curves[0])
Manuel Pégourié-Gonnardba782bb2014-07-08 13:31:34 +0200395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396static mbedtls_ecp_group_id ecp_supported_grp_id[ECP_NB_CURVES];
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200397
398/*
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200399 * List of supported curves and associated info
400 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100401const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list(void)
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200402{
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 return ecp_supported_curves;
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200404}
405
406/*
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100407 * List of supported curves, group ID only
408 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100409const mbedtls_ecp_group_id *mbedtls_ecp_grp_id_list(void)
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100410{
411 static int init_done = 0;
412
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 if (!init_done) {
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100414 size_t i = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200415 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100416
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 for (curve_info = mbedtls_ecp_curve_list();
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 curve_info++) {
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100420 ecp_supported_grp_id[i++] = curve_info->grp_id;
421 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422 ecp_supported_grp_id[i] = MBEDTLS_ECP_DP_NONE;
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100423
424 init_done = 1;
425 }
426
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 return ecp_supported_grp_id;
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100428}
429
430/*
431 * Get the curve info for the internal identifier
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200432 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100433const 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 +0200434{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200435 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200436
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 for (curve_info = mbedtls_ecp_curve_list();
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200438 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 curve_info++) {
440 if (curve_info->grp_id == grp_id) {
441 return curve_info;
442 }
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200443 }
444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 return NULL;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200446}
447
448/*
449 * Get the curve info from the TLS identifier
450 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100451const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_tls_id(uint16_t tls_id)
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200452{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200454
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 for (curve_info = mbedtls_ecp_curve_list();
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200456 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 curve_info++) {
458 if (curve_info->tls_id == tls_id) {
459 return curve_info;
460 }
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200461 }
462
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 return NULL;
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200464}
465
466/*
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100467 * Get the curve info from the name
468 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100469const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_name(const char *name)
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100470{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471 const mbedtls_ecp_curve_info *curve_info;
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 if (name == NULL) {
474 return NULL;
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100475 }
476
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 for (curve_info = mbedtls_ecp_curve_list();
478 curve_info->grp_id != MBEDTLS_ECP_DP_NONE;
479 curve_info++) {
480 if (strcmp(curve_info->name, name) == 0) {
481 return curve_info;
482 }
483 }
484
485 return NULL;
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100486}
487
488/*
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +0100489 * Get the type of a curve
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +0100490 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100491mbedtls_ecp_curve_type mbedtls_ecp_get_type(const mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +0100492{
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 if (grp->G.X.p == NULL) {
494 return MBEDTLS_ECP_TYPE_NONE;
495 }
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +0100496
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (grp->G.Y.p == NULL) {
498 return MBEDTLS_ECP_TYPE_MONTGOMERY;
499 } else {
500 return MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS;
501 }
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +0100502}
503
504/*
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100505 * Initialize (the components of) a point
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100506 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507void mbedtls_ecp_point_init(mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100508{
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 mbedtls_mpi_init(&pt->X);
510 mbedtls_mpi_init(&pt->Y);
511 mbedtls_mpi_init(&pt->Z);
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100512}
513
514/*
515 * Initialize (the components of) a group
516 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100517void mbedtls_ecp_group_init(mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100518{
Manuel Pégourié-Gonnard95e2eca2018-06-20 10:29:47 +0200519 grp->id = MBEDTLS_ECP_DP_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 mbedtls_mpi_init(&grp->P);
521 mbedtls_mpi_init(&grp->A);
522 mbedtls_mpi_init(&grp->B);
523 mbedtls_ecp_point_init(&grp->G);
524 mbedtls_mpi_init(&grp->N);
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +0200525 grp->pbits = 0;
526 grp->nbits = 0;
527 grp->h = 0;
528 grp->modp = NULL;
529 grp->t_pre = NULL;
530 grp->t_post = NULL;
531 grp->t_data = NULL;
532 grp->T = NULL;
533 grp->T_size = 0;
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100534}
535
536/*
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200537 * Initialize (the components of) a key pair
538 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100539void mbedtls_ecp_keypair_init(mbedtls_ecp_keypair *key)
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200540{
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 mbedtls_ecp_group_init(&key->grp);
542 mbedtls_mpi_init(&key->d);
543 mbedtls_ecp_point_init(&key->Q);
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200544}
545
546/*
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100547 * Unallocate (the components of) a point
548 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100549void mbedtls_ecp_point_free(mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100550{
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 if (pt == NULL) {
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100552 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 }
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100554
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 mbedtls_mpi_free(&(pt->X));
556 mbedtls_mpi_free(&(pt->Y));
557 mbedtls_mpi_free(&(pt->Z));
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100558}
559
560/*
kXuanba9cb762021-04-08 14:32:06 +0800561 * Check that the comb table (grp->T) is static initialized.
562 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100563static int ecp_group_is_static_comb_table(const mbedtls_ecp_group *grp)
564{
kXuanba9cb762021-04-08 14:32:06 +0800565#if MBEDTLS_ECP_FIXED_POINT_OPTIM == 1
566 return grp->T != NULL && grp->T_size == 0;
567#else
568 (void) grp;
569 return 0;
570#endif
571}
572
573/*
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100574 * Unallocate (the components of) a group
575 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100576void mbedtls_ecp_group_free(mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100577{
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +0200578 size_t i;
579
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 if (grp == NULL) {
Manuel Pégourié-Gonnard1e8c8ec2012-10-31 19:24:21 +0100581 return;
Manuel Pégourié-Gonnard1f82b042013-12-06 12:51:50 +0100582 }
Manuel Pégourié-Gonnardc9727702013-09-16 18:56:28 +0200583
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 if (grp->h != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 mbedtls_mpi_free(&grp->A);
586 mbedtls_mpi_free(&grp->B);
587 mbedtls_ecp_point_free(&grp->G);
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 */
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +0200949 tls_id = *(*buf)++;
950 tls_id <<= 8;
951 tls_id |= *(*buf)++;
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 if ((curve_info = mbedtls_ecp_curve_info_from_tls_id(tls_id)) == NULL) {
954 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
955 }
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +0200956
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500957 *grp = curve_info->grp_id;
958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 return 0;
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100960}
961
962/*
963 * Write the ECParameters record corresponding to a group (RFC 4492)
964 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100965int mbedtls_ecp_tls_write_group(const mbedtls_ecp_group *grp, size_t *olen,
966 unsigned char *buf, size_t blen)
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100967{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968 const mbedtls_ecp_curve_info *curve_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 if ((curve_info = mbedtls_ecp_curve_info_from_grp_id(grp->id)) == NULL) {
970 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
971 }
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +0200972
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100973 /*
974 * We are going to write 3 bytes (see below)
975 */
976 *olen = 3;
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 if (blen < *olen) {
978 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
979 }
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100980
981 /*
982 * First byte is curve_type, always named_curve
983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984 *buf++ = MBEDTLS_ECP_TLS_NAMED_CURVE;
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100985
986 /*
987 * Next two bytes are the namedcurve value
988 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 MBEDTLS_PUT_UINT16_BE(curve_info->tls_id, buf, 0);
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100990
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 return 0;
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100992}
Manuel Pégourié-Gonnardab38b702012-11-05 17:34:55 +0100993
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200994/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 * Wrapper around fast quasi-modp functions, with fall-back to mbedtls_mpi_mod_mpi.
996 * See the documentation of struct mbedtls_ecp_group.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200997 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 * 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 +0200999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001000static int ecp_modp(mbedtls_mpi *N, const mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +02001001{
Janos Follath24eed8d2019-11-22 13:21:35 +00001002 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001003
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 if (grp->modp == NULL) {
1005 return mbedtls_mpi_mod_mpi(N, N, &grp->P);
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +02001006 }
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 /* N->s < 0 is a much faster test, which fails only if N is 0 */
1009 if ((N->s < 0 && mbedtls_mpi_cmp_int(N, 0) != 0) ||
1010 mbedtls_mpi_bitlen(N) > 2 * grp->pbits) {
1011 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1012 }
1013
1014 MBEDTLS_MPI_CHK(grp->modp(N));
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +02001015
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +02001016 /* N->s < 0 is a much faster test, which fails only if N is 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 while (N->s < 0 && mbedtls_mpi_cmp_int(N, 0) != 0) {
1018 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(N, N, &grp->P));
1019 }
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 while (mbedtls_mpi_cmp_mpi(N, &grp->P) >= 0) {
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +02001022 /* we known P, N and the result are positive */
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_abs(N, N, &grp->P));
1024 }
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001025
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +02001026cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 return ret;
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +02001028}
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +02001029
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +01001030/*
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +01001031 * Fast mod-p functions expect their argument to be in the 0..p^2 range.
Manuel Pégourié-Gonnarddada4da2012-11-10 14:23:17 +01001032 *
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +01001033 * In order to guarantee that, we need to ensure that operands of
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * 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 +01001035 * bring the result back to this range.
1036 *
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +01001037 * The following macros are shortcuts for doing that.
Manuel Pégourié-Gonnarddada4da2012-11-10 14:23:17 +01001038 */
1039
1040/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 * 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 +01001042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnard91814812013-11-21 20:23:55 +01001044#define INC_MUL_COUNT mul_count++;
1045#else
1046#define INC_MUL_COUNT
1047#endif
1048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049#define MOD_MUL(N) \
Hanno Becker1eeca412018-10-15 12:01:35 +01001050 do \
1051 { \
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 MBEDTLS_MPI_CHK(ecp_modp(&(N), grp)); \
Hanno Becker1eeca412018-10-15 12:01:35 +01001053 INC_MUL_COUNT \
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 } while (0)
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001055
Gilles Peskine449bd832023-01-11 14:50:10 +01001056static inline int mbedtls_mpi_mul_mod(const mbedtls_ecp_group *grp,
1057 mbedtls_mpi *X,
1058 const mbedtls_mpi *A,
1059 const mbedtls_mpi *B)
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001060{
Janos Follath24eed8d2019-11-22 13:21:35 +00001061 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mpi(X, A, B));
1063 MOD_MUL(*X);
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001064cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 return ret;
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001066}
1067
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001068/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * Reduce a mbedtls_mpi mod p in-place, to use after mbedtls_mpi_sub_mpi
Manuel Pégourié-Gonnardc9e387c2013-10-17 17:15:35 +02001070 * N->s < 0 is a very fast test, which fails only if N is 0
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001072#define MOD_SUB(N) \
Hanno Beckerce29ae82022-01-04 04:55:11 +00001073 do { \
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 while ((N)->s < 0 && mbedtls_mpi_cmp_int((N), 0) != 0) \
1075 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi((N), (N), &grp->P)); \
1076 } while (0)
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001077
Gilles Peskine449bd832023-01-11 14:50:10 +01001078#if (defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED) && \
1079 !(defined(MBEDTLS_ECP_NO_FALLBACK) && \
1080 defined(MBEDTLS_ECP_DOUBLE_JAC_ALT) && \
1081 defined(MBEDTLS_ECP_ADD_MIXED_ALT))) || \
1082 (defined(MBEDTLS_ECP_MONTGOMERY_ENABLED) && \
1083 !(defined(MBEDTLS_ECP_NO_FALLBACK) && \
1084 defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)))
1085static inline int mbedtls_mpi_sub_mod(const mbedtls_ecp_group *grp,
1086 mbedtls_mpi *X,
1087 const mbedtls_mpi *A,
1088 const mbedtls_mpi *B)
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001089{
Janos Follath24eed8d2019-11-22 13:21:35 +00001090 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(X, A, B));
1092 MOD_SUB(X);
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001093cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return ret;
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001095}
Steven Cooremane5388962021-03-01 14:04:53 +01001096#endif /* All functions referencing mbedtls_mpi_sub_mod() are alt-implemented without fallback */
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001097
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001098/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 * 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 +02001100 * We known P, N and the result are positive, so sub_abs is correct, and
1101 * a bit faster.
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001103#define MOD_ADD(N) \
1104 while (mbedtls_mpi_cmp_mpi((N), &grp->P) >= 0) \
1105 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_abs((N), (N), &grp->P))
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107static inline int mbedtls_mpi_add_mod(const mbedtls_ecp_group *grp,
1108 mbedtls_mpi *X,
1109 const mbedtls_mpi *A,
1110 const mbedtls_mpi *B)
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001111{
Janos Follath24eed8d2019-11-22 13:21:35 +00001112 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(X, A, B));
1114 MOD_ADD(X);
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001115cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 return ret;
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001117}
1118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119static inline int mbedtls_mpi_mul_int_mod(const mbedtls_ecp_group *grp,
1120 mbedtls_mpi *X,
1121 const mbedtls_mpi *A,
1122 mbedtls_mpi_uint c)
Hanno Becker02b35bd2022-01-01 06:54:25 +00001123{
1124 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_int(X, A, c));
1127 MOD_ADD(X);
Hanno Becker02b35bd2022-01-01 06:54:25 +00001128cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 return ret;
Hanno Becker02b35bd2022-01-01 06:54:25 +00001130}
1131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132static inline int mbedtls_mpi_sub_int_mod(const mbedtls_ecp_group *grp,
1133 mbedtls_mpi *X,
1134 const mbedtls_mpi *A,
1135 mbedtls_mpi_uint c)
Hanno Beckerce29ae82022-01-04 04:55:11 +00001136{
1137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(X, A, c));
1140 MOD_SUB(X);
Hanno Beckerce29ae82022-01-04 04:55:11 +00001141cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 return ret;
Hanno Beckerce29ae82022-01-04 04:55:11 +00001143}
1144
Gilles Peskine449bd832023-01-11 14:50:10 +01001145#define MPI_ECP_SUB_INT(X, A, c) \
1146 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int_mod(grp, X, A, c))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001147
Steven Cooremane5388962021-03-01 14:04:53 +01001148#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 !(defined(MBEDTLS_ECP_NO_FALLBACK) && \
1150 defined(MBEDTLS_ECP_DOUBLE_JAC_ALT) && \
1151 defined(MBEDTLS_ECP_ADD_MIXED_ALT))
1152static inline int mbedtls_mpi_shift_l_mod(const mbedtls_ecp_group *grp,
1153 mbedtls_mpi *X,
1154 size_t count)
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001155{
Janos Follath24eed8d2019-11-22 13:21:35 +00001156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_l(X, count));
1158 MOD_ADD(X);
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001159cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 return ret;
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001161}
Gilles Peskine449bd832023-01-11 14:50:10 +01001162#endif \
1163 /* All functions referencing mbedtls_mpi_shift_l_mod() are alt-implemented without fallback */
Gilles Peskine3b3b34f2019-07-18 21:08:27 +02001164
Hanno Becker595616e2022-01-05 08:28:24 +00001165/*
1166 * Macro wrappers around ECP modular arithmetic
1167 *
1168 * Currently, these wrappers are defined via the bignum module.
1169 */
1170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171#define MPI_ECP_ADD(X, A, B) \
1172 MBEDTLS_MPI_CHK(mbedtls_mpi_add_mod(grp, X, A, B))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001173
Gilles Peskine449bd832023-01-11 14:50:10 +01001174#define MPI_ECP_SUB(X, A, B) \
1175 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mod(grp, X, A, B))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001176
Gilles Peskine449bd832023-01-11 14:50:10 +01001177#define MPI_ECP_MUL(X, A, B) \
1178 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mod(grp, X, A, B))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001179
Gilles Peskine449bd832023-01-11 14:50:10 +01001180#define MPI_ECP_SQR(X, A) \
1181 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_mod(grp, X, A, A))
Hanno Becker885ed402022-01-04 06:43:50 +00001182
Gilles Peskine449bd832023-01-11 14:50:10 +01001183#define MPI_ECP_MUL_INT(X, A, c) \
1184 MBEDTLS_MPI_CHK(mbedtls_mpi_mul_int_mod(grp, X, A, c))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001185
Gilles Peskine449bd832023-01-11 14:50:10 +01001186#define MPI_ECP_INV(dst, src) \
1187 MBEDTLS_MPI_CHK(mbedtls_mpi_inv_mod((dst), (src), &grp->P))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001188
Gilles Peskine449bd832023-01-11 14:50:10 +01001189#define MPI_ECP_MOV(X, A) \
1190 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(X, A))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192#define MPI_ECP_SHIFT_L(X, count) \
1193 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_l_mod(grp, X, count))
Hanno Beckerce29ae82022-01-04 04:55:11 +00001194
Gilles Peskine449bd832023-01-11 14:50:10 +01001195#define MPI_ECP_LSET(X, c) \
1196 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(X, c))
Hanno Becker595616e2022-01-05 08:28:24 +00001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198#define MPI_ECP_CMP_INT(X, c) \
1199 mbedtls_mpi_cmp_int(X, c)
Hanno Becker595616e2022-01-05 08:28:24 +00001200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201#define MPI_ECP_CMP(X, Y) \
1202 mbedtls_mpi_cmp_mpi(X, Y)
Hanno Becker595616e2022-01-05 08:28:24 +00001203
1204/* Needs f_rng, p_rng to be defined. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001205#define MPI_ECP_RAND(X) \
1206 MBEDTLS_MPI_CHK(mbedtls_mpi_random((X), 2, &grp->P, f_rng, p_rng))
Hanno Becker595616e2022-01-05 08:28:24 +00001207
1208/* Conditional negation
1209 * Needs grp and a temporary MPI tmp to be defined. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001210#define MPI_ECP_COND_NEG(X, cond) \
Hanno Becker595616e2022-01-05 08:28:24 +00001211 do \
1212 { \
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 unsigned char nonzero = mbedtls_mpi_cmp_int((X), 0) != 0; \
1214 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&tmp, &grp->P, (X))); \
1215 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign((X), &tmp, \
1216 nonzero & cond)); \
1217 } while (0)
Hanno Becker595616e2022-01-05 08:28:24 +00001218
Gilles Peskine449bd832023-01-11 14:50:10 +01001219#define MPI_ECP_NEG(X) MPI_ECP_COND_NEG((X), 1)
Hanno Beckerc27a0e02022-01-06 05:56:34 +00001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221#define MPI_ECP_VALID(X) \
1222 ((X)->p != NULL)
Hanno Beckerc27a0e02022-01-06 05:56:34 +00001223
Gilles Peskine449bd832023-01-11 14:50:10 +01001224#define MPI_ECP_COND_ASSIGN(X, Y, cond) \
1225 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign((X), (Y), (cond)))
Hanno Beckerc27a0e02022-01-06 05:56:34 +00001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227#define MPI_ECP_COND_SWAP(X, Y, cond) \
1228 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_swap((X), (Y), (cond)))
Hanno Beckerc27a0e02022-01-06 05:56:34 +00001229
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02001230#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Glenn Straussefde9d52022-12-20 04:20:12 -05001231
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001232/*
1233 * Computes the right-hand side of the Short Weierstrass equation
1234 * RHS = X^3 + A X + B
1235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001236static int ecp_sw_rhs(const mbedtls_ecp_group *grp,
1237 mbedtls_mpi *rhs,
1238 const mbedtls_mpi *X)
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001239{
1240 int ret;
1241
1242 /* Compute X^3 + A X + B as X (X^2 + A) + B */
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 MPI_ECP_SQR(rhs, X);
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001244
1245 /* Special case for A = -3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001246 if (grp->A.p == NULL) {
1247 MPI_ECP_SUB_INT(rhs, rhs, 3);
1248 } else {
1249 MPI_ECP_ADD(rhs, rhs, &grp->A);
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001250 }
1251
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 MPI_ECP_MUL(rhs, rhs, X);
1253 MPI_ECP_ADD(rhs, rhs, &grp->B);
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001254
1255cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 return ret;
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001257}
1258
1259/*
1260 * Derive Y from X and a parity bit
1261 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001262static int mbedtls_ecp_sw_derive_y(const mbedtls_ecp_group *grp,
1263 const mbedtls_mpi *X,
1264 mbedtls_mpi *Y,
1265 int parity_bit)
Glenn Strauss45241612022-12-19 19:37:07 -05001266{
1267 /* w = y^2 = x^3 + ax + b
1268 * y = sqrt(w) = w^((p+1)/4) mod p (for prime p where p = 3 mod 4)
1269 *
1270 * Note: this method for extracting square root does not validate that w
1271 * was indeed a square so this function will return garbage in Y if X
1272 * does not correspond to a point on the curve.
1273 */
1274
1275 /* Check prerequisite p = 3 mod 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 if (mbedtls_mpi_get_bit(&grp->P, 0) != 1 ||
1277 mbedtls_mpi_get_bit(&grp->P, 1) != 1) {
1278 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
1279 }
Glenn Strauss45241612022-12-19 19:37:07 -05001280
1281 int ret;
1282 mbedtls_mpi exp;
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 mbedtls_mpi_init(&exp);
Glenn Strauss45241612022-12-19 19:37:07 -05001284
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01001285 /* use Y to store intermediate result, actually w above */
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 MBEDTLS_MPI_CHK(ecp_sw_rhs(grp, Y, X));
Glenn Strauss45241612022-12-19 19:37:07 -05001287
1288 /* w = y^2 */ /* Y contains y^2 intermediate result */
1289 /* exp = ((p+1)/4) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&exp, &grp->P, 1));
1291 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_r(&exp, 2));
Glenn Strauss45241612022-12-19 19:37:07 -05001292 /* sqrt(w) = w^((p+1)/4) mod p (for prime p where p = 3 mod 4) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 MBEDTLS_MPI_CHK(mbedtls_mpi_exp_mod(Y, Y /*y^2*/, &exp, &grp->P, NULL));
Glenn Strauss45241612022-12-19 19:37:07 -05001294
1295 /* check parity bit match or else invert Y */
1296 /* This quick inversion implementation is valid because Y != 0 for all
1297 * Short Weierstrass curves supported by mbedtls, as each supported curve
1298 * has an order that is a large prime, so each supported curve does not
1299 * have any point of order 2, and a point with Y == 0 would be of order 2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001300 if (mbedtls_mpi_get_bit(Y, 0) != parity_bit) {
1301 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(Y, &grp->P, Y));
1302 }
Glenn Strauss45241612022-12-19 19:37:07 -05001303
1304cleanup:
1305
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 mbedtls_mpi_free(&exp);
1307 return ret;
Glenn Strauss45241612022-12-19 19:37:07 -05001308}
Glenn Strauss45241612022-12-19 19:37:07 -05001309
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01001310/*
1311 * For curves in short Weierstrass form, we do all the internal operations in
1312 * Jacobian coordinates.
1313 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001314 * For multiplication, we'll use a comb method with countermeasures against
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01001315 * SPA, hence timing attacks.
1316 */
1317
Manuel Pégourié-Gonnard84d1aea2012-11-09 02:09:38 +01001318/*
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +01001319 * Normalize jacobian coordinates so that Z == 0 || Z == 1 (GECC 3.2.1)
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01001320 * Cost: 1N := 1I + 3M + 1S
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001322static int ecp_normalize_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001323{
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (MPI_ECP_CMP_INT(&pt->Z, 0) == 0) {
1325 return 0;
1326 }
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001327
Janos Follathb0697532016-08-18 12:38:46 +01001328#if defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 if (mbedtls_internal_ecp_grp_capable(grp)) {
1330 return mbedtls_internal_ecp_normalize_jac(grp, pt);
1331 }
Janos Follath372697b2016-10-28 16:53:11 +01001332#endif /* MBEDTLS_ECP_NORMALIZE_JAC_ALT */
Manuel Pégourié-Gonnardebac5d32017-08-23 16:23:36 +02001333
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001334#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001336#else
1337 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker76f897d2022-01-02 12:47:34 +00001338 mbedtls_mpi T;
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 mbedtls_mpi_init(&T);
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 MPI_ECP_INV(&T, &pt->Z); /* T <- 1 / Z */
1342 MPI_ECP_MUL(&pt->Y, &pt->Y, &T); /* Y' <- Y*T = Y / Z */
1343 MPI_ECP_SQR(&T, &T); /* T <- T^2 = 1 / Z^2 */
1344 MPI_ECP_MUL(&pt->X, &pt->X, &T); /* X <- X * T = X / Z^2 */
1345 MPI_ECP_MUL(&pt->Y, &pt->Y, &T); /* Y'' <- Y' * T = Y / Z^3 */
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001346
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 MPI_ECP_LSET(&pt->Z, 1);
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001348
1349cleanup:
1350
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 mbedtls_mpi_free(&T);
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001352
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001354#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_JAC_ALT) */
Manuel Pégourié-Gonnardd070f512012-11-08 17:40:51 +01001355}
1356
1357/*
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001358 * Normalize jacobian coordinates of an array of (pointers to) points,
Manuel Pégourié-Gonnard3680c822012-11-21 18:49:45 +01001359 * using Montgomery's trick to perform only one inversion mod P.
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001360 * (See for example Cohen's "A Course in Computational Algebraic Number
1361 * Theory", Algorithm 10.3.4.)
1362 *
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001363 * Warning: fails (returning an error) if one of the points is zero!
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +01001364 * This should never happen, see choice of w in ecp_mul_comb().
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01001365 *
1366 * Cost: 1N(t) := 1I + (6t - 3)M + 1S
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001368static int ecp_normalize_jac_many(const mbedtls_ecp_group *grp,
1369 mbedtls_ecp_point *T[], size_t T_size)
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001370{
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 if (T_size < 2) {
1372 return ecp_normalize_jac(grp, *T);
1373 }
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001374
Janos Follathb0697532016-08-18 12:38:46 +01001375#if defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 if (mbedtls_internal_ecp_grp_capable(grp)) {
1377 return mbedtls_internal_ecp_normalize_jac_many(grp, T, T_size);
1378 }
Janos Follathb0697532016-08-18 12:38:46 +01001379#endif
1380
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001381#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001383#else
1384 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1385 size_t i;
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001386 mbedtls_mpi *c, t;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 if ((c = mbedtls_calloc(T_size, sizeof(mbedtls_mpi))) == NULL) {
1389 return MBEDTLS_ERR_ECP_ALLOC_FAILED;
1390 }
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001391
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 mbedtls_mpi_init(&t);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 mpi_init_many(c, T_size);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001395 /*
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001396 * c[i] = Z_0 * ... * Z_i, i = 0,..,n := T_size-1
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 MPI_ECP_MOV(&c[0], &T[0]->Z);
1399 for (i = 1; i < T_size; i++) {
1400 MPI_ECP_MUL(&c[i], &c[i-1], &T[i]->Z);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001401 }
1402
1403 /*
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001404 * c[n] = 1 / (Z_0 * ... * Z_n) mod P
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001405 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 MPI_ECP_INV(&c[T_size-1], &c[T_size-1]);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 for (i = T_size - 1;; i--) {
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001409 /* At the start of iteration i (note that i decrements), we have
1410 * - c[j] = Z_0 * .... * Z_j for j < i,
1411 * - c[j] = 1 / (Z_0 * .... * Z_j) for j == i,
1412 *
1413 * This is maintained via
1414 * - c[i-1] <- c[i] * Z_i
1415 *
1416 * We also derive 1/Z_i = c[i] * c[i-1] for i>0 and use that
1417 * to do the actual normalization. For i==0, we already have
1418 * c[0] = 1 / Z_0.
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001419 */
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 if (i > 0) {
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001422 /* Compute 1/Z_i and establish invariant for the next iteration. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 MPI_ECP_MUL(&t, &c[i], &c[i-1]);
1424 MPI_ECP_MUL(&c[i-1], &c[i], &T[i]->Z);
1425 } else {
1426 MPI_ECP_MOV(&t, &c[0]);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001427 }
1428
Hanno Beckerb8442cd2022-01-04 06:32:11 +00001429 /* Now t holds 1 / Z_i; normalize as in ecp_normalize_jac() */
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 MPI_ECP_MUL(&T[i]->Y, &T[i]->Y, &t);
1431 MPI_ECP_SQR(&t, &t);
1432 MPI_ECP_MUL(&T[i]->X, &T[i]->X, &t);
1433 MPI_ECP_MUL(&T[i]->Y, &T[i]->Y, &t);
Manuel Pégourié-Gonnard1f789b82013-12-30 17:31:56 +01001434
1435 /*
1436 * Post-precessing: reclaim some memory by shrinking coordinates
1437 * - not storing Z (always 1)
1438 * - shrinking other coordinates, but still keeping the same number of
1439 * limbs as P, as otherwise it will too likely be regrown too fast.
1440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 MBEDTLS_MPI_CHK(mbedtls_mpi_shrink(&T[i]->X, grp->P.n));
1442 MBEDTLS_MPI_CHK(mbedtls_mpi_shrink(&T[i]->Y, grp->P.n));
Hanno Beckeree95f6c2022-01-09 05:46:18 +00001443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 MPI_ECP_LSET(&T[i]->Z, 1);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001445
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 if (i == 0) {
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001447 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 }
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001449 }
1450
1451cleanup:
1452
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 mbedtls_mpi_free(&t);
1454 mpi_free_many(c, T_size);
1455 mbedtls_free(c);
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001458#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT) */
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001459}
1460
Manuel Pégourié-Gonnardcdd44322012-11-21 16:00:55 +01001461/*
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001462 * Conditional point inversion: Q -> -Q = (Q.X, -Q.Y, Q.Z) without leak.
1463 * "inv" must be 0 (don't invert) or 1 (invert) or the result will be invalid
1464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465static int ecp_safe_invert_jac(const mbedtls_ecp_group *grp,
1466 mbedtls_ecp_point *Q,
1467 unsigned char inv)
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001468{
Janos Follath24eed8d2019-11-22 13:21:35 +00001469 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker595616e2022-01-05 08:28:24 +00001470 mbedtls_mpi tmp;
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 mbedtls_mpi_init(&tmp);
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 MPI_ECP_COND_NEG(&Q->Y, inv);
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001474
1475cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 mbedtls_mpi_free(&tmp);
1477 return ret;
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01001478}
1479
1480/*
Manuel Pégourié-Gonnard0cd6f982013-10-10 15:55:39 +02001481 * Point doubling R = 2 P, Jacobian coordinates
Manuel Pégourié-Gonnard0ace4b32013-10-10 12:44:27 +02001482 *
Peter Dettmance661b22015-02-07 14:43:51 +07001483 * 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 +01001484 *
Peter Dettmance661b22015-02-07 14:43:51 +07001485 * We follow the variable naming fairly closely. The formula variations that trade a MUL for a SQR
1486 * (plus a few ADDs) aren't useful as our bignum implementation doesn't distinguish squaring.
1487 *
1488 * Standard optimizations are applied when curve parameter A is one of { 0, -3 }.
1489 *
1490 * Cost: 1D := 3M + 4S (A == 0)
1491 * 4M + 4S (A == -3)
1492 * 3M + 6S + 1a otherwise
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001494static int ecp_double_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
1495 const mbedtls_ecp_point *P,
1496 mbedtls_mpi tmp[4])
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001497{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnard0cd6f982013-10-10 15:55:39 +02001499 dbl_count++;
1500#endif
1501
Janos Follathb0697532016-08-18 12:38:46 +01001502#if defined(MBEDTLS_ECP_DOUBLE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 if (mbedtls_internal_ecp_grp_capable(grp)) {
1504 return mbedtls_internal_ecp_double_jac(grp, R, P);
1505 }
Janos Follath372697b2016-10-28 16:53:11 +01001506#endif /* MBEDTLS_ECP_DOUBLE_JAC_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01001507
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001508#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_DOUBLE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001510#else
1511 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard73cc01d2013-12-06 12:41:30 +01001512
1513 /* Special case for A = -3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 if (grp->A.p == NULL) {
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001515 /* tmp[0] <- M = 3(X + Z^2)(X - Z^2) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 MPI_ECP_SQR(&tmp[1], &P->Z);
1517 MPI_ECP_ADD(&tmp[2], &P->X, &tmp[1]);
1518 MPI_ECP_SUB(&tmp[3], &P->X, &tmp[1]);
1519 MPI_ECP_MUL(&tmp[1], &tmp[2], &tmp[3]);
1520 MPI_ECP_MUL_INT(&tmp[0], &tmp[1], 3);
1521 } else {
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001522 /* tmp[0] <- M = 3.X^2 + A.Z^4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 MPI_ECP_SQR(&tmp[1], &P->X);
1524 MPI_ECP_MUL_INT(&tmp[0], &tmp[1], 3);
Peter Dettmance661b22015-02-07 14:43:51 +07001525
1526 /* Optimize away for "koblitz" curves with A = 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 if (MPI_ECP_CMP_INT(&grp->A, 0) != 0) {
Peter Dettmance661b22015-02-07 14:43:51 +07001528 /* M += A.Z^4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 MPI_ECP_SQR(&tmp[1], &P->Z);
1530 MPI_ECP_SQR(&tmp[2], &tmp[1]);
1531 MPI_ECP_MUL(&tmp[1], &tmp[2], &grp->A);
1532 MPI_ECP_ADD(&tmp[0], &tmp[0], &tmp[1]);
Peter Dettmance661b22015-02-07 14:43:51 +07001533 }
Peter Vaskovica676acf2014-08-06 00:48:39 +02001534 }
Manuel Pégourié-Gonnard73cc01d2013-12-06 12:41:30 +01001535
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001536 /* tmp[1] <- S = 4.X.Y^2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 MPI_ECP_SQR(&tmp[2], &P->Y);
1538 MPI_ECP_SHIFT_L(&tmp[2], 1);
1539 MPI_ECP_MUL(&tmp[1], &P->X, &tmp[2]);
1540 MPI_ECP_SHIFT_L(&tmp[1], 1);
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001541
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001542 /* tmp[3] <- U = 8.Y^4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 MPI_ECP_SQR(&tmp[3], &tmp[2]);
1544 MPI_ECP_SHIFT_L(&tmp[3], 1);
Peter Dettmance661b22015-02-07 14:43:51 +07001545
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001546 /* tmp[2] <- T = M^2 - 2.S */
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 MPI_ECP_SQR(&tmp[2], &tmp[0]);
1548 MPI_ECP_SUB(&tmp[2], &tmp[2], &tmp[1]);
1549 MPI_ECP_SUB(&tmp[2], &tmp[2], &tmp[1]);
Peter Dettmance661b22015-02-07 14:43:51 +07001550
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001551 /* tmp[1] <- S = M(S - T) - U */
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 MPI_ECP_SUB(&tmp[1], &tmp[1], &tmp[2]);
1553 MPI_ECP_MUL(&tmp[1], &tmp[1], &tmp[0]);
1554 MPI_ECP_SUB(&tmp[1], &tmp[1], &tmp[3]);
Peter Dettmance661b22015-02-07 14:43:51 +07001555
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001556 /* tmp[3] <- U = 2.Y.Z */
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 MPI_ECP_MUL(&tmp[3], &P->Y, &P->Z);
1558 MPI_ECP_SHIFT_L(&tmp[3], 1);
Peter Dettmance661b22015-02-07 14:43:51 +07001559
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001560 /* Store results */
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 MPI_ECP_MOV(&R->X, &tmp[2]);
1562 MPI_ECP_MOV(&R->Y, &tmp[1]);
1563 MPI_ECP_MOV(&R->Z, &tmp[3]);
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001564
1565cleanup:
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001566
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001568#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_DOUBLE_JAC_ALT) */
Manuel Pégourié-Gonnard1c4aa242013-10-09 16:09:46 +02001569}
1570
1571/*
Manuel Pégourié-Gonnard469a2092013-11-21 18:20:43 +01001572 * Addition: R = P + Q, mixed affine-Jacobian coordinates (GECC 3.22)
Manuel Pégourié-Gonnard9674fd02012-11-19 21:23:27 +01001573 *
1574 * The coordinates of Q must be normalized (= affine),
1575 * but those of P don't need to. R is not normalized.
1576 *
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001577 * P,Q,R may alias, but only at the level of EC points: they must be either
1578 * equal as pointers, or disjoint (including the coordinate data buffers).
1579 * Fine-grained aliasing at the level of coordinates is not supported.
1580 *
Manuel Pégourié-Gonnardaade42f2013-11-21 19:19:54 +01001581 * Special cases: (1) P or Q is zero, (2) R is zero, (3) P == Q.
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +01001582 * None of these cases can happen as intermediate step in ecp_mul_comb():
Manuel Pégourié-Gonnardaade42f2013-11-21 19:19:54 +01001583 * - at each step, P, Q and R are multiples of the base point, the factor
1584 * being less than its order, so none of them is zero;
1585 * - Q is an odd multiple of the base point, P an even multiple,
1586 * due to the choice of precomputed points in the modified comb method.
1587 * So branches for these cases do not leak secret information.
1588 *
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01001589 * Cost: 1A := 8M + 3S
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591static int ecp_add_mixed(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
1592 const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q,
1593 mbedtls_mpi tmp[4])
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001594{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01001596 add_count++;
1597#endif
1598
Janos Follathb0697532016-08-18 12:38:46 +01001599#if defined(MBEDTLS_ECP_ADD_MIXED_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 if (mbedtls_internal_ecp_grp_capable(grp)) {
1601 return mbedtls_internal_ecp_add_mixed(grp, R, P, Q);
1602 }
Janos Follath372697b2016-10-28 16:53:11 +01001603#endif /* MBEDTLS_ECP_ADD_MIXED_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01001604
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001605#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_ADD_MIXED_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001607#else
1608 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker838b7152022-01-04 05:01:53 +00001609
1610 /* NOTE: Aliasing between input and output is allowed, so one has to make
1611 * sure that at the point X,Y,Z are written, {P,Q}->{X,Y,Z} are no
1612 * longer read from. */
Hanno Becker5c8ea302022-01-01 06:01:45 +00001613 mbedtls_mpi * const X = &R->X;
1614 mbedtls_mpi * const Y = &R->Y;
1615 mbedtls_mpi * const Z = &R->Z;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001616
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 if (!MPI_ECP_VALID(&Q->Z)) {
1618 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1619 }
Hanno Beckeree95f6c2022-01-09 05:46:18 +00001620
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001621 /*
Manuel Pégourié-Gonnardaade42f2013-11-21 19:19:54 +01001622 * Trivial cases: P == 0 or Q == 0 (case 1)
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001623 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 if (MPI_ECP_CMP_INT(&P->Z, 0) == 0) {
1625 return mbedtls_ecp_copy(R, Q);
1626 }
Manuel Pégourié-Gonnard469a2092013-11-21 18:20:43 +01001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 if (MPI_ECP_CMP_INT(&Q->Z, 0) == 0) {
1629 return mbedtls_ecp_copy(R, P);
1630 }
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +01001631
1632 /*
1633 * Make sure Q coordinates are normalized
1634 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 if (MPI_ECP_CMP_INT(&Q->Z, 1) != 0) {
1636 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
1637 }
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001638
Gilles Peskine449bd832023-01-11 14:50:10 +01001639 MPI_ECP_SQR(&tmp[0], &P->Z);
1640 MPI_ECP_MUL(&tmp[1], &tmp[0], &P->Z);
1641 MPI_ECP_MUL(&tmp[0], &tmp[0], &Q->X);
1642 MPI_ECP_MUL(&tmp[1], &tmp[1], &Q->Y);
1643 MPI_ECP_SUB(&tmp[0], &tmp[0], &P->X);
1644 MPI_ECP_SUB(&tmp[1], &tmp[1], &P->Y);
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001645
Manuel Pégourié-Gonnardaade42f2013-11-21 19:19:54 +01001646 /* Special cases (2) and (3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 if (MPI_ECP_CMP_INT(&tmp[0], 0) == 0) {
1648 if (MPI_ECP_CMP_INT(&tmp[1], 0) == 0) {
1649 ret = ecp_double_jac(grp, R, P, tmp);
Manuel Pégourié-Gonnard7e0adfb2012-11-08 23:21:46 +01001650 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 } else {
1652 ret = mbedtls_ecp_set_zero(R);
Manuel Pégourié-Gonnard7e0adfb2012-11-08 23:21:46 +01001653 goto cleanup;
1654 }
1655 }
1656
Hanno Becker838b7152022-01-04 05:01:53 +00001657 /* {P,Q}->Z no longer used, so OK to write to Z even if there's aliasing. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 MPI_ECP_MUL(Z, &P->Z, &tmp[0]);
1659 MPI_ECP_SQR(&tmp[2], &tmp[0]);
1660 MPI_ECP_MUL(&tmp[3], &tmp[2], &tmp[0]);
1661 MPI_ECP_MUL(&tmp[2], &tmp[2], &P->X);
Hanno Beckerce29ae82022-01-04 04:55:11 +00001662
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 MPI_ECP_MOV(&tmp[0], &tmp[2]);
1664 MPI_ECP_SHIFT_L(&tmp[0], 1);
Hanno Beckerce29ae82022-01-04 04:55:11 +00001665
Hanno Becker838b7152022-01-04 05:01:53 +00001666 /* {P,Q}->X no longer used, so OK to write to X even if there's aliasing. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 MPI_ECP_SQR(X, &tmp[1]);
1668 MPI_ECP_SUB(X, X, &tmp[0]);
1669 MPI_ECP_SUB(X, X, &tmp[3]);
1670 MPI_ECP_SUB(&tmp[2], &tmp[2], X);
1671 MPI_ECP_MUL(&tmp[2], &tmp[2], &tmp[1]);
1672 MPI_ECP_MUL(&tmp[3], &tmp[3], &P->Y);
Hanno Becker838b7152022-01-04 05:01:53 +00001673 /* {P,Q}->Y no longer used, so OK to write to Y even if there's aliasing. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 MPI_ECP_SUB(Y, &tmp[2], &tmp[3]);
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001675
1676cleanup:
1677
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001679#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_ADD_MIXED_ALT) */
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +01001680}
1681
1682/*
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001683 * Randomize jacobian coordinates:
1684 * (X, Y, Z) -> (l^2 X, l^3 Y, l Z) for random l
Manuel Pégourié-Gonnard3c0b4ea2013-12-02 19:44:41 +01001685 * This is sort of the reverse operation of ecp_normalize_jac().
Manuel Pégourié-Gonnard44aab792013-11-21 10:53:59 +01001686 *
1687 * This countermeasure was first suggested in [2].
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001688 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001689static int ecp_randomize_jac(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt,
1690 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001691{
Janos Follathb0697532016-08-18 12:38:46 +01001692#if defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 if (mbedtls_internal_ecp_grp_capable(grp)) {
1694 return mbedtls_internal_ecp_randomize_jac(grp, pt, f_rng, p_rng);
1695 }
Janos Follath372697b2016-10-28 16:53:11 +01001696#endif /* MBEDTLS_ECP_RANDOMIZE_JAC_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01001697
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001698#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001700#else
1701 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0d629792022-01-04 06:45:49 +00001702 mbedtls_mpi l;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 mbedtls_mpi_init(&l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001705
1706 /* Generate l such that 1 < l < p */
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 MPI_ECP_RAND(&l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001708
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001709 /* Z' = l * Z */
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 MPI_ECP_MUL(&pt->Z, &pt->Z, &l);
Hanno Becker0d629792022-01-04 06:45:49 +00001711
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001712 /* Y' = l * Y */
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 MPI_ECP_MUL(&pt->Y, &pt->Y, &l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001714
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001715 /* X' = l^2 * X */
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 MPI_ECP_SQR(&l, &l);
1717 MPI_ECP_MUL(&pt->X, &pt->X, &l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001718
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001719 /* Y'' = l^2 * Y' = l^3 * Y */
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 MPI_ECP_MUL(&pt->Y, &pt->Y, &l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001721
1722cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 mbedtls_mpi_free(&l);
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001724
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 if (ret == MBEDTLS_ERR_MPI_NOT_ACCEPTABLE) {
Gilles Peskine59215172021-03-29 22:28:50 +02001726 ret = MBEDTLS_ERR_ECP_RANDOM_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 }
1728 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01001729#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_RANDOMIZE_JAC_ALT) */
Manuel Pégourié-Gonnard07de4b12013-09-02 16:26:04 +02001730}
1731
1732/*
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001733 * Check and define parameters used by the comb method (see below for details)
1734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735#if MBEDTLS_ECP_WINDOW_SIZE < 2 || MBEDTLS_ECP_WINDOW_SIZE > 7
1736#error "MBEDTLS_ECP_WINDOW_SIZE out of bounds"
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001737#endif
1738
1739/* d = ceil( n / w ) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001740#define COMB_MAX_D (MBEDTLS_ECP_MAX_BITS + 1) / 2
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001741
1742/* number of precomputed points */
Gilles Peskine449bd832023-01-11 14:50:10 +01001743#define COMB_MAX_PRE (1 << (MBEDTLS_ECP_WINDOW_SIZE - 1))
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001744
1745/*
1746 * Compute the representation of m that will be used with our comb method.
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001747 *
1748 * The basic comb method is described in GECC 3.44 for example. We use a
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001749 * modified version that provides resistance to SPA by avoiding zero
1750 * digits in the representation as in [3]. We modify the method further by
1751 * requiring that all K_i be odd, which has the small cost that our
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001752 * representation uses one more K_i, due to carries, but saves on the size of
1753 * the precomputed table.
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001754 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001755 * Summary of the comb method and its modifications:
1756 *
1757 * - The goal is to compute m*P for some w*d-bit integer m.
1758 *
1759 * - The basic comb method splits m into the w-bit integers
1760 * x[0] .. x[d-1] where x[i] consists of the bits in m whose
1761 * index has residue i modulo d, and computes m * P as
1762 * S[x[0]] + 2 * S[x[1]] + .. + 2^(d-1) S[x[d-1]], where
1763 * S[i_{w-1} .. i_0] := i_{w-1} 2^{(w-1)d} P + ... + i_1 2^d P + i_0 P.
1764 *
1765 * - If it happens that, say, x[i+1]=0 (=> S[x[i+1]]=0), one can replace the sum by
1766 * .. + 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]] ..,
1767 * thereby successively converting it into a form where all summands
1768 * are nonzero, at the cost of negative summands. This is the basic idea of [3].
1769 *
1770 * - More generally, even if x[i+1] != 0, we can first transform the sum as
1771 * .. - 2^i S[x[i]] + 2^{i+1} ( S[x[i]] + S[x[i+1]] ) + 2^{i+2} S[x[i+2]] ..,
1772 * and then replace S[x[i]] + S[x[i+1]] = S[x[i] ^ x[i+1]] + 2 S[x[i] & x[i+1]].
1773 * Performing and iterating this procedure for those x[i] that are even
1774 * (keeping track of carry), we can transform the original sum into one of the form
1775 * S[x'[0]] +- 2 S[x'[1]] +- .. +- 2^{d-1} S[x'[d-1]] + 2^d S[x'[d]]
1776 * with all x'[i] odd. It is therefore only necessary to know S at odd indices,
1777 * which is why we are only computing half of it in the first place in
1778 * ecp_precompute_comb and accessing it with index abs(i) / 2 in ecp_select_comb.
1779 *
1780 * - For the sake of compactness, only the seven low-order bits of x[i]
1781 * are used to represent its absolute value (K_i in the paper), and the msb
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001782 * 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 +02001783 * if s_i == -1;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001784 *
1785 * Calling conventions:
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001786 * - x is an array of size d + 1
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +01001787 * - w is the size, ie number of teeth, of the comb, and must be between
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 * 2 and 7 (in practice, between 2 and MBEDTLS_ECP_WINDOW_SIZE)
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001789 * - m is the MPI, expected to be odd and such that bitlength(m) <= w * d
1790 * (the result will be incorrect if these assumptions are not satisfied)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001791 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001792static void ecp_comb_recode_core(unsigned char x[], size_t d,
1793 unsigned char w, const mbedtls_mpi *m)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001794{
1795 size_t i, j;
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001796 unsigned char c, cc, adjust;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 memset(x, 0, d+1);
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001799
Manuel Pégourié-Gonnardedc1a1f2013-11-21 09:50:00 +01001800 /* First get the classical comb values (except for x_d = 0) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 for (i = 0; i < d; i++) {
1802 for (j = 0; j < w; j++) {
1803 x[i] |= mbedtls_mpi_get_bit(m, i + d * j) << j;
1804 }
1805 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001806
Manuel Pégourié-Gonnardedc1a1f2013-11-21 09:50:00 +01001807 /* Now make sure x_1 .. x_d are odd */
1808 c = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 for (i = 1; i <= d; i++) {
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001810 /* Add carry and update it */
1811 cc = x[i] & c;
1812 x[i] = x[i] ^ c;
1813 c = cc;
1814
Manuel Pégourié-Gonnardedc1a1f2013-11-21 09:50:00 +01001815 /* Adjust if needed, avoiding branches */
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 adjust = 1 - (x[i] & 0x01);
1817 c |= x[i] & (x[i-1] * adjust);
1818 x[i] = x[i] ^ (x[i-1] * adjust);
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001819 x[i-1] |= adjust << 7;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001820 }
1821}
1822
1823/*
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001824 * Precompute points for the adapted comb method
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001825 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001826 * Assumption: T must be able to hold 2^{w - 1} elements.
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001827 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001828 * Operation: If i = i_{w-1} ... i_1 is the binary representation of i,
1829 * 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 +01001830 *
1831 * 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 +02001832 *
1833 * Note: Even comb values (those where P would be omitted from the
1834 * sum defining T[i] above) are not needed in our adaption
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001835 * the comb method. See ecp_comb_recode_core().
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001836 *
1837 * This function currently works in four steps:
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001838 * (1) [dbl] Computation of intermediate T[i] for 2-power values of i
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001839 * (2) [norm_dbl] Normalization of coordinates of these T[i]
1840 * (3) [add] Computation of all T[i]
1841 * (4) [norm_add] Normalization of all T[i]
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02001842 *
1843 * Step 1 can be interrupted but not the others; together with the final
1844 * coordinate normalization they are the largest steps done at once, depending
1845 * on the window size. Here are operation counts for P-256:
1846 *
1847 * step (2) (3) (4)
1848 * w = 5 142 165 208
1849 * w = 4 136 77 160
1850 * w = 3 130 33 136
1851 * w = 2 124 11 124
1852 *
1853 * So if ECC operations are blocking for too long even with a low max_ops
1854 * value, it's useful to set MBEDTLS_ECP_WINDOW_SIZE to a lower value in order
1855 * to minimize maximum blocking time.
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001857static int ecp_precompute_comb(const mbedtls_ecp_group *grp,
1858 mbedtls_ecp_point T[], const mbedtls_ecp_point *P,
1859 unsigned char w, size_t d,
1860 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001861{
Janos Follath24eed8d2019-11-22 13:21:35 +00001862 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001863 unsigned char i;
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01001864 size_t j = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 const unsigned char T_size = 1U << (w - 1);
1866 mbedtls_ecp_point *cur, *TT[COMB_MAX_PRE - 1] = { NULL };
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001867
Hanno Beckera7f8edd2022-01-04 07:29:46 +00001868 mbedtls_mpi tmp[4];
1869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Beckera7f8edd2022-01-04 07:29:46 +00001871
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001872#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
1874 if (rs_ctx->rsm->state == ecp_rsm_pre_dbl) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001875 goto dbl;
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 }
1877 if (rs_ctx->rsm->state == ecp_rsm_pre_norm_dbl) {
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001878 goto norm_dbl;
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 }
1880 if (rs_ctx->rsm->state == ecp_rsm_pre_add) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001881 goto add;
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 }
1883 if (rs_ctx->rsm->state == ecp_rsm_pre_norm_add) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001884 goto norm_add;
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 }
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01001886 }
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001887#else
1888 (void) rs_ctx;
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01001889#endif
1890
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001891#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001893 rs_ctx->rsm->state = ecp_rsm_pre_dbl;
1894
1895 /* initial state for the loop */
1896 rs_ctx->rsm->i = 0;
1897 }
1898
1899dbl:
1900#endif
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001901 /*
1902 * Set T[0] = P and
1903 * T[2^{l-1}] = 2^{dl} P for l = 1 .. w-1 (this is not the final value)
1904 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(&T[0], P));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001906
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001907#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->i != 0) {
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02001909 j = rs_ctx->rsm->i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 } else
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01001911#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 j = 0;
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 for (; j < d * (w - 1); j++) {
1915 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_DBL);
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01001916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 i = 1U << (j / d);
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001918 cur = T + i;
Manuel Pégourié-Gonnardae557072017-03-20 12:21:24 +01001919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 if (j % d == 0) {
1921 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(cur, T + (i >> 1)));
1922 }
Manuel Pégourié-Gonnardae557072017-03-20 12:21:24 +01001923
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 MBEDTLS_MPI_CHK(ecp_double_jac(grp, cur, cur, tmp));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001925 }
1926
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001927#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001929 rs_ctx->rsm->state = ecp_rsm_pre_norm_dbl;
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 }
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001931
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001932norm_dbl:
1933#endif
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001934 /*
Hanno Beckerac4d4bc2022-01-09 05:58:49 +00001935 * Normalize current elements in T to allow them to be used in
1936 * ecp_add_mixed() below, which requires one normalized input.
1937 *
1938 * As T has holes, use an auxiliary array of pointers to elements in T.
1939 *
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001940 */
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001941 j = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 for (i = 1; i < T_size; i <<= 1) {
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001943 TT[j++] = T + i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 }
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV + 6 * j - 2);
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001947
Gilles Peskine449bd832023-01-11 14:50:10 +01001948 MBEDTLS_MPI_CHK(ecp_normalize_jac_many(grp, TT, j));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001949
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001950#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001952 rs_ctx->rsm->state = ecp_rsm_pre_add;
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 }
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001954
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001955add:
1956#endif
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001957 /*
1958 * Compute the remaining ones using the minimal number of additions
1959 * Be careful to update T[2^l] only after using it!
1960 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 MBEDTLS_ECP_BUDGET((T_size - 1) * MBEDTLS_ECP_OPS_ADD);
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001962
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 for (i = 1; i < T_size; i <<= 1) {
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01001964 j = i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 while (j--) {
1966 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, &T[i + j], &T[j], &T[i], tmp));
1967 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001968 }
1969
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02001970#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001972 rs_ctx->rsm->state = ecp_rsm_pre_norm_add;
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 }
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02001974
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001975norm_add:
1976#endif
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001977 /*
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02001978 * Normalize final elements in T. Even though there are no holes now, we
1979 * still need the auxiliary array for homogeneity with the previous
1980 * call. Also, skip T[0] which is already normalised, being a copy of P.
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02001981 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 for (j = 0; j + 1 < T_size; j++) {
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001983 TT[j] = T + j + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Manuel Pégourié-Gonnardfc3e0be2017-03-20 09:29:31 +01001985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV + 6 * j - 2);
Manuel Pégourié-Gonnarde2d7cb32017-03-20 10:24:17 +01001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 MBEDTLS_MPI_CHK(ecp_normalize_jac_many(grp, TT, j));
Manuel Pégourié-Gonnarde2820122013-11-21 10:08:50 +01001989
Hanno Beckeree95f6c2022-01-09 05:46:18 +00001990 /* Free Z coordinate (=1 after normalization) to save RAM.
1991 * This makes T[i] invalid as mbedtls_ecp_points, but this is OK
1992 * since from this point onwards, they are only accessed indirectly
1993 * via the getter function ecp_select_comb() which does set the
1994 * target's Z coordinate to 1. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 for (i = 0; i < T_size; i++) {
1996 mbedtls_mpi_free(&T[i].Z);
1997 }
Hanno Beckeree95f6c2022-01-09 05:46:18 +00001998
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01001999cleanup:
Hanno Beckera7f8edd2022-01-04 07:29:46 +00002000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Beckera7f8edd2022-01-04 07:29:46 +00002002
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002003#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2005 ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
2006 if (rs_ctx->rsm->state == ecp_rsm_pre_dbl) {
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002007 rs_ctx->rsm->i = j;
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 }
Manuel Pégourié-Gonnard213541a2017-03-20 12:50:41 +01002009 }
2010#endif
Janos Follathb0697532016-08-18 12:38:46 +01002011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 return ret;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002013}
2014
2015/*
Manuel Pégourié-Gonnard101a39f2013-11-20 14:47:19 +01002016 * Select precomputed point: R = sign(i) * T[ abs(i) / 2 ]
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002017 *
2018 * See ecp_comb_recode_core() for background
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002020static int ecp_select_comb(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2021 const mbedtls_ecp_point T[], unsigned char T_size,
2022 unsigned char i)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002023{
Janos Follath24eed8d2019-11-22 13:21:35 +00002024 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002025 unsigned char ii, j;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002026
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002027 /* Ignore the "sign" bit and scale down */
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 ii = (i & 0x7Fu) >> 1;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002029
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002030 /* Read the whole table to thwart cache-based timing attacks */
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 for (j = 0; j < T_size; j++) {
2032 MPI_ECP_COND_ASSIGN(&R->X, &T[j].X, j == ii);
2033 MPI_ECP_COND_ASSIGN(&R->Y, &T[j].Y, j == ii);
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002034 }
2035
Manuel Pégourié-Gonnard01fca5e2013-11-21 17:47:12 +01002036 /* Safely invert result if i is "negative" */
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 MBEDTLS_MPI_CHK(ecp_safe_invert_jac(grp, R, i >> 7));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 MPI_ECP_LSET(&R->Z, 1);
Hanno Becker6a288702022-01-05 05:19:48 +00002040
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002041cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 return ret;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002043}
2044
2045/*
2046 * Core multiplication algorithm for the (modified) comb method.
2047 * This part is actually common with the basic comb method (GECC 3.44)
Manuel Pégourié-Gonnard04a02252013-11-20 22:57:38 +01002048 *
2049 * Cost: d A + d D + 1 R
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002051static int ecp_mul_comb_core(const mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2052 const mbedtls_ecp_point T[], unsigned char T_size,
2053 const unsigned char x[], size_t d,
2054 int (*f_rng)(void *, unsigned char *, size_t),
2055 void *p_rng,
2056 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002057{
Janos Follath24eed8d2019-11-22 13:21:35 +00002058 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002059 mbedtls_ecp_point Txi;
Hanno Beckera7f8edd2022-01-04 07:29:46 +00002060 mbedtls_mpi tmp[4];
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002061 size_t i;
2062
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 mbedtls_ecp_point_init(&Txi);
2064 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002065
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002066#if !defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002067 (void) rs_ctx;
2068#endif
2069
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002070#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2072 rs_ctx->rsm->state != ecp_rsm_comb_core) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002073 rs_ctx->rsm->i = 0;
2074 rs_ctx->rsm->state = ecp_rsm_comb_core;
2075 }
2076
2077 /* new 'if' instead of nested for the sake of the 'else' branch */
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->i != 0) {
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002079 /* restore current index (R already pointing to rs_ctx->rsm->R) */
2080 i = rs_ctx->rsm->i;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 } else
Manuel Pégourié-Gonnardc5d844b2017-03-15 13:06:28 +01002082#endif
2083 {
2084 /* Start with a non-zero point and randomize its coordinates */
2085 i = d;
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 MBEDTLS_MPI_CHK(ecp_select_comb(grp, R, T, T_size, x[i]));
2087 if (f_rng != 0) {
2088 MBEDTLS_MPI_CHK(ecp_randomize_jac(grp, R, f_rng, p_rng));
2089 }
Manuel Pégourié-Gonnardc5d844b2017-03-15 13:06:28 +01002090 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002091
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 while (i != 0) {
2093 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_DBL + MBEDTLS_ECP_OPS_ADD);
Manuel Pégourié-Gonnard90f31b72018-10-16 10:45:24 +02002094 --i;
2095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 MBEDTLS_MPI_CHK(ecp_double_jac(grp, R, R, tmp));
2097 MBEDTLS_MPI_CHK(ecp_select_comb(grp, &Txi, T, T_size, x[i]));
2098 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, R, R, &Txi, tmp));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002099 }
2100
2101cleanup:
Janos Follathb0697532016-08-18 12:38:46 +01002102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 mbedtls_ecp_point_free(&Txi);
2104 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Beckera7f8edd2022-01-04 07:29:46 +00002105
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002106#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (rs_ctx != NULL && rs_ctx->rsm != NULL &&
2108 ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
Manuel Pégourié-Gonnard90f31b72018-10-16 10:45:24 +02002109 rs_ctx->rsm->i = i;
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002110 /* no need to save R, already pointing to rs_ctx->rsm->R */
Manuel Pégourié-Gonnardc5d844b2017-03-15 13:06:28 +01002111 }
2112#endif
2113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 return ret;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002115}
2116
2117/*
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002118 * Recode the scalar to get constant-time comb multiplication
2119 *
2120 * As the actual scalar recoding needs an odd scalar as a starting point,
2121 * this wrapper ensures that by replacing m by N - m if necessary, and
2122 * informs the caller that the result of multiplication will be negated.
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002123 *
Manuel Pégourié-Gonnardfd87e352017-08-24 14:21:05 +02002124 * This works because we only support large prime order for Short Weierstrass
2125 * curves, so N is always odd hence either m or N - m is.
2126 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002127 * See ecp_comb_recode_core() for background.
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002129static int ecp_comb_recode_scalar(const mbedtls_ecp_group *grp,
2130 const mbedtls_mpi *m,
2131 unsigned char k[COMB_MAX_D + 1],
2132 size_t d,
2133 unsigned char w,
2134 unsigned char *parity_trick)
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002135{
Janos Follath24eed8d2019-11-22 13:21:35 +00002136 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002137 mbedtls_mpi M, mm;
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 mbedtls_mpi_init(&M);
2140 mbedtls_mpi_init(&mm);
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002141
Manuel Pégourié-Gonnardfd87e352017-08-24 14:21:05 +02002142 /* N is always odd (see above), just make extra sure */
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 if (mbedtls_mpi_get_bit(&grp->N, 0) != 1) {
2144 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2145 }
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002146
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002147 /* do we need the parity trick? */
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 *parity_trick = (mbedtls_mpi_get_bit(m, 0) == 0);
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002149
2150 /* execute parity fix in constant time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&M, m));
2152 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&mm, &grp->N, m));
2153 MBEDTLS_MPI_CHK(mbedtls_mpi_safe_cond_assign(&M, &mm, *parity_trick));
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002154
2155 /* actual scalar recoding */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 ecp_comb_recode_core(k, d, w, &M);
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002157
2158cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 mbedtls_mpi_free(&mm);
2160 mbedtls_mpi_free(&M);
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 return ret;
Manuel Pégourié-Gonnardec5606a2017-03-09 12:46:45 +01002163}
2164
2165/*
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002166 * Perform comb multiplication (for short Weierstrass curves)
2167 * once the auxiliary table has been pre-computed.
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002168 *
2169 * Scalar recoding may use a parity trick that makes us compute -m * P,
2170 * if that is the case we'll need to recover m * P at the end.
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002172static int ecp_mul_comb_after_precomp(const mbedtls_ecp_group *grp,
2173 mbedtls_ecp_point *R,
2174 const mbedtls_mpi *m,
2175 const mbedtls_ecp_point *T,
2176 unsigned char T_size,
2177 unsigned char w,
2178 size_t d,
2179 int (*f_rng)(void *, unsigned char *, size_t),
2180 void *p_rng,
2181 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002182{
Janos Follath24eed8d2019-11-22 13:21:35 +00002183 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62738e92017-03-14 10:00:21 +01002184 unsigned char parity_trick;
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002185 unsigned char k[COMB_MAX_D + 1];
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +01002186 mbedtls_ecp_point *RR = R;
2187
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002188#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002190 RR = &rs_ctx->rsm->R;
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 if (rs_ctx->rsm->state == ecp_rsm_final_norm) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002193 goto final_norm;
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 }
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002195 }
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +01002196#endif
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 MBEDTLS_MPI_CHK(ecp_comb_recode_scalar(grp, m, k, d, w,
2199 &parity_trick));
2200 MBEDTLS_MPI_CHK(ecp_mul_comb_core(grp, RR, T, T_size, k, d,
2201 f_rng, p_rng, rs_ctx));
2202 MBEDTLS_MPI_CHK(ecp_safe_invert_jac(grp, RR, parity_trick));
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002203
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002204#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002206 rs_ctx->rsm->state = ecp_rsm_final_norm;
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 }
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002208
Manuel Pégourié-Gonnard4ed1dab2017-08-24 11:02:04 +02002209final_norm:
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV);
Manuel Pégourié-Gonnard2fad7ae2017-03-14 13:13:13 +01002211#endif
Manuel Pégourié-Gonnarda4aa89b2020-03-25 12:41:29 +01002212 /*
2213 * Knowledge of the jacobian coordinates may leak the last few bits of the
2214 * scalar [1], and since our MPI implementation isn't constant-flow,
2215 * inversion (used for coordinate normalization) may leak the full value
2216 * of its input via side-channels [2].
2217 *
2218 * [1] https://eprint.iacr.org/2003/191
2219 * [2] https://eprint.iacr.org/2020/055
2220 *
2221 * Avoid the leak by randomizing coordinates before we normalize them.
2222 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (f_rng != 0) {
2224 MBEDTLS_MPI_CHK(ecp_randomize_jac(grp, RR, f_rng, p_rng));
2225 }
Manuel Pégourié-Gonnarda4aa89b2020-03-25 12:41:29 +01002226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 MBEDTLS_MPI_CHK(ecp_normalize_jac(grp, RR));
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +01002228
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002229#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 if (rs_ctx != NULL && rs_ctx->rsm != NULL) {
2231 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, RR));
2232 }
Manuel Pégourié-Gonnard8962ddb2017-03-14 12:11:21 +01002233#endif
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002234
2235cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 return ret;
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002237}
2238
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002239/*
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002240 * Pick window size based on curve size and whether we optimize for base point
2241 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002242static unsigned char ecp_pick_window_size(const mbedtls_ecp_group *grp,
2243 unsigned char p_eq_g)
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002244{
2245 unsigned char w;
2246
2247 /*
2248 * Minimize the number of multiplications, that is minimize
2249 * 10 * d * w + 18 * 2^(w-1) + 11 * d + 7 * w, with d = ceil( nbits / w )
2250 * (see costs of the various parts, with 1S = 1M)
2251 */
2252 w = grp->nbits >= 384 ? 5 : 4;
2253
2254 /*
2255 * If P == G, pre-compute a bit more, since this may be re-used later.
2256 * Just adding one avoids upping the cost of the first mul too much,
2257 * and the memory cost too.
2258 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 if (p_eq_g) {
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002260 w++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 }
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002262
2263 /*
kXuanba9cb762021-04-08 14:32:06 +08002264 * If static comb table may not be used (!p_eq_g) or static comb table does
2265 * not exists, make sure w is within bounds.
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002266 * (The last test is useful only for very small curves in the test suite.)
kXuanba9cb762021-04-08 14:32:06 +08002267 *
2268 * The user reduces MBEDTLS_ECP_WINDOW_SIZE does not changes the size of
2269 * static comb table, because the size of static comb table is fixed when
2270 * it is generated.
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002271 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002272#if (MBEDTLS_ECP_WINDOW_SIZE < 6)
2273 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 +01002274 w = MBEDTLS_ECP_WINDOW_SIZE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 }
k-stachowiak653a4a22019-07-03 14:31:09 +02002276#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if (w >= grp->nbits) {
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002278 w = 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 }
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002280
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 return w;
Manuel Pégourié-Gonnard4b2336d2017-03-09 13:23:50 +01002282}
2283
2284/*
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002285 * Multiplication using the comb method - for curves in short Weierstrass form
2286 *
2287 * This function is mainly responsible for administrative work:
2288 * - managing the restart context if enabled
Manuel Pégourié-Gonnard11556e22017-08-24 13:41:19 +02002289 * - managing the table of precomputed points (passed between the below two
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002290 * functions): allocation, computation, ownership transfer, freeing.
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002291 *
2292 * It delegates the actual arithmetic work to:
2293 * ecp_precompute_comb() and ecp_mul_comb_with_precomp()
2294 *
2295 * See comments on ecp_comb_recode_core() regarding the computation strategy.
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002297static int ecp_mul_comb(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2298 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2299 int (*f_rng)(void *, unsigned char *, size_t),
2300 void *p_rng,
2301 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002302{
Janos Follath24eed8d2019-11-22 13:21:35 +00002303 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard11556e22017-08-24 13:41:19 +02002304 unsigned char w, p_eq_g, i;
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +01002305 size_t d;
Manuel Pégourié-Gonnardf2a9fcf2020-06-03 12:11:56 +02002306 unsigned char T_size = 0, T_ok = 0;
2307 mbedtls_ecp_point *T = NULL;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002308
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 ECP_RS_ENTER(rsm);
Manuel Pégourié-Gonnard510d5ca2017-03-08 11:41:47 +01002310
Manuel Pégourié-Gonnard22be6352017-03-09 13:02:35 +01002311 /* Is P the base point ? */
2312#if MBEDTLS_ECP_FIXED_POINT_OPTIM == 1
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 p_eq_g = (MPI_ECP_CMP(&P->Y, &grp->G.Y) == 0 &&
2314 MPI_ECP_CMP(&P->X, &grp->G.X) == 0);
Manuel Pégourié-Gonnard196d1332017-08-28 13:14:27 +02002315#else
2316 p_eq_g = 0;
Manuel Pégourié-Gonnard22be6352017-03-09 13:02:35 +01002317#endif
2318
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002319 /* Pick window size and deduce related sizes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 w = ecp_pick_window_size(grp, p_eq_g);
2321 T_size = 1U << (w - 1);
2322 d = (grp->nbits + w - 1) / w;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002323
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002324 /* Pre-computed table: do we have it already for the base point? */
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 if (p_eq_g && grp->T != NULL) {
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002326 /* second pointer to the same table, will be deleted on exit */
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002327 T = grp->T;
2328 T_ok = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 } else
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002330#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002331 /* Pre-computed table: do we have one in progress? complete? */
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 if (rs_ctx != NULL && rs_ctx->rsm != NULL && rs_ctx->rsm->T != NULL) {
Manuel Pégourié-Gonnard45fd0162017-03-22 08:24:42 +01002333 /* transfer ownership of T from rsm to local function */
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002334 T = rs_ctx->rsm->T;
2335 rs_ctx->rsm->T = NULL;
2336 rs_ctx->rsm->T_size = 0;
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002337
Manuel Pégourié-Gonnardb25cb602018-10-16 11:48:09 +02002338 /* This effectively jumps to the call to mul_comb_after_precomp() */
Manuel Pégourié-Gonnard11556e22017-08-24 13:41:19 +02002339 T_ok = rs_ctx->rsm->state >= ecp_rsm_comb_core;
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 } else
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +01002341#endif
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002342 /* Allocate table if we didn't have any */
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002343 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 T = mbedtls_calloc(T_size, sizeof(mbedtls_ecp_point));
2345 if (T == NULL) {
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002346 ret = MBEDTLS_ERR_ECP_ALLOC_FAILED;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002347 goto cleanup;
2348 }
Manuel Pégourié-Gonnard5bd38b12017-08-23 16:55:59 +02002349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 for (i = 0; i < T_size; i++) {
2351 mbedtls_ecp_point_init(&T[i]);
2352 }
Manuel Pégourié-Gonnard11556e22017-08-24 13:41:19 +02002353
2354 T_ok = 0;
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002355 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002356
Manuel Pégourié-Gonnard085b1df2017-03-16 16:56:04 +01002357 /* Compute table (or finish computing it) if not done already */
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 if (!T_ok) {
2359 MBEDTLS_MPI_CHK(ecp_precompute_comb(grp, T, P, w, d, rs_ctx));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (p_eq_g) {
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +02002362 /* almost transfer ownership of T to the group, but keep a copy of
Manuel Pégourié-Gonnardee68cff2018-10-15 15:27:49 +02002363 * the pointer to use for calling the next function more easily */
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002364 grp->T = T;
Manuel Pégourié-Gonnard92cceb22017-08-23 16:27:29 +02002365 grp->T_size = T_size;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002366 }
2367 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002368
Manuel Pégourié-Gonnard391f4412017-03-13 12:26:21 +01002369 /* Actual comb multiplication using precomputed points */
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 MBEDTLS_MPI_CHK(ecp_mul_comb_after_precomp(grp, R, m,
2371 T, T_size, w, d,
2372 f_rng, p_rng, rs_ctx));
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002373
2374cleanup:
2375
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002376 /* does T belong to the group? */
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (T == grp->T) {
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002378 T = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 }
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002380
2381 /* does T belong to the restart context? */
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002382#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 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 +01002384 /* transfer ownership of T from local function to rsm */
Manuel Pégourié-Gonnard92cceb22017-08-23 16:27:29 +02002385 rs_ctx->rsm->T_size = T_size;
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +02002386 rs_ctx->rsm->T = T;
Manuel Pégourié-Gonnardc9c0aa62017-03-16 14:53:26 +01002387 T = NULL;
2388 }
2389#endif
2390
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002391 /* did T belong to us? then let's destroy it! */
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (T != NULL) {
2393 for (i = 0; i < T_size; i++) {
2394 mbedtls_ecp_point_free(&T[i]);
2395 }
2396 mbedtls_free(T);
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002397 }
2398
Manuel Pégourié-Gonnard07bf6f52017-03-16 17:21:38 +01002399 /* prevent caller from using invalid value */
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 int should_free_R = (ret != 0);
David Horstmannfc735df2022-10-06 19:11:04 +01002401#if defined(MBEDTLS_ECP_RESTARTABLE)
2402 /* don't free R while in progress in case R == P */
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
David Horstmann6e116872022-10-25 10:32:08 +01002404 should_free_R = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 }
David Horstmannfc735df2022-10-06 19:11:04 +01002406#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 if (should_free_R) {
2408 mbedtls_ecp_point_free(R);
2409 }
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002410
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 ECP_RS_LEAVE(rsm);
Manuel Pégourié-Gonnard77af79a2017-03-14 10:58:00 +01002412
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 return ret;
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002414}
2415
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002416#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01002417
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002418#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01002419/*
2420 * For Montgomery curves, we do all the internal arithmetic in projective
2421 * coordinates. Import/export of points uses only the x coordinates, which is
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002422 * internally represented as X / Z.
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01002423 *
2424 * For scalar multiplication, we'll use a Montgomery ladder.
2425 */
2426
Manuel Pégourié-Gonnardd1c1ba92013-11-16 15:50:12 +01002427/*
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002428 * Normalize Montgomery x/z coordinates: X = X/Z, Z = 1
2429 * Cost: 1M + 1I
2430 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002431static int ecp_normalize_mxz(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P)
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002432{
Janos Follathb0697532016-08-18 12:38:46 +01002433#if defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if (mbedtls_internal_ecp_grp_capable(grp)) {
2435 return mbedtls_internal_ecp_normalize_mxz(grp, P);
2436 }
Janos Follath372697b2016-10-28 16:53:11 +01002437#endif /* MBEDTLS_ECP_NORMALIZE_MXZ_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01002438
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002439#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002441#else
2442 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 MPI_ECP_INV(&P->Z, &P->Z);
2444 MPI_ECP_MUL(&P->X, &P->X, &P->Z);
2445 MPI_ECP_LSET(&P->Z, 1);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002446
2447cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002449#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_NORMALIZE_MXZ_ALT) */
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002450}
2451
2452/*
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002453 * Randomize projective x/z coordinates:
2454 * (X, Z) -> (l X, l Z) for random l
2455 * This is sort of the reverse operation of ecp_normalize_mxz().
2456 *
2457 * This countermeasure was first suggested in [2].
2458 * Cost: 2M
2459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002460static int ecp_randomize_mxz(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P,
2461 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002462{
Janos Follathb0697532016-08-18 12:38:46 +01002463#if defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (mbedtls_internal_ecp_grp_capable(grp)) {
2465 return mbedtls_internal_ecp_randomize_mxz(grp, P, f_rng, p_rng);
2466 }
Janos Follath372697b2016-10-28 16:53:11 +01002467#endif /* MBEDTLS_ECP_RANDOMIZE_MXZ_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01002468
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002469#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002471#else
2472 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2473 mbedtls_mpi l;
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 mbedtls_mpi_init(&l);
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002475
2476 /* Generate l such that 1 < l < p */
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 MPI_ECP_RAND(&l);
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 MPI_ECP_MUL(&P->X, &P->X, &l);
2480 MPI_ECP_MUL(&P->Z, &P->Z, &l);
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002481
2482cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 mbedtls_mpi_free(&l);
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 if (ret == MBEDTLS_ERR_MPI_NOT_ACCEPTABLE) {
Gilles Peskine59215172021-03-29 22:28:50 +02002486 ret = MBEDTLS_ERR_ECP_RANDOM_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 }
2488 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002489#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_RANDOMIZE_MXZ_ALT) */
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002490}
2491
2492/*
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002493 * Double-and-add: R = 2P, S = P + Q, with d = X(P - Q),
2494 * for Montgomery curves in x/z coordinates.
2495 *
2496 * http://www.hyperelliptic.org/EFD/g1p/auto-code/montgom/xz/ladder/mladd-1987-m.op3
2497 * with
2498 * d = X1
2499 * P = (X2, Z2)
2500 * Q = (X3, Z3)
2501 * R = (X4, Z4)
2502 * S = (X5, Z5)
2503 * and eliminating temporary variables tO, ..., t4.
2504 *
2505 * Cost: 5M + 4S
2506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002507static int ecp_double_add_mxz(const mbedtls_ecp_group *grp,
2508 mbedtls_ecp_point *R, mbedtls_ecp_point *S,
2509 const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q,
2510 const mbedtls_mpi *d,
2511 mbedtls_mpi T[4])
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002512{
Janos Follathb0697532016-08-18 12:38:46 +01002513#if defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 if (mbedtls_internal_ecp_grp_capable(grp)) {
2515 return mbedtls_internal_ecp_double_add_mxz(grp, R, S, P, Q, d);
2516 }
Janos Follath372697b2016-10-28 16:53:11 +01002517#endif /* MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT */
Janos Follathb0697532016-08-18 12:38:46 +01002518
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002519#if defined(MBEDTLS_ECP_NO_FALLBACK) && defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002521#else
2522 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 MPI_ECP_ADD(&T[0], &P->X, &P->Z); /* Pp := PX + PZ */
2525 MPI_ECP_SUB(&T[1], &P->X, &P->Z); /* Pm := PX - PZ */
2526 MPI_ECP_ADD(&T[2], &Q->X, &Q->Z); /* Qp := QX + XZ */
2527 MPI_ECP_SUB(&T[3], &Q->X, &Q->Z); /* Qm := QX - QZ */
2528 MPI_ECP_MUL(&T[3], &T[3], &T[0]); /* Qm * Pp */
2529 MPI_ECP_MUL(&T[2], &T[2], &T[1]); /* Qp * Pm */
2530 MPI_ECP_SQR(&T[0], &T[0]); /* Pp^2 */
2531 MPI_ECP_SQR(&T[1], &T[1]); /* Pm^2 */
2532 MPI_ECP_MUL(&R->X, &T[0], &T[1]); /* Pp^2 * Pm^2 */
2533 MPI_ECP_SUB(&T[0], &T[0], &T[1]); /* Pp^2 - Pm^2 */
2534 MPI_ECP_MUL(&R->Z, &grp->A, &T[0]); /* A * (Pp^2 - Pm^2) */
2535 MPI_ECP_ADD(&R->Z, &T[1], &R->Z); /* [ A * (Pp^2-Pm^2) ] + Pm^2 */
2536 MPI_ECP_ADD(&S->X, &T[3], &T[2]); /* Qm*Pp + Qp*Pm */
2537 MPI_ECP_SQR(&S->X, &S->X); /* (Qm*Pp + Qp*Pm)^2 */
2538 MPI_ECP_SUB(&S->Z, &T[3], &T[2]); /* Qm*Pp - Qp*Pm */
2539 MPI_ECP_SQR(&S->Z, &S->Z); /* (Qm*Pp - Qp*Pm)^2 */
2540 MPI_ECP_MUL(&S->Z, d, &S->Z); /* d * ( Qm*Pp - Qp*Pm )^2 */
2541 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 +01002542
2543cleanup:
Hanno Becker28ccb1c2022-01-04 07:15:04 +00002544
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 return ret;
Steven Cooreman7eb2aa02021-01-22 09:43:59 +01002546#endif /* !defined(MBEDTLS_ECP_NO_FALLBACK) || !defined(MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT) */
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002547}
2548
2549/*
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002550 * Multiplication with Montgomery ladder in x/z coordinates,
2551 * for curves in Montgomery form
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002553static int ecp_mul_mxz(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2554 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2555 int (*f_rng)(void *, unsigned char *, size_t),
2556 void *p_rng)
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002557{
Janos Follath24eed8d2019-11-22 13:21:35 +00002558 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002559 size_t i;
Manuel Pégourié-Gonnardb6f45a62013-12-04 21:54:36 +01002560 unsigned char b;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 mbedtls_ecp_point RP;
2562 mbedtls_mpi PX;
Hanno Becker30838862022-01-04 13:25:59 +00002563 mbedtls_mpi tmp[4];
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 mbedtls_ecp_point_init(&RP); mbedtls_mpi_init(&PX);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Becker30838862022-01-04 13:25:59 +00002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (f_rng == NULL) {
2569 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2570 }
Manuel Pégourié-Gonnard02b57052021-06-15 11:29:26 +02002571
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002572 /* Save PX and read from P before writing to R, in case P == R */
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 MPI_ECP_MOV(&PX, &P->X);
2574 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(&RP, P));
Manuel Pégourié-Gonnard357ff652013-12-04 18:39:17 +01002575
2576 /* Set R to zero in modified x/z coordinates */
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 MPI_ECP_LSET(&R->X, 1);
2578 MPI_ECP_LSET(&R->Z, 0);
2579 mbedtls_mpi_free(&R->Y);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002580
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002581 /* RP.X might be slightly larger than P, so reduce it */
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 MOD_ADD(&RP.X);
Manuel Pégourié-Gonnard93f41db2013-12-05 10:48:42 +01002583
Manuel Pégourié-Gonnard3afa07f2013-12-03 13:28:21 +01002584 /* Randomize coordinates of the starting point */
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 MBEDTLS_MPI_CHK(ecp_randomize_mxz(grp, &RP, f_rng, p_rng));
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002586
Manuel Pégourié-Gonnardb6f45a62013-12-04 21:54:36 +01002587 /* Loop invariant: R = result so far, RP = R + P */
Aurelien Jarnoc79ce882022-05-15 13:24:05 +02002588 i = grp->nbits + 1; /* one past the (zero-based) required msb for private keys */
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 while (i-- > 0) {
2590 b = mbedtls_mpi_get_bit(m, i);
Manuel Pégourié-Gonnardb6f45a62013-12-04 21:54:36 +01002591 /*
2592 * if (b) R = 2R + P else R = 2R,
2593 * which is:
2594 * if (b) double_add( RP, R, RP, R )
2595 * else double_add( R, RP, R, RP )
2596 * but using safe conditional swaps to avoid leaks
2597 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 MPI_ECP_COND_SWAP(&R->X, &RP.X, b);
2599 MPI_ECP_COND_SWAP(&R->Z, &RP.Z, b);
2600 MBEDTLS_MPI_CHK(ecp_double_add_mxz(grp, R, &RP, R, &RP, &PX, tmp));
2601 MPI_ECP_COND_SWAP(&R->X, &RP.X, b);
2602 MPI_ECP_COND_SWAP(&R->Z, &RP.Z, b);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002603 }
2604
Manuel Pégourié-Gonnarda4aa89b2020-03-25 12:41:29 +01002605 /*
2606 * Knowledge of the projective coordinates may leak the last few bits of the
2607 * scalar [1], and since our MPI implementation isn't constant-flow,
2608 * inversion (used for coordinate normalization) may leak the full value
2609 * of its input via side-channels [2].
2610 *
2611 * [1] https://eprint.iacr.org/2003/191
2612 * [2] https://eprint.iacr.org/2020/055
2613 *
2614 * Avoid the leak by randomizing coordinates before we normalize them.
2615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 MBEDTLS_MPI_CHK(ecp_randomize_mxz(grp, R, f_rng, p_rng));
2617 MBEDTLS_MPI_CHK(ecp_normalize_mxz(grp, R));
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002618
2619cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 mbedtls_ecp_point_free(&RP); mbedtls_mpi_free(&PX);
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002621
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
2623 return ret;
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002624}
2625
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002626#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnard7c94d8b2013-12-04 23:15:46 +01002627
Manuel Pégourié-Gonnardd9ea82e72013-12-03 12:02:28 +01002628/*
Manuel Pégourié-Gonnard884569c2017-04-20 10:10:59 +02002629 * Restartable multiplication R = m * P
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002630 *
2631 * This internal function can be called without an RNG in case where we know
2632 * the inputs are not sensitive.
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002633 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002634static int ecp_mul_restartable_internal(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2635 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2636 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
2637 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002638{
Janos Follathb0697532016-08-18 12:38:46 +01002639 int ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Janos Follathc44ab972016-11-18 16:38:23 +00002640#if defined(MBEDTLS_ECP_INTERNAL_ALT)
2641 char is_grp_capable = 0;
2642#endif
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02002643
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002644#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002645 /* reset ops count for this call if top-level */
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if (rs_ctx != NULL && rs_ctx->depth++ == 0) {
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002647 rs_ctx->ops_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 }
Gilles Peskine59970052019-02-28 13:12:06 +01002649#else
2650 (void) rs_ctx;
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002651#endif
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002652
Janos Follathc44ab972016-11-18 16:38:23 +00002653#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 if ((is_grp_capable = mbedtls_internal_ecp_grp_capable(grp))) {
2655 MBEDTLS_MPI_CHK(mbedtls_internal_ecp_init(grp));
2656 }
Janos Follathc44ab972016-11-18 16:38:23 +00002657#endif /* MBEDTLS_ECP_INTERNAL_ALT */
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002658
David Horstmannfc735df2022-10-06 19:11:04 +01002659 int restarting = 0;
Manuel Pégourié-Gonnard95aedfe2017-08-24 13:47:04 +02002660#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 restarting = (rs_ctx != NULL && rs_ctx->rsm != NULL);
Manuel Pégourié-Gonnarda08cd1a2017-04-20 11:29:43 +02002662#endif
David Horstmannfc735df2022-10-06 19:11:04 +01002663 /* skip argument check when restarting */
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (!restarting) {
Manuel Pégourié-Gonnard5314f232017-04-21 12:36:59 +02002665 /* check_privkey is free */
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_CHK);
Manuel Pégourié-Gonnard5314f232017-04-21 12:36:59 +02002667
Manuel Pégourié-Gonnarda08cd1a2017-04-20 11:29:43 +02002668 /* Common sanity checks */
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 MBEDTLS_MPI_CHK(mbedtls_ecp_check_privkey(grp, m));
2670 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
Manuel Pégourié-Gonnarda08cd1a2017-04-20 11:29:43 +02002671 }
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002672
2673 ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002674#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
2676 MBEDTLS_MPI_CHK(ecp_mul_mxz(grp, R, m, P, f_rng, p_rng));
2677 }
Janos Follath430d3372016-11-03 14:25:37 +00002678#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002679#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
2681 MBEDTLS_MPI_CHK(ecp_mul_comb(grp, R, m, P, f_rng, p_rng, rs_ctx));
2682 }
Janos Follath430d3372016-11-03 14:25:37 +00002683#endif
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002684
Janos Follath6c8ccd52016-11-29 15:37:09 +00002685cleanup:
Janos Follathb0697532016-08-18 12:38:46 +01002686
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002687#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 if (is_grp_capable) {
2689 mbedtls_internal_ecp_free(grp);
2690 }
Janos Follathc44ab972016-11-18 16:38:23 +00002691#endif /* MBEDTLS_ECP_INTERNAL_ALT */
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002692
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002693#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 if (rs_ctx != NULL) {
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002695 rs_ctx->depth--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 }
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +02002697#endif
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 return ret;
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002700}
2701
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002702/*
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002703 * Restartable multiplication R = m * P
2704 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002705int mbedtls_ecp_mul_restartable(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2706 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2707 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
2708 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002709{
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (f_rng == NULL) {
2711 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
2712 }
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002713
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 return ecp_mul_restartable_internal(grp, R, m, P, f_rng, p_rng, rs_ctx);
Manuel Pégourié-Gonnard75525ae2021-06-15 11:29:26 +02002715}
2716
2717/*
Manuel Pégourié-Gonnard884569c2017-04-20 10:10:59 +02002718 * Multiplication R = m * P
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002720int mbedtls_ecp_mul(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2721 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2722 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002723{
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 return mbedtls_ecp_mul_restartable(grp, R, m, P, f_rng, p_rng, NULL);
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002725}
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +02002726
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002727#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Manuel Pégourié-Gonnarda0179b82013-12-04 11:49:20 +01002728/*
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01002729 * Check that an affine point is valid as a public key,
2730 * short weierstrass curves (SEC1 3.2.3.1)
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002731 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002732static int ecp_check_pubkey_sw(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002733{
Janos Follath24eed8d2019-11-22 13:21:35 +00002734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735 mbedtls_mpi YY, RHS;
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002736
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +01002737 /* pt coordinates must be normalized for our checks */
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 if (mbedtls_mpi_cmp_int(&pt->X, 0) < 0 ||
2739 mbedtls_mpi_cmp_int(&pt->Y, 0) < 0 ||
2740 mbedtls_mpi_cmp_mpi(&pt->X, &grp->P) >= 0 ||
2741 mbedtls_mpi_cmp_mpi(&pt->Y, &grp->P) >= 0) {
2742 return MBEDTLS_ERR_ECP_INVALID_KEY;
2743 }
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002744
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 mbedtls_mpi_init(&YY); mbedtls_mpi_init(&RHS);
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002746
2747 /*
2748 * YY = Y^2
Manuel Pégourié-Gonnard8b6d14b2022-12-20 10:02:52 +01002749 * RHS = X^3 + A X + B
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002750 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 MPI_ECP_SQR(&YY, &pt->Y);
2752 MBEDTLS_MPI_CHK(ecp_sw_rhs(grp, &RHS, &pt->X));
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002753
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (MPI_ECP_CMP(&YY, &RHS) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 }
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002757
2758cleanup:
2759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 mbedtls_mpi_free(&YY); mbedtls_mpi_free(&RHS);
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 return ret;
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02002763}
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002764#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01002765
Gilles Peskine9b99a892018-09-14 18:32:19 +02002766#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002767/*
TRodziewicz9edff742021-03-04 17:59:39 +01002768 * R = m * P with shortcuts for m == 0, m == 1 and m == -1
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002769 * NOT constant-time - ONLY for short Weierstrass!
2770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002771static int mbedtls_ecp_mul_shortcuts(mbedtls_ecp_group *grp,
2772 mbedtls_ecp_point *R,
2773 const mbedtls_mpi *m,
2774 const mbedtls_ecp_point *P,
2775 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002776{
Janos Follath24eed8d2019-11-22 13:21:35 +00002777 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerc27a0e02022-01-06 05:56:34 +00002778 mbedtls_mpi tmp;
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 mbedtls_mpi_init(&tmp);
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 if (mbedtls_mpi_cmp_int(m, 0) == 0) {
2782 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2783 MBEDTLS_MPI_CHK(mbedtls_ecp_set_zero(R));
2784 } else if (mbedtls_mpi_cmp_int(m, 1) == 0) {
2785 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2786 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, P));
2787 } else if (mbedtls_mpi_cmp_int(m, -1) == 0) {
2788 MBEDTLS_MPI_CHK(mbedtls_ecp_check_pubkey(grp, P));
2789 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, P));
2790 MPI_ECP_NEG(&R->Y);
2791 } else {
2792 MBEDTLS_MPI_CHK(ecp_mul_restartable_internal(grp, R, m, P,
2793 NULL, NULL, rs_ctx));
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002794 }
2795
2796cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 mbedtls_mpi_free(&tmp);
Hanno Beckerc27a0e02022-01-06 05:56:34 +00002798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 return ret;
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002800}
2801
2802/*
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002803 * Restartable linear combination
Manuel Pégourié-Gonnardde9f9532015-10-23 15:50:37 +02002804 * NOT constant-time
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002805 */
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002806int mbedtls_ecp_muladd_restartable(
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2808 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2809 const mbedtls_mpi *n, const mbedtls_ecp_point *Q,
2810 mbedtls_ecp_restart_ctx *rs_ctx)
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002811{
Janos Follath24eed8d2019-11-22 13:21:35 +00002812 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002813 mbedtls_ecp_point mP;
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002814 mbedtls_ecp_point *pmP = &mP;
2815 mbedtls_ecp_point *pR = R;
Hanno Becker3b29f212022-01-04 07:34:14 +00002816 mbedtls_mpi tmp[4];
Janos Follathc44ab972016-11-18 16:38:23 +00002817#if defined(MBEDTLS_ECP_INTERNAL_ALT)
2818 char is_grp_capable = 0;
2819#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 if (mbedtls_ecp_get_type(grp) != MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
2821 return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
2822 }
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002823
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 mbedtls_ecp_point_init(&mP);
2825 mpi_init_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Becker3b29f212022-01-04 07:34:14 +00002826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 ECP_RS_ENTER(ma);
Manuel Pégourié-Gonnarddb4a8eb2017-08-23 18:18:22 +02002828
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002829#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002831 /* redirect intermediate results to restart context */
2832 pmP = &rs_ctx->ma->mP;
2833 pR = &rs_ctx->ma->R;
2834
2835 /* jump to next operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 if (rs_ctx->ma->state == ecp_rsma_mul2) {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002837 goto mul2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 }
2839 if (rs_ctx->ma->state == ecp_rsma_add) {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002840 goto add;
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 }
2842 if (rs_ctx->ma->state == ecp_rsma_norm) {
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002843 goto norm;
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 }
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002845 }
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002846#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 MBEDTLS_MPI_CHK(mbedtls_ecp_mul_shortcuts(grp, pmP, m, P, rs_ctx));
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002849#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Manuel Pégourié-Gonnardc9efa002017-08-24 10:25:06 +02002851 rs_ctx->ma->state = ecp_rsma_mul2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 }
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002853
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002854mul2:
2855#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 MBEDTLS_MPI_CHK(mbedtls_ecp_mul_shortcuts(grp, pR, n, Q, rs_ctx));
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002857
2858#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if ((is_grp_capable = mbedtls_internal_ecp_grp_capable(grp))) {
2860 MBEDTLS_MPI_CHK(mbedtls_internal_ecp_init(grp));
2861 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002862#endif /* MBEDTLS_ECP_INTERNAL_ALT */
2863
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002864#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Manuel Pégourié-Gonnardc9efa002017-08-24 10:25:06 +02002866 rs_ctx->ma->state = ecp_rsma_add;
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 }
Manuel Pégourié-Gonnard1a7c5ef2015-08-13 10:19:09 +02002868
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002869add:
2870#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_ADD);
2872 MBEDTLS_MPI_CHK(ecp_add_mixed(grp, pR, pmP, pR, tmp));
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002873#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
Manuel Pégourié-Gonnardc9efa002017-08-24 10:25:06 +02002875 rs_ctx->ma->state = ecp_rsma_norm;
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 }
Janos Follath430d3372016-11-03 14:25:37 +00002877
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002878norm:
2879#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 MBEDTLS_ECP_BUDGET(MBEDTLS_ECP_OPS_INV);
2881 MBEDTLS_MPI_CHK(ecp_normalize_jac(grp, pR));
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002882
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +02002883#if defined(MBEDTLS_ECP_RESTARTABLE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if (rs_ctx != NULL && rs_ctx->ma != NULL) {
2885 MBEDTLS_MPI_CHK(mbedtls_ecp_copy(R, pR));
2886 }
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002887#endif
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002888
2889cleanup:
Hanno Becker3b29f212022-01-04 07:34:14 +00002890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 mpi_free_many(tmp, sizeof(tmp) / sizeof(mbedtls_mpi));
Hanno Becker3b29f212022-01-04 07:34:14 +00002892
Janos Follathc44ab972016-11-18 16:38:23 +00002893#if defined(MBEDTLS_ECP_INTERNAL_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 if (is_grp_capable) {
2895 mbedtls_internal_ecp_free(grp);
2896 }
Janos Follathc44ab972016-11-18 16:38:23 +00002897#endif /* MBEDTLS_ECP_INTERNAL_ALT */
Manuel Pégourié-Gonnard1631d632017-04-20 14:48:56 +02002898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 mbedtls_ecp_point_free(&mP);
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 ECP_RS_LEAVE(ma);
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002902
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 return ret;
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +02002904}
2905
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002906/*
2907 * Linear combination
2908 * NOT constant-time
2909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002910int mbedtls_ecp_muladd(mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
2911 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
2912 const mbedtls_mpi *n, const mbedtls_ecp_point *Q)
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002913{
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 return mbedtls_ecp_muladd_restartable(grp, R, m, P, n, Q, NULL);
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +02002915}
Gilles Peskine9b99a892018-09-14 18:32:19 +02002916#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01002917
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02002918#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002919#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002920#define ECP_MPI_INIT(s, n, p) { s, (n), (mbedtls_mpi_uint *) (p) }
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002921#define ECP_MPI_INIT_ARRAY(x) \
2922 ECP_MPI_INIT(1, sizeof(x) / sizeof(mbedtls_mpi_uint), x)
2923/*
2924 * Constants for the two points other than 0, 1, -1 (mod p) in
2925 * https://cr.yp.to/ecdh.html#validate
2926 * See ecp_check_pubkey_x25519().
2927 */
2928static const mbedtls_mpi_uint x25519_bad_point_1[] = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 MBEDTLS_BYTES_TO_T_UINT_8(0xe0, 0xeb, 0x7a, 0x7c, 0x3b, 0x41, 0xb8, 0xae),
2930 MBEDTLS_BYTES_TO_T_UINT_8(0x16, 0x56, 0xe3, 0xfa, 0xf1, 0x9f, 0xc4, 0x6a),
2931 MBEDTLS_BYTES_TO_T_UINT_8(0xda, 0x09, 0x8d, 0xeb, 0x9c, 0x32, 0xb1, 0xfd),
2932 MBEDTLS_BYTES_TO_T_UINT_8(0x86, 0x62, 0x05, 0x16, 0x5f, 0x49, 0xb8, 0x00),
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002933};
2934static const mbedtls_mpi_uint x25519_bad_point_2[] = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 MBEDTLS_BYTES_TO_T_UINT_8(0x5f, 0x9c, 0x95, 0xbc, 0xa3, 0x50, 0x8c, 0x24),
2936 MBEDTLS_BYTES_TO_T_UINT_8(0xb1, 0xd0, 0xb1, 0x55, 0x9c, 0x83, 0xef, 0x5b),
2937 MBEDTLS_BYTES_TO_T_UINT_8(0x04, 0x44, 0x5c, 0xc4, 0x58, 0x1c, 0x8e, 0x86),
2938 MBEDTLS_BYTES_TO_T_UINT_8(0xd8, 0x22, 0x4e, 0xdd, 0xd0, 0x9f, 0x11, 0x57),
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002939};
2940static const mbedtls_mpi ecp_x25519_bad_point_1 = ECP_MPI_INIT_ARRAY(
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 x25519_bad_point_1);
Manuel Pégourié-Gonnard06215ea2021-06-23 12:53:18 +02002942static const mbedtls_mpi ecp_x25519_bad_point_2 = ECP_MPI_INIT_ARRAY(
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 x25519_bad_point_2);
Janos Follath865a75e2021-06-24 15:34:59 +01002944#endif /* MBEDTLS_ECP_DP_CURVE25519_ENABLED */
Manuel Pégourié-Gonnard2389a602021-06-23 12:25:48 +02002945
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002946/*
2947 * Check that the input point is not one of the low-order points.
2948 * This is recommended by the "May the Fourth" paper:
2949 * https://eprint.iacr.org/2017/806.pdf
2950 * Those points are never sent by an honest peer.
2951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002952static int ecp_check_bad_points_mx(const mbedtls_mpi *X, const mbedtls_mpi *P,
2953 const mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002954{
2955 int ret;
Manuel Pégourié-Gonnard2389a602021-06-23 12:25:48 +02002956 mbedtls_mpi XmP;
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 mbedtls_mpi_init(&XmP);
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002959
2960 /* Reduce X mod P so that we only need to check values less than P.
2961 * We know X < 2^256 so we can proceed by subtraction. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 MBEDTLS_MPI_CHK(mbedtls_mpi_copy(&XmP, X));
2963 while (mbedtls_mpi_cmp_mpi(&XmP, P) >= 0) {
2964 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_mpi(&XmP, &XmP, P));
2965 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002966
Janos Follath865a75e2021-06-24 15:34:59 +01002967 /* Check against the known bad values that are less than P. For Curve448
2968 * these are 0, 1 and -1. For Curve25519 we check the values less than P
2969 * from the following list: https://cr.yp.to/ecdh.html#validate */
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (mbedtls_mpi_cmp_int(&XmP, 1) <= 0) { /* takes care of 0 and 1 */
Janos Follath8081ced2021-06-24 14:24:13 +01002971 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2972 goto cleanup;
2973 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002974
Janos Follath865a75e2021-06-24 15:34:59 +01002975#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (grp_id == MBEDTLS_ECP_DP_CURVE25519) {
2977 if (mbedtls_mpi_cmp_mpi(&XmP, &ecp_x25519_bad_point_1) == 0) {
Janos Follath865a75e2021-06-24 15:34:59 +01002978 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2979 goto cleanup;
2980 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 if (mbedtls_mpi_cmp_mpi(&XmP, &ecp_x25519_bad_point_2) == 0) {
Janos Follath865a75e2021-06-24 15:34:59 +01002983 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2984 goto cleanup;
2985 }
Janos Follath8081ced2021-06-24 14:24:13 +01002986 }
Janos Follath83e384d2021-06-25 15:29:56 +01002987#else
2988 (void) grp_id;
Janos Follath865a75e2021-06-24 15:34:59 +01002989#endif
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002990
Manuel Pégourié-Gonnard2389a602021-06-23 12:25:48 +02002991 /* Final check: check if XmP + 1 is P (final because it changes XmP!) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&XmP, &XmP, 1));
2993 if (mbedtls_mpi_cmp_mpi(&XmP, P) == 0) {
Janos Follath8081ced2021-06-24 14:24:13 +01002994 ret = MBEDTLS_ERR_ECP_INVALID_KEY;
2995 goto cleanup;
2996 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02002997
2998 ret = 0;
2999
3000cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 mbedtls_mpi_free(&XmP);
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02003002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 return ret;
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02003004}
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02003005
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003006/*
3007 * Check validity of a public key for Montgomery curves with x-only schemes
3008 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003009static int ecp_check_pubkey_mx(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003010{
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +02003011 /* [Curve25519 p. 5] Just check X is the correct number of bytes */
Nicholas Wilson08f3ef12015-11-10 13:10:01 +00003012 /* Allow any public value, if it's too big then we'll just reduce it mod p
3013 * (RFC 7748 sec. 5 para. 3). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 if (mbedtls_mpi_size(&pt->X) > (grp->nbits + 7) / 8) {
3015 return MBEDTLS_ERR_ECP_INVALID_KEY;
3016 }
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003017
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02003018 /* Implicit in all standards (as they don't consider negative numbers):
3019 * X must be non-negative. This is normally ensured by the way it's
3020 * encoded for transmission, but let's be extra sure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 if (mbedtls_mpi_cmp_int(&pt->X, 0) < 0) {
3022 return MBEDTLS_ERR_ECP_INVALID_KEY;
3023 }
Manuel Pégourié-Gonnardf29857c2021-06-23 10:14:58 +02003024
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 return ecp_check_bad_points_mx(&pt->X, &grp->P, grp->id);
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003026}
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003027#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003028
3029/*
3030 * Check that a point is valid as a public key
3031 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003032int mbedtls_ecp_check_pubkey(const mbedtls_ecp_group *grp,
3033 const mbedtls_ecp_point *pt)
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003034{
3035 /* Must use affine coordinates */
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 if (mbedtls_mpi_cmp_int(&pt->Z, 1) != 0) {
3037 return MBEDTLS_ERR_ECP_INVALID_KEY;
3038 }
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003039
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003040#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3042 return ecp_check_pubkey_mx(grp, pt);
3043 }
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003044#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003045#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3047 return ecp_check_pubkey_sw(grp, pt);
3048 }
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003049#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardd9622732013-12-05 10:06:06 +01003051}
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003052
3053/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054 * Check that an mbedtls_mpi is valid as a private key
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003056int mbedtls_ecp_check_privkey(const mbedtls_ecp_group *grp,
3057 const mbedtls_mpi *d)
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003058{
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003059#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Nicholas Wilson08f3ef12015-11-10 13:10:01 +00003061 /* see RFC 7748 sec. 5 para. 5 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 if (mbedtls_mpi_get_bit(d, 0) != 0 ||
3063 mbedtls_mpi_get_bit(d, 1) != 0 ||
3064 mbedtls_mpi_bitlen(d) - 1 != grp->nbits) { /* mbedtls_mpi_bitlen is one-based! */
3065 return MBEDTLS_ERR_ECP_INVALID_KEY;
3066 }
Nicholas Wilson08f3ef12015-11-10 13:10:01 +00003067
3068 /* see [Curve25519] page 5 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (grp->nbits == 254 && mbedtls_mpi_get_bit(d, 2) != 0) {
3070 return MBEDTLS_ERR_ECP_INVALID_KEY;
3071 }
Nicholas Wilson08f3ef12015-11-10 13:10:01 +00003072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 return 0;
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +01003074 }
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003075#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
3076#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +01003078 /* see SEC1 3.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if (mbedtls_mpi_cmp_int(d, 1) < 0 ||
3080 mbedtls_mpi_cmp_mpi(d, &grp->N) >= 0) {
3081 return MBEDTLS_ERR_ECP_INVALID_KEY;
3082 } else {
3083 return 0;
3084 }
Manuel Pégourié-Gonnard312d2e82013-12-04 11:08:01 +01003085 }
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003086#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003087
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003089}
3090
Gilles Peskine72fcc982021-03-23 22:31:31 +01003091#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3092MBEDTLS_STATIC_TESTABLE
Gilles Peskine449bd832023-01-11 14:50:10 +01003093int mbedtls_ecp_gen_privkey_mx(size_t high_bit,
3094 mbedtls_mpi *d,
3095 int (*f_rng)(void *, unsigned char *, size_t),
3096 void *p_rng)
Gilles Peskine72fcc982021-03-23 22:31:31 +01003097{
3098 int ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Gilles Peskine61f1f5f2021-03-24 12:46:46 +01003099 size_t n_random_bytes = high_bit / 8 + 1;
Gilles Peskine72fcc982021-03-23 22:31:31 +01003100
3101 /* [Curve25519] page 5 */
Gilles Peskine61f1f5f2021-03-24 12:46:46 +01003102 /* Generate a (high_bit+1)-bit random number by generating just enough
3103 * random bytes, then shifting out extra bits from the top (necessary
3104 * when (high_bit+1) is not a multiple of 8). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 MBEDTLS_MPI_CHK(mbedtls_mpi_fill_random(d, n_random_bytes,
3106 f_rng, p_rng));
3107 MBEDTLS_MPI_CHK(mbedtls_mpi_shift_r(d, 8 * n_random_bytes - high_bit - 1));
Gilles Peskine72fcc982021-03-23 22:31:31 +01003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, high_bit, 1));
Gilles Peskine72fcc982021-03-23 22:31:31 +01003110
3111 /* Make sure the last two bits are unset for Curve448, three bits for
3112 Curve25519 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 0, 0));
3114 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 1, 0));
3115 if (high_bit == 254) {
3116 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(d, 2, 0));
Gilles Peskine72fcc982021-03-23 22:31:31 +01003117 }
3118
3119cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 return ret;
Gilles Peskine72fcc982021-03-23 22:31:31 +01003121}
3122#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
3123
Gilles Peskine60d8b982021-03-29 22:28:21 +02003124#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
3125static int mbedtls_ecp_gen_privkey_sw(
3126 const mbedtls_mpi *N, mbedtls_mpi *d,
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Gilles Peskine60d8b982021-03-29 22:28:21 +02003128{
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 int ret = mbedtls_mpi_random(d, 1, N, f_rng, p_rng);
3130 switch (ret) {
Gilles Peskine60d8b982021-03-29 22:28:21 +02003131 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 return MBEDTLS_ERR_ECP_RANDOM_FAILED;
Gilles Peskine60d8b982021-03-29 22:28:21 +02003133 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 return ret;
Gilles Peskine60d8b982021-03-29 22:28:21 +02003135 }
3136}
3137#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3138
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02003139/*
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003140 * Generate a private key
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01003141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003142int mbedtls_ecp_gen_privkey(const mbedtls_ecp_group *grp,
3143 mbedtls_mpi *d,
3144 int (*f_rng)(void *, unsigned char *, size_t),
3145 void *p_rng)
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01003146{
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003147#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3149 return mbedtls_ecp_gen_privkey_mx(grp->nbits, d, f_rng, p_rng);
3150 }
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003151#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003152
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003153#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 if (mbedtls_ecp_get_type(grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3155 return mbedtls_ecp_gen_privkey_sw(&grp->N, d, f_rng, p_rng);
3156 }
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003157#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01003158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003160}
Manuel Pégourié-Gonnardc9573992014-01-03 12:54:00 +01003161
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003162/*
3163 * Generate a keypair with configurable base point
3164 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003165int mbedtls_ecp_gen_keypair_base(mbedtls_ecp_group *grp,
3166 const mbedtls_ecp_point *G,
3167 mbedtls_mpi *d, mbedtls_ecp_point *Q,
3168 int (*f_rng)(void *, unsigned char *, size_t),
3169 void *p_rng)
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003170{
Janos Follath24eed8d2019-11-22 13:21:35 +00003171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 MBEDTLS_MPI_CHK(mbedtls_ecp_gen_privkey(grp, d, f_rng, p_rng));
3173 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, Q, d, G, f_rng, p_rng));
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02003174
3175cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 return ret;
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02003177}
3178
3179/*
3180 * Generate key pair, wrapper for conventional base point
3181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003182int mbedtls_ecp_gen_keypair(mbedtls_ecp_group *grp,
3183 mbedtls_mpi *d, mbedtls_ecp_point *Q,
3184 int (*f_rng)(void *, unsigned char *, size_t),
3185 void *p_rng)
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02003186{
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 return mbedtls_ecp_gen_keypair_base(grp, &grp->G, d, Q, f_rng, p_rng);
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01003188}
Manuel Pégourié-Gonnardefaa31e2012-11-06 21:34:35 +01003189
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003190/*
3191 * Generate a keypair, prettier wrapper
3192 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003193int mbedtls_ecp_gen_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
3194 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003195{
Janos Follath24eed8d2019-11-22 13:21:35 +00003196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3198 return ret;
3199 }
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003200
Gilles Peskine449bd832023-01-11 14:50:10 +01003201 return mbedtls_ecp_gen_keypair(&key->grp, &key->d, &key->Q, f_rng, p_rng);
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01003202}
3203
Janos Follath77800962019-02-25 16:32:08 +00003204#define ECP_CURVE25519_KEY_SIZE 32
Archana1d2e2bb2021-06-07 06:13:16 +05303205#define ECP_CURVE448_KEY_SIZE 56
Janos Follath171a7ef2019-02-15 16:17:45 +00003206/*
3207 * Read a private key.
3208 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003209int mbedtls_ecp_read_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
3210 const unsigned char *buf, size_t buflen)
Janos Follath171a7ef2019-02-15 16:17:45 +00003211{
3212 int ret = 0;
3213
Gilles Peskine449bd832023-01-11 14:50:10 +01003214 if ((ret = mbedtls_ecp_group_load(&key->grp, grp_id)) != 0) {
3215 return ret;
3216 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003217
Janos Follath28eb06d2019-02-26 10:53:34 +00003218 ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
3219
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003220#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
Janos Follath28eb06d2019-02-26 10:53:34 +00003222 /*
Archana1d2e2bb2021-06-07 06:13:16 +05303223 * Mask the key as mandated by RFC7748 for Curve25519 and Curve448.
Janos Follath28eb06d2019-02-26 10:53:34 +00003224 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 if (grp_id == MBEDTLS_ECP_DP_CURVE25519) {
3226 if (buflen != ECP_CURVE25519_KEY_SIZE) {
3227 return MBEDTLS_ERR_ECP_INVALID_KEY;
3228 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&key->d, buf, buflen));
Janos Follath171a7ef2019-02-15 16:17:45 +00003231
Janos Follath28eb06d2019-02-26 10:53:34 +00003232 /* Set the three least significant bits to 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 0, 0));
3234 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 1, 0));
3235 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 2, 0));
Janos Follath171a7ef2019-02-15 16:17:45 +00003236
Janos Follath28eb06d2019-02-26 10:53:34 +00003237 /* Set the most significant bit to 0 */
3238 MBEDTLS_MPI_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 mbedtls_mpi_set_bit(&key->d,
3240 ECP_CURVE25519_KEY_SIZE * 8 - 1, 0)
3241 );
Janos Follath171a7ef2019-02-15 16:17:45 +00003242
Janos Follath28eb06d2019-02-26 10:53:34 +00003243 /* Set the second most significant bit to 1 */
3244 MBEDTLS_MPI_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 mbedtls_mpi_set_bit(&key->d,
3246 ECP_CURVE25519_KEY_SIZE * 8 - 2, 1)
3247 );
3248 } else if (grp_id == MBEDTLS_ECP_DP_CURVE448) {
3249 if (buflen != ECP_CURVE448_KEY_SIZE) {
3250 return MBEDTLS_ERR_ECP_INVALID_KEY;
3251 }
Archana1d2e2bb2021-06-07 06:13:16 +05303252
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary_le(&key->d, buf, buflen));
Archana1d2e2bb2021-06-07 06:13:16 +05303254
3255 /* Set the two least significant bits to 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 0, 0));
3257 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(&key->d, 1, 0));
Archana1d2e2bb2021-06-07 06:13:16 +05303258
3259 /* Set the 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_CURVE448_KEY_SIZE * 8 - 1, 1)
3263 );
Archana1d2e2bb2021-06-07 06:13:16 +05303264 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003265 }
3266
3267#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003268#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3270 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&key->d, buf, buflen));
Janos Follath171a7ef2019-02-15 16:17:45 +00003271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 MBEDTLS_MPI_CHK(mbedtls_ecp_check_privkey(&key->grp, &key->d));
Janos Follath171a7ef2019-02-15 16:17:45 +00003273 }
3274
3275#endif
3276cleanup:
3277
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 if (ret != 0) {
3279 mbedtls_mpi_free(&key->d);
3280 }
Janos Follath171a7ef2019-02-15 16:17:45 +00003281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 return ret;
Janos Follath171a7ef2019-02-15 16:17:45 +00003283}
3284
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003285/*
Steven Cooremande8593f2020-06-09 19:55:26 +02003286 * Write a private key.
3287 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003288int mbedtls_ecp_write_key(mbedtls_ecp_keypair *key,
3289 unsigned char *buf, size_t buflen)
Steven Cooremande8593f2020-06-09 19:55:26 +02003290{
Steven Cooreman0024df62020-07-13 10:59:40 +02003291 int ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
Steven Cooremande8593f2020-06-09 19:55:26 +02003292
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003293#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_MONTGOMERY) {
3295 if (key->grp.id == MBEDTLS_ECP_DP_CURVE25519) {
3296 if (buflen < ECP_CURVE25519_KEY_SIZE) {
3297 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3298 }
Steven Cooremande8593f2020-06-09 19:55:26 +02003299
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 } else if (key->grp.id == MBEDTLS_ECP_DP_CURVE448) {
3301 if (buflen < ECP_CURVE448_KEY_SIZE) {
3302 return MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3303 }
Steven Cooremande8593f2020-06-09 19:55:26 +02003304 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary_le(&key->d, buf, buflen));
Steven Cooremande8593f2020-06-09 19:55:26 +02003306 }
Steven Cooremande8593f2020-06-09 19:55:26 +02003307#endif
Gilles Peskinee8c04fe2018-09-14 17:44:21 +02003308#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 if (mbedtls_ecp_get_type(&key->grp) == MBEDTLS_ECP_TYPE_SHORT_WEIERSTRASS) {
3310 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&key->d, buf, buflen));
Steven Cooremande8593f2020-06-09 19:55:26 +02003311 }
3312
3313#endif
3314cleanup:
3315
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 return ret;
Steven Cooremande8593f2020-06-09 19:55:26 +02003317}
3318
3319
3320/*
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003321 * Check a public-private key pair
3322 */
Manuel Pégourié-Gonnardf8c24bf2021-06-15 11:29:26 +02003323int mbedtls_ecp_check_pub_priv(
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 const mbedtls_ecp_keypair *pub, const mbedtls_ecp_keypair *prv,
3325 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003326{
Janos Follath24eed8d2019-11-22 13:21:35 +00003327 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328 mbedtls_ecp_point Q;
3329 mbedtls_ecp_group grp;
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (pub->grp.id == MBEDTLS_ECP_DP_NONE ||
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003331 pub->grp.id != prv->grp.id ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 mbedtls_mpi_cmp_mpi(&pub->Q.X, &prv->Q.X) ||
3333 mbedtls_mpi_cmp_mpi(&pub->Q.Y, &prv->Q.Y) ||
3334 mbedtls_mpi_cmp_mpi(&pub->Q.Z, &prv->Q.Z)) {
3335 return MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003336 }
3337
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 mbedtls_ecp_point_init(&Q);
3339 mbedtls_ecp_group_init(&grp);
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341 /* mbedtls_ecp_mul() needs a non-const group... */
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 mbedtls_ecp_group_copy(&grp, &prv->grp);
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003343
3344 /* Also checks d is valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 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 +01003346
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 if (mbedtls_mpi_cmp_mpi(&Q.X, &prv->Q.X) ||
3348 mbedtls_mpi_cmp_mpi(&Q.Y, &prv->Q.Y) ||
3349 mbedtls_mpi_cmp_mpi(&Q.Z, &prv->Q.Z)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350 ret = MBEDTLS_ERR_ECP_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003351 goto cleanup;
3352 }
3353
3354cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 mbedtls_ecp_point_free(&Q);
3356 mbedtls_ecp_group_free(&grp);
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 return ret;
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01003359}
3360
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003361/*
3362 * Export generic key-pair parameters.
3363 */
3364int mbedtls_ecp_export(const mbedtls_ecp_keypair *key, mbedtls_ecp_group *grp,
3365 mbedtls_mpi *d, mbedtls_ecp_point *Q)
3366{
3367 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003368
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 if ((ret = mbedtls_ecp_group_copy(grp, &key->grp)) != 0) {
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003370 return ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 }
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003372
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 if ((ret = mbedtls_mpi_copy(d, &key->d)) != 0) {
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003374 return ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 }
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003376
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 if ((ret = mbedtls_ecp_copy(Q, &key->Q)) != 0) {
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003378 return ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 }
Przemek Stekiel711d0f52022-03-18 13:52:26 +01003380
3381 return 0;
3382}
3383
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003385
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02003386/*
3387 * PRNG for test - !!!INSECURE NEVER USE IN PRODUCTION!!!
3388 *
3389 * This is the linear congruential generator from numerical recipes,
3390 * except we only use the low byte as the output. See
3391 * https://en.wikipedia.org/wiki/Linear_congruential_generator#Parameters_in_common_use
3392 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003393static int self_test_rng(void *ctx, unsigned char *out, size_t len)
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02003394{
3395 static uint32_t state = 42;
3396
3397 (void) ctx;
3398
Gilles Peskine449bd832023-01-11 14:50:10 +01003399 for (size_t i = 0; i < len; i++) {
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02003400 state = state * 1664525u + 1013904223u;
3401 out[i] = (unsigned char) state;
3402 }
3403
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 return 0;
Manuel Pégourié-Gonnardaa3ed6f2021-06-15 11:29:26 +02003405}
3406
Gilles Peskine6d9c8d72020-07-22 01:26:25 +02003407/* Adjust the exponent to be a valid private point for the specified curve.
3408 * This is sometimes necessary because we use a single set of exponents
3409 * for all curves but the validity of values depends on the curve. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003410static int self_test_adjust_exponent(const mbedtls_ecp_group *grp,
3411 mbedtls_mpi *m)
Gilles Peskinea088c812018-09-17 18:31:15 +02003412{
3413 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003414 switch (grp->id) {
3415 /* If Curve25519 is available, then that's what we use for the
3416 * Montgomery test, so we don't need the adjustment code. */
3417#if !defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Gilles Peskinea088c812018-09-17 18:31:15 +02003418#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
3419 case MBEDTLS_ECP_DP_CURVE448:
3420 /* Move highest bit from 254 to N-1. Setting bit N-1 is
3421 * necessary to enforce the highest-bit-set constraint. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(m, 254, 0));
3423 MBEDTLS_MPI_CHK(mbedtls_mpi_set_bit(m, grp->nbits, 1));
Gilles Peskinea088c812018-09-17 18:31:15 +02003424 /* Copy second-highest bit from 253 to N-2. This is not
3425 * necessary but improves the test variety a bit. */
3426 MBEDTLS_MPI_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01003427 mbedtls_mpi_set_bit(m, grp->nbits - 1,
3428 mbedtls_mpi_get_bit(m, 253)));
Gilles Peskinea088c812018-09-17 18:31:15 +02003429 break;
3430#endif
3431#endif /* ! defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) */
3432 default:
3433 /* Non-Montgomery curves and Curve25519 need no adjustment. */
3434 (void) grp;
3435 (void) m;
3436 goto cleanup;
3437 }
3438cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 return ret;
Gilles Peskinea088c812018-09-17 18:31:15 +02003440}
3441
Gilles Peskine6d9c8d72020-07-22 01:26:25 +02003442/* Calculate R = m.P for each m in exponents. Check that the number of
3443 * basic operations doesn't depend on the value of m. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003444static int self_test_point(int verbose,
3445 mbedtls_ecp_group *grp,
3446 mbedtls_ecp_point *R,
3447 mbedtls_mpi *m,
3448 const mbedtls_ecp_point *P,
3449 const char *const *exponents,
3450 size_t n_exponents)
Gilles Peskinec95696f2018-09-17 15:59:01 +02003451{
3452 int ret = 0;
Gilles Peskine24666792018-09-17 18:29:49 +02003453 size_t i = 0;
Gilles Peskinec95696f2018-09-17 15:59:01 +02003454 unsigned long add_c_prev, dbl_c_prev, mul_c_prev;
3455 add_count = 0;
3456 dbl_count = 0;
3457 mul_count = 0;
Gilles Peskinea088c812018-09-17 18:31:15 +02003458
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(m, 16, exponents[0]));
3460 MBEDTLS_MPI_CHK(self_test_adjust_exponent(grp, m));
3461 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, R, m, P, self_test_rng, NULL));
Gilles Peskinec95696f2018-09-17 15:59:01 +02003462
Gilles Peskine449bd832023-01-11 14:50:10 +01003463 for (i = 1; i < n_exponents; i++) {
Gilles Peskinec95696f2018-09-17 15:59:01 +02003464 add_c_prev = add_count;
3465 dbl_c_prev = dbl_count;
3466 mul_c_prev = mul_count;
3467 add_count = 0;
3468 dbl_count = 0;
3469 mul_count = 0;
3470
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 MBEDTLS_MPI_CHK(mbedtls_mpi_read_string(m, 16, exponents[i]));
3472 MBEDTLS_MPI_CHK(self_test_adjust_exponent(grp, m));
3473 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(grp, R, m, P, self_test_rng, NULL));
Gilles Peskinec95696f2018-09-17 15:59:01 +02003474
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 if (add_count != add_c_prev ||
Gilles Peskinec95696f2018-09-17 15:59:01 +02003476 dbl_count != dbl_c_prev ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003477 mul_count != mul_c_prev) {
Gilles Peskinec95696f2018-09-17 15:59:01 +02003478 ret = 1;
3479 break;
3480 }
3481 }
3482
3483cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 if (verbose != 0) {
3485 if (ret != 0) {
3486 mbedtls_printf("failed (%u)\n", (unsigned int) i);
3487 } else {
3488 mbedtls_printf("passed\n");
3489 }
Gilles Peskinec95696f2018-09-17 15:59:01 +02003490 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 return ret;
Gilles Peskinec95696f2018-09-17 15:59:01 +02003492}
3493
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +01003494/*
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003495 * Checkup routine
3496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003497int mbedtls_ecp_self_test(int verbose)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003498{
Janos Follath24eed8d2019-11-22 13:21:35 +00003499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003500 mbedtls_ecp_group grp;
3501 mbedtls_ecp_point R, P;
3502 mbedtls_mpi m;
Gilles Peskine24666792018-09-17 18:29:49 +02003503
3504#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Gilles Peskined9767a52018-09-14 19:29:47 +02003505 /* Exponents especially adapted for secp192k1, which has the lowest
3506 * order n of all supported curves (secp192r1 is in a slightly larger
3507 * field but the order of its base point is slightly smaller). */
Gilles Peskine24666792018-09-17 18:29:49 +02003508 const char *sw_exponents[] =
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003509 {
Manuel Pégourié-Gonnardb63f9e92012-11-21 13:00:58 +01003510 "000000000000000000000000000000000000000000000001", /* one */
Gilles Peskined9767a52018-09-14 19:29:47 +02003511 "FFFFFFFFFFFFFFFFFFFFFFFE26F2FC170F69466A74DEFD8C", /* n - 1 */
Manuel Pégourié-Gonnardb63f9e92012-11-21 13:00:58 +01003512 "5EA6F389A38B8BC81E767753B15AA5569E1782E30ABE7D25", /* random */
Manuel Pégourié-Gonnardff27b7c2013-11-21 09:28:03 +01003513 "400000000000000000000000000000000000000000000000", /* one and zeros */
3514 "7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", /* all ones */
3515 "555555555555555555555555555555555555555555555555", /* 101010... */
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003516 };
Gilles Peskine24666792018-09-17 18:29:49 +02003517#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3518#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
3519 const char *m_exponents[] =
3520 {
Gilles Peskine6d9c8d72020-07-22 01:26:25 +02003521 /* Valid private values for Curve25519. In a build with Curve448
3522 * but not Curve25519, they will be adjusted in
3523 * self_test_adjust_exponent(). */
Gilles Peskine24666792018-09-17 18:29:49 +02003524 "4000000000000000000000000000000000000000000000000000000000000000",
3525 "5C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C3C30",
3526 "5715ECCE24583F7A7023C24164390586842E816D7280A49EF6DF4EAE6B280BF8",
3527 "41A2B017516F6D254E1F002BCCBADD54BE30F8CEC737A0E912B4963B6BA74460",
3528 "5555555555555555555555555555555555555555555555555555555555555550",
3529 "7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF8",
3530 };
3531#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003532
Gilles Peskine449bd832023-01-11 14:50:10 +01003533 mbedtls_ecp_group_init(&grp);
3534 mbedtls_ecp_point_init(&R);
3535 mbedtls_ecp_point_init(&P);
3536 mbedtls_mpi_init(&m);
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003537
Gilles Peskine24666792018-09-17 18:29:49 +02003538#if defined(MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED)
Manuel Pégourié-Gonnardb8012fc2013-10-10 15:40:49 +02003539 /* Use secp192r1 if available, or any available curve */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003541 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_SECP192R1));
Paul Bakker5dc6b5f2013-06-29 23:26:34 +02003542#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003543 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, mbedtls_ecp_curve_list()->grp_id));
Manuel Pégourié-Gonnardb8012fc2013-10-10 15:40:49 +02003544#endif
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003545
Gilles Peskine449bd832023-01-11 14:50:10 +01003546 if (verbose != 0) {
3547 mbedtls_printf(" ECP SW test #1 (constant op_count, base point G): ");
3548 }
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +02003549 /* Do a dummy multiplication first to trigger precomputation */
Gilles Peskine449bd832023-01-11 14:50:10 +01003550 MBEDTLS_MPI_CHK(mbedtls_mpi_lset(&m, 2));
3551 MBEDTLS_MPI_CHK(mbedtls_ecp_mul(&grp, &P, &m, &grp.G, self_test_rng, NULL));
3552 ret = self_test_point(verbose,
3553 &grp, &R, &m, &grp.G,
3554 sw_exponents,
3555 sizeof(sw_exponents) / sizeof(sw_exponents[0]));
3556 if (ret != 0) {
Gilles Peskinec95696f2018-09-17 15:59:01 +02003557 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003558 }
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003559
Gilles Peskine449bd832023-01-11 14:50:10 +01003560 if (verbose != 0) {
3561 mbedtls_printf(" ECP SW test #2 (constant op_count, other point): ");
3562 }
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +02003563 /* We computed P = 2G last time, use it */
Gilles Peskine449bd832023-01-11 14:50:10 +01003564 ret = self_test_point(verbose,
3565 &grp, &R, &m, &P,
3566 sw_exponents,
3567 sizeof(sw_exponents) / sizeof(sw_exponents[0]));
3568 if (ret != 0) {
Gilles Peskine24666792018-09-17 18:29:49 +02003569 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003570 }
Gilles Peskine24666792018-09-17 18:29:49 +02003571
Gilles Peskine449bd832023-01-11 14:50:10 +01003572 mbedtls_ecp_group_free(&grp);
3573 mbedtls_ecp_point_free(&R);
Gilles Peskine24666792018-09-17 18:29:49 +02003574#endif /* MBEDTLS_ECP_SHORT_WEIERSTRASS_ENABLED */
3575
3576#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003577 if (verbose != 0) {
3578 mbedtls_printf(" ECP Montgomery test (constant op_count): ");
3579 }
Gilles Peskine24666792018-09-17 18:29:49 +02003580#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003581 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_CURVE25519));
Gilles Peskine24666792018-09-17 18:29:49 +02003582#elif defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003583 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&grp, MBEDTLS_ECP_DP_CURVE448));
Gilles Peskine24666792018-09-17 18:29:49 +02003584#else
3585#error "MBEDTLS_ECP_MONTGOMERY_ENABLED is defined, but no curve is supported for self-test"
3586#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003587 ret = self_test_point(verbose,
3588 &grp, &R, &m, &grp.G,
3589 m_exponents,
3590 sizeof(m_exponents) / sizeof(m_exponents[0]));
3591 if (ret != 0) {
Gilles Peskine24666792018-09-17 18:29:49 +02003592 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003593 }
Gilles Peskine24666792018-09-17 18:29:49 +02003594#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
Manuel Pégourié-Gonnard161ef962013-09-17 19:13:10 +02003595
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003596cleanup:
3597
Gilles Peskine449bd832023-01-11 14:50:10 +01003598 if (ret < 0 && verbose != 0) {
3599 mbedtls_printf("Unexpected error, return code = %08X\n", (unsigned int) ret);
3600 }
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003601
Gilles Peskine449bd832023-01-11 14:50:10 +01003602 mbedtls_ecp_group_free(&grp);
3603 mbedtls_ecp_point_free(&R);
3604 mbedtls_ecp_point_free(&P);
3605 mbedtls_mpi_free(&m);
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003606
Gilles Peskine449bd832023-01-11 14:50:10 +01003607 if (verbose != 0) {
3608 mbedtls_printf("\n");
3609 }
Manuel Pégourié-Gonnardb4a310b2012-11-13 20:57:00 +01003610
Gilles Peskine449bd832023-01-11 14:50:10 +01003611 return ret;
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003612}
3613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003614#endif /* MBEDTLS_SELF_TEST */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003615
Janos Follathb0697532016-08-18 12:38:46 +01003616#endif /* !MBEDTLS_ECP_ALT */
3617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618#endif /* MBEDTLS_ECP_C */