90da84eb7d0041a8b9aa58729a5eee13d4024477
[openssl.git] / crypto / ec / ec_lib.c
1 /* crypto/ec/ec_lib.c */
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 #include <string.h>
57
58 #include <openssl/err.h>
59
60 #include "ec_lcl.h"
61
62
63 /* functions for EC_GROUP objects */
64
65 EC_GROUP *EC_GROUP_new(const EC_METHOD *meth)
66         {
67         EC_GROUP *ret;
68
69         if (meth == NULL)
70                 {
71                 ECerr(EC_F_EC_GROUP_NEW, ERR_R_PASSED_NULL_PARAMETER);
72                 return NULL;
73                 }
74         if (meth->group_init == 0)
75                 {
76                 ECerr(EC_F_EC_GROUP_NEW, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
77                 return NULL;
78                 }
79
80         ret = OPENSSL_malloc(sizeof *ret);
81         if (ret == NULL)
82                 {
83                 ECerr(EC_F_EC_GROUP_NEW, ERR_R_MALLOC_FAILURE);
84                 return NULL;
85                 }
86
87         ret->meth = meth;
88
89         ret->extra_data = NULL;
90         ret->extra_data_dup_func = 0;
91         ret->extra_data_free_func = 0;
92         ret->extra_data_clear_free_func = 0;
93         
94         if (!meth->group_init(ret))
95                 {
96                 OPENSSL_free(ret);
97                 return NULL;
98                 }
99         
100         return ret;
101         }
102
103
104 int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
105         {
106         if (group->meth->group_set_curve_GFp == 0)
107                 {
108                 ECerr(EC_F_EC_GROUP_SET_CURVE_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
109                 return 0;
110                 }
111         
112         return group->meth->group_set_curve_GFp(group, p, a, b, ctx);
113         }
114
115
116 void EC_GROUP_free(EC_GROUP *group)
117         {
118         if (group->meth->group_finish != 0)
119                 group->meth->group_finish(group);
120
121         EC_GROUP_free_extra_data(group);
122
123         OPENSSL_free(group);
124         }
125  
126
127 void EC_GROUP_clear_free(EC_GROUP *group)
128         {
129         if (group->meth->group_clear_finish != 0)
130                 group->meth->group_clear_finish(group);
131         else if (group->meth != NULL && group->meth->group_finish != 0)
132                 group->meth->group_finish(group);
133
134         EC_GROUP_clear_free_extra_data(group);
135
136         memset(group, 0, sizeof *group);
137         OPENSSL_free(group);
138         }
139
140
141 int EC_GROUP_copy(EC_GROUP *dest, const EC_GROUP *src)
142         {
143         if (dest->meth->group_copy == 0)
144                 {
145                 ECerr(EC_F_EC_GROUP_COPY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
146                 return 0;
147                 }
148         if (dest->meth != src->meth)
149                 {
150                 ECerr(EC_F_EC_GROUP_COPY, EC_R_INCOMPATIBLE_OBJECTS);
151                 return 0;
152                 }
153         
154         EC_GROUP_clear_free_extra_data(dest);
155         if (src->extra_data_dup_func)
156                 {
157                 if (src->extra_data != NULL)
158                         {
159                         dest->extra_data = src->extra_data_dup_func(src->extra_data);
160                         if (dest->extra_data == NULL)
161                                 return 0;
162                         }
163
164                 dest->extra_data_dup_func = src->extra_data_dup_func;
165                 dest->extra_data_free_func = src->extra_data_free_func;
166                 dest->extra_data_clear_free_func = src->extra_data_clear_free_func;
167                 }
168
169         return dest->meth->group_copy(dest, src);
170         }
171
172
173 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor)
174         {
175         if (group->meth->group_set_generator == 0)
176                 {
177                 ECerr(EC_F_EC_GROUP_SET_GENERATOR, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
178                 return 0;
179                 }
180         return group->meth->group_set_generator(group, generator, order, cofactor);
181         }
182
183
184 /* TODO: 'set' and 'get' functions for EC_GROUPs */
185
186
187 /* this has 'package' visibility */
188 int EC_GROUP_set_extra_data(EC_GROUP *group, void *extra_data, void *(*extra_data_dup_func)(void *),
189         void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *))
190         {
191         if ((group->extra_data != NULL)
192                 || (group->extra_data_dup_func != 0)
193                 || (group->extra_data_free_func != 0)
194                 || (group->extra_data_clear_free_func != 0))
195                 {
196                 ECerr(EC_F_EC_GROUP_SET_EXTRA_DATA, EC_R_SLOT_FULL);
197                 return 0;
198                 }
199
200         group->extra_data = extra_data;
201         group->extra_data_dup_func = extra_data_dup_func;
202         group->extra_data_free_func = extra_data_free_func;
203         group->extra_data_clear_free_func = extra_data_clear_free_func;
204         return 1;
205         }
206
207
208 /* this has 'package' visibility */
209 void *EC_GROUP_get_extra_data(EC_GROUP *group, void *(*extra_data_dup_func)(void *),
210         void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *))
211         {
212         if ((group->extra_data_dup_func != extra_data_dup_func)
213                 || (group->extra_data_free_func != extra_data_free_func)
214                 || (group->extra_data_clear_free_func != extra_data_clear_free_func))
215                 {
216                 ECerr(EC_F_EC_GROUP_GET_EXTRA_DATA, EC_R_NO_SUCH_EXTRA_DATA);
217                 return NULL;
218                 }
219
220         return group->extra_data;
221         }
222
223
224 /* this has 'package' visibility */
225 void EC_GROUP_free_extra_data(EC_GROUP *group)
226         {
227         if (group->extra_data_free_func)
228                 group->extra_data_free_func(group->extra_data);
229         group->extra_data = NULL;
230         group->extra_data_dup_func = 0;
231         group->extra_data_free_func = 0;
232         group->extra_data_clear_free_func = 0;
233         }
234
235
236 /* this has 'package' visibility */
237 void EC_GROUP_clear_free_extra_data(EC_GROUP *group)
238         {
239         if (group->extra_data_clear_free_func)
240                 group->extra_data_clear_free_func(group->extra_data);
241         else if (group->extra_data_free_func)
242                 group->extra_data_free_func(group->extra_data);
243         group->extra_data = NULL;
244         group->extra_data_dup_func = 0;
245         group->extra_data_free_func = 0;
246         group->extra_data_clear_free_func = 0;
247         }
248
249
250
251 /* functions for EC_POINT objects */
252
253 EC_POINT *EC_POINT_new(const EC_GROUP *group)
254         {
255         EC_POINT *ret;
256
257         if (group == NULL)
258                 {
259                 ECerr(EC_F_EC_POINT_NEW, ERR_R_PASSED_NULL_PARAMETER);
260                 return NULL;
261                 }
262         if (group->meth->point_init == 0)
263                 {
264                 ECerr(EC_F_EC_POINT_NEW, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
265                 return NULL;
266                 }
267
268         ret = OPENSSL_malloc(sizeof *ret);
269         if (ret == NULL)
270                 {
271                 ECerr(EC_F_EC_POINT_NEW, ERR_R_MALLOC_FAILURE);
272                 return NULL;
273                 }
274
275         ret->meth = group->meth;
276         
277         if (!ret->meth->point_init(ret))
278                 {
279                 OPENSSL_free(ret);
280                 return NULL;
281                 }
282         
283         return ret;
284         }
285
286
287 void EC_POINT_free(EC_POINT *point)
288         {
289         if (point->meth->point_finish != 0)
290                 point->meth->point_finish(point);
291         OPENSSL_free(point);
292         }
293  
294
295 void EC_POINT_clear_free(EC_POINT *point)
296         {
297         if (point->meth->point_clear_finish != 0)
298                 point->meth->point_clear_finish(point);
299         else if (point->meth != NULL && point->meth->point_finish != 0)
300                 point->meth->point_finish(point);
301         memset(point, 0, sizeof *point);
302         OPENSSL_free(point);
303         }
304
305
306 int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src)
307         {
308         if (dest->meth->point_copy == 0)
309                 {
310                 ECerr(EC_F_EC_POINT_COPY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
311                 return 0;
312                 }
313         if (dest->meth != src->meth)
314                 {
315                 ECerr(EC_F_EC_POINT_COPY, EC_R_INCOMPATIBLE_OBJECTS);
316                 return 0;
317                 }
318         
319         return dest->meth->point_copy(dest, src);
320         }
321
322
323 /* TODO: 'set' and 'get' functions for EC_POINTs */
324
325
326 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *point, point_conversion_form_t form,
327         unsigned char *buf, size_t len, BN_CTX *ctx)
328         {
329         if (group->meth->point2oct == 0)
330                 {
331                 ECerr(EC_F_EC_POINT_POINT2OCT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
332                 return 0;
333                 }
334         if (group->meth != point->meth)
335                 {
336                 ECerr(EC_F_EC_POINT_POINT2OCT, EC_R_INCOMPATIBLE_OBJECTS);
337                 return 0;
338                 }
339         return group->meth->point2oct(group, point, form, buf, len, ctx);
340         }
341
342
343 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *point,
344         const unsigned char *buf, size_t len, BN_CTX *ctx)
345         {
346         if (group->meth->oct2point == 0)
347                 {
348                 ECerr(EC_F_EC_POINT_OCT2POINT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
349                 return 0;
350                 }
351         if (group->meth != point->meth)
352                 {
353                 ECerr(EC_F_EC_POINT_OCT2POINT, EC_R_INCOMPATIBLE_OBJECTS);
354                 return 0;
355                 }
356         return group->meth->oct2point(group, point, buf, len, ctx);
357         }
358
359
360 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
361         {
362         if (group->meth->add == 0)
363                 {
364                 ECerr(EC_F_EC_POINT_ADD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
365                 return 0;
366                 }
367         if ((group->meth != r->meth) || (r->meth != a->meth) || (a->meth != b->meth))
368                 {
369                 ECerr(EC_F_EC_POINT_ADD, EC_R_INCOMPATIBLE_OBJECTS);
370                 return 0;
371                 }
372         return group->meth->add(group, r, a, b, ctx);
373         }
374
375
376 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx)
377         {
378         if (group->meth->dbl == 0)
379                 {
380                 ECerr(EC_F_EC_POINT_DBL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
381                 return 0;
382                 }
383         if ((group->meth != r->meth) || (r->meth != a->meth))
384                 {
385                 ECerr(EC_F_EC_POINT_DBL, EC_R_INCOMPATIBLE_OBJECTS);
386                 return 0;
387                 }
388         return group->meth->dbl(group, r, a, ctx);
389         }
390
391
392 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *point)
393         {
394         if (group->meth->is_at_infinity == 0)
395                 {
396                 ECerr(EC_F_EC_POINT_IS_AT_INFINITY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
397                 return 0;
398                 }
399         if (group->meth != point->meth)
400                 {
401                 ECerr(EC_F_EC_POINT_IS_AT_INFINITY, EC_R_INCOMPATIBLE_OBJECTS);
402                 return 0;
403                 }
404         return group->meth->is_at_infinity(group, point);
405         }
406
407
408 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx)
409         {
410         if (group->meth->is_on_curve == 0)
411                 {
412                 ECerr(EC_F_EC_POINT_IS_ON_CURVE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
413                 return 0;
414                 }
415         if (group->meth != point->meth)
416                 {
417                 ECerr(EC_F_EC_POINT_IS_ON_CURVE, EC_R_INCOMPATIBLE_OBJECTS);
418                 return 0;
419                 }
420         return group->meth->is_on_curve(group, point, ctx);
421         }
422
423
424 int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
425         {
426         if (group->meth->make_affine == 0)
427                 {
428                 ECerr(EC_F_EC_POINT_MAKE_AFFINE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
429                 return 0;
430                 }
431         if (group->meth != point->meth)
432                 {
433                 ECerr(EC_F_EC_POINT_MAKE_AFFINE, EC_R_INCOMPATIBLE_OBJECTS);
434                 return 0;
435                 }
436         return group->meth->make_affine(group, point, ctx);
437         }