mbed TLS v2.7.17
ecp.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 #ifndef MBEDTLS_ECP_H
50 #define MBEDTLS_ECP_H
51 
52 #if !defined(MBEDTLS_CONFIG_FILE)
53 #include "config.h"
54 #else
55 #include MBEDTLS_CONFIG_FILE
56 #endif
57 
58 #include "bignum.h"
59 
60 /*
61  * ECP error codes
62  */
63 #define MBEDTLS_ERR_ECP_BAD_INPUT_DATA -0x4F80
64 #define MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL -0x4F00
65 #define MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE -0x4E80
66 #define MBEDTLS_ERR_ECP_VERIFY_FAILED -0x4E00
67 #define MBEDTLS_ERR_ECP_ALLOC_FAILED -0x4D80
68 #define MBEDTLS_ERR_ECP_RANDOM_FAILED -0x4D00
69 #define MBEDTLS_ERR_ECP_INVALID_KEY -0x4C80
70 #define MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH -0x4C00
71 #define MBEDTLS_ERR_ECP_HW_ACCEL_FAILED -0x4B80
73 #if !defined(MBEDTLS_ECP_ALT)
74 /*
75  * default mbed TLS elliptic curve arithmetic implementation
76  *
77  * (in case MBEDTLS_ECP_ALT is defined then the developer has to provide an
78  * alternative implementation for the whole module and it will replace this
79  * one.)
80  */
81 
82 #ifdef __cplusplus
83 extern "C" {
84 #endif
85 
95 typedef enum
96 {
111 
117 #define MBEDTLS_ECP_DP_MAX 12
118 
122 typedef struct
123 {
125  uint16_t tls_id;
126  uint16_t bit_size;
127  const char *name;
129 
139 typedef struct
140 {
144 }
146 
171 typedef struct
172 {
179  size_t pbits;
180  size_t nbits;
181  unsigned int h;
182  int (*modp)(mbedtls_mpi *);
183  int (*t_pre)(mbedtls_ecp_point *, void *);
184  int (*t_post)(mbedtls_ecp_point *, void *);
185  void *t_data;
187  size_t T_size;
188 }
190 
198 typedef struct
199 {
203 }
205 
214 #if !defined(MBEDTLS_ECP_MAX_BITS)
215 
218 #define MBEDTLS_ECP_MAX_BITS 521
219 #endif
220 
221 #define MBEDTLS_ECP_MAX_BYTES ( ( MBEDTLS_ECP_MAX_BITS + 7 ) / 8 )
222 #define MBEDTLS_ECP_MAX_PT_LEN ( 2 * MBEDTLS_ECP_MAX_BYTES + 1 )
223 
224 #if !defined(MBEDTLS_ECP_WINDOW_SIZE)
225 /*
226  * Maximum "window" size used for point multiplication.
227  * Default: 6.
228  * Minimum value: 2. Maximum value: 7.
229  *
230  * Result is an array of at most ( 1 << ( MBEDTLS_ECP_WINDOW_SIZE - 1 ) )
231  * points used for point multiplication. This value is directly tied to EC
232  * peak memory usage, so decreasing it by one should roughly cut memory usage
233  * by two (if large curves are in use).
234  *
235  * Reduction in size may reduce speed, but larger curves are impacted first.
236  * Sample performances (in ECDHE handshakes/s, with FIXED_POINT_OPTIM = 1):
237  * w-size: 6 5 4 3 2
238  * 521 145 141 135 120 97
239  * 384 214 209 198 177 146
240  * 256 320 320 303 262 226
241 
242  * 224 475 475 453 398 342
243  * 192 640 640 633 587 476
244  */
245 #define MBEDTLS_ECP_WINDOW_SIZE 6
246 #endif /* MBEDTLS_ECP_WINDOW_SIZE */
247 
248 #if !defined(MBEDTLS_ECP_FIXED_POINT_OPTIM)
249 /*
250  * Trade memory for speed on fixed-point multiplication.
251  *
252  * This speeds up repeated multiplication of the generator (that is, the
253  * multiplication in ECDSA signatures, and half of the multiplications in
254  * ECDSA verification and ECDHE) by a factor roughly 3 to 4.
255  *
256  * The cost is increasing EC peak memory usage by a factor roughly 2.
257  *
258  * Change this value to 0 to reduce peak memory usage.
259  */
260 #define MBEDTLS_ECP_FIXED_POINT_OPTIM 1
261 #endif /* MBEDTLS_ECP_FIXED_POINT_OPTIM */
262 
263 /* \} name SECTION: Module settings */
264 
265 /*
266  * Point formats, from RFC 4492's enum ECPointFormat
267  */
268 #define MBEDTLS_ECP_PF_UNCOMPRESSED 0
269 #define MBEDTLS_ECP_PF_COMPRESSED 1
271 /*
272  * Some other constants from RFC 4492
273  */
274 #define MBEDTLS_ECP_TLS_NAMED_CURVE 3
282 const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list( void );
283 
292 
301 
310 
319 
324 
329 
334 
339 
344 
349 
360 
371 
381 
390 
404  const mbedtls_ecp_point *Q );
405 
417  const char *x, const char *y );
418 
434  int format, size_t *olen,
435  unsigned char *buf, size_t buflen );
436 
456  const unsigned char *buf, size_t ilen );
457 
473  const unsigned char **buf, size_t len );
474 
490  int format, size_t *olen,
491  unsigned char *buf, size_t blen );
492 
507 
521 int mbedtls_ecp_tls_read_group( mbedtls_ecp_group *grp, const unsigned char **buf, size_t len );
522 
534 int mbedtls_ecp_tls_write_group( const mbedtls_ecp_group *grp, size_t *olen,
535  unsigned char *buf, size_t blen );
536 
567  const mbedtls_mpi *m, const mbedtls_ecp_point *P,
568  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
569 
591  const mbedtls_mpi *m, const mbedtls_ecp_point *P,
592  const mbedtls_mpi *n, const mbedtls_ecp_point *Q );
593 
616 
630 int mbedtls_ecp_check_privkey( const mbedtls_ecp_group *grp, const mbedtls_mpi *d );
631 
644  mbedtls_mpi *d,
645  int (*f_rng)(void *, unsigned char *, size_t),
646  void *p_rng );
647 
666  const mbedtls_ecp_point *G,
668  int (*f_rng)(void *, unsigned char *, size_t),
669  void *p_rng );
670 
688  int (*f_rng)(void *, unsigned char *, size_t),
689  void *p_rng );
690 
703  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
704 
716 
717 #if defined(MBEDTLS_SELF_TEST)
718 
724 int mbedtls_ecp_self_test( int verbose );
725 
726 #endif /* MBEDTLS_SELF_TEST */
727 
728 #ifdef __cplusplus
729 }
730 #endif
731 
732 #else /* MBEDTLS_ECP_ALT */
733 #include "ecp_alt.h"
734 #endif /* MBEDTLS_ECP_ALT */
735 
736 #endif /* ecp.h */
uint16_t tls_id
Definition: ecp.h:125
int mbedtls_ecp_is_zero(mbedtls_ecp_point *pt)
Tell if a point is zero.
mbedtls_mpi N
Definition: ecp.h:178
mbedtls_mpi Z
Definition: ecp.h:143
int mbedtls_ecp_muladd(mbedtls_ecp_group *grp, mbedtls_ecp_point *R, const mbedtls_mpi *m, const mbedtls_ecp_point *P, const mbedtls_mpi *n, const mbedtls_ecp_point *Q)
Multiplication and addition of two points by integers: R = m * P + n * Q (Not thread-safe to use same...
int mbedtls_ecp_check_pub_priv(const mbedtls_ecp_keypair *pub, const mbedtls_ecp_keypair *prv)
Check a public-private key pair.
int mbedtls_ecp_point_read_binary(const mbedtls_ecp_group *grp, mbedtls_ecp_point *P, const unsigned char *buf, size_t ilen)
Import a point from unsigned binary data.
mbedtls_mpi Y
Definition: ecp.h:142
mbedtls_ecp_group grp
Definition: ecp.h:200
ECP key pair structure.
Definition: ecp.h:198
int mbedtls_ecp_set_zero(mbedtls_ecp_point *pt)
Set a point to zero.
int mbedtls_ecp_copy(mbedtls_ecp_point *P, const mbedtls_ecp_point *Q)
Copy the contents of point Q into P.
const mbedtls_ecp_group_id * mbedtls_ecp_grp_id_list(void)
Get the list of supported curves in order of preferrence (grp_id only)
int mbedtls_ecp_group_copy(mbedtls_ecp_group *dst, const mbedtls_ecp_group *src)
Copy the contents of a group object.
Configuration options (set of defines)
size_t nbits
Definition: ecp.h:180
int mbedtls_ecp_gen_keypair(mbedtls_ecp_group *grp, mbedtls_mpi *d, mbedtls_ecp_point *Q, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Generate a keypair.
void mbedtls_ecp_point_free(mbedtls_ecp_point *pt)
Free the components of a point.
int mbedtls_ecp_gen_privkey(const mbedtls_ecp_group *grp, mbedtls_mpi *d, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Generate a private key.
void mbedtls_ecp_keypair_init(mbedtls_ecp_keypair *key)
Initialize a key pair (as an invalid one)
size_t pbits
Definition: ecp.h:179
mbedtls_mpi X
Definition: ecp.h:141
Multi-precision integer library.
int mbedtls_ecp_gen_key(mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Generate a keypair.
ECP group structure.
Definition: ecp.h:171
int mbedtls_ecp_check_privkey(const mbedtls_ecp_group *grp, const mbedtls_mpi *d)
Check that an mbedtls_mpi is a valid private key for this curve.
mbedtls_ecp_group_id id
Definition: ecp.h:173
const mbedtls_ecp_curve_info * mbedtls_ecp_curve_info_from_grp_id(mbedtls_ecp_group_id grp_id)
Get curve information from an internal group identifier.
int mbedtls_ecp_tls_write_group(const mbedtls_ecp_group *grp, size_t *olen, unsigned char *buf, size_t blen)
Write the TLS ECParameters record for a group.
void mbedtls_ecp_group_free(mbedtls_ecp_group *grp)
Free the components of an ECP group.
int mbedtls_ecp_mul(mbedtls_ecp_group *grp, mbedtls_ecp_point *R, const mbedtls_mpi *m, const mbedtls_ecp_point *P, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Multiplication by an integer: R = m * P (Not thread-safe to use same group in multiple threads) ...
int mbedtls_ecp_check_pubkey(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt)
Check that a point is a valid public key on this curve.
mbedtls_mpi A
Definition: ecp.h:175
mbedtls_mpi P
Definition: ecp.h:174
void mbedtls_ecp_keypair_free(mbedtls_ecp_keypair *key)
Free the components of a key pair.
int mbedtls_ecp_tls_read_group(mbedtls_ecp_group *grp, const unsigned char **buf, size_t len)
Set a group from a TLS ECParameters record.
mbedtls_ecp_point Q
Definition: ecp.h:202
void * t_data
Definition: ecp.h:185
void mbedtls_ecp_point_init(mbedtls_ecp_point *pt)
Initialize a point (as zero)
mbedtls_ecp_group_id
Definition: ecp.h:95
int mbedtls_ecp_point_read_string(mbedtls_ecp_point *P, int radix, const char *x, const char *y)
Import a non-zero point from two ASCII strings.
int mbedtls_ecp_self_test(int verbose)
Checkup routine.
int mbedtls_ecp_point_write_binary(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *P, int format, size_t *olen, unsigned char *buf, size_t buflen)
Export a point into unsigned binary data.
const mbedtls_ecp_curve_info * mbedtls_ecp_curve_info_from_tls_id(uint16_t tls_id)
Get curve information from a TLS NamedCurve value.
int mbedtls_ecp_tls_read_point(const mbedtls_ecp_group *grp, mbedtls_ecp_point *pt, const unsigned char **buf, size_t len)
Import a point from a TLS ECPoint record.
mbedtls_ecp_group_id grp_id
Definition: ecp.h:124
int mbedtls_ecp_gen_keypair_base(mbedtls_ecp_group *grp, const mbedtls_ecp_point *G, mbedtls_mpi *d, mbedtls_ecp_point *Q, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Generate a keypair with configurable base point.
mbedtls_mpi d
Definition: ecp.h:201
unsigned int h
Definition: ecp.h:181
int mbedtls_ecp_point_cmp(const mbedtls_ecp_point *P, const mbedtls_ecp_point *Q)
Compare two points.
int mbedtls_ecp_tls_write_point(const mbedtls_ecp_group *grp, const mbedtls_ecp_point *pt, int format, size_t *olen, unsigned char *buf, size_t blen)
Export a point as a TLS ECPoint record.
size_t T_size
Definition: ecp.h:187
mbedtls_ecp_point * T
Definition: ecp.h:186
mbedtls_ecp_point G
Definition: ecp.h:177
MPI structure.
Definition: bignum.h:205
ECP point structure (jacobian coordinates)
Definition: ecp.h:139
const mbedtls_ecp_curve_info * mbedtls_ecp_curve_info_from_name(const char *name)
Get curve information from a human-readable name.
const char * name
Definition: ecp.h:127
int mbedtls_ecp_group_load(mbedtls_ecp_group *grp, mbedtls_ecp_group_id id)
Set a group using well-known domain parameters.
uint16_t bit_size
Definition: ecp.h:126
mbedtls_mpi B
Definition: ecp.h:176
void mbedtls_ecp_group_init(mbedtls_ecp_group *grp)
Initialize a group (to something meaningless)