2 * Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
5 * Licensed under the OpenSSL license (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
11 #include <openssl/err.h>
13 #include "internal/bn_int.h"
16 #ifndef OPENSSL_NO_EC2M
18 const EC_METHOD *EC_GF2m_simple_method(void)
20 static const EC_METHOD ret = {
22 NID_X9_62_characteristic_two_field,
23 ec_GF2m_simple_group_init,
24 ec_GF2m_simple_group_finish,
25 ec_GF2m_simple_group_clear_finish,
26 ec_GF2m_simple_group_copy,
27 ec_GF2m_simple_group_set_curve,
28 ec_GF2m_simple_group_get_curve,
29 ec_GF2m_simple_group_get_degree,
30 ec_group_simple_order_bits,
31 ec_GF2m_simple_group_check_discriminant,
32 ec_GF2m_simple_point_init,
33 ec_GF2m_simple_point_finish,
34 ec_GF2m_simple_point_clear_finish,
35 ec_GF2m_simple_point_copy,
36 ec_GF2m_simple_point_set_to_infinity,
37 0 /* set_Jprojective_coordinates_GFp */ ,
38 0 /* get_Jprojective_coordinates_GFp */ ,
39 ec_GF2m_simple_point_set_affine_coordinates,
40 ec_GF2m_simple_point_get_affine_coordinates,
44 ec_GF2m_simple_invert,
45 ec_GF2m_simple_is_at_infinity,
46 ec_GF2m_simple_is_on_curve,
48 ec_GF2m_simple_make_affine,
49 ec_GF2m_simple_points_make_affine,
51 0 /* precompute_mul */,
52 0 /* have_precompute_mul */,
53 ec_GF2m_simple_field_mul,
54 ec_GF2m_simple_field_sqr,
55 ec_GF2m_simple_field_div,
56 0 /* field_encode */ ,
57 0 /* field_decode */ ,
58 0, /* field_set_to_one */
59 ec_key_simple_priv2oct,
60 ec_key_simple_oct2priv,
62 ec_key_simple_generate_key,
63 ec_key_simple_check_key,
64 ec_key_simple_generate_public_key,
67 ecdh_simple_compute_key
74 * Initialize a GF(2^m)-based EC_GROUP structure. Note that all other members
75 * are handled by EC_GROUP_new.
77 int ec_GF2m_simple_group_init(EC_GROUP *group)
79 group->field = BN_new();
83 if (group->field == NULL || group->a == NULL || group->b == NULL) {
84 BN_free(group->field);
93 * Free a GF(2^m)-based EC_GROUP structure. Note that all other members are
94 * handled by EC_GROUP_free.
96 void ec_GF2m_simple_group_finish(EC_GROUP *group)
98 BN_free(group->field);
104 * Clear and free a GF(2^m)-based EC_GROUP structure. Note that all other
105 * members are handled by EC_GROUP_clear_free.
107 void ec_GF2m_simple_group_clear_finish(EC_GROUP *group)
109 BN_clear_free(group->field);
110 BN_clear_free(group->a);
111 BN_clear_free(group->b);
121 * Copy a GF(2^m)-based EC_GROUP structure. Note that all other members are
122 * handled by EC_GROUP_copy.
124 int ec_GF2m_simple_group_copy(EC_GROUP *dest, const EC_GROUP *src)
126 if (!BN_copy(dest->field, src->field))
128 if (!BN_copy(dest->a, src->a))
130 if (!BN_copy(dest->b, src->b))
132 dest->poly[0] = src->poly[0];
133 dest->poly[1] = src->poly[1];
134 dest->poly[2] = src->poly[2];
135 dest->poly[3] = src->poly[3];
136 dest->poly[4] = src->poly[4];
137 dest->poly[5] = src->poly[5];
138 if (bn_wexpand(dest->a, (int)(dest->poly[0] + BN_BITS2 - 1) / BN_BITS2) ==
141 if (bn_wexpand(dest->b, (int)(dest->poly[0] + BN_BITS2 - 1) / BN_BITS2) ==
144 bn_set_all_zero(dest->a);
145 bn_set_all_zero(dest->b);
149 /* Set the curve parameters of an EC_GROUP structure. */
150 int ec_GF2m_simple_group_set_curve(EC_GROUP *group,
151 const BIGNUM *p, const BIGNUM *a,
152 const BIGNUM *b, BN_CTX *ctx)
157 if (!BN_copy(group->field, p))
159 i = BN_GF2m_poly2arr(group->field, group->poly, 6) - 1;
160 if ((i != 5) && (i != 3)) {
161 ECerr(EC_F_EC_GF2M_SIMPLE_GROUP_SET_CURVE, EC_R_UNSUPPORTED_FIELD);
166 if (!BN_GF2m_mod_arr(group->a, a, group->poly))
168 if (bn_wexpand(group->a, (int)(group->poly[0] + BN_BITS2 - 1) / BN_BITS2)
171 bn_set_all_zero(group->a);
174 if (!BN_GF2m_mod_arr(group->b, b, group->poly))
176 if (bn_wexpand(group->b, (int)(group->poly[0] + BN_BITS2 - 1) / BN_BITS2)
179 bn_set_all_zero(group->b);
187 * Get the curve parameters of an EC_GROUP structure. If p, a, or b are NULL
188 * then there values will not be set but the method will return with success.
190 int ec_GF2m_simple_group_get_curve(const EC_GROUP *group, BIGNUM *p,
191 BIGNUM *a, BIGNUM *b, BN_CTX *ctx)
196 if (!BN_copy(p, group->field))
201 if (!BN_copy(a, group->a))
206 if (!BN_copy(b, group->b))
217 * Gets the degree of the field. For a curve over GF(2^m) this is the value
220 int ec_GF2m_simple_group_get_degree(const EC_GROUP *group)
222 return BN_num_bits(group->field) - 1;
226 * Checks the discriminant of the curve. y^2 + x*y = x^3 + a*x^2 + b is an
227 * elliptic curve <=> b != 0 (mod p)
229 int ec_GF2m_simple_group_check_discriminant(const EC_GROUP *group,
234 BN_CTX *new_ctx = NULL;
237 ctx = new_ctx = BN_CTX_new();
239 ECerr(EC_F_EC_GF2M_SIMPLE_GROUP_CHECK_DISCRIMINANT,
240 ERR_R_MALLOC_FAILURE);
249 if (!BN_GF2m_mod_arr(b, group->b, group->poly))
253 * check the discriminant: y^2 + x*y = x^3 + a*x^2 + b is an elliptic
254 * curve <=> b != 0 (mod p)
264 BN_CTX_free(new_ctx);
268 /* Initializes an EC_POINT. */
269 int ec_GF2m_simple_point_init(EC_POINT *point)
275 if (point->X == NULL || point->Y == NULL || point->Z == NULL) {
284 /* Frees an EC_POINT. */
285 void ec_GF2m_simple_point_finish(EC_POINT *point)
292 /* Clears and frees an EC_POINT. */
293 void ec_GF2m_simple_point_clear_finish(EC_POINT *point)
295 BN_clear_free(point->X);
296 BN_clear_free(point->Y);
297 BN_clear_free(point->Z);
302 * Copy the contents of one EC_POINT into another. Assumes dest is
305 int ec_GF2m_simple_point_copy(EC_POINT *dest, const EC_POINT *src)
307 if (!BN_copy(dest->X, src->X))
309 if (!BN_copy(dest->Y, src->Y))
311 if (!BN_copy(dest->Z, src->Z))
313 dest->Z_is_one = src->Z_is_one;
319 * Set an EC_POINT to the point at infinity. A point at infinity is
320 * represented by having Z=0.
322 int ec_GF2m_simple_point_set_to_infinity(const EC_GROUP *group,
331 * Set the coordinates of an EC_POINT using affine coordinates. Note that
332 * the simple implementation only uses affine coordinates.
334 int ec_GF2m_simple_point_set_affine_coordinates(const EC_GROUP *group,
337 const BIGNUM *y, BN_CTX *ctx)
340 if (x == NULL || y == NULL) {
341 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES,
342 ERR_R_PASSED_NULL_PARAMETER);
346 if (!BN_copy(point->X, x))
348 BN_set_negative(point->X, 0);
349 if (!BN_copy(point->Y, y))
351 BN_set_negative(point->Y, 0);
352 if (!BN_copy(point->Z, BN_value_one()))
354 BN_set_negative(point->Z, 0);
363 * Gets the affine coordinates of an EC_POINT. Note that the simple
364 * implementation only uses affine coordinates.
366 int ec_GF2m_simple_point_get_affine_coordinates(const EC_GROUP *group,
367 const EC_POINT *point,
368 BIGNUM *x, BIGNUM *y,
373 if (EC_POINT_is_at_infinity(group, point)) {
374 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES,
375 EC_R_POINT_AT_INFINITY);
379 if (BN_cmp(point->Z, BN_value_one())) {
380 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES,
381 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
385 if (!BN_copy(x, point->X))
387 BN_set_negative(x, 0);
390 if (!BN_copy(y, point->Y))
392 BN_set_negative(y, 0);
401 * Computes a + b and stores the result in r. r could be a or b, a could be
402 * b. Uses algorithm A.10.2 of IEEE P1363.
404 int ec_GF2m_simple_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,
405 const EC_POINT *b, BN_CTX *ctx)
407 BN_CTX *new_ctx = NULL;
408 BIGNUM *x0, *y0, *x1, *y1, *x2, *y2, *s, *t;
411 if (EC_POINT_is_at_infinity(group, a)) {
412 if (!EC_POINT_copy(r, b))
417 if (EC_POINT_is_at_infinity(group, b)) {
418 if (!EC_POINT_copy(r, a))
424 ctx = new_ctx = BN_CTX_new();
430 x0 = BN_CTX_get(ctx);
431 y0 = BN_CTX_get(ctx);
432 x1 = BN_CTX_get(ctx);
433 y1 = BN_CTX_get(ctx);
434 x2 = BN_CTX_get(ctx);
435 y2 = BN_CTX_get(ctx);
442 if (!BN_copy(x0, a->X))
444 if (!BN_copy(y0, a->Y))
447 if (!EC_POINT_get_affine_coordinates_GF2m(group, a, x0, y0, ctx))
451 if (!BN_copy(x1, b->X))
453 if (!BN_copy(y1, b->Y))
456 if (!EC_POINT_get_affine_coordinates_GF2m(group, b, x1, y1, ctx))
460 if (BN_GF2m_cmp(x0, x1)) {
461 if (!BN_GF2m_add(t, x0, x1))
463 if (!BN_GF2m_add(s, y0, y1))
465 if (!group->meth->field_div(group, s, s, t, ctx))
467 if (!group->meth->field_sqr(group, x2, s, ctx))
469 if (!BN_GF2m_add(x2, x2, group->a))
471 if (!BN_GF2m_add(x2, x2, s))
473 if (!BN_GF2m_add(x2, x2, t))
476 if (BN_GF2m_cmp(y0, y1) || BN_is_zero(x1)) {
477 if (!EC_POINT_set_to_infinity(group, r))
482 if (!group->meth->field_div(group, s, y1, x1, ctx))
484 if (!BN_GF2m_add(s, s, x1))
487 if (!group->meth->field_sqr(group, x2, s, ctx))
489 if (!BN_GF2m_add(x2, x2, s))
491 if (!BN_GF2m_add(x2, x2, group->a))
495 if (!BN_GF2m_add(y2, x1, x2))
497 if (!group->meth->field_mul(group, y2, y2, s, ctx))
499 if (!BN_GF2m_add(y2, y2, x2))
501 if (!BN_GF2m_add(y2, y2, y1))
504 if (!EC_POINT_set_affine_coordinates_GF2m(group, r, x2, y2, ctx))
511 BN_CTX_free(new_ctx);
516 * Computes 2 * a and stores the result in r. r could be a. Uses algorithm
517 * A.10.2 of IEEE P1363.
519 int ec_GF2m_simple_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,
522 return ec_GF2m_simple_add(group, r, a, a, ctx);
525 int ec_GF2m_simple_invert(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
527 if (EC_POINT_is_at_infinity(group, point) || BN_is_zero(point->Y))
528 /* point is its own inverse */
531 if (!EC_POINT_make_affine(group, point, ctx))
533 return BN_GF2m_add(point->Y, point->X, point->Y);
536 /* Indicates whether the given point is the point at infinity. */
537 int ec_GF2m_simple_is_at_infinity(const EC_GROUP *group,
538 const EC_POINT *point)
540 return BN_is_zero(point->Z);
544 * Determines whether the given EC_POINT is an actual point on the curve defined
545 * in the EC_GROUP. A point is valid if it satisfies the Weierstrass equation:
546 * y^2 + x*y = x^3 + a*x^2 + b.
548 int ec_GF2m_simple_is_on_curve(const EC_GROUP *group, const EC_POINT *point,
552 BN_CTX *new_ctx = NULL;
554 int (*field_mul) (const EC_GROUP *, BIGNUM *, const BIGNUM *,
555 const BIGNUM *, BN_CTX *);
556 int (*field_sqr) (const EC_GROUP *, BIGNUM *, const BIGNUM *, BN_CTX *);
558 if (EC_POINT_is_at_infinity(group, point))
561 field_mul = group->meth->field_mul;
562 field_sqr = group->meth->field_sqr;
564 /* only support affine coordinates */
565 if (!point->Z_is_one)
569 ctx = new_ctx = BN_CTX_new();
575 y2 = BN_CTX_get(ctx);
576 lh = BN_CTX_get(ctx);
581 * We have a curve defined by a Weierstrass equation
582 * y^2 + x*y = x^3 + a*x^2 + b.
583 * <=> x^3 + a*x^2 + x*y + b + y^2 = 0
584 * <=> ((x + a) * x + y ) * x + b + y^2 = 0
586 if (!BN_GF2m_add(lh, point->X, group->a))
588 if (!field_mul(group, lh, lh, point->X, ctx))
590 if (!BN_GF2m_add(lh, lh, point->Y))
592 if (!field_mul(group, lh, lh, point->X, ctx))
594 if (!BN_GF2m_add(lh, lh, group->b))
596 if (!field_sqr(group, y2, point->Y, ctx))
598 if (!BN_GF2m_add(lh, lh, y2))
600 ret = BN_is_zero(lh);
604 BN_CTX_free(new_ctx);
609 * Indicates whether two points are equal.
612 * 0 equal (in affine coordinates)
615 int ec_GF2m_simple_cmp(const EC_GROUP *group, const EC_POINT *a,
616 const EC_POINT *b, BN_CTX *ctx)
618 BIGNUM *aX, *aY, *bX, *bY;
619 BN_CTX *new_ctx = NULL;
622 if (EC_POINT_is_at_infinity(group, a)) {
623 return EC_POINT_is_at_infinity(group, b) ? 0 : 1;
626 if (EC_POINT_is_at_infinity(group, b))
629 if (a->Z_is_one && b->Z_is_one) {
630 return ((BN_cmp(a->X, b->X) == 0) && BN_cmp(a->Y, b->Y) == 0) ? 0 : 1;
634 ctx = new_ctx = BN_CTX_new();
640 aX = BN_CTX_get(ctx);
641 aY = BN_CTX_get(ctx);
642 bX = BN_CTX_get(ctx);
643 bY = BN_CTX_get(ctx);
647 if (!EC_POINT_get_affine_coordinates_GF2m(group, a, aX, aY, ctx))
649 if (!EC_POINT_get_affine_coordinates_GF2m(group, b, bX, bY, ctx))
651 ret = ((BN_cmp(aX, bX) == 0) && BN_cmp(aY, bY) == 0) ? 0 : 1;
655 BN_CTX_free(new_ctx);
659 /* Forces the given EC_POINT to internally use affine coordinates. */
660 int ec_GF2m_simple_make_affine(const EC_GROUP *group, EC_POINT *point,
663 BN_CTX *new_ctx = NULL;
667 if (point->Z_is_one || EC_POINT_is_at_infinity(group, point))
671 ctx = new_ctx = BN_CTX_new();
682 if (!EC_POINT_get_affine_coordinates_GF2m(group, point, x, y, ctx))
684 if (!BN_copy(point->X, x))
686 if (!BN_copy(point->Y, y))
688 if (!BN_one(point->Z))
696 BN_CTX_free(new_ctx);
701 * Forces each of the EC_POINTs in the given array to use affine coordinates.
703 int ec_GF2m_simple_points_make_affine(const EC_GROUP *group, size_t num,
704 EC_POINT *points[], BN_CTX *ctx)
708 for (i = 0; i < num; i++) {
709 if (!group->meth->make_affine(group, points[i], ctx))
716 /* Wrapper to simple binary polynomial field multiplication implementation. */
717 int ec_GF2m_simple_field_mul(const EC_GROUP *group, BIGNUM *r,
718 const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
720 return BN_GF2m_mod_mul_arr(r, a, b, group->poly, ctx);
723 /* Wrapper to simple binary polynomial field squaring implementation. */
724 int ec_GF2m_simple_field_sqr(const EC_GROUP *group, BIGNUM *r,
725 const BIGNUM *a, BN_CTX *ctx)
727 return BN_GF2m_mod_sqr_arr(r, a, group->poly, ctx);
730 /* Wrapper to simple binary polynomial field division implementation. */
731 int ec_GF2m_simple_field_div(const EC_GROUP *group, BIGNUM *r,
732 const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
734 return BN_GF2m_mod_div(r, a, b, group->field, ctx);