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);
102 ret->asn1_flag = OPENSSL_EC_EXPLICIT | OPENSSL_EC_COMPRESSED;
107 if (!meth->group_init(ret))
117 void EC_GROUP_free(EC_GROUP *group)
121 if (group->meth->group_finish != 0)
122 group->meth->group_finish(group);
124 EC_GROUP_free_extra_data(group);
126 if (group->generator != NULL)
127 EC_POINT_free(group->generator);
128 BN_free(&group->order);
129 BN_free(&group->cofactor);
132 OPENSSL_free(group->seed);
138 void EC_GROUP_clear_free(EC_GROUP *group)
142 if (group->meth->group_clear_finish != 0)
143 group->meth->group_clear_finish(group);
144 else if (group->meth != NULL && group->meth->group_finish != 0)
145 group->meth->group_finish(group);
147 EC_GROUP_clear_free_extra_data(group);
149 if (group->generator != NULL)
150 EC_POINT_clear_free(group->generator);
151 BN_clear_free(&group->order);
152 BN_clear_free(&group->cofactor);
156 memset(group->seed, 0, group->seed_len);
157 OPENSSL_free(group->seed);
160 memset(group, 0, sizeof *group);
165 int EC_GROUP_copy(EC_GROUP *dest, const EC_GROUP *src)
167 if (dest->meth->group_copy == 0)
169 ECerr(EC_F_EC_GROUP_COPY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
172 if (dest->meth != src->meth)
174 ECerr(EC_F_EC_GROUP_COPY, EC_R_INCOMPATIBLE_OBJECTS);
180 EC_GROUP_clear_free_extra_data(dest);
181 if (src->extra_data_dup_func)
183 if (src->extra_data != NULL)
185 dest->extra_data = src->extra_data_dup_func(src->extra_data);
186 if (dest->extra_data == NULL)
190 dest->extra_data_dup_func = src->extra_data_dup_func;
191 dest->extra_data_free_func = src->extra_data_free_func;
192 dest->extra_data_clear_free_func = src->extra_data_clear_free_func;
195 if (src->generator != NULL)
197 if (dest->generator == NULL)
199 dest->generator = EC_POINT_new(dest);
200 if (dest->generator == NULL) return 0;
202 if (!EC_POINT_copy(dest->generator, src->generator)) return 0;
206 /* src->generator == NULL */
207 if (dest->generator != NULL)
209 EC_POINT_clear_free(dest->generator);
210 dest->generator = NULL;
214 if (!BN_copy(&dest->order, &src->order)) return 0;
215 if (!BN_copy(&dest->cofactor, &src->cofactor)) return 0;
217 dest->nid = src->nid;
218 dest->asn1_flag = src->asn1_flag;
223 OPENSSL_free(dest->seed);
224 dest->seed = OPENSSL_malloc(src->seed_len);
225 if (dest->seed == NULL)
227 if (!memcpy(dest->seed, src->seed, src->seed_len))
229 dest->seed_len = src->seed_len;
234 OPENSSL_free(dest->seed);
240 return dest->meth->group_copy(dest, src);
244 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group)
250 int EC_METHOD_get_field_type(const EC_METHOD *meth)
252 return meth->field_type;
256 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor)
258 if (generator == NULL)
260 ECerr(EC_F_EC_GROUP_SET_GENERATOR, ERR_R_PASSED_NULL_PARAMETER);
264 if (group->generator == NULL)
266 group->generator = EC_POINT_new(group);
267 if (group->generator == NULL) return 0;
269 if (!EC_POINT_copy(group->generator, generator)) return 0;
272 { if (!BN_copy(&group->order, order)) return 0; }
274 { if (!BN_zero(&group->order)) return 0; }
276 if (cofactor != NULL)
277 { if (!BN_copy(&group->cofactor, cofactor)) return 0; }
279 { if (!BN_zero(&group->cofactor)) return 0; }
285 EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group)
287 return group->generator;
291 int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx)
293 if (!BN_copy(order, &group->order))
296 return !BN_is_zero(order);
300 int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx)
302 if (!BN_copy(cofactor, &group->cofactor))
305 return !BN_is_zero(&group->cofactor);
309 void EC_GROUP_set_nid(EC_GROUP *group, int nid)
315 int EC_GROUP_get_nid(const EC_GROUP *group)
321 void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag)
323 group->asn1_flag = flag;
327 int EC_GROUP_get_asn1_flag(const EC_GROUP *group)
329 return group->asn1_flag;
333 int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
335 if (group->meth->group_set_curve_GFp == 0)
337 ECerr(EC_F_EC_GROUP_SET_CURVE_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
340 return group->meth->group_set_curve_GFp(group, p, a, b, ctx);
344 int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx)
346 if (group->meth->group_get_curve_GFp == 0)
348 ECerr(EC_F_EC_GROUP_GET_CURVE_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
351 return group->meth->group_get_curve_GFp(group, p, a, b, ctx);
355 int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx)
357 if (group->meth->group_check_discriminant == 0)
359 ECerr(EC_F_EC_GROUP_CHECK_DISCRIMINANT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
362 return group->meth->group_check_discriminant(group, ctx);
366 /* this has 'package' visibility */
367 int EC_GROUP_set_extra_data(EC_GROUP *group, void *extra_data, void *(*extra_data_dup_func)(void *),
368 void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *))
370 if ((group->extra_data != NULL)
371 || (group->extra_data_dup_func != 0)
372 || (group->extra_data_free_func != 0)
373 || (group->extra_data_clear_free_func != 0))
375 ECerr(EC_F_EC_GROUP_SET_EXTRA_DATA, EC_R_SLOT_FULL);
379 group->extra_data = extra_data;
380 group->extra_data_dup_func = extra_data_dup_func;
381 group->extra_data_free_func = extra_data_free_func;
382 group->extra_data_clear_free_func = extra_data_clear_free_func;
387 /* this has 'package' visibility */
388 void *EC_GROUP_get_extra_data(const EC_GROUP *group, void *(*extra_data_dup_func)(void *),
389 void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *))
391 if ((group->extra_data_dup_func != extra_data_dup_func)
392 || (group->extra_data_free_func != extra_data_free_func)
393 || (group->extra_data_clear_free_func != extra_data_clear_free_func))
395 ECerr(EC_F_EC_GROUP_GET_EXTRA_DATA, EC_R_NO_SUCH_EXTRA_DATA);
399 return group->extra_data;
403 /* this has 'package' visibility */
404 void EC_GROUP_free_extra_data(EC_GROUP *group)
406 if (group->extra_data_free_func)
407 group->extra_data_free_func(group->extra_data);
408 group->extra_data = NULL;
409 group->extra_data_dup_func = 0;
410 group->extra_data_free_func = 0;
411 group->extra_data_clear_free_func = 0;
415 /* this has 'package' visibility */
416 void EC_GROUP_clear_free_extra_data(EC_GROUP *group)
418 if (group->extra_data_clear_free_func)
419 group->extra_data_clear_free_func(group->extra_data);
420 else if (group->extra_data_free_func)
421 group->extra_data_free_func(group->extra_data);
422 group->extra_data = NULL;
423 group->extra_data_dup_func = 0;
424 group->extra_data_free_func = 0;
425 group->extra_data_clear_free_func = 0;
429 /* functions for EC_POINT objects */
431 EC_POINT *EC_POINT_new(const EC_GROUP *group)
437 ECerr(EC_F_EC_POINT_NEW, ERR_R_PASSED_NULL_PARAMETER);
440 if (group->meth->point_init == 0)
442 ECerr(EC_F_EC_POINT_NEW, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
446 ret = OPENSSL_malloc(sizeof *ret);
449 ECerr(EC_F_EC_POINT_NEW, ERR_R_MALLOC_FAILURE);
453 ret->meth = group->meth;
455 if (!ret->meth->point_init(ret))
465 void EC_POINT_free(EC_POINT *point)
469 if (point->meth->point_finish != 0)
470 point->meth->point_finish(point);
475 void EC_POINT_clear_free(EC_POINT *point)
479 if (point->meth->point_clear_finish != 0)
480 point->meth->point_clear_finish(point);
481 else if (point->meth != NULL && point->meth->point_finish != 0)
482 point->meth->point_finish(point);
483 memset(point, 0, sizeof *point);
488 int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src)
490 if (dest->meth->point_copy == 0)
492 ECerr(EC_F_EC_POINT_COPY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
495 if (dest->meth != src->meth)
497 ECerr(EC_F_EC_POINT_COPY, EC_R_INCOMPATIBLE_OBJECTS);
502 return dest->meth->point_copy(dest, src);
506 const EC_METHOD *EC_POINT_method_of(const EC_POINT *point)
512 int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point)
514 if (group->meth->point_set_to_infinity == 0)
516 ECerr(EC_F_EC_POINT_SET_TO_INFINITY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
519 if (group->meth != point->meth)
521 ECerr(EC_F_EC_POINT_SET_TO_INFINITY, EC_R_INCOMPATIBLE_OBJECTS);
524 return group->meth->point_set_to_infinity(group, point);
528 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
529 const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *ctx)
531 if (group->meth->point_set_Jprojective_coordinates_GFp == 0)
533 ECerr(EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
536 if (group->meth != point->meth)
538 ECerr(EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
541 return group->meth->point_set_Jprojective_coordinates_GFp(group, point, x, y, z, ctx);
545 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group, const EC_POINT *point,
546 BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx)
548 if (group->meth->point_get_Jprojective_coordinates_GFp == 0)
550 ECerr(EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
553 if (group->meth != point->meth)
555 ECerr(EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
558 return group->meth->point_get_Jprojective_coordinates_GFp(group, point, x, y, z, ctx);
562 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
563 const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx)
565 if (group->meth->point_set_affine_coordinates_GFp == 0)
567 ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
570 if (group->meth != point->meth)
572 ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
575 return group->meth->point_set_affine_coordinates_GFp(group, point, x, y, ctx);
579 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, const EC_POINT *point,
580 BIGNUM *x, BIGNUM *y, BN_CTX *ctx)
582 if (group->meth->point_get_affine_coordinates_GFp == 0)
584 ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
587 if (group->meth != point->meth)
589 ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
592 return group->meth->point_get_affine_coordinates_GFp(group, point, x, y, ctx);
596 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
597 const BIGNUM *x, int y_bit, BN_CTX *ctx)
599 if (group->meth->point_set_compressed_coordinates_GFp == 0)
601 ECerr(EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
604 if (group->meth != point->meth)
606 ECerr(EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
609 return group->meth->point_set_compressed_coordinates_GFp(group, point, x, y_bit, ctx);
613 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *point, point_conversion_form_t form,
614 unsigned char *buf, size_t len, BN_CTX *ctx)
616 if (group->meth->point2oct == 0)
618 ECerr(EC_F_EC_POINT_POINT2OCT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
621 if (group->meth != point->meth)
623 ECerr(EC_F_EC_POINT_POINT2OCT, EC_R_INCOMPATIBLE_OBJECTS);
626 return group->meth->point2oct(group, point, form, buf, len, ctx);
630 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *point,
631 const unsigned char *buf, size_t len, BN_CTX *ctx)
633 if (group->meth->oct2point == 0)
635 ECerr(EC_F_EC_POINT_OCT2POINT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
638 if (group->meth != point->meth)
640 ECerr(EC_F_EC_POINT_OCT2POINT, EC_R_INCOMPATIBLE_OBJECTS);
643 return group->meth->oct2point(group, point, buf, len, ctx);
647 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
649 if (group->meth->add == 0)
651 ECerr(EC_F_EC_POINT_ADD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
654 if ((group->meth != r->meth) || (r->meth != a->meth) || (a->meth != b->meth))
656 ECerr(EC_F_EC_POINT_ADD, EC_R_INCOMPATIBLE_OBJECTS);
659 return group->meth->add(group, r, a, b, ctx);
663 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx)
665 if (group->meth->dbl == 0)
667 ECerr(EC_F_EC_POINT_DBL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
670 if ((group->meth != r->meth) || (r->meth != a->meth))
672 ECerr(EC_F_EC_POINT_DBL, EC_R_INCOMPATIBLE_OBJECTS);
675 return group->meth->dbl(group, r, a, ctx);
679 int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx)
681 if (group->meth->dbl == 0)
683 ECerr(EC_F_EC_POINT_DBL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
686 if (group->meth != a->meth)
688 ECerr(EC_F_EC_POINT_DBL, EC_R_INCOMPATIBLE_OBJECTS);
691 return group->meth->invert(group, a, ctx);
695 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *point)
697 if (group->meth->is_at_infinity == 0)
699 ECerr(EC_F_EC_POINT_IS_AT_INFINITY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
702 if (group->meth != point->meth)
704 ECerr(EC_F_EC_POINT_IS_AT_INFINITY, EC_R_INCOMPATIBLE_OBJECTS);
707 return group->meth->is_at_infinity(group, point);
711 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx)
713 if (group->meth->is_on_curve == 0)
715 ECerr(EC_F_EC_POINT_IS_ON_CURVE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
718 if (group->meth != point->meth)
720 ECerr(EC_F_EC_POINT_IS_ON_CURVE, EC_R_INCOMPATIBLE_OBJECTS);
723 return group->meth->is_on_curve(group, point, ctx);
727 int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
729 if (group->meth->point_cmp == 0)
731 ECerr(EC_F_EC_POINT_CMP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
734 if ((group->meth != a->meth) || (a->meth != b->meth))
736 ECerr(EC_F_EC_POINT_CMP, EC_R_INCOMPATIBLE_OBJECTS);
739 return group->meth->point_cmp(group, a, b, ctx);
743 int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
745 if (group->meth->make_affine == 0)
747 ECerr(EC_F_EC_POINT_MAKE_AFFINE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
750 if (group->meth != point->meth)
752 ECerr(EC_F_EC_POINT_MAKE_AFFINE, EC_R_INCOMPATIBLE_OBJECTS);
755 return group->meth->make_affine(group, point, ctx);
759 int EC_POINTs_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[], BN_CTX *ctx)
763 if (group->meth->points_make_affine == 0)
765 ECerr(EC_F_EC_POINTS_MAKE_AFFINE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
768 for (i = 0; i < num; i++)
770 if (group->meth != points[i]->meth)
772 ECerr(EC_F_EC_POINTS_MAKE_AFFINE, EC_R_INCOMPATIBLE_OBJECTS);
776 return group->meth->points_make_affine(group, num, points, ctx);