crypto/ec/ec.h

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