a205ab09285bef3b578d92a5332fa172d5bf07eb
[openssl.git] / crypto / ec / ec_lcl.h
1 /* TODO */
2 /* crypto/ec/ec_lcl.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
58 #include <stdlib.h>
59
60 #include <openssl/ec.h>
61
62
63 /* Structure details are not part of the exported interface,
64  * so all this may change in future versions. */
65
66 struct ec_method_st {
67         /* used by EC_GROUP_new, EC_GROUP_set_GFp, EC_GROUP_free: */
68         int (*group_init)(EC_GROUP *);
69         /* int (*group_set)(EC_GROUP *, .....); */
70         int (*group_set_GFp)(EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b);
71         void (*group_finish)(EC_GROUP *);
72
73         /* used by EC_POINT_new, EC_POINT_free: */
74         int (*point_init)(EC_POINT *);
75         void (*point_finish)(EC_POINT *);
76
77         /* used by EC_POINT_add, EC_POINT_dbl: */
78         int (*add)(const EC_GROUP *, EC_POINT *r, EC_POINT *a, EC_POINT *b);
79         int (*dbl)(const EC_GROUP *, EC_POINT *r, EC_POINT *a);
80
81         /* used by EC_POINT_point2oct, EC_POINT_oct2point: */
82         size_t (*point2oct)(const EC_GROUP *, EC_POINT *, unsigned char *buf,
83                 size_t len, point_conversion_form_t form);
84         int (*oct2point)(const EC_GROUP *, EC_POINT *, unsigned char *buf, size_t len);
85
86
87         /* internal functions */
88
89         /* 'field_mult' and 'field_sqr' can be used by 'add' and 'dbl' so that
90          * the same implementations of point operations can be used with different
91          * optimized implementations of expensive field operations: */
92         int (*field_mult)(const EC_GROUP *, BIGNUM *r, BIGNUM *a, BIGNUM *b);
93         int (*field_sqr)(const EC_GROUP *, BIGNUM *r, BIGNUM *a);
94 } /* EC_METHOD */;
95
96
97 struct ec_group_st {
98         EC_METHOD *meth;
99
100         BIGNUM field; /* Field specification.
101                        * For curves over GF(p), this is the modulus. */
102         void *field_data; /* method-specific (e.g., Montgomery structure) */
103
104         BIGNUM a, b; /* Curve coefficients.
105                       * (Here the assumption is that BIGNUMs can be used
106                       * or abused for all kinds of fields, not just GF(p).) */
107         int a_is_minus3; /* enable optimized point arithmetics for special case */
108
109         /* TODO: optional generator with associated information (order, cofactor) */
110         /*       optional Lim/Lee precomputation table */
111 } /* EC_GROUP */;
112
113
114 struct ec_point_st {
115         EC_METHOD *meth;
116
117         BIGNUM x;
118         BIGNUM y;
119         BIGNUM z; /* Jacobian projective coordinates */
120         int z_is_one; /* enable optimized point arithmetics for special case */
121 } /* EC_POINT */;