blob: bdc750eb244e0c5a0ef270e0661fd50862e49528 [file] [log] [blame]
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001/**
2 * \file ecp.h
3 *
Rose Zadikb2e111a2018-04-20 10:13:48 +01004 * \brief This file provides an API for Elliptic Curves over GF(P) (ECP).
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01005 *
Rose Zadikb2e111a2018-04-20 10:13:48 +01006 * The use of ECP in cryptography and TLS is defined in
7 * <em>Standards for Efficient Cryptography Group (SECG): SEC1
8 * Elliptic Curve Cryptography</em> and
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01009 * <em>RFC-4492: Elliptic Curve Cryptography (ECC) Cipher Suites
10 * for Transport Layer Security (TLS)</em>.
Rose Zadika7a61552018-04-24 13:14:01 +010011 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010012 * <em>RFC-2409: The Internet Key Exchange (IKE)</em> defines ECP
13 * group types.
Rose Zadika7a61552018-04-24 13:14:01 +010014 *
Darryl Greena40a1012018-01-05 15:33:17 +000015 */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010016
Darryl Greena40a1012018-01-05 15:33:17 +000017/*
Bence Szépkútia2947ac2020-08-19 16:37:36 +020018 * Copyright The Mbed TLS Contributors
Bence Szépkútif744bd72020-06-05 13:02:18 +020019 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
20 *
21 * This file is provided under the Apache License 2.0, or the
22 * GNU General Public License v2.0 or later.
23 *
24 * **********
25 * Apache License 2.0:
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020026 *
27 * Licensed under the Apache License, Version 2.0 (the "License"); you may
28 * not use this file except in compliance with the License.
29 * You may obtain a copy of the License at
30 *
31 * http://www.apache.org/licenses/LICENSE-2.0
32 *
33 * Unless required by applicable law or agreed to in writing, software
34 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
35 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
36 * See the License for the specific language governing permissions and
37 * limitations under the License.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010038 *
Bence Szépkútif744bd72020-06-05 13:02:18 +020039 * **********
40 *
41 * **********
42 * GNU General Public License v2.0 or later:
43 *
44 * This program is free software; you can redistribute it and/or modify
45 * it under the terms of the GNU General Public License as published by
46 * the Free Software Foundation; either version 2 of the License, or
47 * (at your option) any later version.
48 *
49 * This program is distributed in the hope that it will be useful,
50 * but WITHOUT ANY WARRANTY; without even the implied warranty of
51 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
52 * GNU General Public License for more details.
53 *
54 * You should have received a copy of the GNU General Public License along
55 * with this program; if not, write to the Free Software Foundation, Inc.,
56 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
57 *
58 * **********
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010059 */
Rose Zadika7a61552018-04-24 13:14:01 +010060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020061#ifndef MBEDTLS_ECP_H
62#define MBEDTLS_ECP_H
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010063
Ron Eldor8b0cf2e2018-02-14 16:02:41 +020064#if !defined(MBEDTLS_CONFIG_FILE)
65#include "config.h"
66#else
67#include MBEDTLS_CONFIG_FILE
68#endif
69
Manuel Pégourié-Gonnardbdc96762013-10-03 11:50:39 +020070#include "bignum.h"
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010071
72/*
Manuel Pégourié-Gonnard7cfcea32012-11-05 10:06:12 +010073 * ECP error codes
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020075#define MBEDTLS_ERR_ECP_BAD_INPUT_DATA -0x4F80 /**< Bad input parameters to function. */
76#define MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL -0x4F00 /**< The buffer is too small to write to. */
Rose Zadikd3534052018-04-23 16:12:42 +010077#define MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE -0x4E80 /**< The requested feature is not available, for example, the requested curve is not supported. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020078#define MBEDTLS_ERR_ECP_VERIFY_FAILED -0x4E00 /**< The signature is not valid. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +020079#define MBEDTLS_ERR_ECP_ALLOC_FAILED -0x4D80 /**< Memory allocation failed. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010080#define MBEDTLS_ERR_ECP_RANDOM_FAILED -0x4D00 /**< Generation of random value, such as ephemeral key, failed. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081#define MBEDTLS_ERR_ECP_INVALID_KEY -0x4C80 /**< Invalid private or public key. */
Gilles Peskine5114d3e2018-03-30 07:12:15 +020082#define MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH -0x4C00 /**< The buffer contains a valid signature followed by more data. */
Ron Eldor9924bdc2018-10-04 10:59:13 +030083
84/* MBEDTLS_ERR_ECP_HW_ACCEL_FAILED is deprecated and should not be used. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010085#define MBEDTLS_ERR_ECP_HW_ACCEL_FAILED -0x4B80 /**< The ECP hardware accelerator failed. */
Ron Eldor9924bdc2018-10-04 10:59:13 +030086
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +020087#define MBEDTLS_ERR_ECP_IN_PROGRESS -0x4B00 /**< Operation in progress, call again with the same parameters to continue. */
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +010088
Paul Bakker407a0da2013-06-27 14:29:21 +020089#ifdef __cplusplus
90extern "C" {
91#endif
92
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010093/**
Rose Zadikd76ac582018-04-23 06:29:34 +010094 * Domain-parameter identifiers: curve, subgroup, and generator.
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020095 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010096 * \note Only curves over prime fields are supported.
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020097 *
98 * \warning This library does not support validation of arbitrary domain
Rose Zadikf56cb342018-04-19 12:49:10 +010099 * parameters. Therefore, only standardized domain parameters from trusted
Manuel Pégourié-Gonnarde3a062b2015-05-11 18:46:47 +0200100 * sources should be used. See mbedtls_ecp_group_load().
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +0200101 */
102typedef enum
103{
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100104 MBEDTLS_ECP_DP_NONE = 0, /*!< Curve not defined. */
Rose Zadikb2e111a2018-04-20 10:13:48 +0100105 MBEDTLS_ECP_DP_SECP192R1, /*!< Domain parameters for the 192-bit curve defined by FIPS 186-4 and SEC1. */
106 MBEDTLS_ECP_DP_SECP224R1, /*!< Domain parameters for the 224-bit curve defined by FIPS 186-4 and SEC1. */
107 MBEDTLS_ECP_DP_SECP256R1, /*!< Domain parameters for the 256-bit curve defined by FIPS 186-4 and SEC1. */
108 MBEDTLS_ECP_DP_SECP384R1, /*!< Domain parameters for the 384-bit curve defined by FIPS 186-4 and SEC1. */
109 MBEDTLS_ECP_DP_SECP521R1, /*!< Domain parameters for the 521-bit curve defined by FIPS 186-4 and SEC1. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100110 MBEDTLS_ECP_DP_BP256R1, /*!< Domain parameters for 256-bit Brainpool curve. */
111 MBEDTLS_ECP_DP_BP384R1, /*!< Domain parameters for 384-bit Brainpool curve. */
112 MBEDTLS_ECP_DP_BP512R1, /*!< Domain parameters for 512-bit Brainpool curve. */
Rose Zadikb2e111a2018-04-20 10:13:48 +0100113 MBEDTLS_ECP_DP_CURVE25519, /*!< Domain parameters for Curve25519. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100114 MBEDTLS_ECP_DP_SECP192K1, /*!< Domain parameters for 192-bit "Koblitz" curve. */
115 MBEDTLS_ECP_DP_SECP224K1, /*!< Domain parameters for 224-bit "Koblitz" curve. */
116 MBEDTLS_ECP_DP_SECP256K1, /*!< Domain parameters for 256-bit "Koblitz" curve. */
Jaeden Amerofe0669f2018-04-27 17:43:32 +0100117 MBEDTLS_ECP_DP_CURVE448, /*!< Domain parameters for Curve448. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118} mbedtls_ecp_group_id;
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +0200119
120/**
Rose Zadikf56cb342018-04-19 12:49:10 +0100121 * The number of supported curves, plus one for #MBEDTLS_ECP_DP_NONE.
Manuel Pégourié-Gonnard66153662013-12-03 14:12:26 +0100122 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100123 * \note Montgomery curves are currently excluded.
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +0200124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200125#define MBEDTLS_ECP_DP_MAX 12
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +0200126
127/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100128 * Curve information, for use by other modules.
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200129 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200130typedef struct mbedtls_ecp_curve_info
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200131{
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100132 mbedtls_ecp_group_id grp_id; /*!< An internal identifier. */
133 uint16_t tls_id; /*!< The TLS NamedCurve identifier. */
Rose Zadikb2e111a2018-04-20 10:13:48 +0100134 uint16_t bit_size; /*!< The curve size in bits. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100135 const char *name; /*!< A human-friendly name. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200136} mbedtls_ecp_curve_info;
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200137
138/**
Rose Zadikf56cb342018-04-19 12:49:10 +0100139 * \brief The ECP point structure, in Jacobian coordinates.
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100140 *
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +0100141 * \note All functions expect and return points satisfying
Rose Zadikf56cb342018-04-19 12:49:10 +0100142 * the following condition: <code>Z == 0</code> or
Rose Zadika7a61552018-04-24 13:14:01 +0100143 * <code>Z == 1</code>. Other values of \p Z are
Rose Zadikf56cb342018-04-19 12:49:10 +0100144 * used only by internal functions.
145 * The point is zero, or "at infinity", if <code>Z == 0</code>.
Rose Zadika7a61552018-04-24 13:14:01 +0100146 * Otherwise, \p X and \p Y are its standard (affine)
Rose Zadikf56cb342018-04-19 12:49:10 +0100147 * coordinates.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100148 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200149typedef struct mbedtls_ecp_point
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100150{
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100151 mbedtls_mpi X; /*!< The X coordinate of the ECP point. */
152 mbedtls_mpi Y; /*!< The Y coordinate of the ECP point. */
153 mbedtls_mpi Z; /*!< The Z coordinate of the ECP point. */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100154}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200155mbedtls_ecp_point;
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100156
157#if !defined(MBEDTLS_ECP_ALT)
158/*
159 * default mbed TLS elliptic curve arithmetic implementation
160 *
161 * (in case MBEDTLS_ECP_ALT is defined then the developer has to provide an
162 * alternative implementation for the whole module and it will replace this
163 * one.)
164 */
165
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100166/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100167 * \brief The ECP group structure.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100168 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100169 * We consider two types of curve equations:
Rose Zadikb2e111a2018-04-20 10:13:48 +0100170 * <ul><li>Short Weierstrass: <code>y^2 = x^3 + A x + B mod P</code>
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100171 * (SEC1 + RFC-4492)</li>
Rose Zadikf56cb342018-04-19 12:49:10 +0100172 * <li>Montgomery: <code>y^2 = x^3 + A x^2 + x mod P</code> (Curve25519,
Rose Zadikb2e111a2018-04-20 10:13:48 +0100173 * Curve448)</li></ul>
Rose Zadikf56cb342018-04-19 12:49:10 +0100174 * In both cases, the generator (\p G) for a prime-order subgroup is fixed.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100175 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100176 * For Short Weierstrass, this subgroup is the whole curve, and its
Rose Zadikf56cb342018-04-19 12:49:10 +0100177 * cardinality is denoted by \p N. Our code requires that \p N is an
Rose Zadikb2e111a2018-04-20 10:13:48 +0100178 * odd prime as mbedtls_ecp_mul() requires an odd number, and
179 * mbedtls_ecdsa_sign() requires that it is prime for blinding purposes.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100180 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100181 * For Montgomery curves, we do not store \p A, but <code>(A + 2) / 4</code>,
Rose Zadika7a61552018-04-24 13:14:01 +0100182 * which is the quantity used in the formulas. Additionally, \p nbits is
Rose Zadikf56cb342018-04-19 12:49:10 +0100183 * not the size of \p N but the required size for private keys.
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +0100184 *
Rose Zadika7a61552018-04-24 13:14:01 +0100185 * If \p modp is NULL, reduction modulo \p P is done using a generic algorithm.
186 * Otherwise, \p modp must point to a function that takes an \p mbedtls_mpi in the
187 * range of <code>0..2^(2*pbits)-1</code>, and transforms it in-place to an integer
188 * which is congruent mod \p P to the given MPI, and is close enough to \p pbits
189 * in size, so that it may be efficiently brought in the 0..P-1 range by a few
190 * additions or subtractions. Therefore, it is only an approximative modular
191 * reduction. It must return 0 on success and non-zero on failure.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100192 *
Janos Follathc3b680b2018-12-05 16:01:13 +0000193 * \note Alternative implementations must keep the group IDs distinct. If
194 * two group structures have the same ID, then they must be
195 * identical.
196 *
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100197 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200198typedef struct mbedtls_ecp_group
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100199{
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100200 mbedtls_ecp_group_id id; /*!< An internal group identifier. */
Rose Zadikf56cb342018-04-19 12:49:10 +0100201 mbedtls_mpi P; /*!< The prime modulus of the base field. */
Rose Zadikb2e111a2018-04-20 10:13:48 +0100202 mbedtls_mpi A; /*!< For Short Weierstrass: \p A in the equation. For
203 Montgomery curves: <code>(A + 2) / 4</code>. */
204 mbedtls_mpi B; /*!< For Short Weierstrass: \p B in the equation.
205 For Montgomery curves: unused. */
Rose Zadikf56cb342018-04-19 12:49:10 +0100206 mbedtls_ecp_point G; /*!< The generator of the subgroup used. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100207 mbedtls_mpi N; /*!< The order of \p G. */
208 size_t pbits; /*!< The number of bits in \p P.*/
Rose Zadikb2e111a2018-04-20 10:13:48 +0100209 size_t nbits; /*!< For Short Weierstrass: The number of bits in \p P.
Rose Zadika7a61552018-04-24 13:14:01 +0100210 For Montgomery curves: the number of bits in the
Rose Zadikd76ac582018-04-23 06:29:34 +0100211 private keys. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100212 unsigned int h; /*!< \internal 1 if the constants are static. */
Rose Zadika7a61552018-04-24 13:14:01 +0100213 int (*modp)(mbedtls_mpi *); /*!< The function for fast pseudo-reduction
Rose Zadikf56cb342018-04-19 12:49:10 +0100214 mod \p P (see above).*/
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100215 int (*t_pre)(mbedtls_ecp_point *, void *); /*!< Unused. */
216 int (*t_post)(mbedtls_ecp_point *, void *); /*!< Unused. */
217 void *t_data; /*!< Unused. */
218 mbedtls_ecp_point *T; /*!< Pre-computed points for ecp_mul_comb(). */
Rose Zadikb2e111a2018-04-20 10:13:48 +0100219 size_t T_size; /*!< The number of pre-computed points. */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100220}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221mbedtls_ecp_group;
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100222
Darryl Greenb7797592019-01-04 16:18:06 +0000223/**
224 * \name SECTION: Module settings
225 *
226 * The configuration options you can set for this module are in this section.
227 * Either change them in config.h, or define them using the compiler command line.
228 * \{
229 */
230
231#if !defined(MBEDTLS_ECP_MAX_BITS)
232/**
233 * The maximum size of the groups, that is, of \c N and \c P.
234 */
235#define MBEDTLS_ECP_MAX_BITS 521 /**< The maximum size of groups, in bits. */
236#endif
237
238#define MBEDTLS_ECP_MAX_BYTES ( ( MBEDTLS_ECP_MAX_BITS + 7 ) / 8 )
239#define MBEDTLS_ECP_MAX_PT_LEN ( 2 * MBEDTLS_ECP_MAX_BYTES + 1 )
240
241#if !defined(MBEDTLS_ECP_WINDOW_SIZE)
242/*
243 * Maximum "window" size used for point multiplication.
244 * Default: 6.
245 * Minimum value: 2. Maximum value: 7.
246 *
247 * Result is an array of at most ( 1 << ( MBEDTLS_ECP_WINDOW_SIZE - 1 ) )
248 * points used for point multiplication. This value is directly tied to EC
249 * peak memory usage, so decreasing it by one should roughly cut memory usage
250 * by two (if large curves are in use).
251 *
252 * Reduction in size may reduce speed, but larger curves are impacted first.
253 * Sample performances (in ECDHE handshakes/s, with FIXED_POINT_OPTIM = 1):
254 * w-size: 6 5 4 3 2
255 * 521 145 141 135 120 97
256 * 384 214 209 198 177 146
257 * 256 320 320 303 262 226
258 * 224 475 475 453 398 342
259 * 192 640 640 633 587 476
260 */
261#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< The maximum window size used. */
262#endif /* MBEDTLS_ECP_WINDOW_SIZE */
263
264#if !defined(MBEDTLS_ECP_FIXED_POINT_OPTIM)
265/*
266 * Trade memory for speed on fixed-point multiplication.
267 *
268 * This speeds up repeated multiplication of the generator (that is, the
269 * multiplication in ECDSA signatures, and half of the multiplications in
270 * ECDSA verification and ECDHE) by a factor roughly 3 to 4.
271 *
272 * The cost is increasing EC peak memory usage by a factor roughly 2.
273 *
274 * Change this value to 0 to reduce peak memory usage.
275 */
276#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up. */
277#endif /* MBEDTLS_ECP_FIXED_POINT_OPTIM */
278
279/* \} name SECTION: Module settings */
280
281#else /* MBEDTLS_ECP_ALT */
282#include "ecp_alt.h"
283#endif /* MBEDTLS_ECP_ALT */
284
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200285#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnardb5a50e72017-04-20 16:06:13 +0200286
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200287/**
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +0200288 * \brief Internal restart context for multiplication
289 *
290 * \note Opaque struct
291 */
292typedef struct mbedtls_ecp_restart_mul mbedtls_ecp_restart_mul_ctx;
293
294/**
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200295 * \brief Internal restart context for ecp_muladd()
296 *
297 * \note Opaque struct
298 */
299typedef struct mbedtls_ecp_restart_muladd mbedtls_ecp_restart_muladd_ctx;
300
301/**
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200302 * \brief General context for resuming ECC operations
303 */
304typedef struct
305{
Manuel Pégourié-Gonnard646393b2017-04-20 10:03:45 +0200306 unsigned ops_done; /*!< current ops count */
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +0200307 unsigned depth; /*!< call depth (0 = top-level) */
Manuel Pégourié-Gonnard646393b2017-04-20 10:03:45 +0200308 mbedtls_ecp_restart_mul_ctx *rsm; /*!< ecp_mul_comb() sub-context */
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200309 mbedtls_ecp_restart_muladd_ctx *ma; /*!< ecp_muladd() sub-context */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200310} mbedtls_ecp_restart_ctx;
Manuel Pégourié-Gonnardb5a50e72017-04-20 16:06:13 +0200311
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200312/*
313 * Operation counts for restartable functions
314 */
Manuel Pégourié-Gonnard5314f232017-04-21 12:36:59 +0200315#define MBEDTLS_ECP_OPS_CHK 3 /*!< basic ops count for ecp_check_pubkey() */
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200316#define MBEDTLS_ECP_OPS_DBL 8 /*!< basic ops count for ecp_double_jac() */
317#define MBEDTLS_ECP_OPS_ADD 11 /*!< basic ops count for see ecp_add_mixed() */
318#define MBEDTLS_ECP_OPS_INV 120 /*!< empirical equivalent for mpi_mod_inv() */
319
320/**
321 * \brief Internal; for restartable functions in other modules.
322 * Check and update basic ops budget.
323 *
324 * \param grp Group structure
325 * \param rs_ctx Restart context
326 * \param ops Number of basic ops to do
327 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200328 * \return \c 0 if doing \p ops basic ops is still allowed,
329 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS otherwise.
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200330 */
331int mbedtls_ecp_check_budget( const mbedtls_ecp_group *grp,
332 mbedtls_ecp_restart_ctx *rs_ctx,
333 unsigned ops );
334
335/* Utility macro for checking and updating ops budget */
Hanno Beckerabdf67e2018-10-26 13:28:32 +0100336#define MBEDTLS_ECP_BUDGET( ops ) \
337 MBEDTLS_MPI_CHK( mbedtls_ecp_check_budget( grp, rs_ctx, \
338 (unsigned) (ops) ) );
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200339
Manuel Pégourié-Gonnardb5a50e72017-04-20 16:06:13 +0200340#else /* MBEDTLS_ECP_RESTARTABLE */
341
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200342#define MBEDTLS_ECP_BUDGET( ops ) /* no-op; for compatibility */
343
Manuel Pégourié-Gonnardb5a50e72017-04-20 16:06:13 +0200344/* We want to declare restartable versions of existing functions anyway */
345typedef void mbedtls_ecp_restart_ctx;
346
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200347#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200348
Paul Bakker088c5c52014-04-25 11:11:10 +0200349/**
Jaeden Amero89453432018-04-24 17:15:38 +0100350 * \brief The ECP key-pair structure.
Ron Eldor05d0e512018-04-16 17:40:04 +0300351 *
Jaeden Amero89453432018-04-24 17:15:38 +0100352 * A generic key-pair that may be used for ECDSA and fixed ECDH, for example.
Ron Eldor05d0e512018-04-16 17:40:04 +0300353 *
Jaeden Amero89453432018-04-24 17:15:38 +0100354 * \note Members are deliberately in the same order as in the
355 * ::mbedtls_ecdsa_context structure.
Ron Eldor05d0e512018-04-16 17:40:04 +0300356 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200357typedef struct mbedtls_ecp_keypair
Ron Eldor05d0e512018-04-16 17:40:04 +0300358{
359 mbedtls_ecp_group grp; /*!< Elliptic curve and base point */
360 mbedtls_mpi d; /*!< our secret value */
361 mbedtls_ecp_point Q; /*!< our public value */
362}
363mbedtls_ecp_keypair;
364
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100365/*
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100366 * Point formats, from RFC 4492's enum ECPointFormat
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100367 */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100368#define MBEDTLS_ECP_PF_UNCOMPRESSED 0 /**< Uncompressed point format. */
369#define MBEDTLS_ECP_PF_COMPRESSED 1 /**< Compressed point format. */
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100370
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100371/*
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100372 * Some other constants from RFC 4492
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100373 */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100374#define MBEDTLS_ECP_TLS_NAMED_CURVE 3 /**< The named_curve of ECCurveType. */
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100375
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200376#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100377/**
378 * \brief Set the maximum number of basic operations done in a row.
379 *
380 * If more operations are needed to complete a computation,
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200381 * #MBEDTLS_ERR_ECP_IN_PROGRESS will be returned by the
Manuel Pégourié-Gonnard8467e682017-04-20 09:47:06 +0200382 * function performing the computation. It is then the
383 * caller's responsibility to either call again with the same
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +0200384 * parameters until it returns 0 or an error code; or to free
Manuel Pégourié-Gonnard8467e682017-04-20 09:47:06 +0200385 * the restart context if the operation is to be aborted.
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100386 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +0200387 * It is strictly required that all input parameters and the
388 * restart context be the same on successive calls for the
389 * same operation, but output parameters need not be the
390 * same; they must not be used until the function finally
391 * returns 0.
392 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +0200393 * This only applies to functions whose documentation
394 * mentions they may return #MBEDTLS_ERR_ECP_IN_PROGRESS (or
395 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS for functions in the
396 * SSL module). For functions that accept a "restart context"
397 * argument, passing NULL disables restart and makes the
398 * function equivalent to the function with the same name
399 * with \c _restartable removed. For functions in the ECDH
400 * module, restart is disabled unless the function accepts
401 * an "ECDH context" argument and
402 * mbedtls_ecdh_enable_restart() was previously called on
403 * that context. For function in the SSL module, restart is
404 * only enabled for specific sides and key exchanges
405 * (currently only for clients and ECDHE-ECDSA).
Manuel Pégourié-Gonnard8f28add2017-04-19 10:20:49 +0200406 *
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100407 * \param max_ops Maximum number of basic operations done in a row.
408 * Default: 0 (unlimited).
409 * Lower (non-zero) values mean ECC functions will block for
410 * a lesser maximum amount of time.
411 *
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100412 * \note A "basic operation" is defined as a rough equivalent of a
413 * multiplication in GF(p) for the NIST P-256 curve.
414 * As an indication, with default settings, a scalar
415 * multiplication (full run of \c mbedtls_ecp_mul()) is:
416 * - about 3300 basic operations for P-256
417 * - about 9400 basic operations for P-384
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100418 *
Manuel Pégourié-Gonnarde58f65a2017-03-20 14:59:54 +0100419 * \note Very low values are not always respected: sometimes
Manuel Pégourié-Gonnard1c678e02017-03-20 13:39:39 +0100420 * functions need to block for a minimum number of
421 * operations, and will do so even if max_ops is set to a
422 * lower value. That minimum depends on the curve size, and
423 * can be made lower by decreasing the value of
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +0200424 * \c MBEDTLS_ECP_WINDOW_SIZE. As an indication, here is the
425 * lowest effective value for various curves and values of
426 * that parameter (w for short):
427 * w=6 w=5 w=4 w=3 w=2
428 * P-256 208 208 160 136 124
429 * P-384 682 416 320 272 248
430 * P-521 1364 832 640 544 496
Manuel Pégourié-Gonnarde58f65a2017-03-20 14:59:54 +0100431 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200432 * \note This setting is currently ignored by Curve25519.
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100433 */
434void mbedtls_ecp_set_max_ops( unsigned max_ops );
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200435
436/**
437 * \brief Check if restart is enabled (max_ops != 0)
438 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200439 * \return \c 0 if \c max_ops == 0 (restart disabled)
440 * \return \c 1 otherwise (restart enabled)
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200441 */
Manuel Pégourié-Gonnardb843b152018-10-16 10:41:31 +0200442int mbedtls_ecp_restart_is_enabled( void );
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200443#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100444
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100445/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100446 * \brief This function retrieves the information defined in
Rose Zadikf56cb342018-04-19 12:49:10 +0100447 * mbedtls_ecp_curve_info() for all supported curves in order
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100448 * of preference.
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200449 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100450 * \return A statically allocated array. The last entry is 0.
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200452const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list( void );
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200453
454/**
Rose Zadikf56cb342018-04-19 12:49:10 +0100455 * \brief This function retrieves the list of internal group
456 * identifiers of all supported curves in the order of
457 * preference.
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100458 *
459 * \return A statically allocated array,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200460 * terminated with MBEDTLS_ECP_DP_NONE.
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200462const mbedtls_ecp_group_id *mbedtls_ecp_grp_id_list( void );
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100463
464/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100465 * \brief This function retrieves curve information from an internal
466 * group identifier.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200467 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100468 * \param grp_id An \c MBEDTLS_ECP_DP_XXX value.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200469 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100470 * \return The associated curve information on success.
471 * \return NULL on failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200473const 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 +0200474
475/**
Rose Zadika7a61552018-04-24 13:14:01 +0100476 * \brief This function retrieves curve information from a TLS
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100477 * NamedCurve value.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200478 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100479 * \param tls_id An \c MBEDTLS_ECP_DP_XXX value.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200480 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100481 * \return The associated curve information on success.
482 * \return NULL on failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_tls_id( uint16_t tls_id );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200485
486/**
Rose Zadika7a61552018-04-24 13:14:01 +0100487 * \brief This function retrieves curve information from a
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100488 * human-readable name.
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100489 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100490 * \param name The human-readable name.
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100491 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100492 * \return The associated curve information on success.
493 * \return NULL on failure.
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200495const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_name( const char *name );
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100496
497/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100498 * \brief This function initializes a point as zero.
499 *
500 * \param pt The point to initialize.
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200502void mbedtls_ecp_point_init( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100503
504/**
Rose Zadikf56cb342018-04-19 12:49:10 +0100505 * \brief This function initializes an ECP group context
Rose Zadika7a61552018-04-24 13:14:01 +0100506 * without loading any domain parameters.
Rose Zadikf56cb342018-04-19 12:49:10 +0100507 *
508 * \note After this function is called, domain parameters
509 * for various ECP groups can be loaded through the
Gilles Peskine4dc50bc2018-11-07 22:06:48 +0100510 * mbedtls_ecp_group_load() or mbedtls_ecp_tls_read_group()
Rose Zadikf56cb342018-04-19 12:49:10 +0100511 * functions.
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513void mbedtls_ecp_group_init( mbedtls_ecp_group *grp );
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100514
515/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100516 * \brief This function initializes a key pair as an invalid one.
517 *
518 * \param key The key pair to initialize.
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200520void mbedtls_ecp_keypair_init( mbedtls_ecp_keypair *key );
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200521
522/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100523 * \brief This function frees the components of a point.
524 *
525 * \param pt The point to free.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527void mbedtls_ecp_point_free( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100528
529/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100530 * \brief This function frees the components of an ECP group.
Hanno Beckerebffa792018-12-14 15:07:50 +0000531 *
532 * \param grp The group to free. This may be \c NULL, in which
Hanno Becker486f1b32018-12-18 13:00:34 +0000533 * case this function returns immediately. If it is not
534 * \c NULL, it must point to an initialized ECP group.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536void mbedtls_ecp_group_free( mbedtls_ecp_group *grp );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100537
538/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100539 * \brief This function frees the components of a key pair.
Hanno Beckerebffa792018-12-14 15:07:50 +0000540 *
541 * \param key The key pair to free. This may be \c NULL, in which
Hanno Becker486f1b32018-12-18 13:00:34 +0000542 * case this function returns immediately. If it is not
543 * \c NULL, it must point to an initialized ECP key pair.
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545void mbedtls_ecp_keypair_free( mbedtls_ecp_keypair *key );
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200546
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200547#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200548/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000549 * \brief Initialize a restart context.
550 *
551 * \param ctx The restart context to initialize. This must
552 * not be \c NULL.
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200553 */
554void mbedtls_ecp_restart_init( mbedtls_ecp_restart_ctx *ctx );
555
556/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000557 * \brief Free the components of a restart context.
558 *
559 * \param ctx The restart context to free. This may be \c NULL, in which
Hanno Becker486f1b32018-12-18 13:00:34 +0000560 * case this function returns immediately. If it is not
561 * \c NULL, it must point to an initialized restart context.
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200562 */
563void mbedtls_ecp_restart_free( mbedtls_ecp_restart_ctx *ctx );
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200564#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200565
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200566/**
Rose Zadika7a61552018-04-24 13:14:01 +0100567 * \brief This function copies the contents of point \p Q into
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100568 * point \p P.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100569 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000570 * \param P The destination point. This must be initialized.
571 * \param Q The source point. This must be initialized.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100572 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100573 * \return \c 0 on success.
Rose Zadikf56cb342018-04-19 12:49:10 +0100574 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000575 * \return Another negative error code for other kinds of failure.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200577int mbedtls_ecp_copy( mbedtls_ecp_point *P, const mbedtls_ecp_point *Q );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100578
579/**
Rose Zadika7a61552018-04-24 13:14:01 +0100580 * \brief This function copies the contents of group \p src into
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100581 * group \p dst.
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200582 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000583 * \param dst The destination group. This must be initialized.
584 * \param src The source group. This must be initialized.
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200585 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100586 * \return \c 0 on success.
Rose Zadikf56cb342018-04-19 12:49:10 +0100587 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000588 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200589 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000590int mbedtls_ecp_group_copy( mbedtls_ecp_group *dst,
591 const mbedtls_ecp_group *src );
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200592
593/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000594 * \brief This function sets a point to the point at infinity.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200595 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000596 * \param pt The point to set. This must be initialized.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200597 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100598 * \return \c 0 on success.
Rose Zadikf56cb342018-04-19 12:49:10 +0100599 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000600 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602int mbedtls_ecp_set_zero( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200603
604/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000605 * \brief This function checks if a point is the point at infinity.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200606 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000607 * \param pt The point to test. This must be initialized.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200608 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100609 * \return \c 1 if the point is zero.
610 * \return \c 0 if the point is non-zero.
Hanno Beckerebffa792018-12-14 15:07:50 +0000611 * \return A negative error code on failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200613int mbedtls_ecp_is_zero( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200614
615/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100616 * \brief This function compares two points.
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200617 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100618 * \note This assumes that the points are normalized. Otherwise,
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200619 * they may compare as "not equal" even if they are.
620 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000621 * \param P The first point to compare. This must be initialized.
622 * \param Q The second point to compare. This must be initialized.
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200623 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100624 * \return \c 0 if the points are equal.
625 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the points are not equal.
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200626 */
627int mbedtls_ecp_point_cmp( const mbedtls_ecp_point *P,
628 const mbedtls_ecp_point *Q );
629
630/**
Rose Zadika7a61552018-04-24 13:14:01 +0100631 * \brief This function imports a non-zero point from two ASCII
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100632 * strings.
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100633 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000634 * \param P The destination point. This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100635 * \param radix The numeric base of the input.
636 * \param x The first affine coordinate, as a null-terminated string.
637 * \param y The second affine coordinate, as a null-terminated string.
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100638 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100639 * \return \c 0 on success.
640 * \return An \c MBEDTLS_ERR_MPI_XXX error code on failure.
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100641 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200642int mbedtls_ecp_point_read_string( mbedtls_ecp_point *P, int radix,
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100643 const char *x, const char *y );
644
645/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100646 * \brief This function exports a point into unsigned binary data.
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100647 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100648 * \param grp The group to which the point should belong.
Hanno Beckerebffa792018-12-14 15:07:50 +0000649 * This must be initialized and have group parameters
650 * set, for example through mbedtls_ecp_group_load().
651 * \param P The point to export. This must be initialized.
652 * \param format The point format. This must be either
653 * #MBEDTLS_ECP_PF_COMPRESSED or #MBEDTLS_ECP_PF_UNCOMPRESSED.
654 * \param olen The address at which to store the length of
Hanno Becker5edcfa52018-12-18 12:49:55 +0000655 * the output in Bytes. This must not be \c NULL.
Hanno Beckerebffa792018-12-14 15:07:50 +0000656 * \param buf The output buffer. This must be a writable buffer
657 * of length \p buflen Bytes.
658 * \param buflen The length of the output buffer \p buf in Bytes.
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100659 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100660 * \return \c 0 on success.
Hanno Beckerebffa792018-12-14 15:07:50 +0000661 * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the output buffer
662 * is too small to hold the point.
663 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665int mbedtls_ecp_point_write_binary( const mbedtls_ecp_group *grp, const mbedtls_ecp_point *P,
Manuel Pégourié-Gonnard420f1eb2013-02-10 12:22:46 +0100666 int format, size_t *olen,
Manuel Pégourié-Gonnard7e860252013-02-10 10:58:48 +0100667 unsigned char *buf, size_t buflen );
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100668
669/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100670 * \brief This function imports a point from unsigned binary data.
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100671 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100672 * \note This function does not check that the point actually
Rose Zadika7a61552018-04-24 13:14:01 +0100673 * belongs to the given group, see mbedtls_ecp_check_pubkey()
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100674 * for that.
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100675 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100676 * \param grp The group to which the point should belong.
Hanno Beckerebffa792018-12-14 15:07:50 +0000677 * This must be initialized and have group parameters
678 * set, for example through mbedtls_ecp_group_load().
679 * \param P The destination context to import the point to.
680 * This must be initialized.
681 * \param buf The input buffer. This must be a readable buffer
682 * of length \p ilen Bytes.
683 * \param ilen The length of the input buffer \p buf in Bytes.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100684 *
685 * \return \c 0 on success.
Hanno Beckerebffa792018-12-14 15:07:50 +0000686 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the input is invalid.
Rose Zadikf56cb342018-04-19 12:49:10 +0100687 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100688 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the point format
Manuel Pégourié-Gonnard5246ee52014-03-19 16:18:38 +0100689 * is not implemented.
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100690 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000691int mbedtls_ecp_point_read_binary( const mbedtls_ecp_group *grp,
692 mbedtls_ecp_point *P,
693 const unsigned char *buf, size_t ilen );
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100694
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100695/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100696 * \brief This function imports a point from a TLS ECPoint record.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200697 *
Janos Follath89ac8c92018-10-30 11:24:05 +0000698 * \note On function return, \p *buf is updated to point immediately
Rose Zadikf56cb342018-04-19 12:49:10 +0100699 * after the ECPoint record.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200700 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000701 * \param grp The ECP group to use.
702 * This must be initialized and have group parameters
703 * set, for example through mbedtls_ecp_group_load().
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100704 * \param pt The destination point.
Rose Zadikf56cb342018-04-19 12:49:10 +0100705 * \param buf The address of the pointer to the start of the input buffer.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100706 * \param len The length of the buffer.
Manuel Pégourié-Gonnard150c4f62014-11-21 09:14:52 +0100707 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100708 * \return \c 0 on success.
Janos Follath89ac8c92018-10-30 11:24:05 +0000709 * \return An \c MBEDTLS_ERR_MPI_XXX error code on initialization
710 * failure.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100711 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200712 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000713int mbedtls_ecp_tls_read_point( const mbedtls_ecp_group *grp,
714 mbedtls_ecp_point *pt,
715 const unsigned char **buf, size_t len );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200716
717/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000718 * \brief This function exports a point as a TLS ECPoint record
719 * defined in RFC 4492, Section 5.4.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200720 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000721 * \param grp The ECP group to use.
722 * This must be initialized and have group parameters
723 * set, for example through mbedtls_ecp_group_load().
724 * \param pt The point to be exported. This must be initialized.
725 * \param format The point format to use. This must be either
726 * #MBEDTLS_ECP_PF_COMPRESSED or #MBEDTLS_ECP_PF_UNCOMPRESSED.
727 * \param olen The address at which to store the length in Bytes
728 * of the data written.
729 * \param buf The target buffer. This must be a writable buffer of
730 * length \p blen Bytes.
731 * \param blen The length of the target buffer \p buf in Bytes.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200732 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100733 * \return \c 0 on success.
Hanno Beckerebffa792018-12-14 15:07:50 +0000734 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the input is invalid.
735 * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the target buffer
736 * is too small to hold the exported point.
737 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200738 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000739int mbedtls_ecp_tls_write_point( const mbedtls_ecp_group *grp,
740 const mbedtls_ecp_point *pt,
741 int format, size_t *olen,
742 unsigned char *buf, size_t blen );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200743
744/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000745 * \brief This function sets up an ECP group context
746 * from a standardized set of domain parameters.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100747 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100748 * \note The index should be a value of the NamedCurve enum,
Rose Zadika7a61552018-04-24 13:14:01 +0100749 * as defined in <em>RFC-4492: Elliptic Curve Cryptography
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100750 * (ECC) Cipher Suites for Transport Layer Security (TLS)</em>,
751 * usually in the form of an \c MBEDTLS_ECP_DP_XXX macro.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100752 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000753 * \param grp The group context to setup. This must be initialized.
Rose Zadikf56cb342018-04-19 12:49:10 +0100754 * \param id The identifier of the domain parameter set to load.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100755 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000756 * \return \c 0 on success.
757 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if \p id doesn't
758 * correspond to a known group.
759 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100760 */
Hanno Becker61937d42017-04-26 15:01:23 +0100761int mbedtls_ecp_group_load( mbedtls_ecp_group *grp, mbedtls_ecp_group_id id );
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100762
763/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000764 * \brief This function sets up an ECP group context from a TLS
765 * ECParameters record as defined in RFC 4492, Section 5.4.
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100766 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000767 * \note The read pointer \p buf is updated to point right after
768 * the ECParameters record on exit.
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100769 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000770 * \param grp The group context to setup. This must be initialized.
Rose Zadikf56cb342018-04-19 12:49:10 +0100771 * \param buf The address of the pointer to the start of the input buffer.
Hanno Beckerebffa792018-12-14 15:07:50 +0000772 * \param len The length of the input buffer \c *buf in Bytes.
Manuel Pégourié-Gonnard150c4f62014-11-21 09:14:52 +0100773 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100774 * \return \c 0 on success.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100775 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid.
Janos Follath89ac8c92018-10-30 11:24:05 +0000776 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the group is not
Hanno Beckerebffa792018-12-14 15:07:50 +0000777 * recognized.
778 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100779 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000780int mbedtls_ecp_tls_read_group( mbedtls_ecp_group *grp,
781 const unsigned char **buf, size_t len );
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100782
783/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000784 * \brief This function extracts an elliptic curve group ID from a
785 * TLS ECParameters record as defined in RFC 4492, Section 5.4.
Janos Follath89ac8c92018-10-30 11:24:05 +0000786 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000787 * \note The read pointer \p buf is updated to point right after
788 * the ECParameters record on exit.
Janos Follath89ac8c92018-10-30 11:24:05 +0000789 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000790 * \param grp The address at which to store the group id.
791 * This must not be \c NULL.
Janos Follath89ac8c92018-10-30 11:24:05 +0000792 * \param buf The address of the pointer to the start of the input buffer.
Hanno Beckerebffa792018-12-14 15:07:50 +0000793 * \param len The length of the input buffer \c *buf in Bytes.
Janos Follath89ac8c92018-10-30 11:24:05 +0000794 *
795 * \return \c 0 on success.
796 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid.
797 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the group is not
Hanno Beckerebffa792018-12-14 15:07:50 +0000798 * recognized.
799 * \return Another negative error code on other kinds of failure.
Janos Follath89ac8c92018-10-30 11:24:05 +0000800 */
801int mbedtls_ecp_tls_read_group_id( mbedtls_ecp_group_id *grp,
Hanno Beckerebffa792018-12-14 15:07:50 +0000802 const unsigned char **buf,
803 size_t len );
Janos Follath89ac8c92018-10-30 11:24:05 +0000804/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000805 * \brief This function exports an elliptic curve as a TLS
806 * ECParameters record as defined in RFC 4492, Section 5.4.
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100807 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000808 * \param grp The ECP group to be exported.
809 * This must be initialized and have group parameters
810 * set, for example through mbedtls_ecp_group_load().
811 * \param olen The address at which to store the number of Bytes written.
812 * This must not be \c NULL.
813 * \param buf The buffer to write to. This must be a writable buffer
814 * of length \p blen Bytes.
815 * \param blen The length of the output buffer \p buf in Bytes.
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100816 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100817 * \return \c 0 on success.
Hanno Beckerebffa792018-12-14 15:07:50 +0000818 * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the output
819 * buffer is too small to hold the exported group.
820 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100821 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000822int mbedtls_ecp_tls_write_group( const mbedtls_ecp_group *grp,
823 size_t *olen,
824 unsigned char *buf, size_t blen );
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100825
826/**
Hanno Becker5edcfa52018-12-18 12:49:55 +0000827 * \brief This function performs a scalar multiplication of a point
Hanno Beckerebffa792018-12-14 15:07:50 +0000828 * by an integer: \p R = \p m * \p P.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100829 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100830 * It is not thread-safe to use same group in multiple threads.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200831 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100832 * \note To prevent timing attacks, this function
833 * executes the exact same sequence of base-field
834 * operations for any valid \p m. It avoids any if-branch or
835 * array index depending on the value of \p m.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200836 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100837 * \note If \p f_rng is not NULL, it is used to randomize
838 * intermediate results to prevent potential timing attacks
839 * targeting these results. We recommend always providing
840 * a non-NULL \p f_rng. The overhead is negligible.
Manuel Pégourié-Gonnardb34aeeb2020-06-04 10:20:12 +0200841 * Note: unless #MBEDTLS_ECP_NO_INTERNAL_RNG is defined, when
842 * \p f_rng is NULL, an internal RNG (seeded from the value
843 * of \p m) will be used instead.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100844 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000845 * \param grp The ECP group to use.
846 * This must be initialized and have group parameters
847 * set, for example through mbedtls_ecp_group_load().
848 * \param R The point in which to store the result of the calculation.
849 * This must be initialized.
850 * \param m The integer by which to multiply. This must be initialized.
851 * \param P The point to multiply. This must be initialized.
852 * \param f_rng The RNG function. This may be \c NULL if randomization
853 * of intermediate results isn't desired (discouraged).
854 * \param p_rng The RNG context to be passed to \p p_rng.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100855 *
856 * \return \c 0 on success.
Rose Zadikf56cb342018-04-19 12:49:10 +0100857 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m is not a valid private
858 * key, or \p P is not a valid public key.
859 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000860 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200861 */
862int mbedtls_ecp_mul( mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
863 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
864 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
865
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200866/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200867 * \brief This function performs multiplication of a point by
868 * an integer: \p R = \p m * \p P in a restartable way.
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200869 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200870 * \see mbedtls_ecp_mul()
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200871 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200872 * \note This function does the same as \c mbedtls_ecp_mul(), but
873 * it can return early and restart according to the limit set
874 * with \c mbedtls_ecp_set_max_ops() to reduce blocking.
875 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000876 * \param grp The ECP group to use.
877 * This must be initialized and have group parameters
878 * set, for example through mbedtls_ecp_group_load().
879 * \param R The point in which to store the result of the calculation.
880 * This must be initialized.
881 * \param m The integer by which to multiply. This must be initialized.
882 * \param P The point to multiply. This must be initialized.
883 * \param f_rng The RNG function. This may be \c NULL if randomization
884 * of intermediate results isn't desired (discouraged).
885 * \param p_rng The RNG context to be passed to \p p_rng.
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200886 * \param rs_ctx The restart context (NULL disables restart).
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200887 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200888 * \return \c 0 on success.
889 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m is not a valid private
890 * key, or \p P is not a valid public key.
891 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
892 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard8467e682017-04-20 09:47:06 +0200893 * operations was reached: see \c mbedtls_ecp_set_max_ops().
Hanno Beckerebffa792018-12-14 15:07:50 +0000894 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100895 */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200896int mbedtls_ecp_mul_restartable( mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200898 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
899 mbedtls_ecp_restart_ctx *rs_ctx );
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100900
901/**
Rose Zadika7a61552018-04-24 13:14:01 +0100902 * \brief This function performs multiplication and addition of two
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100903 * points by integers: \p R = \p m * \p P + \p n * \p Q
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200904 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100905 * It is not thread-safe to use same group in multiple threads.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200906 *
Rose Zadika7a61552018-04-24 13:14:01 +0100907 * \note In contrast to mbedtls_ecp_mul(), this function does not
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100908 * guarantee a constant execution flow and timing.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200909 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000910 * \param grp The ECP group to use.
911 * This must be initialized and have group parameters
912 * set, for example through mbedtls_ecp_group_load().
913 * \param R The point in which to store the result of the calculation.
914 * This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100915 * \param m The integer by which to multiply \p P.
Hanno Beckerebffa792018-12-14 15:07:50 +0000916 * This must be initialized.
917 * \param P The point to multiply by \p m. This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100918 * \param n The integer by which to multiply \p Q.
Hanno Beckerebffa792018-12-14 15:07:50 +0000919 * This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100920 * \param Q The point to be multiplied by \p n.
Hanno Beckerebffa792018-12-14 15:07:50 +0000921 * This must be initialized.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200922 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100923 * \return \c 0 on success.
Rose Zadika7a61552018-04-24 13:14:01 +0100924 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m or \p n are not
925 * valid private keys, or \p P or \p Q are not valid public
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100926 * keys.
Rose Zadikf56cb342018-04-19 12:49:10 +0100927 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000928 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200929 */
930int mbedtls_ecp_muladd( mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
931 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
932 const mbedtls_mpi *n, const mbedtls_ecp_point *Q );
933
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200934/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200935 * \brief This function performs multiplication and addition of two
936 * points by integers: \p R = \p m * \p P + \p n * \p Q in a
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200937 * restartable way.
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200938 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200939 * \see \c mbedtls_ecp_muladd()
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200940 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200941 * \note This function works the same as \c mbedtls_ecp_muladd(),
942 * but it can return early and restart according to the limit
943 * set with \c mbedtls_ecp_set_max_ops() to reduce blocking.
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200944 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000945 * \param grp The ECP group to use.
946 * This must be initialized and have group parameters
947 * set, for example through mbedtls_ecp_group_load().
948 * \param R The point in which to store the result of the calculation.
949 * This must be initialized.
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200950 * \param m The integer by which to multiply \p P.
Hanno Beckerebffa792018-12-14 15:07:50 +0000951 * This must be initialized.
952 * \param P The point to multiply by \p m. This must be initialized.
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200953 * \param n The integer by which to multiply \p Q.
Hanno Beckerebffa792018-12-14 15:07:50 +0000954 * This must be initialized.
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200955 * \param Q The point to be multiplied by \p n.
Hanno Beckerebffa792018-12-14 15:07:50 +0000956 * This must be initialized.
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200957 * \param rs_ctx The restart context (NULL disables restart).
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200958 *
959 * \return \c 0 on success.
960 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m or \p n are not
961 * valid private keys, or \p P or \p Q are not valid public
962 * keys.
963 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
964 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200965 * operations was reached: see \c mbedtls_ecp_set_max_ops().
Hanno Beckerebffa792018-12-14 15:07:50 +0000966 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200967 */
968int mbedtls_ecp_muladd_restartable(
969 mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
970 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
971 const mbedtls_mpi *n, const mbedtls_ecp_point *Q,
972 mbedtls_ecp_restart_ctx *rs_ctx );
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200973
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200974/**
Rose Zadika7a61552018-04-24 13:14:01 +0100975 * \brief This function checks that a point is a valid public key
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100976 * on this curve.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200977 *
Rose Zadika7a61552018-04-24 13:14:01 +0100978 * It only checks that the point is non-zero, has
979 * valid coordinates and lies on the curve. It does not verify
980 * that it is indeed a multiple of \p G. This additional
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100981 * check is computationally more expensive, is not required
982 * by standards, and should not be necessary if the group
Rose Zadika7a61552018-04-24 13:14:01 +0100983 * used has a small cofactor. In particular, it is useless for
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100984 * the NIST groups which all have a cofactor of 1.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200985 *
Rose Zadika7a61552018-04-24 13:14:01 +0100986 * \note This function uses bare components rather than an
987 * ::mbedtls_ecp_keypair structure, to ease use with other
988 * structures, such as ::mbedtls_ecdh_context or
Rose Zadikb2e111a2018-04-20 10:13:48 +0100989 * ::mbedtls_ecdsa_context.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200990 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000991 * \param grp The ECP group the point should belong to.
992 * This must be initialized and have group parameters
993 * set, for example through mbedtls_ecp_group_load().
994 * \param pt The point to check. This must be initialized.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200995 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100996 * \return \c 0 if the point is a valid public key.
Hanno Beckerebffa792018-12-14 15:07:50 +0000997 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if the point is not
998 * a valid public key for the given curve.
999 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001000 */
Hanno Beckerebffa792018-12-14 15:07:50 +00001001int mbedtls_ecp_check_pubkey( const mbedtls_ecp_group *grp,
1002 const mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001003
1004/**
Hanno Beckerebffa792018-12-14 15:07:50 +00001005 * \brief This function checks that an \p mbedtls_mpi is a
1006 * valid private key for this curve.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001007 *
Rose Zadika7a61552018-04-24 13:14:01 +01001008 * \note This function uses bare components rather than an
1009 * ::mbedtls_ecp_keypair structure to ease use with other
1010 * structures, such as ::mbedtls_ecdh_context or
Rose Zadikb2e111a2018-04-20 10:13:48 +01001011 * ::mbedtls_ecdsa_context.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001012 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001013 * \param grp The ECP group the private key should belong to.
1014 * This must be initialized and have group parameters
1015 * set, for example through mbedtls_ecp_group_load().
1016 * \param d The integer to check. This must be initialized.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001017 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001018 * \return \c 0 if the point is a valid private key.
Hanno Beckerebffa792018-12-14 15:07:50 +00001019 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if the point is not a valid
1020 * private key for the given curve.
1021 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001022 */
Hanno Beckerebffa792018-12-14 15:07:50 +00001023int mbedtls_ecp_check_privkey( const mbedtls_ecp_group *grp,
1024 const mbedtls_mpi *d );
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001025
1026/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +02001027 * \brief This function generates a private key.
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02001028 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001029 * \param grp The ECP group to generate a private key for.
1030 * This must be initialized and have group parameters
1031 * set, for example through mbedtls_ecp_group_load().
1032 * \param d The destination MPI (secret part). This must be initialized.
1033 * \param f_rng The RNG function. This must not be \c NULL.
1034 * \param p_rng The RNG parameter to be passed to \p f_rng. This may be
1035 * \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02001036 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +02001037 * \return \c 0 on success.
1038 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code
1039 * on failure.
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02001040 */
1041int mbedtls_ecp_gen_privkey( const mbedtls_ecp_group *grp,
1042 mbedtls_mpi *d,
1043 int (*f_rng)(void *, unsigned char *, size_t),
1044 void *p_rng );
1045
1046/**
Rose Zadika7a61552018-04-24 13:14:01 +01001047 * \brief This function generates a keypair with a configurable base
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001048 * point.
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001049 *
Rose Zadika7a61552018-04-24 13:14:01 +01001050 * \note This function uses bare components rather than an
1051 * ::mbedtls_ecp_keypair structure to ease use with other
1052 * structures, such as ::mbedtls_ecdh_context or
Rose Zadikb2e111a2018-04-20 10:13:48 +01001053 * ::mbedtls_ecdsa_context.
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001054 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001055 * \param grp The ECP group to generate a key pair for.
1056 * This must be initialized and have group parameters
1057 * set, for example through mbedtls_ecp_group_load().
1058 * \param G The base point to use. This must be initialized
1059 * and belong to \p grp. It replaces the default base
1060 * point \c grp->G used by mbedtls_ecp_gen_keypair().
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001061 * \param d The destination MPI (secret part).
Hanno Beckerebffa792018-12-14 15:07:50 +00001062 * This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001063 * \param Q The destination point (public part).
Hanno Beckerebffa792018-12-14 15:07:50 +00001064 * This must be initialized.
1065 * \param f_rng The RNG function. This must not be \c NULL.
1066 * \param p_rng The RNG context to be passed to \p f_rng. This may
1067 * be \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001068 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001069 * \return \c 0 on success.
1070 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code
1071 * on failure.
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001072 */
1073int mbedtls_ecp_gen_keypair_base( mbedtls_ecp_group *grp,
Hanno Beckerebffa792018-12-14 15:07:50 +00001074 const mbedtls_ecp_point *G,
1075 mbedtls_mpi *d, mbedtls_ecp_point *Q,
1076 int (*f_rng)(void *, unsigned char *, size_t),
1077 void *p_rng );
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001078
1079/**
Rose Zadikf56cb342018-04-19 12:49:10 +01001080 * \brief This function generates an ECP keypair.
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01001081 *
Rose Zadika7a61552018-04-24 13:14:01 +01001082 * \note This function uses bare components rather than an
1083 * ::mbedtls_ecp_keypair structure to ease use with other
1084 * structures, such as ::mbedtls_ecdh_context or
Rose Zadikb2e111a2018-04-20 10:13:48 +01001085 * ::mbedtls_ecdsa_context.
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01001086 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001087 * \param grp The ECP group to generate a key pair for.
1088 * This must be initialized and have group parameters
1089 * set, for example through mbedtls_ecp_group_load().
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001090 * \param d The destination MPI (secret part).
Hanno Beckerebffa792018-12-14 15:07:50 +00001091 * This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001092 * \param Q The destination point (public part).
Hanno Beckerebffa792018-12-14 15:07:50 +00001093 * This must be initialized.
1094 * \param f_rng The RNG function. This must not be \c NULL.
1095 * \param p_rng The RNG context to be passed to \p f_rng. This may
1096 * be \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001097 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001098 * \return \c 0 on success.
1099 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code
1100 * on failure.
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01001101 */
Hanno Beckerebffa792018-12-14 15:07:50 +00001102int mbedtls_ecp_gen_keypair( mbedtls_ecp_group *grp, mbedtls_mpi *d,
1103 mbedtls_ecp_point *Q,
1104 int (*f_rng)(void *, unsigned char *, size_t),
1105 void *p_rng );
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01001106
1107/**
Rose Zadikf56cb342018-04-19 12:49:10 +01001108 * \brief This function generates an ECP key.
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001109 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001110 * \param grp_id The ECP group identifier.
Hanno Beckerebffa792018-12-14 15:07:50 +00001111 * \param key The destination key. This must be initialized.
1112 * \param f_rng The RNG function to use. This must not be \c NULL.
1113 * \param p_rng The RNG context to be passed to \p f_rng. This may
1114 * be \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001115 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001116 * \return \c 0 on success.
1117 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code
1118 * on failure.
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120int mbedtls_ecp_gen_key( mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
Hanno Beckerebffa792018-12-14 15:07:50 +00001121 int (*f_rng)(void *, unsigned char *, size_t),
1122 void *p_rng );
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001123
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001124/**
Rose Zadika7a61552018-04-24 13:14:01 +01001125 * \brief This function checks that the keypair objects
Rose Zadikb2e111a2018-04-20 10:13:48 +01001126 * \p pub and \p prv have the same group and the
1127 * same public point, and that the private key in
1128 * \p prv is consistent with the public key.
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001129 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001130 * \param pub The keypair structure holding the public key. This
1131 * must be initialized. If it contains a private key, that
1132 * part is ignored.
Rose Zadikb2e111a2018-04-20 10:13:48 +01001133 * \param prv The keypair structure holding the full keypair.
Hanno Beckerebffa792018-12-14 15:07:50 +00001134 * This must be initialized.
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001135 *
Rose Zadika7a61552018-04-24 13:14:01 +01001136 * \return \c 0 on success, meaning that the keys are valid and match.
Rose Zadikb2e111a2018-04-20 10:13:48 +01001137 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the keys are invalid or do not match.
Rose Zadika7a61552018-04-24 13:14:01 +01001138 * \return An \c MBEDTLS_ERR_ECP_XXX or an \c MBEDTLS_ERR_MPI_XXX
Rose Zadikb2e111a2018-04-20 10:13:48 +01001139 * error code on calculation failure.
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001140 */
Hanno Beckerebffa792018-12-14 15:07:50 +00001141int mbedtls_ecp_check_pub_priv( const mbedtls_ecp_keypair *pub,
1142 const mbedtls_ecp_keypair *prv );
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#if defined(MBEDTLS_SELF_TEST)
Janos Follathb0697532016-08-18 12:38:46 +01001145
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001146/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001147 * \brief The ECP checkup routine.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001148 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001149 * \return \c 0 on success.
1150 * \return \c 1 on failure.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152int mbedtls_ecp_self_test( int verbose );
Janos Follathb0697532016-08-18 12:38:46 +01001153
Janos Follath372697b2016-10-28 16:53:11 +01001154#endif /* MBEDTLS_SELF_TEST */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001155
1156#ifdef __cplusplus
1157}
1158#endif
1159
Paul Bakker9af723c2014-05-01 13:03:14 +02001160#endif /* ecp.h */