1 /* crypto/ec/ec_lib.c */
2 /* ====================================================================
3 * Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
31 * 6. Redistributions of any form whatsoever must retain the following
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
58 #include <openssl/err.h>
59 #include <openssl/opensslv.h>
63 static const char EC_version[] = "EC" OPENSSL_VERSION_PTEXT;
66 /* functions for EC_GROUP objects */
68 EC_GROUP *EC_GROUP_new(const EC_METHOD *meth)
74 ECerr(EC_F_EC_GROUP_NEW, ERR_R_PASSED_NULL_PARAMETER);
77 if (meth->group_init == 0)
79 ECerr(EC_F_EC_GROUP_NEW, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
83 ret = OPENSSL_malloc(sizeof *ret);
86 ECerr(EC_F_EC_GROUP_NEW, ERR_R_MALLOC_FAILURE);
92 ret->extra_data = NULL;
93 ret->extra_data_dup_func = 0;
94 ret->extra_data_free_func = 0;
95 ret->extra_data_clear_free_func = 0;
97 ret->generator = NULL;
99 BN_init(&ret->cofactor);
103 ret->asn1_form = POINT_CONVERSION_COMPRESSED;
108 if (!meth->group_init(ret))
118 void EC_GROUP_free(EC_GROUP *group)
122 if (group->meth->group_finish != 0)
123 group->meth->group_finish(group);
125 EC_GROUP_free_extra_data(group);
127 if (group->generator != NULL)
128 EC_POINT_free(group->generator);
129 BN_free(&group->order);
130 BN_free(&group->cofactor);
133 OPENSSL_free(group->seed);
139 void EC_GROUP_clear_free(EC_GROUP *group)
143 if (group->meth->group_clear_finish != 0)
144 group->meth->group_clear_finish(group);
145 else if (group->meth != NULL && group->meth->group_finish != 0)
146 group->meth->group_finish(group);
148 EC_GROUP_clear_free_extra_data(group);
150 if (group->generator != NULL)
151 EC_POINT_clear_free(group->generator);
152 BN_clear_free(&group->order);
153 BN_clear_free(&group->cofactor);
157 memset(group->seed, 0, group->seed_len);
158 OPENSSL_free(group->seed);
161 memset(group, 0, sizeof *group);
166 int EC_GROUP_copy(EC_GROUP *dest, const EC_GROUP *src)
168 if (dest->meth->group_copy == 0)
170 ECerr(EC_F_EC_GROUP_COPY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
173 if (dest->meth != src->meth)
175 ECerr(EC_F_EC_GROUP_COPY, EC_R_INCOMPATIBLE_OBJECTS);
181 EC_GROUP_clear_free_extra_data(dest);
182 if (src->extra_data_dup_func)
184 if (src->extra_data != NULL)
186 dest->extra_data = src->extra_data_dup_func(src->extra_data);
187 if (dest->extra_data == NULL)
191 dest->extra_data_dup_func = src->extra_data_dup_func;
192 dest->extra_data_free_func = src->extra_data_free_func;
193 dest->extra_data_clear_free_func = src->extra_data_clear_free_func;
196 if (src->generator != NULL)
198 if (dest->generator == NULL)
200 dest->generator = EC_POINT_new(dest);
201 if (dest->generator == NULL) return 0;
203 if (!EC_POINT_copy(dest->generator, src->generator)) return 0;
207 /* src->generator == NULL */
208 if (dest->generator != NULL)
210 EC_POINT_clear_free(dest->generator);
211 dest->generator = NULL;
215 if (!BN_copy(&dest->order, &src->order)) return 0;
216 if (!BN_copy(&dest->cofactor, &src->cofactor)) return 0;
218 dest->curve_name = src->curve_name;
219 dest->asn1_flag = src->asn1_flag;
220 dest->asn1_form = src->asn1_form;
225 OPENSSL_free(dest->seed);
226 dest->seed = OPENSSL_malloc(src->seed_len);
227 if (dest->seed == NULL)
229 if (!memcpy(dest->seed, src->seed, src->seed_len))
231 dest->seed_len = src->seed_len;
236 OPENSSL_free(dest->seed);
242 return dest->meth->group_copy(dest, src);
246 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group)
252 int EC_METHOD_get_field_type(const EC_METHOD *meth)
254 return meth->field_type;
258 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor)
260 if (generator == NULL)
262 ECerr(EC_F_EC_GROUP_SET_GENERATOR, ERR_R_PASSED_NULL_PARAMETER);
266 if (group->generator == NULL)
268 group->generator = EC_POINT_new(group);
269 if (group->generator == NULL) return 0;
271 if (!EC_POINT_copy(group->generator, generator)) return 0;
274 { if (!BN_copy(&group->order, order)) return 0; }
276 { if (!BN_zero(&group->order)) return 0; }
278 if (cofactor != NULL)
279 { if (!BN_copy(&group->cofactor, cofactor)) return 0; }
281 { if (!BN_zero(&group->cofactor)) return 0; }
287 EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group)
289 return group->generator;
293 int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx)
295 if (!BN_copy(order, &group->order))
298 return !BN_is_zero(order);
302 int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx)
304 if (!BN_copy(cofactor, &group->cofactor))
307 return !BN_is_zero(&group->cofactor);
311 void EC_GROUP_set_nid(EC_GROUP *group, int nid)
313 group->curve_name = nid;
317 int EC_GROUP_get_nid(const EC_GROUP *group)
319 return group->curve_name;
323 void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag)
325 group->asn1_flag = flag;
329 int EC_GROUP_get_asn1_flag(const EC_GROUP *group)
331 return group->asn1_flag;
335 void EC_GROUP_set_point_conversion_form(EC_GROUP *group,
336 point_conversion_form_t form)
338 group->asn1_form = form;
342 point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *group)
344 return group->asn1_form;
348 int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
350 if (group->meth->group_set_curve_GFp == 0)
352 ECerr(EC_F_EC_GROUP_SET_CURVE_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
355 return group->meth->group_set_curve_GFp(group, p, a, b, ctx);
359 int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx)
361 if (group->meth->group_get_curve_GFp == 0)
363 ECerr(EC_F_EC_GROUP_GET_CURVE_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
366 return group->meth->group_get_curve_GFp(group, p, a, b, ctx);
370 int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx)
372 if (group->meth->group_check_discriminant == 0)
374 ECerr(EC_F_EC_GROUP_CHECK_DISCRIMINANT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
377 return group->meth->group_check_discriminant(group, ctx);
381 /* this has 'package' visibility */
382 int EC_GROUP_set_extra_data(EC_GROUP *group, void *extra_data, void *(*extra_data_dup_func)(void *),
383 void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *))
385 if ((group->extra_data != NULL)
386 || (group->extra_data_dup_func != 0)
387 || (group->extra_data_free_func != 0)
388 || (group->extra_data_clear_free_func != 0))
390 ECerr(EC_F_EC_GROUP_SET_EXTRA_DATA, EC_R_SLOT_FULL);
394 group->extra_data = extra_data;
395 group->extra_data_dup_func = extra_data_dup_func;
396 group->extra_data_free_func = extra_data_free_func;
397 group->extra_data_clear_free_func = extra_data_clear_free_func;
402 /* this has 'package' visibility */
403 void *EC_GROUP_get_extra_data(const EC_GROUP *group, void *(*extra_data_dup_func)(void *),
404 void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *))
406 if ((group->extra_data_dup_func != extra_data_dup_func)
407 || (group->extra_data_free_func != extra_data_free_func)
408 || (group->extra_data_clear_free_func != extra_data_clear_free_func))
410 ECerr(EC_F_EC_GROUP_GET_EXTRA_DATA, EC_R_NO_SUCH_EXTRA_DATA);
414 return group->extra_data;
418 /* this has 'package' visibility */
419 void EC_GROUP_free_extra_data(EC_GROUP *group)
421 if (group->extra_data_free_func)
422 group->extra_data_free_func(group->extra_data);
423 group->extra_data = NULL;
424 group->extra_data_dup_func = 0;
425 group->extra_data_free_func = 0;
426 group->extra_data_clear_free_func = 0;
430 /* this has 'package' visibility */
431 void EC_GROUP_clear_free_extra_data(EC_GROUP *group)
433 if (group->extra_data_clear_free_func)
434 group->extra_data_clear_free_func(group->extra_data);
435 else if (group->extra_data_free_func)
436 group->extra_data_free_func(group->extra_data);
437 group->extra_data = NULL;
438 group->extra_data_dup_func = 0;
439 group->extra_data_free_func = 0;
440 group->extra_data_clear_free_func = 0;
444 /* functions for EC_POINT objects */
446 EC_POINT *EC_POINT_new(const EC_GROUP *group)
452 ECerr(EC_F_EC_POINT_NEW, ERR_R_PASSED_NULL_PARAMETER);
455 if (group->meth->point_init == 0)
457 ECerr(EC_F_EC_POINT_NEW, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
461 ret = OPENSSL_malloc(sizeof *ret);
464 ECerr(EC_F_EC_POINT_NEW, ERR_R_MALLOC_FAILURE);
468 ret->meth = group->meth;
470 if (!ret->meth->point_init(ret))
480 void EC_POINT_free(EC_POINT *point)
484 if (point->meth->point_finish != 0)
485 point->meth->point_finish(point);
490 void EC_POINT_clear_free(EC_POINT *point)
494 if (point->meth->point_clear_finish != 0)
495 point->meth->point_clear_finish(point);
496 else if (point->meth != NULL && point->meth->point_finish != 0)
497 point->meth->point_finish(point);
498 memset(point, 0, sizeof *point);
503 int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src)
505 if (dest->meth->point_copy == 0)
507 ECerr(EC_F_EC_POINT_COPY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
510 if (dest->meth != src->meth)
512 ECerr(EC_F_EC_POINT_COPY, EC_R_INCOMPATIBLE_OBJECTS);
517 return dest->meth->point_copy(dest, src);
521 const EC_METHOD *EC_POINT_method_of(const EC_POINT *point)
527 int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point)
529 if (group->meth->point_set_to_infinity == 0)
531 ECerr(EC_F_EC_POINT_SET_TO_INFINITY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
534 if (group->meth != point->meth)
536 ECerr(EC_F_EC_POINT_SET_TO_INFINITY, EC_R_INCOMPATIBLE_OBJECTS);
539 return group->meth->point_set_to_infinity(group, point);
543 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
544 const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *ctx)
546 if (group->meth->point_set_Jprojective_coordinates_GFp == 0)
548 ECerr(EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
551 if (group->meth != point->meth)
553 ECerr(EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
556 return group->meth->point_set_Jprojective_coordinates_GFp(group, point, x, y, z, ctx);
560 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group, const EC_POINT *point,
561 BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx)
563 if (group->meth->point_get_Jprojective_coordinates_GFp == 0)
565 ECerr(EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
568 if (group->meth != point->meth)
570 ECerr(EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
573 return group->meth->point_get_Jprojective_coordinates_GFp(group, point, x, y, z, ctx);
577 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
578 const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx)
580 if (group->meth->point_set_affine_coordinates_GFp == 0)
582 ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
585 if (group->meth != point->meth)
587 ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
590 return group->meth->point_set_affine_coordinates_GFp(group, point, x, y, ctx);
594 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, const EC_POINT *point,
595 BIGNUM *x, BIGNUM *y, BN_CTX *ctx)
597 if (group->meth->point_get_affine_coordinates_GFp == 0)
599 ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
602 if (group->meth != point->meth)
604 ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
607 return group->meth->point_get_affine_coordinates_GFp(group, point, x, y, ctx);
611 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
612 const BIGNUM *x, int y_bit, BN_CTX *ctx)
614 if (group->meth->point_set_compressed_coordinates_GFp == 0)
616 ECerr(EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
619 if (group->meth != point->meth)
621 ECerr(EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
624 return group->meth->point_set_compressed_coordinates_GFp(group, point, x, y_bit, ctx);
628 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *point, point_conversion_form_t form,
629 unsigned char *buf, size_t len, BN_CTX *ctx)
631 if (group->meth->point2oct == 0)
633 ECerr(EC_F_EC_POINT_POINT2OCT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
636 if (group->meth != point->meth)
638 ECerr(EC_F_EC_POINT_POINT2OCT, EC_R_INCOMPATIBLE_OBJECTS);
641 return group->meth->point2oct(group, point, form, buf, len, ctx);
645 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *point,
646 const unsigned char *buf, size_t len, BN_CTX *ctx)
648 if (group->meth->oct2point == 0)
650 ECerr(EC_F_EC_POINT_OCT2POINT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
653 if (group->meth != point->meth)
655 ECerr(EC_F_EC_POINT_OCT2POINT, EC_R_INCOMPATIBLE_OBJECTS);
658 return group->meth->oct2point(group, point, buf, len, ctx);
662 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
664 if (group->meth->add == 0)
666 ECerr(EC_F_EC_POINT_ADD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
669 if ((group->meth != r->meth) || (r->meth != a->meth) || (a->meth != b->meth))
671 ECerr(EC_F_EC_POINT_ADD, EC_R_INCOMPATIBLE_OBJECTS);
674 return group->meth->add(group, r, a, b, ctx);
678 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx)
680 if (group->meth->dbl == 0)
682 ECerr(EC_F_EC_POINT_DBL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
685 if ((group->meth != r->meth) || (r->meth != a->meth))
687 ECerr(EC_F_EC_POINT_DBL, EC_R_INCOMPATIBLE_OBJECTS);
690 return group->meth->dbl(group, r, a, ctx);
694 int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx)
696 if (group->meth->dbl == 0)
698 ECerr(EC_F_EC_POINT_DBL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
701 if (group->meth != a->meth)
703 ECerr(EC_F_EC_POINT_DBL, EC_R_INCOMPATIBLE_OBJECTS);
706 return group->meth->invert(group, a, ctx);
710 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *point)
712 if (group->meth->is_at_infinity == 0)
714 ECerr(EC_F_EC_POINT_IS_AT_INFINITY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
717 if (group->meth != point->meth)
719 ECerr(EC_F_EC_POINT_IS_AT_INFINITY, EC_R_INCOMPATIBLE_OBJECTS);
722 return group->meth->is_at_infinity(group, point);
726 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx)
728 if (group->meth->is_on_curve == 0)
730 ECerr(EC_F_EC_POINT_IS_ON_CURVE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
733 if (group->meth != point->meth)
735 ECerr(EC_F_EC_POINT_IS_ON_CURVE, EC_R_INCOMPATIBLE_OBJECTS);
738 return group->meth->is_on_curve(group, point, ctx);
742 int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
744 if (group->meth->point_cmp == 0)
746 ECerr(EC_F_EC_POINT_CMP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
749 if ((group->meth != a->meth) || (a->meth != b->meth))
751 ECerr(EC_F_EC_POINT_CMP, EC_R_INCOMPATIBLE_OBJECTS);
754 return group->meth->point_cmp(group, a, b, ctx);
758 int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
760 if (group->meth->make_affine == 0)
762 ECerr(EC_F_EC_POINT_MAKE_AFFINE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
765 if (group->meth != point->meth)
767 ECerr(EC_F_EC_POINT_MAKE_AFFINE, EC_R_INCOMPATIBLE_OBJECTS);
770 return group->meth->make_affine(group, point, ctx);
774 int EC_POINTs_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[], BN_CTX *ctx)
778 if (group->meth->points_make_affine == 0)
780 ECerr(EC_F_EC_POINTS_MAKE_AFFINE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
783 for (i = 0; i < num; i++)
785 if (group->meth != points[i]->meth)
787 ECerr(EC_F_EC_POINTS_MAKE_AFFINE, EC_R_INCOMPATIBLE_OBJECTS);
791 return group->meth->points_make_affine(group, num, points, ctx);