blob: 2009a364acf6b54280ed8ec8cb8039679a40d0b6 [file] [log] [blame]
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001/**
2 * \file ecp.h
3 *
4 * \brief Elliptic curves over GF(p)
5 *
Manuel Pégourié-Gonnarda658a402015-01-23 09:45:19 +00006 * Copyright (C) 2006-2013, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01007 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +00008 * This file is part of mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01009 *
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010010 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_ECP_H
25#define MBEDTLS_ECP_H
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010026
Manuel Pégourié-Gonnardbdc96762013-10-03 11:50:39 +020027#include "bignum.h"
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010028
29/*
Manuel Pégourié-Gonnard7cfcea32012-11-05 10:06:12 +010030 * ECP error codes
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010031 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#define MBEDTLS_ERR_ECP_BAD_INPUT_DATA -0x4F80 /**< Bad input parameters to function. */
33#define MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL -0x4F00 /**< The buffer is too small to write to. */
34#define MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE -0x4E80 /**< Requested curve not available. */
35#define MBEDTLS_ERR_ECP_VERIFY_FAILED -0x4E00 /**< The signature is not valid. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +020036#define MBEDTLS_ERR_ECP_ALLOC_FAILED -0x4D80 /**< Memory allocation failed. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020037#define MBEDTLS_ERR_ECP_RANDOM_FAILED -0x4D00 /**< Generation of random value, such as (ephemeral) key, failed. */
38#define MBEDTLS_ERR_ECP_INVALID_KEY -0x4C80 /**< Invalid private or public key. */
39#define MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH -0x4C00 /**< Signature is valid but shorter than the user-supplied length. */
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +010040
Paul Bakker407a0da2013-06-27 14:29:21 +020041#ifdef __cplusplus
42extern "C" {
43#endif
44
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010045/**
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020046 * Domain parameters (curve, subgroup and generator) identifiers.
47 *
48 * Only curves over prime fields are supported.
49 *
50 * \warning This library does not support validation of arbitrary domain
51 * parameters. Therefore, only well-known domain parameters from trusted
Manuel Pégourié-Gonnarde3a062b2015-05-11 18:46:47 +020052 * sources should be used. See mbedtls_ecp_group_load().
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020053 */
54typedef enum
55{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020056 MBEDTLS_ECP_DP_NONE = 0,
57 MBEDTLS_ECP_DP_SECP192R1, /*!< 192-bits NIST curve */
58 MBEDTLS_ECP_DP_SECP224R1, /*!< 224-bits NIST curve */
59 MBEDTLS_ECP_DP_SECP256R1, /*!< 256-bits NIST curve */
60 MBEDTLS_ECP_DP_SECP384R1, /*!< 384-bits NIST curve */
61 MBEDTLS_ECP_DP_SECP521R1, /*!< 521-bits NIST curve */
62 MBEDTLS_ECP_DP_BP256R1, /*!< 256-bits Brainpool curve */
63 MBEDTLS_ECP_DP_BP384R1, /*!< 384-bits Brainpool curve */
64 MBEDTLS_ECP_DP_BP512R1, /*!< 512-bits Brainpool curve */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +020065 MBEDTLS_ECP_DP_CURVE25519, /*!< Curve25519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020066 MBEDTLS_ECP_DP_SECP192K1, /*!< 192-bits "Koblitz" curve */
67 MBEDTLS_ECP_DP_SECP224K1, /*!< 224-bits "Koblitz" curve */
68 MBEDTLS_ECP_DP_SECP256K1, /*!< 256-bits "Koblitz" curve */
69} mbedtls_ecp_group_id;
Manuel Pégourié-Gonnard70380392013-09-16 16:19:53 +020070
71/**
Manuel Pégourié-Gonnard66153662013-12-03 14:12:26 +010072 * Number of supported curves (plus one for NONE).
73 *
74 * (Montgomery curves excluded for now.)
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +020075 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020076#define MBEDTLS_ECP_DP_MAX 12
Manuel Pégourié-Gonnardf24b4a72013-09-23 18:14:50 +020077
78/**
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +020079 * Curve information for use by other modules
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +020080 */
81typedef struct
82{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020083 mbedtls_ecp_group_id grp_id; /*!< Internal identifier */
Manuel Pégourié-Gonnard797f48a2015-06-18 15:45:05 +020084 uint16_t tls_id; /*!< TLS NamedCurve identifier */
85 uint16_t bit_size; /*!< Curve size in bits */
86 const char *name; /*!< Human-friendly name */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087} mbedtls_ecp_curve_info;
Manuel Pégourié-Gonnard568c9cf2013-09-16 17:30:04 +020088
89/**
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +010090 * \brief ECP point structure (jacobian coordinates)
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +010091 *
Manuel Pégourié-Gonnard1c2782c2012-11-19 20:16:28 +010092 * \note All functions expect and return points satisfying
93 * the following condition: Z == 0 or Z == 1. (Other
94 * values of Z are used by internal functions only.)
95 * The point is zero, or "at infinity", if Z == 0.
96 * Otherwise, X and Y are its standard (affine) coordinates.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +010097 */
98typedef struct
99{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200100 mbedtls_mpi X; /*!< the point's X coordinate */
101 mbedtls_mpi Y; /*!< the point's Y coordinate */
102 mbedtls_mpi Z; /*!< the point's Z coordinate */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100103}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200104mbedtls_ecp_point;
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100105
106/**
107 * \brief ECP group structure
108 *
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +0100109 * We consider two types of curves equations:
110 * 1. Short Weierstrass y^2 = x^3 + A x + B mod P (SEC1 + RFC 4492)
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200111 * 2. Montgomery, y^2 = x^3 + A x^2 + x mod P (Curve25519 + draft)
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +0100112 * In both cases, a generator G for a prime-order subgroup is fixed. In the
113 * short weierstrass, this subgroup is actually the whole curve, and its
114 * cardinal is denoted by N.
Manuel Pégourié-Gonnard62aad142012-11-10 00:27:12 +0100115 *
Manuel Pégourié-Gonnarddd75c312014-03-31 11:55:42 +0200116 * In the case of Short Weierstrass curves, our code requires that N is an odd
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117 * prime. (Use odd in mbedtls_ecp_mul() and prime in mbedtls_ecdsa_sign() for blinding.)
Manuel Pégourié-Gonnarddd75c312014-03-31 11:55:42 +0200118 *
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +0100119 * In the case of Montgomery curves, we don't store A but (A + 2) / 4 which is
Paul Bakker75342a62014-04-08 17:35:40 +0200120 * the quantity actually used in the formulas. Also, nbits is not the size of N
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +0100121 * but the required size for private keys.
Manuel Pégourié-Gonnard47123252012-11-10 14:44:24 +0100122 *
Manuel Pégourié-Gonnardc9727702013-09-16 18:56:28 +0200123 * If modp is NULL, reduction modulo P is done using a generic algorithm.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200124 * Otherwise, it must point to a function that takes an mbedtls_mpi in the range
Manuel Pégourié-Gonnardc9727702013-09-16 18:56:28 +0200125 * 0..2^(2*pbits)-1 and transforms it in-place in an integer of little more
126 * than pbits, so that the integer may be efficiently brought in the 0..P-1
127 * range by a few additions or substractions. It must return 0 on success and
128 * non-zero on failure.
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100129 */
130typedef struct
131{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132 mbedtls_ecp_group_id id; /*!< internal group identifier */
133 mbedtls_mpi P; /*!< prime modulus of the base field */
134 mbedtls_mpi A; /*!< 1. A in the equation, or 2. (A + 2) / 4 */
135 mbedtls_mpi B; /*!< 1. B in the equation, or 2. unused */
136 mbedtls_ecp_point G; /*!< generator of the (sub)group used */
137 mbedtls_mpi N; /*!< 1. the order of G, or 2. unused */
Manuel Pégourié-Gonnardcd7458a2013-10-08 13:11:30 +0200138 size_t pbits; /*!< number of bits in P */
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +0100139 size_t nbits; /*!< number of bits in 1. P, or 2. private keys */
Manuel Pégourié-Gonnard1f82b042013-12-06 12:51:50 +0100140 unsigned int h; /*!< internal: 1 if the constants are static */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200141 int (*modp)(mbedtls_mpi *); /*!< function for fast reduction mod P */
142 int (*t_pre)(mbedtls_ecp_point *, void *); /*!< unused */
143 int (*t_post)(mbedtls_ecp_point *, void *); /*!< unused */
Manuel Pégourié-Gonnard7a949d32013-12-05 10:26:01 +0100144 void *t_data; /*!< unused */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200145 mbedtls_ecp_point *T; /*!< pre-computed points for ecp_mul_comb() */
Manuel Pégourié-Gonnardcd7458a2013-10-08 13:11:30 +0200146 size_t T_size; /*!< number for pre-computed points */
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100147}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200148mbedtls_ecp_group;
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100149
150/**
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200151 * \brief ECP key pair structure
152 *
153 * A generic key pair that could be used for ECDSA, fixed ECDH, etc.
Manuel Pégourié-Gonnard09162dd2013-08-14 18:16:50 +0200154 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200155 * \note Members purposefully in the same order as struc mbedtls_ecdsa_context.
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200156 */
157typedef struct
158{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159 mbedtls_ecp_group grp; /*!< Elliptic curve and base point */
160 mbedtls_mpi d; /*!< our secret value */
161 mbedtls_ecp_point Q; /*!< our public value */
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200162}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200163mbedtls_ecp_keypair;
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200164
Paul Bakker088c5c52014-04-25 11:11:10 +0200165/**
166 * \name SECTION: Module settings
167 *
168 * The configuration options you can set for this module are in this section.
169 * Either change them in config.h or define them on the compiler command line.
170 * \{
171 */
172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200173#if !defined(MBEDTLS_ECP_MAX_BITS)
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200174/**
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200175 * Maximum size of the groups (that is, of N and P)
Manuel Pégourié-Gonnardb63f9e92012-11-21 13:00:58 +0100176 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
Paul Bakkere1b665e2013-12-11 16:02:58 +0100178#endif
179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180#define MBEDTLS_ECP_MAX_BYTES ( ( MBEDTLS_ECP_MAX_BITS + 7 ) / 8 )
181#define MBEDTLS_ECP_MAX_PT_LEN ( 2 * MBEDTLS_ECP_MAX_BYTES + 1 )
Manuel Pégourié-Gonnardb63f9e92012-11-21 13:00:58 +0100182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183#if !defined(MBEDTLS_ECP_WINDOW_SIZE)
Manuel Pégourié-Gonnard85556072012-11-17 19:54:20 +0100184/*
Manuel Pégourié-Gonnardc30200e2013-11-20 18:39:55 +0100185 * Maximum "window" size used for point multiplication.
186 * Default: 6.
187 * Minimum value: 2. Maximum value: 7.
Manuel Pégourié-Gonnard85556072012-11-17 19:54:20 +0100188 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189 * Result is an array of at most ( 1 << ( MBEDTLS_ECP_WINDOW_SIZE - 1 ) )
Manuel Pégourié-Gonnard9e4191c2013-12-30 18:41:16 +0100190 * points used for point multiplication. This value is directly tied to EC
191 * peak memory usage, so decreasing it by one should roughly cut memory usage
192 * by two (if large curves are in use).
Manuel Pégourié-Gonnard85556072012-11-17 19:54:20 +0100193 *
Manuel Pégourié-Gonnard9e4191c2013-12-30 18:41:16 +0100194 * Reduction in size may reduce speed, but larger curves are impacted first.
195 * Sample performances (in ECDHE handshakes/s, with FIXED_POINT_OPTIM = 1):
196 * w-size: 6 5 4 3 2
197 * 521 145 141 135 120 97
198 * 384 214 209 198 177 146
199 * 256 320 320 303 262 226
Paul Bakker088c5c52014-04-25 11:11:10 +0200200
Manuel Pégourié-Gonnard9e4191c2013-12-30 18:41:16 +0100201 * 224 475 475 453 398 342
202 * 192 640 640 633 587 476
Manuel Pégourié-Gonnard85556072012-11-17 19:54:20 +0100203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
205#endif /* MBEDTLS_ECP_WINDOW_SIZE */
Manuel Pégourié-Gonnard9e4191c2013-12-30 18:41:16 +0100206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207#if !defined(MBEDTLS_ECP_FIXED_POINT_OPTIM)
Manuel Pégourié-Gonnard9e4191c2013-12-30 18:41:16 +0100208/*
209 * Trade memory for speed on fixed-point multiplication.
210 *
211 * This speeds up repeated multiplication of the generator (that is, the
212 * multiplication in ECDSA signatures, and half of the multiplications in
213 * ECDSA verification and ECDHE) by a factor roughly 3 to 4.
214 *
215 * The cost is increasing EC peak memory usage by a factor roughly 2.
216 *
217 * Change this value to 0 to reduce peak memory usage.
218 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
220#endif /* MBEDTLS_ECP_FIXED_POINT_OPTIM */
Manuel Pégourié-Gonnard85556072012-11-17 19:54:20 +0100221
Paul Bakker088c5c52014-04-25 11:11:10 +0200222/* \} name SECTION: Module settings */
223
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100224/*
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100225 * Point formats, from RFC 4492's enum ECPointFormat
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227#define MBEDTLS_ECP_PF_UNCOMPRESSED 0 /**< Uncompressed point format */
228#define MBEDTLS_ECP_PF_COMPRESSED 1 /**< Compressed point format */
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100229
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100230/*
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100231 * Some other constants from RFC 4492
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233#define MBEDTLS_ECP_TLS_NAMED_CURVE 3 /**< ECCurveType's named_curve */
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100234
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100235/**
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100236 * \brief Get the list of supported curves in order of preferrence
237 * (full information)
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200238 *
239 * \return A statically allocated array, the last entry is 0.
240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list( void );
Manuel Pégourié-Gonnardda179e42013-09-18 15:31:24 +0200242
243/**
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100244 * \brief Get the list of supported curves in order of preferrence
245 * (grp_id only)
246 *
247 * \return A statically allocated array,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248 * terminated with MBEDTLS_ECP_DP_NONE.
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250const mbedtls_ecp_group_id *mbedtls_ecp_grp_id_list( void );
Manuel Pégourié-Gonnardac719412014-02-04 14:48:50 +0100251
252/**
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200253 * \brief Get curve information from an internal group identifier
254 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200255 * \param grp_id A MBEDTLS_ECP_DP_XXX value
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200256 *
257 * \return The associated curve information or NULL
258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259const 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 +0200260
261/**
262 * \brief Get curve information from a TLS NamedCurve value
263 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264 * \param tls_id A MBEDTLS_ECP_DP_XXX value
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200265 *
266 * \return The associated curve information or NULL
267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200268const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_tls_id( uint16_t tls_id );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200269
270/**
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100271 * \brief Get curve information from a human-readable name
272 *
273 * \param name The name
274 *
275 * \return The associated curve information or NULL
276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200277const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_name( const char *name );
Manuel Pégourié-Gonnard0267e3d2013-11-30 15:10:14 +0100278
279/**
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100280 * \brief Initialize a point (as zero)
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100281 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200282void mbedtls_ecp_point_init( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardae180d02012-11-02 18:14:40 +0100283
284/**
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100285 * \brief Initialize a group (to something meaningless)
286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287void mbedtls_ecp_group_init( mbedtls_ecp_group *grp );
Manuel Pégourié-Gonnardb505c272012-11-05 17:27:54 +0100288
289/**
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200290 * \brief Initialize a key pair (as an invalid one)
291 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292void mbedtls_ecp_keypair_init( mbedtls_ecp_keypair *key );
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200293
294/**
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100295 * \brief Free the components of a point
296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200297void mbedtls_ecp_point_free( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100298
299/**
300 * \brief Free the components of an ECP group
301 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302void mbedtls_ecp_group_free( mbedtls_ecp_group *grp );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100303
304/**
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200305 * \brief Free the components of a key pair
306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307void mbedtls_ecp_keypair_free( mbedtls_ecp_keypair *key );
Manuel Pégourié-Gonnardb8c6e0e2013-07-01 13:40:52 +0200308
309/**
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100310 * \brief Copy the contents of point Q into P
311 *
312 * \param P Destination point
313 * \param Q Source point
314 *
Manuel Pégourié-Gonnard7cfcea32012-11-05 10:06:12 +0100315 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200316 * MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318int mbedtls_ecp_copy( mbedtls_ecp_point *P, const mbedtls_ecp_point *Q );
Manuel Pégourié-Gonnard883f3132012-11-02 09:40:25 +0100319
320/**
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200321 * \brief Copy the contents of a group object
322 *
323 * \param dst Destination group
324 * \param src Source group
325 *
326 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200327 * MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329int mbedtls_ecp_group_copy( mbedtls_ecp_group *dst, const mbedtls_ecp_group *src );
Manuel Pégourié-Gonnarde09631b2013-08-12 15:44:31 +0200330
331/**
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200332 * \brief Set a point to zero
333 *
334 * \param pt Destination point
335 *
336 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200337 * MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200339int mbedtls_ecp_set_zero( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200340
341/**
342 * \brief Tell if a point is zero
343 *
344 * \param pt Point to test
345 *
346 * \return 1 if point is zero, 0 otherwise
347 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200348int mbedtls_ecp_is_zero( mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200349
350/**
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100351 * \brief Import a non-zero point from two ASCII strings
352 *
353 * \param P Destination point
354 * \param radix Input numeric base
355 * \param x First affine coordinate as a null-terminated string
356 * \param y Second affine coordinate as a null-terminated string
357 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358 * \return 0 if successful, or a MBEDTLS_ERR_MPI_XXX error code
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360int mbedtls_ecp_point_read_string( mbedtls_ecp_point *P, int radix,
Manuel Pégourié-Gonnard847395a2012-11-05 13:13:44 +0100361 const char *x, const char *y );
362
363/**
Manuel Pégourié-Gonnard37d218a2012-11-24 15:19:55 +0100364 * \brief Export a point into unsigned binary data
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100365 *
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100366 * \param grp Group to which the point should belong
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100367 * \param P Point to export
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * \param format Point format, should be a MBEDTLS_ECP_PF_XXX macro
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100369 * \param olen Length of the actual output
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100370 * \param buf Output buffer
371 * \param buflen Length of the output buffer
372 *
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100373 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200374 * or MBEDTLS_ERR_ECP_BAD_INPUT_DATA
375 * or MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377int mbedtls_ecp_point_write_binary( const mbedtls_ecp_group *grp, const mbedtls_ecp_point *P,
Manuel Pégourié-Gonnard420f1eb2013-02-10 12:22:46 +0100378 int format, size_t *olen,
Manuel Pégourié-Gonnard7e860252013-02-10 10:58:48 +0100379 unsigned char *buf, size_t buflen );
Manuel Pégourié-Gonnarde19feb52012-11-24 14:10:14 +0100380
381/**
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100382 * \brief Import a point from unsigned binary data
383 *
384 * \param grp Group to which the point should belong
385 * \param P Point to import
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100386 * \param buf Input buffer
387 * \param ilen Actual length of input
388 *
389 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390 * MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200391 * MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392 * MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the point format
Manuel Pégourié-Gonnard5246ee52014-03-19 16:18:38 +0100393 * is not implemented.
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100394 *
395 * \note This function does NOT check that the point actually
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396 * belongs to the given group, see mbedtls_ecp_check_pubkey() for
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100397 * that.
398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399int mbedtls_ecp_point_read_binary( const mbedtls_ecp_group *grp, mbedtls_ecp_point *P,
Manuel Pégourié-Gonnard7e860252013-02-10 10:58:48 +0100400 const unsigned char *buf, size_t ilen );
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100401
Manuel Pégourié-Gonnard5e402d82012-11-24 16:19:42 +0100402/**
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200403 * \brief Import a point from a TLS ECPoint record
404 *
405 * \param grp ECP group used
406 * \param pt Destination point
407 * \param buf $(Start of input buffer)
408 * \param len Buffer length
409 *
Manuel Pégourié-Gonnard150c4f62014-11-21 09:14:52 +0100410 * \note buf is updated to point right after the ECPoint on exit
411 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +0200412 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200413 * MBEDTLS_ERR_MPI_XXX if initialization failed
414 * MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416int mbedtls_ecp_tls_read_point( const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt,
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200417 const unsigned char **buf, size_t len );
418
419/**
420 * \brief Export a point as a TLS ECPoint record
421 *
422 * \param grp ECP group used
423 * \param pt Point to export
424 * \param format Export format
425 * \param olen length of data written
426 * \param buf Buffer to write to
427 * \param blen Buffer length
428 *
429 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430 * or MBEDTLS_ERR_ECP_BAD_INPUT_DATA
431 * or MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433int mbedtls_ecp_tls_write_point( const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt,
Manuel Pégourié-Gonnardcae6f3e2013-10-23 20:19:57 +0200434 int format, size_t *olen,
435 unsigned char *buf, size_t blen );
436
437/**
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100438 * \brief Set a group using well-known domain parameters
439 *
440 * \param grp Destination group
441 * \param index Index in the list of well-known domain parameters
442 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +0200443 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200444 * MBEDTLS_ERR_MPI_XXX if initialization failed
445 * MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE for unkownn groups
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100446 *
Manuel Pégourié-Gonnardaff37e52015-05-11 18:11:57 +0200447 * \note Index should be a value of RFC 4492's enum NamedCurve,
448 * usually in the form of a MBEDTLS_ECP_DP_XXX macro.
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100449 */
Manuel Pégourié-Gonnarde3a062b2015-05-11 18:46:47 +0200450int mbedtls_ecp_group_load( mbedtls_ecp_group *grp, mbedtls_ecp_group_id index );
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100451
452/**
Manuel Pégourié-Gonnard00794052013-02-09 19:00:07 +0100453 * \brief Set a group from a TLS ECParameters record
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100454 *
455 * \param grp Destination group
Manuel Pégourié-Gonnard7c145c62013-02-10 13:20:52 +0100456 * \param buf &(Start of input buffer)
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100457 * \param len Buffer length
458 *
Manuel Pégourié-Gonnard150c4f62014-11-21 09:14:52 +0100459 * \note buf is updated to point right after ECParameters on exit
460 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +0200461 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200462 * MBEDTLS_ERR_MPI_XXX if initialization failed
463 * MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid
Manuel Pégourié-Gonnard1a967282013-02-09 17:03:58 +0100464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200465int mbedtls_ecp_tls_read_group( mbedtls_ecp_group *grp, const unsigned char **buf, size_t len );
Manuel Pégourié-Gonnarda5402fe2012-11-07 20:24:05 +0100466
467/**
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100468 * \brief Write the TLS ECParameters record for a group
469 *
470 * \param grp ECP group used
471 * \param olen Number of bytes actually written
472 * \param buf Buffer to write to
473 * \param blen Buffer length
474 *
475 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200476 * or MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478int mbedtls_ecp_tls_write_group( const mbedtls_ecp_group *grp, size_t *olen,
Manuel Pégourié-Gonnardb3258872013-02-10 12:06:19 +0100479 unsigned char *buf, size_t blen );
480
481/**
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100482 * \brief Multiplication by an integer: R = m * P
Paul Bakker6838bd12013-09-30 13:56:38 +0200483 * (Not thread-safe to use same group in multiple threads)
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100484 *
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200485 * \note In order to prevent timing attacks, this function
486 * executes the exact same sequence of (base field)
487 * operations for any valid m. It avoids any if-branch or
488 * array index depending on the value of m.
489 *
490 * \note If f_rng is not NULL, it is used to randomize intermediate
491 * results in order to prevent potential timing attacks
492 * targeting these results. It is recommended to always
493 * provide a non-NULL f_rng (the overhead is negligible).
494 *
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100495 * \param grp ECP group
496 * \param R Destination point
497 * \param m Integer by which to multiply
498 * \param P Point to multiply
Manuel Pégourié-Gonnarde09d2f82013-09-02 14:29:09 +0200499 * \param f_rng RNG function (see notes)
500 * \param p_rng RNG parameter
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100501 *
Manuel Pégourié-Gonnard7cfcea32012-11-05 10:06:12 +0100502 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200503 * MBEDTLS_ERR_ECP_INVALID_KEY if m is not a valid privkey
Manuel Pégourié-Gonnardff27b7c2013-11-21 09:28:03 +0100504 * or P is not a valid pubkey,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200505 * MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200507int mbedtls_ecp_mul( mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
508 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
Manuel Pégourié-Gonnard09ceaf42013-11-20 23:06:14 +0100509 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100510
511/**
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200512 * \brief Multiplication and addition of two points by integers:
513 * R = m * P + n * Q
514 * (Not thread-safe to use same group in multiple threads)
515 *
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +0200516 * \note In contrast to mbedtls_ecp_mul(), this function does not guarantee
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200517 * a constant execution flow and timing.
518 *
519 * \param grp ECP group
520 * \param R Destination point
521 * \param m Integer by which to multiply P
522 * \param P Point to multiply by m
523 * \param n Integer by which to multiply Q
524 * \param Q Point to be multiplied by n
525 *
526 * \return 0 if successful,
527 * MBEDTLS_ERR_ECP_INVALID_KEY if m or n is not a valid privkey
528 * or P or Q is not a valid pubkey,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200529 * MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed
Manuel Pégourié-Gonnard56cc88a2015-05-11 18:40:45 +0200530 */
531int mbedtls_ecp_muladd( mbedtls_ecp_group *grp, mbedtls_ecp_point *R,
532 const mbedtls_mpi *m, const mbedtls_ecp_point *P,
533 const mbedtls_mpi *n, const mbedtls_ecp_point *Q );
534
535/**
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200536 * \brief Check that a point is a valid public key on this curve
537 *
538 * \param grp Curve/group the point should belong to
539 * \param pt Point to check
540 *
541 * \return 0 if point is a valid public key,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542 * MBEDTLS_ERR_ECP_INVALID_KEY otherwise.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200543 *
544 * \note This function only checks the point is non-zero, has valid
545 * coordinates and lies on the curve, but not that it is
546 * indeed a multiple of G. This is additional check is more
547 * expensive, isn't required by standards, and shouldn't be
548 * necessary if the group used has a small cofactor. In
549 * particular, it is useless for the NIST groups which all
550 * have a cofactor of 1.
551 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552 * \note Uses bare components rather than an mbedtls_ecp_keypair structure
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200553 * in order to ease use with other structures such as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554 * mbedtls_ecdh_context of mbedtls_ecdsa_context.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556int mbedtls_ecp_check_pubkey( const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt );
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200557
558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 * \brief Check that an mbedtls_mpi is a valid private key for this curve
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200560 *
561 * \param grp Group used
562 * \param d Integer to check
563 *
564 * \return 0 if point is a valid private key,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 * MBEDTLS_ERR_ECP_INVALID_KEY otherwise.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200566 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * \note Uses bare components rather than an mbedtls_ecp_keypair structure
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200568 * in order to ease use with other structures such as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569 * mbedtls_ecdh_context of mbedtls_ecdsa_context.
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571int mbedtls_ecp_check_privkey( const mbedtls_ecp_group *grp, const mbedtls_mpi *d );
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200572
573/**
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +0100574 * \brief Generate a keypair
575 *
576 * \param grp ECP group
577 * \param d Destination MPI (secret part)
578 * \param Q Destination point (public part)
579 * \param f_rng RNG function
580 * \param p_rng RNG parameter
581 *
582 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200583 * or a MBEDTLS_ERR_ECP_XXX or MBEDTLS_MPI_XXX error code
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200584 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200585 * \note Uses bare components rather than an mbedtls_ecp_keypair structure
Manuel Pégourié-Gonnardc8dc2952013-07-01 14:06:13 +0200586 * in order to ease use with other structures such as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587 * mbedtls_ecdh_context of mbedtls_ecdsa_context.
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +0100588 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200589int mbedtls_ecp_gen_keypair( mbedtls_ecp_group *grp, mbedtls_mpi *d, mbedtls_ecp_point *Q,
Manuel Pégourié-Gonnard45a035a2013-01-26 14:42:45 +0100590 int (*f_rng)(void *, unsigned char *, size_t),
591 void *p_rng );
592
593/**
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +0100594 * \brief Generate a keypair
595 *
596 * \param grp_id ECP group identifier
597 * \param key Destination keypair
598 * \param f_rng RNG function
599 * \param p_rng RNG parameter
600 *
601 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602 * or a MBEDTLS_ERR_ECP_XXX or MBEDTLS_MPI_XXX error code
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +0100603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604int mbedtls_ecp_gen_key( mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +0100605 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
606
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +0100607/**
608 * \brief Check a public-private key pair
609 *
610 * \param pub Keypair structure holding a public key
611 * \param prv Keypair structure holding a private (plus public) key
612 *
Manuel Pégourié-Gonnard862d5032015-04-15 11:30:46 +0200613 * \return 0 if successful (keys are valid and match), or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 * MBEDTLS_ERR_ECP_BAD_INPUT_DATA, or
615 * a MBEDTLS_ERR_ECP_XXX or MBEDTLS_ERR_MPI_XXX code.
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +0100616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617int mbedtls_ecp_check_pub_priv( const mbedtls_ecp_keypair *pub, const mbedtls_ecp_keypair *prv );
Manuel Pégourié-Gonnard30668d62014-11-06 15:25:32 +0100618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619#if defined(MBEDTLS_SELF_TEST)
Manuel Pégourié-Gonnard104ee1d2013-11-30 14:13:16 +0100620/**
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100621 * \brief Checkup routine
622 *
Manuel Pégourié-Gonnard13a1ef82014-03-27 20:12:44 +0100623 * \return 0 if successful, or 1 if a test failed
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100624 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200625int mbedtls_ecp_self_test( int verbose );
Manuel Pégourié-Gonnard13a1ef82014-03-27 20:12:44 +0100626#endif
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +0100627
628#ifdef __cplusplus
629}
630#endif
631
Paul Bakker9af723c2014-05-01 13:03:14 +0200632#endif /* ecp.h */