ecp.h

Go to the documentation of this file.

 
#ifndef POLARSSL_ECP_H
#define POLARSSL_ECP_H
 
#include "bignum.h"
 
/*
 * ECP error codes
 */
#define POLARSSL_ERR_ECP_BAD_INPUT_DATA                    -0x4F80  
#define POLARSSL_ERR_ECP_BUFFER_TOO_SMALL                  -0x4F00  
#define POLARSSL_ERR_ECP_FEATURE_UNAVAILABLE               -0x4E80  
#define POLARSSL_ERR_ECP_VERIFY_FAILED                     -0x4E00  
#define POLARSSL_ERR_ECP_MALLOC_FAILED                     -0x4D80  
#define POLARSSL_ERR_ECP_RANDOM_FAILED                     -0x4D00  
#define POLARSSL_ERR_ECP_INVALID_KEY                       -0x4C80  
#define POLARSSL_ERR_ECP_SIG_LEN_MISMATCH                  -0x4C00  
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    POLARSSL_ECP_DP_NONE = 0,
    POLARSSL_ECP_DP_SECP192R1,      
    POLARSSL_ECP_DP_SECP224R1,      
    POLARSSL_ECP_DP_SECP256R1,      
    POLARSSL_ECP_DP_SECP384R1,      
    POLARSSL_ECP_DP_SECP521R1,      
    POLARSSL_ECP_DP_BP256R1,        
    POLARSSL_ECP_DP_BP384R1,        
    POLARSSL_ECP_DP_BP512R1,        
    POLARSSL_ECP_DP_M221,           
    POLARSSL_ECP_DP_M255,           
    POLARSSL_ECP_DP_M383,           
    POLARSSL_ECP_DP_M511,           
    POLARSSL_ECP_DP_SECP192K1,      
    POLARSSL_ECP_DP_SECP224K1,      
    POLARSSL_ECP_DP_SECP256K1,      
} ecp_group_id;
 
#define POLARSSL_ECP_DP_MAX     12
 
typedef struct
{
    ecp_group_id grp_id;    
    uint16_t tls_id;        
    uint16_t size;          
    const char *name;       
} ecp_curve_info;
 
typedef struct
{
    mpi X;          
    mpi Y;          
    mpi Z;          
}
ecp_point;
 
typedef struct
{
    ecp_group_id id;    
    mpi P;              
    mpi A;              
    mpi B;              
    ecp_point G;        
    mpi N;              
    size_t pbits;       
    size_t nbits;       
    unsigned int h;     
    int (*modp)(mpi *); 
    int (*t_pre)(ecp_point *, void *);  
    int (*t_post)(ecp_point *, void *); 
    void *t_data;                       
    ecp_point *T;       
    size_t T_size;      
}
ecp_group;
 
typedef struct
{
    ecp_group grp;      
    mpi d;              
    ecp_point Q;        
}
ecp_keypair;
 
#if !defined(POLARSSL_ECP_MAX_BITS)
#define POLARSSL_ECP_MAX_BITS     521   
#endif
 
#define POLARSSL_ECP_MAX_BYTES    ( ( POLARSSL_ECP_MAX_BITS + 7 ) / 8 )
#define POLARSSL_ECP_MAX_PT_LEN   ( 2 * POLARSSL_ECP_MAX_BYTES + 1 )
 
#if !defined(POLARSSL_ECP_WINDOW_SIZE)
/*
 * Maximum "window" size used for point multiplication.
 * Default: 6.
 * Minimum value: 2. Maximum value: 7.
 *
 * Result is an array of at most ( 1 << ( POLARSSL_ECP_WINDOW_SIZE - 1 ) )
 * points used for point multiplication. This value is directly tied to EC
 * peak memory usage, so decreasing it by one should roughly cut memory usage
 * by two (if large curves are in use).
 *
 * Reduction in size may reduce speed, but larger curves are impacted first.
 * Sample performances (in ECDHE handshakes/s, with FIXED_POINT_OPTIM = 1):
 *      w-size:     6       5       4       3       2
 *      521       145     141     135     120      97
 *      384       214     209     198     177     146
 *      256       320     320     303     262     226
 
 *      224       475     475     453     398     342
 *      192       640     640     633     587     476
 */
#define POLARSSL_ECP_WINDOW_SIZE    6   
#endif /* POLARSSL_ECP_WINDOW_SIZE */
 
#if !defined(POLARSSL_ECP_FIXED_POINT_OPTIM)
/*
 * Trade memory for speed on fixed-point multiplication.
 *
 * This speeds up repeated multiplication of the generator (that is, the
 * multiplication in ECDSA signatures, and half of the multiplications in
 * ECDSA verification and ECDHE) by a factor roughly 3 to 4.
 *
 * The cost is increasing EC peak memory usage by a factor roughly 2.
 *
 * Change this value to 0 to reduce peak memory usage.
 */
#define POLARSSL_ECP_FIXED_POINT_OPTIM  1   
#endif /* POLARSSL_ECP_FIXED_POINT_OPTIM */
 
/* \} name SECTION: Module settings */
 
/*
 * Point formats, from RFC 4492's enum ECPointFormat
 */
#define POLARSSL_ECP_PF_UNCOMPRESSED    0   
#define POLARSSL_ECP_PF_COMPRESSED      1   
/*
 * Some other constants from RFC 4492
 */
#define POLARSSL_ECP_TLS_NAMED_CURVE    3   
const ecp_curve_info *ecp_curve_list( void );
 
const ecp_group_id *ecp_grp_id_list( void );
 
const ecp_curve_info *ecp_curve_info_from_grp_id( ecp_group_id grp_id );
 
const ecp_curve_info *ecp_curve_info_from_tls_id( uint16_t tls_id );
 
const ecp_curve_info *ecp_curve_info_from_name( const char *name );
 
void ecp_point_init( ecp_point *pt );
 
void ecp_group_init( ecp_group *grp );
 
void ecp_keypair_init( ecp_keypair *key );
 
void ecp_point_free( ecp_point *pt );
 
void ecp_group_free( ecp_group *grp );
 
void ecp_keypair_free( ecp_keypair *key );
 
int ecp_copy( ecp_point *P, const ecp_point *Q );
 
int ecp_group_copy( ecp_group *dst, const ecp_group *src );
 
int ecp_set_zero( ecp_point *pt );
 
int ecp_is_zero( ecp_point *pt );
 
int ecp_point_read_string( ecp_point *P, int radix,
                           const char *x, const char *y );
 
int ecp_point_write_binary( const ecp_group *grp, const ecp_point *P,
                            int format, size_t *olen,
                            unsigned char *buf, size_t buflen );
 
int ecp_point_read_binary( const ecp_group *grp, ecp_point *P,
                           const unsigned char *buf, size_t ilen );
 
int ecp_tls_read_point( const ecp_group *grp, ecp_point *pt,
                        const unsigned char **buf, size_t len );
 
int ecp_tls_write_point( const ecp_group *grp, const ecp_point *pt,
                         int format, size_t *olen,
                         unsigned char *buf, size_t blen );
 
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);
 
int ecp_use_known_dp( ecp_group *grp, ecp_group_id index );
 
int ecp_tls_read_group( ecp_group *grp, const unsigned char **buf, size_t len );
 
int ecp_tls_write_group( const ecp_group *grp, size_t *olen,
                         unsigned char *buf, size_t blen );
 
int ecp_add( const ecp_group *grp, ecp_point *R,
             const ecp_point *P, const ecp_point *Q );
 
int ecp_sub( const ecp_group *grp, ecp_point *R,
             const ecp_point *P, const ecp_point *Q );
 
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 );
 
int ecp_check_pubkey( const ecp_group *grp, const ecp_point *pt );
 
int ecp_check_privkey( const ecp_group *grp, const mpi *d );
 
int ecp_gen_keypair( ecp_group *grp, mpi *d, ecp_point *Q,
                     int (*f_rng)(void *, unsigned char *, size_t),
                     void *p_rng );
 
int ecp_gen_key( ecp_group_id grp_id, ecp_keypair *key,
                int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
 
#if defined(POLARSSL_SELF_TEST)
int ecp_self_test( int verbose );
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ecp.h */