blob: 384286edb464f23ef05aabd49a3b6e44e18dc7bd [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/*
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010018 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020019 * SPDX-License-Identifier: Apache-2.0
20 *
21 * Licensed under the Apache License, Version 2.0 (the "License"); you may
22 * not use this file except in compliance with the License.
23 * You may obtain a copy of the License at
24 *
25 * http://www.apache.org/licenses/LICENSE-2.0
26 *
27 * Unless required by applicable law or agreed to in writing, software
28 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
29 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
30 * See the License for the specific language governing permissions and
31 * limitations under the License.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010032 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010033 * This file is part of Mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010034 */
Rose Zadika7a61552018-04-24 13:14:01 +010035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020036#ifndef MBEDTLS_ECP_H
37#define MBEDTLS_ECP_H
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010038
Ron Eldor8b0cf2e2018-02-14 16:02:41 +020039#if !defined(MBEDTLS_CONFIG_FILE)
40#include "config.h"
41#else
42#include MBEDTLS_CONFIG_FILE
43#endif
44
Manuel Pégourié-Gonnardbdc96762013-10-03 11:50:39 +020045#include "bignum.h"
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010046
47/*
Manuel Pégourié-Gonnard7cfcea32012-11-05 10:06:12 +010048 * ECP error codes
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_ERR_ECP_BAD_INPUT_DATA -0x4F80 /**< Bad input parameters to function. */
51#define MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL -0x4F00 /**< The buffer is too small to write to. */
Rose Zadikd3534052018-04-23 16:12:42 +010052#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 +020053#define MBEDTLS_ERR_ECP_VERIFY_FAILED -0x4E00 /**< The signature is not valid. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +020054#define MBEDTLS_ERR_ECP_ALLOC_FAILED -0x4D80 /**< Memory allocation failed. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010055#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 +020056#define MBEDTLS_ERR_ECP_INVALID_KEY -0x4C80 /**< Invalid private or public key. */
Gilles Peskine5114d3e2018-03-30 07:12:15 +020057#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 +030058
59/* MBEDTLS_ERR_ECP_HW_ACCEL_FAILED is deprecated and should not be used. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010060#define MBEDTLS_ERR_ECP_HW_ACCEL_FAILED -0x4B80 /**< The ECP hardware accelerator failed. */
Ron Eldor9924bdc2018-10-04 10:59:13 +030061
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +020062#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 +010063
Paul Bakker407a0da2013-06-27 14:29:21 +020064#ifdef __cplusplus
65extern "C" {
66#endif
67
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010068/**
Rose Zadikd76ac582018-04-23 06:29:34 +010069 * Domain-parameter identifiers: curve, subgroup, and generator.
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020070 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010071 * \note Only curves over prime fields are supported.
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020072 *
73 * \warning This library does not support validation of arbitrary domain
Rose Zadikf56cb342018-04-19 12:49:10 +010074 * parameters. Therefore, only standardized domain parameters from trusted
Manuel Pégourié-Gonnarde3a062b2015-05-11 18:46:47 +020075 * sources should be used. See mbedtls_ecp_group_load().
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020076 */
77typedef enum
78{
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010079 MBEDTLS_ECP_DP_NONE = 0, /*!< Curve not defined. */
Rose Zadikb2e111a2018-04-20 10:13:48 +010080 MBEDTLS_ECP_DP_SECP192R1, /*!< Domain parameters for the 192-bit curve defined by FIPS 186-4 and SEC1. */
81 MBEDTLS_ECP_DP_SECP224R1, /*!< Domain parameters for the 224-bit curve defined by FIPS 186-4 and SEC1. */
82 MBEDTLS_ECP_DP_SECP256R1, /*!< Domain parameters for the 256-bit curve defined by FIPS 186-4 and SEC1. */
83 MBEDTLS_ECP_DP_SECP384R1, /*!< Domain parameters for the 384-bit curve defined by FIPS 186-4 and SEC1. */
84 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 +010085 MBEDTLS_ECP_DP_BP256R1, /*!< Domain parameters for 256-bit Brainpool curve. */
86 MBEDTLS_ECP_DP_BP384R1, /*!< Domain parameters for 384-bit Brainpool curve. */
87 MBEDTLS_ECP_DP_BP512R1, /*!< Domain parameters for 512-bit Brainpool curve. */
Rose Zadikb2e111a2018-04-20 10:13:48 +010088 MBEDTLS_ECP_DP_CURVE25519, /*!< Domain parameters for Curve25519. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010089 MBEDTLS_ECP_DP_SECP192K1, /*!< Domain parameters for 192-bit "Koblitz" curve. */
90 MBEDTLS_ECP_DP_SECP224K1, /*!< Domain parameters for 224-bit "Koblitz" curve. */
91 MBEDTLS_ECP_DP_SECP256K1, /*!< Domain parameters for 256-bit "Koblitz" curve. */
Jaeden Amerofe0669f2018-04-27 17:43:32 +010092 MBEDTLS_ECP_DP_CURVE448, /*!< Domain parameters for Curve448. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093} mbedtls_ecp_group_id;
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020094
95/**
Rose Zadikf56cb342018-04-19 12:49:10 +010096 * The number of supported curves, plus one for #MBEDTLS_ECP_DP_NONE.
Manuel Pégourié-Gonnard66153662013-12-03 14:12:26 +010097 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +010098 * \note Montgomery curves are currently excluded.
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +020099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200100#define MBEDTLS_ECP_DP_MAX 12
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +0200101
102/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100103 * Curve information, for use by other modules.
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200104 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200105typedef struct mbedtls_ecp_curve_info
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200106{
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100107 mbedtls_ecp_group_id grp_id; /*!< An internal identifier. */
108 uint16_t tls_id; /*!< The TLS NamedCurve identifier. */
Rose Zadikb2e111a2018-04-20 10:13:48 +0100109 uint16_t bit_size; /*!< The curve size in bits. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100110 const char *name; /*!< A human-friendly name. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200111} mbedtls_ecp_curve_info;
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +0200112
113/**
Rose Zadikf56cb342018-04-19 12:49:10 +0100114 * \brief The ECP point structure, in Jacobian coordinates.
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100115 *
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +0100116 * \note All functions expect and return points satisfying
Rose Zadikf56cb342018-04-19 12:49:10 +0100117 * the following condition: <code>Z == 0</code> or
Rose Zadika7a61552018-04-24 13:14:01 +0100118 * <code>Z == 1</code>. Other values of \p Z are
Rose Zadikf56cb342018-04-19 12:49:10 +0100119 * used only by internal functions.
120 * The point is zero, or "at infinity", if <code>Z == 0</code>.
Rose Zadika7a61552018-04-24 13:14:01 +0100121 * Otherwise, \p X and \p Y are its standard (affine)
Rose Zadikf56cb342018-04-19 12:49:10 +0100122 * coordinates.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100123 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200124typedef struct mbedtls_ecp_point
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100125{
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100126 mbedtls_mpi X; /*!< The X coordinate of the ECP point. */
127 mbedtls_mpi Y; /*!< The Y coordinate of the ECP point. */
128 mbedtls_mpi Z; /*!< The Z coordinate of the ECP point. */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100129}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200130mbedtls_ecp_point;
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100131
132#if !defined(MBEDTLS_ECP_ALT)
133/*
134 * default mbed TLS elliptic curve arithmetic implementation
135 *
136 * (in case MBEDTLS_ECP_ALT is defined then the developer has to provide an
137 * alternative implementation for the whole module and it will replace this
138 * one.)
139 */
140
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100141/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100142 * \brief The ECP group structure.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100143 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100144 * We consider two types of curve equations:
Rose Zadikb2e111a2018-04-20 10:13:48 +0100145 * <ul><li>Short Weierstrass: <code>y^2 = x^3 + A x + B mod P</code>
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100146 * (SEC1 + RFC-4492)</li>
Rose Zadikf56cb342018-04-19 12:49:10 +0100147 * <li>Montgomery: <code>y^2 = x^3 + A x^2 + x mod P</code> (Curve25519,
Rose Zadikb2e111a2018-04-20 10:13:48 +0100148 * Curve448)</li></ul>
Rose Zadikf56cb342018-04-19 12:49:10 +0100149 * In both cases, the generator (\p G) for a prime-order subgroup is fixed.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100150 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100151 * For Short Weierstrass, this subgroup is the whole curve, and its
Rose Zadikf56cb342018-04-19 12:49:10 +0100152 * cardinality is denoted by \p N. Our code requires that \p N is an
Rose Zadikb2e111a2018-04-20 10:13:48 +0100153 * odd prime as mbedtls_ecp_mul() requires an odd number, and
154 * mbedtls_ecdsa_sign() requires that it is prime for blinding purposes.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100155 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100156 * For Montgomery curves, we do not store \p A, but <code>(A + 2) / 4</code>,
Rose Zadika7a61552018-04-24 13:14:01 +0100157 * which is the quantity used in the formulas. Additionally, \p nbits is
Rose Zadikf56cb342018-04-19 12:49:10 +0100158 * not the size of \p N but the required size for private keys.
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +0100159 *
Rose Zadika7a61552018-04-24 13:14:01 +0100160 * If \p modp is NULL, reduction modulo \p P is done using a generic algorithm.
161 * Otherwise, \p modp must point to a function that takes an \p mbedtls_mpi in the
162 * range of <code>0..2^(2*pbits)-1</code>, and transforms it in-place to an integer
163 * which is congruent mod \p P to the given MPI, and is close enough to \p pbits
164 * in size, so that it may be efficiently brought in the 0..P-1 range by a few
165 * additions or subtractions. Therefore, it is only an approximative modular
166 * reduction. It must return 0 on success and non-zero on failure.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100167 *
Janos Follathc3b680b2018-12-05 16:01:13 +0000168 * \note Alternative implementations must keep the group IDs distinct. If
169 * two group structures have the same ID, then they must be
170 * identical.
171 *
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100172 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200173typedef struct mbedtls_ecp_group
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100174{
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100175 mbedtls_ecp_group_id id; /*!< An internal group identifier. */
Rose Zadikf56cb342018-04-19 12:49:10 +0100176 mbedtls_mpi P; /*!< The prime modulus of the base field. */
Rose Zadikb2e111a2018-04-20 10:13:48 +0100177 mbedtls_mpi A; /*!< For Short Weierstrass: \p A in the equation. For
178 Montgomery curves: <code>(A + 2) / 4</code>. */
179 mbedtls_mpi B; /*!< For Short Weierstrass: \p B in the equation.
180 For Montgomery curves: unused. */
Rose Zadikf56cb342018-04-19 12:49:10 +0100181 mbedtls_ecp_point G; /*!< The generator of the subgroup used. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100182 mbedtls_mpi N; /*!< The order of \p G. */
183 size_t pbits; /*!< The number of bits in \p P.*/
Rose Zadikb2e111a2018-04-20 10:13:48 +0100184 size_t nbits; /*!< For Short Weierstrass: The number of bits in \p P.
Rose Zadika7a61552018-04-24 13:14:01 +0100185 For Montgomery curves: the number of bits in the
Rose Zadikd76ac582018-04-23 06:29:34 +0100186 private keys. */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100187 unsigned int h; /*!< \internal 1 if the constants are static. */
Rose Zadika7a61552018-04-24 13:14:01 +0100188 int (*modp)(mbedtls_mpi *); /*!< The function for fast pseudo-reduction
Rose Zadikf56cb342018-04-19 12:49:10 +0100189 mod \p P (see above).*/
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100190 int (*t_pre)(mbedtls_ecp_point *, void *); /*!< Unused. */
191 int (*t_post)(mbedtls_ecp_point *, void *); /*!< Unused. */
192 void *t_data; /*!< Unused. */
193 mbedtls_ecp_point *T; /*!< Pre-computed points for ecp_mul_comb(). */
Rose Zadikb2e111a2018-04-20 10:13:48 +0100194 size_t T_size; /*!< The number of pre-computed points. */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100195}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196mbedtls_ecp_group;
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100197
Darryl Greena7064c32019-01-04 16:18:06 +0000198/**
199 * \name SECTION: Module settings
200 *
201 * The configuration options you can set for this module are in this section.
202 * Either change them in config.h, or define them using the compiler command line.
203 * \{
204 */
205
206#if !defined(MBEDTLS_ECP_MAX_BITS)
207/**
208 * The maximum size of the groups, that is, of \c N and \c P.
209 */
210#define MBEDTLS_ECP_MAX_BITS 521 /**< The maximum size of groups, in bits. */
211#endif
212
213#define MBEDTLS_ECP_MAX_BYTES ( ( MBEDTLS_ECP_MAX_BITS + 7 ) / 8 )
214#define MBEDTLS_ECP_MAX_PT_LEN ( 2 * MBEDTLS_ECP_MAX_BYTES + 1 )
215
216#if !defined(MBEDTLS_ECP_WINDOW_SIZE)
217/*
218 * Maximum "window" size used for point multiplication.
219 * Default: 6.
220 * Minimum value: 2. Maximum value: 7.
221 *
222 * Result is an array of at most ( 1 << ( MBEDTLS_ECP_WINDOW_SIZE - 1 ) )
223 * points used for point multiplication. This value is directly tied to EC
224 * peak memory usage, so decreasing it by one should roughly cut memory usage
225 * by two (if large curves are in use).
226 *
227 * Reduction in size may reduce speed, but larger curves are impacted first.
228 * Sample performances (in ECDHE handshakes/s, with FIXED_POINT_OPTIM = 1):
229 * w-size: 6 5 4 3 2
230 * 521 145 141 135 120 97
231 * 384 214 209 198 177 146
232 * 256 320 320 303 262 226
233 * 224 475 475 453 398 342
234 * 192 640 640 633 587 476
235 */
236#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< The maximum window size used. */
237#endif /* MBEDTLS_ECP_WINDOW_SIZE */
238
239#if !defined(MBEDTLS_ECP_FIXED_POINT_OPTIM)
240/*
241 * Trade memory for speed on fixed-point multiplication.
242 *
243 * This speeds up repeated multiplication of the generator (that is, the
244 * multiplication in ECDSA signatures, and half of the multiplications in
245 * ECDSA verification and ECDHE) by a factor roughly 3 to 4.
246 *
247 * The cost is increasing EC peak memory usage by a factor roughly 2.
248 *
249 * Change this value to 0 to reduce peak memory usage.
250 */
251#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up. */
252#endif /* MBEDTLS_ECP_FIXED_POINT_OPTIM */
253
254/* \} name SECTION: Module settings */
255
256#else /* MBEDTLS_ECP_ALT */
257#include "ecp_alt.h"
258#endif /* MBEDTLS_ECP_ALT */
259
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200260#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnardb5a50e72017-04-20 16:06:13 +0200261
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200262/**
Manuel Pégourié-Gonnard3cade222017-04-20 09:31:00 +0200263 * \brief Internal restart context for multiplication
264 *
265 * \note Opaque struct
266 */
267typedef struct mbedtls_ecp_restart_mul mbedtls_ecp_restart_mul_ctx;
268
269/**
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200270 * \brief Internal restart context for ecp_muladd()
271 *
272 * \note Opaque struct
273 */
274typedef struct mbedtls_ecp_restart_muladd mbedtls_ecp_restart_muladd_ctx;
275
276/**
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200277 * \brief General context for resuming ECC operations
278 */
279typedef struct
280{
Manuel Pégourié-Gonnard646393b2017-04-20 10:03:45 +0200281 unsigned ops_done; /*!< current ops count */
Manuel Pégourié-Gonnard3a256122017-04-20 11:20:26 +0200282 unsigned depth; /*!< call depth (0 = top-level) */
Manuel Pégourié-Gonnard646393b2017-04-20 10:03:45 +0200283 mbedtls_ecp_restart_mul_ctx *rsm; /*!< ecp_mul_comb() sub-context */
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200284 mbedtls_ecp_restart_muladd_ctx *ma; /*!< ecp_muladd() sub-context */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200285} mbedtls_ecp_restart_ctx;
Manuel Pégourié-Gonnardb5a50e72017-04-20 16:06:13 +0200286
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200287/*
288 * Operation counts for restartable functions
289 */
Manuel Pégourié-Gonnard5314f232017-04-21 12:36:59 +0200290#define MBEDTLS_ECP_OPS_CHK 3 /*!< basic ops count for ecp_check_pubkey() */
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200291#define MBEDTLS_ECP_OPS_DBL 8 /*!< basic ops count for ecp_double_jac() */
292#define MBEDTLS_ECP_OPS_ADD 11 /*!< basic ops count for see ecp_add_mixed() */
293#define MBEDTLS_ECP_OPS_INV 120 /*!< empirical equivalent for mpi_mod_inv() */
294
295/**
296 * \brief Internal; for restartable functions in other modules.
297 * Check and update basic ops budget.
298 *
299 * \param grp Group structure
300 * \param rs_ctx Restart context
301 * \param ops Number of basic ops to do
302 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200303 * \return \c 0 if doing \p ops basic ops is still allowed,
304 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS otherwise.
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200305 */
306int mbedtls_ecp_check_budget( const mbedtls_ecp_group *grp,
307 mbedtls_ecp_restart_ctx *rs_ctx,
308 unsigned ops );
309
310/* Utility macro for checking and updating ops budget */
Hanno Beckerabdf67e2018-10-26 13:28:32 +0100311#define MBEDTLS_ECP_BUDGET( ops ) \
312 MBEDTLS_MPI_CHK( mbedtls_ecp_check_budget( grp, rs_ctx, \
313 (unsigned) (ops) ) );
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200314
Manuel Pégourié-Gonnardb5a50e72017-04-20 16:06:13 +0200315#else /* MBEDTLS_ECP_RESTARTABLE */
316
Manuel Pégourié-Gonnardc7511482017-04-20 16:31:00 +0200317#define MBEDTLS_ECP_BUDGET( ops ) /* no-op; for compatibility */
318
Manuel Pégourié-Gonnardb5a50e72017-04-20 16:06:13 +0200319/* We want to declare restartable versions of existing functions anyway */
320typedef void mbedtls_ecp_restart_ctx;
321
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200322#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200323
Paul Bakker088c5c52014-04-25 11:11:10 +0200324/**
Jaeden Amero89453432018-04-24 17:15:38 +0100325 * \brief The ECP key-pair structure.
Ron Eldor05d0e512018-04-16 17:40:04 +0300326 *
Jaeden Amero89453432018-04-24 17:15:38 +0100327 * A generic key-pair that may be used for ECDSA and fixed ECDH, for example.
Ron Eldor05d0e512018-04-16 17:40:04 +0300328 *
Jaeden Amero89453432018-04-24 17:15:38 +0100329 * \note Members are deliberately in the same order as in the
330 * ::mbedtls_ecdsa_context structure.
Ron Eldor05d0e512018-04-16 17:40:04 +0300331 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200332typedef struct mbedtls_ecp_keypair
Ron Eldor05d0e512018-04-16 17:40:04 +0300333{
334 mbedtls_ecp_group grp; /*!< Elliptic curve and base point */
335 mbedtls_mpi d; /*!< our secret value */
336 mbedtls_ecp_point Q; /*!< our public value */
337}
338mbedtls_ecp_keypair;
339
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100340/*
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100341 * Point formats, from RFC 4492's enum ECPointFormat
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100342 */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100343#define MBEDTLS_ECP_PF_UNCOMPRESSED 0 /**< Uncompressed point format. */
344#define MBEDTLS_ECP_PF_COMPRESSED 1 /**< Compressed point format. */
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100345
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100346/*
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100347 * Some other constants from RFC 4492
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100348 */
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100349#define MBEDTLS_ECP_TLS_NAMED_CURVE 3 /**< The named_curve of ECCurveType. */
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100350
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200351#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100352/**
353 * \brief Set the maximum number of basic operations done in a row.
354 *
355 * If more operations are needed to complete a computation,
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200356 * #MBEDTLS_ERR_ECP_IN_PROGRESS will be returned by the
Manuel Pégourié-Gonnard8467e682017-04-20 09:47:06 +0200357 * function performing the computation. It is then the
358 * caller's responsibility to either call again with the same
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +0200359 * parameters until it returns 0 or an error code; or to free
Manuel Pégourié-Gonnard8467e682017-04-20 09:47:06 +0200360 * the restart context if the operation is to be aborted.
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100361 *
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +0200362 * It is strictly required that all input parameters and the
363 * restart context be the same on successive calls for the
364 * same operation, but output parameters need not be the
365 * same; they must not be used until the function finally
366 * returns 0.
367 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +0200368 * This only applies to functions whose documentation
369 * mentions they may return #MBEDTLS_ERR_ECP_IN_PROGRESS (or
370 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS for functions in the
371 * SSL module). For functions that accept a "restart context"
372 * argument, passing NULL disables restart and makes the
373 * function equivalent to the function with the same name
374 * with \c _restartable removed. For functions in the ECDH
375 * module, restart is disabled unless the function accepts
376 * an "ECDH context" argument and
377 * mbedtls_ecdh_enable_restart() was previously called on
378 * that context. For function in the SSL module, restart is
379 * only enabled for specific sides and key exchanges
380 * (currently only for clients and ECDHE-ECDSA).
Manuel Pégourié-Gonnard8f28add2017-04-19 10:20:49 +0200381 *
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100382 * \param max_ops Maximum number of basic operations done in a row.
383 * Default: 0 (unlimited).
384 * Lower (non-zero) values mean ECC functions will block for
385 * a lesser maximum amount of time.
386 *
Manuel Pégourié-Gonnarde6854492017-03-20 14:35:19 +0100387 * \note A "basic operation" is defined as a rough equivalent of a
388 * multiplication in GF(p) for the NIST P-256 curve.
389 * As an indication, with default settings, a scalar
390 * multiplication (full run of \c mbedtls_ecp_mul()) is:
391 * - about 3300 basic operations for P-256
392 * - about 9400 basic operations for P-384
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100393 *
Manuel Pégourié-Gonnarde58f65a2017-03-20 14:59:54 +0100394 * \note Very low values are not always respected: sometimes
Manuel Pégourié-Gonnard1c678e02017-03-20 13:39:39 +0100395 * functions need to block for a minimum number of
396 * operations, and will do so even if max_ops is set to a
397 * lower value. That minimum depends on the curve size, and
398 * can be made lower by decreasing the value of
Manuel Pégourié-Gonnard7037e222017-08-23 14:30:36 +0200399 * \c MBEDTLS_ECP_WINDOW_SIZE. As an indication, here is the
400 * lowest effective value for various curves and values of
401 * that parameter (w for short):
402 * w=6 w=5 w=4 w=3 w=2
403 * P-256 208 208 160 136 124
404 * P-384 682 416 320 272 248
405 * P-521 1364 832 640 544 496
Manuel Pégourié-Gonnarde58f65a2017-03-20 14:59:54 +0100406 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200407 * \note This setting is currently ignored by Curve25519.
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100408 */
409void mbedtls_ecp_set_max_ops( unsigned max_ops );
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200410
411/**
412 * \brief Check if restart is enabled (max_ops != 0)
413 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200414 * \return \c 0 if \c max_ops == 0 (restart disabled)
415 * \return \c 1 otherwise (restart enabled)
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200416 */
Manuel Pégourié-Gonnardb843b152018-10-16 10:41:31 +0200417int mbedtls_ecp_restart_is_enabled( void );
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200418#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard054433c2017-03-22 11:18:33 +0100419
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100420/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100421 * \brief This function retrieves the information defined in
Rose Zadikf56cb342018-04-19 12:49:10 +0100422 * mbedtls_ecp_curve_info() for all supported curves in order
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100423 * of preference.
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200424 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100425 * \return A statically allocated array. The last entry is 0.
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200427const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list( void );
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200428
429/**
Rose Zadikf56cb342018-04-19 12:49:10 +0100430 * \brief This function retrieves the list of internal group
431 * identifiers of all supported curves in the order of
432 * preference.
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100433 *
434 * \return A statically allocated array,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200435 * terminated with MBEDTLS_ECP_DP_NONE.
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200437const mbedtls_ecp_group_id *mbedtls_ecp_grp_id_list( void );
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100438
439/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100440 * \brief This function retrieves curve information from an internal
441 * group identifier.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200442 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100443 * \param grp_id An \c MBEDTLS_ECP_DP_XXX value.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200444 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100445 * \return The associated curve information on success.
446 * \return NULL on failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448const 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 +0200449
450/**
Rose Zadika7a61552018-04-24 13:14:01 +0100451 * \brief This function retrieves curve information from a TLS
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100452 * NamedCurve value.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200453 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100454 * \param tls_id An \c MBEDTLS_ECP_DP_XXX value.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200455 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100456 * \return The associated curve information on success.
457 * \return NULL on failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200459const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_tls_id( uint16_t tls_id );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200460
461/**
Rose Zadika7a61552018-04-24 13:14:01 +0100462 * \brief This function retrieves curve information from a
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100463 * human-readable name.
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100464 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100465 * \param name The human-readable name.
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100466 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100467 * \return The associated curve information on success.
468 * \return NULL on failure.
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100469 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200470const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_name( const char *name );
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100471
472/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100473 * \brief This function initializes a point as zero.
474 *
475 * \param pt The point to initialize.
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200477void mbedtls_ecp_point_init( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100478
479/**
Rose Zadikf56cb342018-04-19 12:49:10 +0100480 * \brief This function initializes an ECP group context
Rose Zadika7a61552018-04-24 13:14:01 +0100481 * without loading any domain parameters.
Rose Zadikf56cb342018-04-19 12:49:10 +0100482 *
483 * \note After this function is called, domain parameters
484 * for various ECP groups can be loaded through the
Gilles Peskine13cf3ec2018-11-07 22:06:48 +0100485 * mbedtls_ecp_group_load() or mbedtls_ecp_tls_read_group()
Rose Zadikf56cb342018-04-19 12:49:10 +0100486 * functions.
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200488void mbedtls_ecp_group_init( mbedtls_ecp_group *grp );
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100489
490/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100491 * \brief This function initializes a key pair as an invalid one.
492 *
493 * \param key The key pair to initialize.
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200495void mbedtls_ecp_keypair_init( mbedtls_ecp_keypair *key );
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200496
497/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100498 * \brief This function frees the components of a point.
499 *
500 * \param pt The point to free.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200502void mbedtls_ecp_point_free( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100503
504/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100505 * \brief This function frees the components of an ECP group.
Hanno Beckerebffa792018-12-14 15:07:50 +0000506 *
507 * \param grp The group to free. This may be \c NULL, in which
Hanno Becker486f1b32018-12-18 13:00:34 +0000508 * case this function returns immediately. If it is not
509 * \c NULL, it must point to an initialized ECP group.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200511void mbedtls_ecp_group_free( mbedtls_ecp_group *grp );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100512
513/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100514 * \brief This function frees the components of a key pair.
Hanno Beckerebffa792018-12-14 15:07:50 +0000515 *
516 * \param key The key pair to free. This may be \c NULL, in which
Hanno Becker486f1b32018-12-18 13:00:34 +0000517 * case this function returns immediately. If it is not
518 * \c NULL, it must point to an initialized ECP key pair.
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200520void mbedtls_ecp_keypair_free( mbedtls_ecp_keypair *key );
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200521
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200522#if defined(MBEDTLS_ECP_RESTARTABLE)
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200523/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000524 * \brief Initialize a restart context.
525 *
526 * \param ctx The restart context to initialize. This must
527 * not be \c NULL.
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200528 */
529void mbedtls_ecp_restart_init( mbedtls_ecp_restart_ctx *ctx );
530
531/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000532 * \brief Free the components of a restart context.
533 *
534 * \param ctx The restart context to free. This may be \c NULL, in which
Hanno Becker486f1b32018-12-18 13:00:34 +0000535 * case this function returns immediately. If it is not
536 * \c NULL, it must point to an initialized restart context.
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200537 */
538void mbedtls_ecp_restart_free( mbedtls_ecp_restart_ctx *ctx );
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200539#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200540
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200541/**
Rose Zadika7a61552018-04-24 13:14:01 +0100542 * \brief This function copies the contents of point \p Q into
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100543 * point \p P.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100544 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000545 * \param P The destination point. This must be initialized.
546 * \param Q The source point. This must be initialized.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100547 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100548 * \return \c 0 on success.
Rose Zadikf56cb342018-04-19 12:49:10 +0100549 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000550 * \return Another negative error code for other kinds of failure.
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552int mbedtls_ecp_copy( mbedtls_ecp_point *P, const mbedtls_ecp_point *Q );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100553
554/**
Rose Zadika7a61552018-04-24 13:14:01 +0100555 * \brief This function copies the contents of group \p src into
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100556 * group \p dst.
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200557 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000558 * \param dst The destination group. This must be initialized.
559 * \param src The source group. This must be initialized.
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200560 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100561 * \return \c 0 on success.
Rose Zadikf56cb342018-04-19 12:49:10 +0100562 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000563 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200564 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000565int mbedtls_ecp_group_copy( mbedtls_ecp_group *dst,
566 const mbedtls_ecp_group *src );
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200567
568/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000569 * \brief This function sets a point to the point at infinity.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200570 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000571 * \param pt The point to set. This must be initialized.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200572 *
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 on other kinds of failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200577int mbedtls_ecp_set_zero( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200578
579/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000580 * \brief This function checks if a point is the point at infinity.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200581 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000582 * \param pt The point to test. This must be initialized.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200583 *
Rose Zadikf56cb342018-04-19 12:49:10 +0100584 * \return \c 1 if the point is zero.
585 * \return \c 0 if the point is non-zero.
Hanno Beckerebffa792018-12-14 15:07:50 +0000586 * \return A negative error code on failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588int mbedtls_ecp_is_zero( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200589
590/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100591 * \brief This function compares two points.
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200592 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100593 * \note This assumes that the points are normalized. Otherwise,
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200594 * they may compare as "not equal" even if they are.
595 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000596 * \param P The first point to compare. This must be initialized.
597 * \param Q The second point to compare. This must be initialized.
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200598 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100599 * \return \c 0 if the points are equal.
600 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the points are not equal.
Manuel Pégourié-Gonnard6029a852015-08-11 15:44:41 +0200601 */
602int mbedtls_ecp_point_cmp( const mbedtls_ecp_point *P,
603 const mbedtls_ecp_point *Q );
604
605/**
Rose Zadika7a61552018-04-24 13:14:01 +0100606 * \brief This function imports a non-zero point from two ASCII
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100607 * strings.
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100608 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000609 * \param P The destination point. This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100610 * \param radix The numeric base of the input.
611 * \param x The first affine coordinate, as a null-terminated string.
612 * \param y The second affine coordinate, as a null-terminated string.
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100613 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100614 * \return \c 0 on success.
615 * \return An \c MBEDTLS_ERR_MPI_XXX error code on failure.
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617int mbedtls_ecp_point_read_string( mbedtls_ecp_point *P, int radix,
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100618 const char *x, const char *y );
619
620/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100621 * \brief This function exports a point into unsigned binary data.
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100622 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100623 * \param grp The group to which the point should belong.
Hanno Beckerebffa792018-12-14 15:07:50 +0000624 * This must be initialized and have group parameters
625 * set, for example through mbedtls_ecp_group_load().
626 * \param P The point to export. This must be initialized.
627 * \param format The point format. This must be either
628 * #MBEDTLS_ECP_PF_COMPRESSED or #MBEDTLS_ECP_PF_UNCOMPRESSED.
Janos Follath28eb06d2019-02-26 10:53:34 +0000629 * (For groups without these formats, this parameter is
630 * ignored. But it still has to be either of the above
631 * values.)
Hanno Beckerebffa792018-12-14 15:07:50 +0000632 * \param olen The address at which to store the length of
Hanno Becker5edcfa52018-12-18 12:49:55 +0000633 * the output in Bytes. This must not be \c NULL.
Hanno Beckerebffa792018-12-14 15:07:50 +0000634 * \param buf The output buffer. This must be a writable buffer
635 * of length \p buflen Bytes.
636 * \param buflen The length of the output buffer \p buf in Bytes.
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100637 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100638 * \return \c 0 on success.
Hanno Beckerebffa792018-12-14 15:07:50 +0000639 * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the output buffer
640 * is too small to hold the point.
Janos Follath28eb06d2019-02-26 10:53:34 +0000641 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the point format
642 * or the export for the given group is not implemented.
Hanno Beckerebffa792018-12-14 15:07:50 +0000643 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100644 */
Janos Follath28eb06d2019-02-26 10:53:34 +0000645int mbedtls_ecp_point_write_binary( const mbedtls_ecp_group *grp,
646 const mbedtls_ecp_point *P,
647 int format, size_t *olen,
648 unsigned char *buf, size_t buflen );
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100649
650/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100651 * \brief This function imports a point from unsigned binary data.
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100652 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100653 * \note This function does not check that the point actually
Rose Zadika7a61552018-04-24 13:14:01 +0100654 * belongs to the given group, see mbedtls_ecp_check_pubkey()
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100655 * for that.
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100656 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100657 * \param grp The group to which the point should belong.
Hanno Beckerebffa792018-12-14 15:07:50 +0000658 * This must be initialized and have group parameters
659 * set, for example through mbedtls_ecp_group_load().
660 * \param P The destination context to import the point to.
661 * This must be initialized.
662 * \param buf The input buffer. This must be a readable buffer
663 * of length \p ilen Bytes.
664 * \param ilen The length of the input buffer \p buf in Bytes.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100665 *
666 * \return \c 0 on success.
Hanno Beckerebffa792018-12-14 15:07:50 +0000667 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the input is invalid.
Rose Zadikf56cb342018-04-19 12:49:10 +0100668 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Janos Follath28eb06d2019-02-26 10:53:34 +0000669 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the import for the
670 * given group is not implemented.
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100671 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000672int mbedtls_ecp_point_read_binary( const mbedtls_ecp_group *grp,
673 mbedtls_ecp_point *P,
674 const unsigned char *buf, size_t ilen );
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100675
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100676/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100677 * \brief This function imports a point from a TLS ECPoint record.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200678 *
Janos Follath89ac8c92018-10-30 11:24:05 +0000679 * \note On function return, \p *buf is updated to point immediately
Rose Zadikf56cb342018-04-19 12:49:10 +0100680 * after the ECPoint record.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200681 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000682 * \param grp The ECP group to use.
683 * This must be initialized and have group parameters
684 * set, for example through mbedtls_ecp_group_load().
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100685 * \param pt The destination point.
Rose Zadikf56cb342018-04-19 12:49:10 +0100686 * \param buf The address of the pointer to the start of the input buffer.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100687 * \param len The length of the buffer.
Manuel Pégourié-Gonnard150c4f62014-11-21 09:14:52 +0100688 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100689 * \return \c 0 on success.
Janos Follath89ac8c92018-10-30 11:24:05 +0000690 * \return An \c MBEDTLS_ERR_MPI_XXX error code on initialization
691 * failure.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100692 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200693 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000694int mbedtls_ecp_tls_read_point( const mbedtls_ecp_group *grp,
695 mbedtls_ecp_point *pt,
696 const unsigned char **buf, size_t len );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200697
698/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000699 * \brief This function exports a point as a TLS ECPoint record
700 * defined in RFC 4492, Section 5.4.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200701 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000702 * \param grp The ECP group to use.
703 * This must be initialized and have group parameters
704 * set, for example through mbedtls_ecp_group_load().
705 * \param pt The point to be exported. This must be initialized.
706 * \param format The point format to use. This must be either
707 * #MBEDTLS_ECP_PF_COMPRESSED or #MBEDTLS_ECP_PF_UNCOMPRESSED.
708 * \param olen The address at which to store the length in Bytes
709 * of the data written.
710 * \param buf The target buffer. This must be a writable buffer of
711 * length \p blen Bytes.
712 * \param blen The length of the target buffer \p buf in Bytes.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200713 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100714 * \return \c 0 on success.
Hanno Beckerebffa792018-12-14 15:07:50 +0000715 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the input is invalid.
716 * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the target buffer
717 * is too small to hold the exported point.
718 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200719 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000720int mbedtls_ecp_tls_write_point( const mbedtls_ecp_group *grp,
721 const mbedtls_ecp_point *pt,
722 int format, size_t *olen,
723 unsigned char *buf, size_t blen );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200724
725/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000726 * \brief This function sets up an ECP group context
727 * from a standardized set of domain parameters.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100728 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100729 * \note The index should be a value of the NamedCurve enum,
Rose Zadika7a61552018-04-24 13:14:01 +0100730 * as defined in <em>RFC-4492: Elliptic Curve Cryptography
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100731 * (ECC) Cipher Suites for Transport Layer Security (TLS)</em>,
732 * usually in the form of an \c MBEDTLS_ECP_DP_XXX macro.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100733 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000734 * \param grp The group context to setup. This must be initialized.
Rose Zadikf56cb342018-04-19 12:49:10 +0100735 * \param id The identifier of the domain parameter set to load.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100736 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000737 * \return \c 0 on success.
738 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if \p id doesn't
739 * correspond to a known group.
740 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100741 */
Hanno Becker61937d42017-04-26 15:01:23 +0100742int mbedtls_ecp_group_load( mbedtls_ecp_group *grp, mbedtls_ecp_group_id id );
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100743
744/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000745 * \brief This function sets up an ECP group context from a TLS
746 * ECParameters record as defined in RFC 4492, Section 5.4.
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100747 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000748 * \note The read pointer \p buf is updated to point right after
749 * the ECParameters record on exit.
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100750 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000751 * \param grp The group context to setup. This must be initialized.
Rose Zadikf56cb342018-04-19 12:49:10 +0100752 * \param buf The address of the pointer to the start of the input buffer.
Hanno Beckerebffa792018-12-14 15:07:50 +0000753 * \param len The length of the input buffer \c *buf in Bytes.
Manuel Pégourié-Gonnard150c4f62014-11-21 09:14:52 +0100754 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100755 * \return \c 0 on success.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100756 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid.
Janos Follath89ac8c92018-10-30 11:24:05 +0000757 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the group is not
Hanno Beckerebffa792018-12-14 15:07:50 +0000758 * recognized.
759 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100760 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000761int mbedtls_ecp_tls_read_group( mbedtls_ecp_group *grp,
762 const unsigned char **buf, size_t len );
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100763
764/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000765 * \brief This function extracts an elliptic curve group ID from a
766 * TLS ECParameters record as defined in RFC 4492, Section 5.4.
Janos Follath89ac8c92018-10-30 11:24:05 +0000767 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000768 * \note The read pointer \p buf is updated to point right after
769 * the ECParameters record on exit.
Janos Follath89ac8c92018-10-30 11:24:05 +0000770 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000771 * \param grp The address at which to store the group id.
772 * This must not be \c NULL.
Janos Follath89ac8c92018-10-30 11:24:05 +0000773 * \param buf The address of the pointer to the start of the input buffer.
Hanno Beckerebffa792018-12-14 15:07:50 +0000774 * \param len The length of the input buffer \c *buf in Bytes.
Janos Follath89ac8c92018-10-30 11:24:05 +0000775 *
776 * \return \c 0 on success.
777 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid.
778 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the group is not
Hanno Beckerebffa792018-12-14 15:07:50 +0000779 * recognized.
780 * \return Another negative error code on other kinds of failure.
Janos Follath89ac8c92018-10-30 11:24:05 +0000781 */
782int mbedtls_ecp_tls_read_group_id( mbedtls_ecp_group_id *grp,
Hanno Beckerebffa792018-12-14 15:07:50 +0000783 const unsigned char **buf,
784 size_t len );
Janos Follath89ac8c92018-10-30 11:24:05 +0000785/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000786 * \brief This function exports an elliptic curve as a TLS
787 * ECParameters record as defined in RFC 4492, Section 5.4.
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100788 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000789 * \param grp The ECP group to be exported.
790 * This must be initialized and have group parameters
791 * set, for example through mbedtls_ecp_group_load().
792 * \param olen The address at which to store the number of Bytes written.
793 * This must not be \c NULL.
794 * \param buf The buffer to write to. This must be a writable buffer
795 * of length \p blen Bytes.
796 * \param blen The length of the output buffer \p buf in Bytes.
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100797 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100798 * \return \c 0 on success.
Hanno Beckerebffa792018-12-14 15:07:50 +0000799 * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the output
800 * buffer is too small to hold the exported group.
801 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100802 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000803int mbedtls_ecp_tls_write_group( const mbedtls_ecp_group *grp,
804 size_t *olen,
805 unsigned char *buf, size_t blen );
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100806
807/**
Hanno Becker5edcfa52018-12-18 12:49:55 +0000808 * \brief This function performs a scalar multiplication of a point
Hanno Beckerebffa792018-12-14 15:07:50 +0000809 * by an integer: \p R = \p m * \p P.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100810 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100811 * It is not thread-safe to use same group in multiple threads.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200812 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100813 * \note To prevent timing attacks, this function
814 * executes the exact same sequence of base-field
815 * operations for any valid \p m. It avoids any if-branch or
816 * array index depending on the value of \p m.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200817 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100818 * \note If \p f_rng is not NULL, it is used to randomize
819 * intermediate results to prevent potential timing attacks
820 * targeting these results. We recommend always providing
821 * a non-NULL \p f_rng. The overhead is negligible.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100822 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000823 * \param grp The ECP group to use.
824 * This must be initialized and have group parameters
825 * set, for example through mbedtls_ecp_group_load().
826 * \param R The point in which to store the result of the calculation.
827 * This must be initialized.
828 * \param m The integer by which to multiply. This must be initialized.
829 * \param P The point to multiply. This must be initialized.
830 * \param f_rng The RNG function. This may be \c NULL if randomization
831 * of intermediate results isn't desired (discouraged).
832 * \param p_rng The RNG context to be passed to \p p_rng.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100833 *
834 * \return \c 0 on success.
Rose Zadikf56cb342018-04-19 12:49:10 +0100835 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m is not a valid private
836 * key, or \p P is not a valid public key.
837 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000838 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200839 */
840int mbedtls_ecp_mul( mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
841 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
842 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
843
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200844/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200845 * \brief This function performs multiplication of a point by
846 * an integer: \p R = \p m * \p P in a restartable way.
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200847 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200848 * \see mbedtls_ecp_mul()
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200849 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200850 * \note This function does the same as \c mbedtls_ecp_mul(), but
851 * it can return early and restart according to the limit set
852 * with \c mbedtls_ecp_set_max_ops() to reduce blocking.
853 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000854 * \param grp The ECP group to use.
855 * This must be initialized and have group parameters
856 * set, for example through mbedtls_ecp_group_load().
857 * \param R The point in which to store the result of the calculation.
858 * This must be initialized.
859 * \param m The integer by which to multiply. This must be initialized.
860 * \param P The point to multiply. This must be initialized.
861 * \param f_rng The RNG function. This may be \c NULL if randomization
862 * of intermediate results isn't desired (discouraged).
863 * \param p_rng The RNG context to be passed to \p p_rng.
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200864 * \param rs_ctx The restart context (NULL disables restart).
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200865 *
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200866 * \return \c 0 on success.
867 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m is not a valid private
868 * key, or \p P is not a valid public key.
869 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
870 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard8467e682017-04-20 09:47:06 +0200871 * operations was reached: see \c mbedtls_ecp_set_max_ops().
Hanno Beckerebffa792018-12-14 15:07:50 +0000872 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100873 */
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200874int mbedtls_ecp_mul_restartable( mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
Manuel Pégourié-Gonnardb739a712017-04-19 10:11:56 +0200876 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
877 mbedtls_ecp_restart_ctx *rs_ctx );
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100878
879/**
Rose Zadika7a61552018-04-24 13:14:01 +0100880 * \brief This function performs multiplication and addition of two
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100881 * points by integers: \p R = \p m * \p P + \p n * \p Q
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200882 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100883 * It is not thread-safe to use same group in multiple threads.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200884 *
Rose Zadika7a61552018-04-24 13:14:01 +0100885 * \note In contrast to mbedtls_ecp_mul(), this function does not
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100886 * guarantee a constant execution flow and timing.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200887 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000888 * \param grp The ECP group to use.
889 * This must be initialized and have group parameters
890 * set, for example through mbedtls_ecp_group_load().
891 * \param R The point in which to store the result of the calculation.
892 * This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100893 * \param m The integer by which to multiply \p P.
Hanno Beckerebffa792018-12-14 15:07:50 +0000894 * This must be initialized.
895 * \param P The point to multiply by \p m. This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100896 * \param n The integer by which to multiply \p Q.
Hanno Beckerebffa792018-12-14 15:07:50 +0000897 * This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100898 * \param Q The point to be multiplied by \p n.
Hanno Beckerebffa792018-12-14 15:07:50 +0000899 * This must be initialized.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200900 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100901 * \return \c 0 on success.
Rose Zadika7a61552018-04-24 13:14:01 +0100902 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m or \p n are not
903 * valid private keys, or \p P or \p Q are not valid public
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100904 * keys.
Rose Zadikf56cb342018-04-19 12:49:10 +0100905 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
Hanno Beckerebffa792018-12-14 15:07:50 +0000906 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200907 */
908int mbedtls_ecp_muladd( mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
909 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
910 const mbedtls_mpi *n, const mbedtls_ecp_point *Q );
911
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200912/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200913 * \brief This function performs multiplication and addition of two
914 * points by integers: \p R = \p m * \p P + \p n * \p Q in a
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200915 * restartable way.
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200916 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200917 * \see \c mbedtls_ecp_muladd()
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200918 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200919 * \note This function works the same as \c mbedtls_ecp_muladd(),
920 * but it can return early and restart according to the limit
921 * set with \c mbedtls_ecp_set_max_ops() to reduce blocking.
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200922 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000923 * \param grp The ECP group to use.
924 * This must be initialized and have group parameters
925 * set, for example through mbedtls_ecp_group_load().
926 * \param R The point in which to store the result of the calculation.
927 * This must be initialized.
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200928 * \param m The integer by which to multiply \p P.
Hanno Beckerebffa792018-12-14 15:07:50 +0000929 * This must be initialized.
930 * \param P The point to multiply by \p m. This must be initialized.
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200931 * \param n The integer by which to multiply \p Q.
Hanno Beckerebffa792018-12-14 15:07:50 +0000932 * This must be initialized.
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200933 * \param Q The point to be multiplied by \p n.
Hanno Beckerebffa792018-12-14 15:07:50 +0000934 * This must be initialized.
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200935 * \param rs_ctx The restart context (NULL disables restart).
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200936 *
937 * \return \c 0 on success.
938 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m or \p n are not
939 * valid private keys, or \p P or \p Q are not valid public
940 * keys.
941 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure.
942 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200943 * operations was reached: see \c mbedtls_ecp_set_max_ops().
Hanno Beckerebffa792018-12-14 15:07:50 +0000944 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200945 */
946int mbedtls_ecp_muladd_restartable(
947 mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
948 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
949 const mbedtls_mpi *n, const mbedtls_ecp_point *Q,
950 mbedtls_ecp_restart_ctx *rs_ctx );
Manuel Pégourié-Gonnard54dd6522017-04-20 13:36:18 +0200951
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200952/**
Rose Zadika7a61552018-04-24 13:14:01 +0100953 * \brief This function checks that a point is a valid public key
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100954 * on this curve.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200955 *
Rose Zadika7a61552018-04-24 13:14:01 +0100956 * It only checks that the point is non-zero, has
957 * valid coordinates and lies on the curve. It does not verify
958 * that it is indeed a multiple of \p G. This additional
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100959 * check is computationally more expensive, is not required
960 * by standards, and should not be necessary if the group
Rose Zadika7a61552018-04-24 13:14:01 +0100961 * used has a small cofactor. In particular, it is useless for
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100962 * the NIST groups which all have a cofactor of 1.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200963 *
Rose Zadika7a61552018-04-24 13:14:01 +0100964 * \note This function uses bare components rather than an
965 * ::mbedtls_ecp_keypair structure, to ease use with other
966 * structures, such as ::mbedtls_ecdh_context or
Rose Zadikb2e111a2018-04-20 10:13:48 +0100967 * ::mbedtls_ecdsa_context.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200968 *
Hanno Beckerebffa792018-12-14 15:07:50 +0000969 * \param grp The ECP group the point should belong to.
970 * This must be initialized and have group parameters
971 * set, for example through mbedtls_ecp_group_load().
972 * \param pt The point to check. This must be initialized.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200973 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +0100974 * \return \c 0 if the point is a valid public key.
Hanno Beckerebffa792018-12-14 15:07:50 +0000975 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if the point is not
976 * a valid public key for the given curve.
977 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200978 */
Hanno Beckerebffa792018-12-14 15:07:50 +0000979int mbedtls_ecp_check_pubkey( const mbedtls_ecp_group *grp,
980 const mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200981
982/**
Hanno Beckerebffa792018-12-14 15:07:50 +0000983 * \brief This function checks that an \p mbedtls_mpi is a
984 * valid private key for this curve.
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 private key should belong to.
992 * This must be initialized and have group parameters
993 * set, for example through mbedtls_ecp_group_load().
994 * \param d The integer 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 private key.
Hanno Beckerebffa792018-12-14 15:07:50 +0000997 * \return #MBEDTLS_ERR_ECP_INVALID_KEY if the point is not a valid
998 * private 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_privkey( const mbedtls_ecp_group *grp,
1002 const mbedtls_mpi *d );
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001003
1004/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +02001005 * \brief This function generates a private key.
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02001006 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001007 * \param grp The ECP group to generate a private key for.
1008 * This must be initialized and have group parameters
1009 * set, for example through mbedtls_ecp_group_load().
1010 * \param d The destination MPI (secret part). This must be initialized.
1011 * \param f_rng The RNG function. This must not be \c NULL.
1012 * \param p_rng The RNG parameter to be passed to \p f_rng. This may be
1013 * \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02001014 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +02001015 * \return \c 0 on success.
1016 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code
1017 * on failure.
Manuel Pégourié-Gonnarda7937f92017-04-20 15:37:46 +02001018 */
1019int mbedtls_ecp_gen_privkey( const mbedtls_ecp_group *grp,
1020 mbedtls_mpi *d,
1021 int (*f_rng)(void *, unsigned char *, size_t),
1022 void *p_rng );
1023
1024/**
Rose Zadika7a61552018-04-24 13:14:01 +01001025 * \brief This function generates a keypair with a configurable base
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001026 * point.
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001027 *
Rose Zadika7a61552018-04-24 13:14:01 +01001028 * \note This function uses bare components rather than an
1029 * ::mbedtls_ecp_keypair structure to ease use with other
1030 * structures, such as ::mbedtls_ecdh_context or
Rose Zadikb2e111a2018-04-20 10:13:48 +01001031 * ::mbedtls_ecdsa_context.
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001032 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001033 * \param grp The ECP group to generate a key pair for.
1034 * This must be initialized and have group parameters
1035 * set, for example through mbedtls_ecp_group_load().
1036 * \param G The base point to use. This must be initialized
1037 * and belong to \p grp. It replaces the default base
1038 * point \c grp->G used by mbedtls_ecp_gen_keypair().
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001039 * \param d The destination MPI (secret part).
Hanno Beckerebffa792018-12-14 15:07:50 +00001040 * This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001041 * \param Q The destination point (public part).
Hanno Beckerebffa792018-12-14 15:07:50 +00001042 * This must be initialized.
1043 * \param f_rng The RNG function. This must not be \c NULL.
1044 * \param p_rng The RNG context to be passed to \p f_rng. This may
1045 * be \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001046 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001047 * \return \c 0 on success.
1048 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code
1049 * on failure.
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001050 */
1051int mbedtls_ecp_gen_keypair_base( mbedtls_ecp_group *grp,
Hanno Beckerebffa792018-12-14 15:07:50 +00001052 const mbedtls_ecp_point *G,
1053 mbedtls_mpi *d, mbedtls_ecp_point *Q,
1054 int (*f_rng)(void *, unsigned char *, size_t),
1055 void *p_rng );
Manuel Pégourié-Gonnardd9a3f472015-08-11 14:31:03 +02001056
1057/**
Rose Zadikf56cb342018-04-19 12:49:10 +01001058 * \brief This function generates an ECP keypair.
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01001059 *
Rose Zadika7a61552018-04-24 13:14:01 +01001060 * \note This function uses bare components rather than an
1061 * ::mbedtls_ecp_keypair structure to ease use with other
1062 * structures, such as ::mbedtls_ecdh_context or
Rose Zadikb2e111a2018-04-20 10:13:48 +01001063 * ::mbedtls_ecdsa_context.
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01001064 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001065 * \param grp The ECP group to generate a key pair for.
1066 * This must be initialized and have group parameters
1067 * set, for example through mbedtls_ecp_group_load().
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001068 * \param d The destination MPI (secret part).
Hanno Beckerebffa792018-12-14 15:07:50 +00001069 * This must be initialized.
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001070 * \param Q The destination point (public part).
Hanno Beckerebffa792018-12-14 15:07:50 +00001071 * This must be initialized.
1072 * \param f_rng The RNG function. This must not be \c NULL.
1073 * \param p_rng The RNG context to be passed to \p f_rng. This may
1074 * be \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +02001075 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001076 * \return \c 0 on success.
1077 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code
1078 * on failure.
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01001079 */
Hanno Beckerebffa792018-12-14 15:07:50 +00001080int mbedtls_ecp_gen_keypair( mbedtls_ecp_group *grp, mbedtls_mpi *d,
1081 mbedtls_ecp_point *Q,
1082 int (*f_rng)(void *, unsigned char *, size_t),
1083 void *p_rng );
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +01001084
1085/**
Rose Zadikf56cb342018-04-19 12:49:10 +01001086 * \brief This function generates an ECP key.
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001087 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001088 * \param grp_id The ECP group identifier.
Hanno Beckerebffa792018-12-14 15:07:50 +00001089 * \param key The destination key. This must be initialized.
1090 * \param f_rng The RNG function to use. This must not be \c NULL.
1091 * \param p_rng The RNG context to be passed to \p f_rng. This may
1092 * be \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001093 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001094 * \return \c 0 on success.
1095 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code
1096 * on failure.
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001097 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098int mbedtls_ecp_gen_key( mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
Hanno Beckerebffa792018-12-14 15:07:50 +00001099 int (*f_rng)(void *, unsigned char *, size_t),
1100 void *p_rng );
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001101
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001102/**
Janos Follathb65853c2019-02-25 16:33:28 +00001103 * \brief This function reads an elliptic curve private key.
Janos Follath171a7ef2019-02-15 16:17:45 +00001104 *
1105 * \param grp_id The ECP group identifier.
1106 * \param key The destination key.
1107 * \param buf The the buffer containing the binary representation of the
1108 * key. (Big endian integer for Weierstrass curves, byte
1109 * string for Montgomery curves.)
1110 * \param buflen The length of the buffer in bytes.
1111 *
1112 * \return \c 0 on success.
Janos Follathb65853c2019-02-25 16:33:28 +00001113 * \return #MBEDTLS_ERR_ECP_INVALID_KEY error if the key is
1114 * invalid.
1115 * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed.
Janos Follath28eb06d2019-02-26 10:53:34 +00001116 * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the operation for
1117 * the group is not implemented.
Janos Follathb65853c2019-02-25 16:33:28 +00001118 * \return Another negative error code on different kinds of failure.
Janos Follath171a7ef2019-02-15 16:17:45 +00001119 */
1120int mbedtls_ecp_read_key( mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
1121 const unsigned char *buf, size_t buflen );
1122/**
Rose Zadika7a61552018-04-24 13:14:01 +01001123 * \brief This function checks that the keypair objects
Rose Zadikb2e111a2018-04-20 10:13:48 +01001124 * \p pub and \p prv have the same group and the
1125 * same public point, and that the private key in
1126 * \p prv is consistent with the public key.
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001127 *
Hanno Beckerebffa792018-12-14 15:07:50 +00001128 * \param pub The keypair structure holding the public key. This
1129 * must be initialized. If it contains a private key, that
1130 * part is ignored.
Rose Zadikb2e111a2018-04-20 10:13:48 +01001131 * \param prv The keypair structure holding the full keypair.
Hanno Beckerebffa792018-12-14 15:07:50 +00001132 * This must be initialized.
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001133 *
Rose Zadika7a61552018-04-24 13:14:01 +01001134 * \return \c 0 on success, meaning that the keys are valid and match.
Rose Zadikb2e111a2018-04-20 10:13:48 +01001135 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the keys are invalid or do not match.
Rose Zadika7a61552018-04-24 13:14:01 +01001136 * \return An \c MBEDTLS_ERR_ECP_XXX or an \c MBEDTLS_ERR_MPI_XXX
Rose Zadikb2e111a2018-04-20 10:13:48 +01001137 * error code on calculation failure.
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001138 */
Hanno Beckerebffa792018-12-14 15:07:50 +00001139int mbedtls_ecp_check_pub_priv( const mbedtls_ecp_keypair *pub,
1140 const mbedtls_ecp_keypair *prv );
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +01001141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142#if defined(MBEDTLS_SELF_TEST)
Janos Follathb0697532016-08-18 12:38:46 +01001143
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +01001144/**
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001145 * \brief The ECP checkup routine.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001146 *
Rose Zadikd3c9bfc2018-04-17 10:56:55 +01001147 * \return \c 0 on success.
1148 * \return \c 1 on failure.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150int mbedtls_ecp_self_test( int verbose );
Janos Follathb0697532016-08-18 12:38:46 +01001151
Janos Follath372697b2016-10-28 16:53:11 +01001152#endif /* MBEDTLS_SELF_TEST */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001153
1154#ifdef __cplusplus
1155}
1156#endif
1157
Paul Bakker9af723c2014-05-01 13:03:14 +02001158#endif /* ecp.h */