PolarSSL v1.3.2
ecp.h
Go to the documentation of this file.
1 
27 #ifndef POLARSSL_ECP_H
28 #define POLARSSL_ECP_H
29 
30 #include "bignum.h"
31 
32 /*
33  * ECP error codes
34  */
35 #define POLARSSL_ERR_ECP_BAD_INPUT_DATA -0x4F80
36 #define POLARSSL_ERR_ECP_BUFFER_TOO_SMALL -0x4F00
37 #define POLARSSL_ERR_ECP_FEATURE_UNAVAILABLE -0x4E80
38 #define POLARSSL_ERR_ECP_VERIFY_FAILED -0x4E00
39 #define POLARSSL_ERR_ECP_MALLOC_FAILED -0x4D80
40 #define POLARSSL_ERR_ECP_RANDOM_FAILED -0x4D00
41 #define POLARSSL_ERR_ECP_INVALID_KEY -0x4C80
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
56 typedef enum
57 {
67 } ecp_group_id;
68 
72 #define POLARSSL_ECP_DP_MAX 9
73 
77 typedef struct
78 {
80  uint16_t tls_id;
81  uint16_t size;
82  const char *name;
84 
94 typedef struct
95 {
96  mpi X;
97  mpi Y;
98  mpi Z;
99 }
100 ecp_point;
101 
117 typedef struct
118 {
120  mpi P;
121  mpi A;
122  mpi B;
124  mpi N;
125  size_t pbits;
126  size_t nbits;
127  unsigned int h;
128  int (*modp)(mpi *);
129  int (*t_pre)(ecp_point *, void *);
130  int (*t_post)(ecp_point *, void *);
131  void *t_data;
133  size_t T_size;
134 }
135 ecp_group;
136 
144 typedef struct
145 {
147  mpi d;
149 }
151 
155 #define POLARSSL_ECP_MAX_BITS 521
156 #define POLARSSL_ECP_MAX_BYTES ( ( POLARSSL_ECP_MAX_BITS + 7 ) / 8 )
157 #define POLARSSL_ECP_MAX_PT_LEN ( 2 * POLARSSL_ECP_MAX_BYTES + 1 )
158 
159 /*
160  * Maximum window size (actually, NAF width) used for point multipliation.
161  * Default: 8.
162  * Minimum value: 2. Maximum value: 8.
163  *
164  * Result is an array of at most ( 1 << ( POLARSSL_ECP_WINDOW_SIZE - 1 ) )
165  * points used for point multiplication.
166  *
167  * Reduction in size may reduce speed for big curves.
168  */
169 #define POLARSSL_ECP_WINDOW_SIZE 8
171 /*
172  * Point formats, from RFC 4492's enum ECPointFormat
173  */
174 #define POLARSSL_ECP_PF_UNCOMPRESSED 0
175 #define POLARSSL_ECP_PF_COMPRESSED 1
177 /*
178  * Some other constants from RFC 4492
179  */
180 #define POLARSSL_ECP_TLS_NAMED_CURVE 3
187 const ecp_curve_info *ecp_curve_list( void );
188 
197 
205 const ecp_curve_info *ecp_curve_info_from_tls_id( uint16_t tls_id );
206 
210 void ecp_point_init( ecp_point *pt );
211 
215 void ecp_group_init( ecp_group *grp );
216 
220 void ecp_keypair_init( ecp_keypair *key );
221 
225 void ecp_point_free( ecp_point *pt );
226 
230 void ecp_group_free( ecp_group *grp );
231 
235 void ecp_keypair_free( ecp_keypair *key );
236 
246 int ecp_copy( ecp_point *P, const ecp_point *Q );
247 
257 int ecp_group_copy( ecp_group *dst, const ecp_group *src );
258 
267 int ecp_set_zero( ecp_point *pt );
268 
276 int ecp_is_zero( ecp_point *pt );
277 
288 int ecp_point_read_string( ecp_point *P, int radix,
289  const char *x, const char *y );
290 
305 int ecp_point_write_binary( const ecp_group *grp, const ecp_point *P,
306  int format, size_t *olen,
307  unsigned char *buf, size_t buflen );
308 
325 int ecp_point_read_binary( const ecp_group *grp, ecp_point *P,
326  const unsigned char *buf, size_t ilen );
327 
340 int ecp_tls_read_point( const ecp_group *grp, ecp_point *pt,
341  const unsigned char **buf, size_t len );
342 
357 int ecp_tls_write_point( const ecp_group *grp, const ecp_point *pt,
358  int format, size_t *olen,
359  unsigned char *buf, size_t blen );
360 
376 int ecp_group_read_string( ecp_group *grp, int radix,
377  const char *p, const char *b,
378  const char *gx, const char *gy, const char *n);
379 
393 int ecp_use_known_dp( ecp_group *grp, ecp_group_id index );
394 
406 int ecp_tls_read_group( ecp_group *grp, const unsigned char **buf, size_t len );
407 
419 int ecp_tls_write_group( const ecp_group *grp, size_t *olen,
420  unsigned char *buf, size_t blen );
421 
433 int ecp_add( const ecp_group *grp, ecp_point *R,
434  const ecp_point *P, const ecp_point *Q );
435 
447 int ecp_sub( const ecp_group *grp, ecp_point *R,
448  const ecp_point *P, const ecp_point *Q );
449 
479 int ecp_mul( ecp_group *grp, ecp_point *R,
480  const mpi *m, const ecp_point *P,
481  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
482 
483 
505 int ecp_check_pubkey( const ecp_group *grp, const ecp_point *pt );
506 
520 int ecp_check_privkey( const ecp_group *grp, const mpi *d );
521 
538 int ecp_gen_keypair( ecp_group *grp, mpi *d, ecp_point *Q,
539  int (*f_rng)(void *, unsigned char *, size_t),
540  void *p_rng );
541 
547 int ecp_self_test( int verbose );
548 
549 #ifdef __cplusplus
550 }
551 #endif
552 
553 #endif
size_t pbits
Definition: ecp.h:125
int ecp_sub(const ecp_group *grp, ecp_point *R, const ecp_point *P, const ecp_point *Q)
Subtraction: R = P - Q.
int ecp_check_privkey(const ecp_group *grp, const mpi *d)
Check that an mpi is a valid private key for this curve.
void ecp_keypair_init(ecp_keypair *key)
Initialize a key pair (as an invalid one)
int ecp_group_copy(ecp_group *dst, const ecp_group *src)
Copy the contents of a group object.
void * t_data
Definition: ecp.h:131
ecp_group_id grp_id
Definition: ecp.h:79
const char * name
Definition: ecp.h:82
int ecp_self_test(int verbose)
Checkup routine.
mpi P
Definition: ecp.h:120
ecp_group grp
Definition: ecp.h:146
ECP group structure.
Definition: ecp.h:117
unsigned int h
Definition: ecp.h:127
ECP key pair structure.
Definition: ecp.h:144
mpi d
Definition: ecp.h:147
MPI structure.
Definition: bignum.h:171
int ecp_mul(ecp_group *grp, ecp_point *R, const mpi *m, const 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 ecp_point_read_binary(const ecp_group *grp, ecp_point *P, const unsigned char *buf, size_t ilen)
Import a point from unsigned binary data.
mpi X
Definition: ecp.h:96
Multi-precision integer library.
ecp_point G
Definition: ecp.h:123
ecp_group_id id
Definition: ecp.h:119
ECP point structure (jacobian coordinates)
Definition: ecp.h:94
size_t T_size
Definition: ecp.h:133
int ecp_is_zero(ecp_point *pt)
Tell if a point is zero.
void ecp_point_init(ecp_point *pt)
Initialize a point (as zero)
mpi B
Definition: ecp.h:122
mpi N
Definition: ecp.h:124
const ecp_curve_info * ecp_curve_info_from_grp_id(ecp_group_id grp_id)
Get curve information from an internal group identifier.
int ecp_point_read_string(ecp_point *P, int radix, const char *x, const char *y)
Import a non-zero point from two ASCII strings.
void ecp_group_free(ecp_group *grp)
Free the components of an ECP group.
Curve information for use by other modules.
Definition: ecp.h:77
int ecp_tls_write_point(const ecp_group *grp, const ecp_point *pt, int format, size_t *olen, unsigned char *buf, size_t blen)
Export a point as a TLS ECPoint record.
int ecp_gen_keypair(ecp_group *grp, mpi *d, ecp_point *Q, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Generate a keypair.
uint16_t size
Definition: ecp.h:81
int ecp_use_known_dp(ecp_group *grp, ecp_group_id index)
Set a group using well-known domain parameters.
int ecp_copy(ecp_point *P, const ecp_point *Q)
Copy the contents of point Q into P.
mpi A
Definition: ecp.h:121
int ecp_tls_write_group(const ecp_group *grp, size_t *olen, unsigned char *buf, size_t blen)
Write the TLS ECParameters record for a group.
ecp_group_id
Domain parameters (curve, subgroup and generator) identifiers.
Definition: ecp.h:56
int ecp_point_write_binary(const ecp_group *grp, const ecp_point *P, int format, size_t *olen, unsigned char *buf, size_t buflen)
Export a point into unsigned binary data.
void ecp_group_init(ecp_group *grp)
Initialize a group (to something meaningless)
size_t nbits
Definition: ecp.h:126
mpi Y
Definition: ecp.h:97
int ecp_tls_read_group(ecp_group *grp, const unsigned char **buf, size_t len)
Set a group from a TLS ECParameters record.
ecp_point Q
Definition: ecp.h:148
mpi Z
Definition: ecp.h:98
uint16_t tls_id
Definition: ecp.h:80
int ecp_check_pubkey(const ecp_group *grp, const ecp_point *pt)
Check that a point is a valid public key on this curve.
const ecp_curve_info * ecp_curve_info_from_tls_id(uint16_t tls_id)
Get curve information from a TLS NamedCurve value.
int ecp_add(const ecp_group *grp, ecp_point *R, const ecp_point *P, const ecp_point *Q)
Addition: R = P + Q.
int ecp_set_zero(ecp_point *pt)
Set a point to zero.
ecp_point * T
Definition: ecp.h:132
void ecp_keypair_free(ecp_keypair *key)
Free the components of a key pair.
int ecp_tls_read_point(const ecp_group *grp, ecp_point *pt, const unsigned char **buf, size_t len)
Import a point from a TLS ECPoint record.
int ecp_group_read_string(ecp_group *grp, int radix, const char *p, const char *b, const char *gx, const char *gy, const char *n)
Import an ECP group from null-terminated ASCII strings.
void ecp_point_free(ecp_point *pt)
Free the components of a point.