crypto/ec/ec.h

   1 /* crypto/ec/ec.h */
   2 /* ====================================================================
   3  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in
  14  *    the documentation and/or other materials provided with the
  15  *    distribution.
  16  *
  17  * 3. All advertising materials mentioning features or use of this
  18  *    software must display the following acknowledgment:
  19  *    "This product includes software developed by the OpenSSL Project
  20  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  21  *
  22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  23  *    endorse or promote products derived from this software without
  24  *    prior written permission. For written permission, please contact
  25  *    openssl-core@openssl.org.
  26  *
  27  * 5. Products derived from this software may not be called "OpenSSL"
  28  *    nor may "OpenSSL" appear in their names without prior written
  29  *    permission of the OpenSSL Project.
  30  *
  31  * 6. Redistributions of any form whatsoever must retain the following
  32  *    acknowledgment:
  33  *    "This product includes software developed by the OpenSSL Project
  34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  35  *
  36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  47  * OF THE POSSIBILITY OF SUCH DAMAGE.
  48  * ====================================================================
  49  *
  50  * This product includes cryptographic software written by Eric Young
  51  * (eay@cryptsoft.com).  This product includes software written by Tim
  52  * Hudson (tjh@cryptsoft.com).
  53  *
  54  */
  55
  56 #ifndef HEADER_EC_H
  57 #define HEADER_EC_H
  58
  59 #include <openssl/bn.h>
  60
  61 #ifdef  __cplusplus
  62 extern "C" {
  63 #endif
  64
  65
  66
  67 typedef enum {
  68         POINT_CONVERSION_COMPRESSED = 2,
  69         POINT_CONVERSION_UNCOMPRESSED = 4,
  70         POINT_CONVERSION_HYBRID = 6
  71 } point_conversion_form_t;
  72
  73
  74 typedef struct ec_method_st EC_METHOD;
  75
  76 typedef struct ec_group_st
  77         /*
  78          EC_METHOD *meth;
  79          -- field definition
  80          -- curve coefficients
  81          -- optional generator with associated information (order, cofactor)
  82          -- optional Lim/Lee precomputation table
  83         */
  84         EC_GROUP;
  85
  86 typedef struct ec_point_st EC_POINT;
  87
  88
  89 /* EC_METHODs for curves over GF(p).
  90  * EC_GFp_simple_method provides the basis for the optimized methods.
  91  */
  92
  93 const EC_METHOD *EC_GFp_simple_method(void);
  94 const EC_METHOD *EC_GFp_mont_method(void);
  95 const EC_METHOD *EC_GFp_recp_method(void);
  96 const EC_METHOD *EC_GFp_nist_method(void);
  97
  98
  99 EC_GROUP *EC_GROUP_new(const EC_METHOD *);
 100 /* We don't have types for field specifications and field elements in general.
 101  * Otherwise we would declare
 102  *     int EC_GROUP_set_curve(EC_GROUP *, .....);
 103  */
 104 int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 105 void EC_GROUP_free(EC_GROUP *);
 106 void EC_GROUP_clear_free(EC_GROUP *);
 107 int EC_GROUP_copy(EC_GROUP *, const EC_GROUP*);
 108
 109 /* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
 110  * after choosing an appropriate EC_METHOD */
 111 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 112
 113 int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
 114
 115 /* TODO: 'get' functions for EC_GROUPs */
 116
 117
 118 EC_POINT *EC_POINT_new(const EC_GROUP *);
 119 void EC_POINT_free(EC_POINT *);
 120 void EC_POINT_clear_free(EC_POINT *);
 121 int EC_POINT_copy(EC_POINT *, const EC_POINT *);
 122
 123 /* TODO: 'set' and 'get' functions for EC_POINTs */
 124
 125 size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
 126         unsigned char *buf, size_t len, BN_CTX *);
 127 int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
 128         const unsigned char *buf, size_t len, BN_CTX *);
 129
 130 int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
 131 int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
 132
 133 int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
 134 int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
 135
 136 int EC_POINT_make_affine(const EC_GROUP *, const EC_POINT *, BN_CTX *);
 137
 138
 139
 140 /* TODO: scalar multiplication */
 141
 142
 143
 144 /* BEGIN ERROR CODES */
 145 /* The following lines are auto generated by the script mkerr.pl. Any changes
 146  * made after this point may be overwritten when the script is next run.
 147  */
 148
 149 /* Error codes for the EC functions. */
 150
 151 /* Function codes. */
 152 #define EC_F_EC_GROUP_CLEAR_FREE                         103
 153 #define EC_F_EC_GROUP_COPY                               102
 154 #define EC_F_EC_GROUP_FREE                               104
 155 #define EC_F_EC_GROUP_GET_EXTRA_DATA                     115
 156 #define EC_F_EC_GROUP_NEW                                100
 157 #define EC_F_EC_GROUP_SET_CURVE_GFP                      101
 158 #define EC_F_EC_GROUP_SET_EXTRA_DATA                     116
 159 #define EC_F_EC_GROUP_SET_GENERATOR                      106
 160 #define EC_F_EC_POINT_ADD                                107
 161 #define EC_F_EC_POINT_COPY                               108
 162 #define EC_F_EC_POINT_DBL                                109
 163 #define EC_F_EC_POINT_IS_AT_INFINITY                     110
 164 #define EC_F_EC_POINT_IS_ON_CURVE                        111
 165 #define EC_F_EC_POINT_MAKE_AFFINE                        112
 166 #define EC_F_EC_POINT_NEW                                105
 167 #define EC_F_EC_POINT_OCT2POINT                          113
 168 #define EC_F_EC_POINT_POINT2OCT                          114
 169
 170 /* Reason codes. */
 171 #define EC_R_INCOMPATIBLE_OBJECTS                        100
 172 #define EC_R_NO_SUCH_EXTRA_DATA                          101
 173 #define EC_R_SLOT_FULL                                   102
 174
 175 #ifdef  __cplusplus
 176 }
 177 #endif
 178 #endif
 179