mbed TLS v2.7.11
ecp.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8  * SPDX-License-Identifier: Apache-2.0
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License"); you may
11  * not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  *
22  * This file is part of mbed TLS (https://tls.mbed.org)
23  */
24 #ifndef MBEDTLS_ECP_H
25 #define MBEDTLS_ECP_H
26 
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32 
33 #include "bignum.h"
34 
35 /*
36  * ECP error codes
37  */
38 #define MBEDTLS_ERR_ECP_BAD_INPUT_DATA -0x4F80
39 #define MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL -0x4F00
40 #define MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE -0x4E80
41 #define MBEDTLS_ERR_ECP_VERIFY_FAILED -0x4E00
42 #define MBEDTLS_ERR_ECP_ALLOC_FAILED -0x4D80
43 #define MBEDTLS_ERR_ECP_RANDOM_FAILED -0x4D00
44 #define MBEDTLS_ERR_ECP_INVALID_KEY -0x4C80
45 #define MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH -0x4C00
46 #define MBEDTLS_ERR_ECP_HW_ACCEL_FAILED -0x4B80
48 #if !defined(MBEDTLS_ECP_ALT)
49 /*
50  * default mbed TLS elliptic curve arithmetic implementation
51  *
52  * (in case MBEDTLS_ECP_ALT is defined then the developer has to provide an
53  * alternative implementation for the whole module and it will replace this
54  * one.)
55  */
56 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
70 typedef enum
71 {
86 
92 #define MBEDTLS_ECP_DP_MAX 12
93 
97 typedef struct
98 {
100  uint16_t tls_id;
101  uint16_t bit_size;
102  const char *name;
104 
114 typedef struct
115 {
119 }
121 
146 typedef struct
147 {
154  size_t pbits;
155  size_t nbits;
156  unsigned int h;
157  int (*modp)(mbedtls_mpi *);
158  int (*t_pre)(mbedtls_ecp_point *, void *);
159  int (*t_post)(mbedtls_ecp_point *, void *);
160  void *t_data;
162  size_t T_size;
163 }
165 
173 typedef struct
174 {
178 }
180 
189 #if !defined(MBEDTLS_ECP_MAX_BITS)
190 
193 #define MBEDTLS_ECP_MAX_BITS 521
194 #endif
195 
196 #define MBEDTLS_ECP_MAX_BYTES ( ( MBEDTLS_ECP_MAX_BITS + 7 ) / 8 )
197 #define MBEDTLS_ECP_MAX_PT_LEN ( 2 * MBEDTLS_ECP_MAX_BYTES + 1 )
198 
199 #if !defined(MBEDTLS_ECP_WINDOW_SIZE)
200 /*
201  * Maximum "window" size used for point multiplication.
202  * Default: 6.
203  * Minimum value: 2. Maximum value: 7.
204  *
205  * Result is an array of at most ( 1 << ( MBEDTLS_ECP_WINDOW_SIZE - 1 ) )
206  * points used for point multiplication. This value is directly tied to EC
207  * peak memory usage, so decreasing it by one should roughly cut memory usage
208  * by two (if large curves are in use).
209  *
210  * Reduction in size may reduce speed, but larger curves are impacted first.
211  * Sample performances (in ECDHE handshakes/s, with FIXED_POINT_OPTIM = 1):
212  * w-size: 6 5 4 3 2
213  * 521 145 141 135 120 97
214  * 384 214 209 198 177 146
215  * 256 320 320 303 262 226
216 
217  * 224 475 475 453 398 342
218  * 192 640 640 633 587 476
219  */
220 #define MBEDTLS_ECP_WINDOW_SIZE 6
221 #endif /* MBEDTLS_ECP_WINDOW_SIZE */
222 
223 #if !defined(MBEDTLS_ECP_FIXED_POINT_OPTIM)
224 /*
225  * Trade memory for speed on fixed-point multiplication.
226  *
227  * This speeds up repeated multiplication of the generator (that is, the
228  * multiplication in ECDSA signatures, and half of the multiplications in
229  * ECDSA verification and ECDHE) by a factor roughly 3 to 4.
230  *
231  * The cost is increasing EC peak memory usage by a factor roughly 2.
232  *
233  * Change this value to 0 to reduce peak memory usage.
234  */
235 #define MBEDTLS_ECP_FIXED_POINT_OPTIM 1
236 #endif /* MBEDTLS_ECP_FIXED_POINT_OPTIM */
237 
238 /* \} name SECTION: Module settings */
239 
240 /*
241  * Point formats, from RFC 4492's enum ECPointFormat
242  */
243 #define MBEDTLS_ECP_PF_UNCOMPRESSED 0
244 #define MBEDTLS_ECP_PF_COMPRESSED 1
246 /*
247  * Some other constants from RFC 4492
248  */
249 #define MBEDTLS_ECP_TLS_NAMED_CURVE 3
257 const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list( void );
258 
267 
276 
285 
294 
299 
304 
309 
314 
319 
324 
335 
346 
356 
365 
379  const mbedtls_ecp_point *Q );
380 
392  const char *x, const char *y );
393 
409  int format, size_t *olen,
410  unsigned char *buf, size_t buflen );
411 
431  const unsigned char *buf, size_t ilen );
432 
448  const unsigned char **buf, size_t len );
449 
465  int format, size_t *olen,
466  unsigned char *buf, size_t blen );
467 
482 
496 int mbedtls_ecp_tls_read_group( mbedtls_ecp_group *grp, const unsigned char **buf, size_t len );
497 
509 int mbedtls_ecp_tls_write_group( const mbedtls_ecp_group *grp, size_t *olen,
510  unsigned char *buf, size_t blen );
511 
539  const mbedtls_mpi *m, const mbedtls_ecp_point *P,
540  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
541 
563  const mbedtls_mpi *m, const mbedtls_ecp_point *P,
564  const mbedtls_mpi *n, const mbedtls_ecp_point *Q );
565 
588 
602 int mbedtls_ecp_check_privkey( const mbedtls_ecp_group *grp, const mbedtls_mpi *d );
603 
622  const mbedtls_ecp_point *G,
624  int (*f_rng)(void *, unsigned char *, size_t),
625  void *p_rng );
626 
644  int (*f_rng)(void *, unsigned char *, size_t),
645  void *p_rng );
646 
659  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
660 
672 
673 #if defined(MBEDTLS_SELF_TEST)
674 
680 int mbedtls_ecp_self_test( int verbose );
681 
682 #endif /* MBEDTLS_SELF_TEST */
683 
684 #ifdef __cplusplus
685 }
686 #endif
687 
688 #else /* MBEDTLS_ECP_ALT */
689 #include "ecp_alt.h"
690 #endif /* MBEDTLS_ECP_ALT */
691 
692 #endif /* ecp.h */
uint16_t tls_id
Definition: ecp.h:100
int mbedtls_ecp_is_zero(mbedtls_ecp_point *pt)
Tell if a point is zero.
mbedtls_mpi N
Definition: ecp.h:153
mbedtls_mpi Z
Definition: ecp.h:118
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:117
mbedtls_ecp_group grp
Definition: ecp.h:175
ECP key pair structure.
Definition: ecp.h:173
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:155
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.
void mbedtls_ecp_keypair_init(mbedtls_ecp_keypair *key)
Initialize a key pair (as an invalid one)
size_t pbits
Definition: ecp.h:154
mbedtls_mpi X
Definition: ecp.h:116
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:146
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:148
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:150
mbedtls_mpi P
Definition: ecp.h:149
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:177
void * t_data
Definition: ecp.h:160
void mbedtls_ecp_point_init(mbedtls_ecp_point *pt)
Initialize a point (as zero)
mbedtls_ecp_group_id
Definition: ecp.h:70
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:99
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:176
unsigned int h
Definition: ecp.h:156
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:162
mbedtls_ecp_point * T
Definition: ecp.h:161
mbedtls_ecp_point G
Definition: ecp.h:152
MPI structure.
Definition: bignum.h:180
ECP point structure (jacobian coordinates)
Definition: ecp.h:114
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:102
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:101
mbedtls_mpi B
Definition: ecp.h:151
void mbedtls_ecp_group_init(mbedtls_ecp_group *grp)
Initialize a group (to something meaningless)