crypto/ec/ec2_smpl.c

   1 /* crypto/ec/ec2_smpl.c */
   2 /* ====================================================================
   3  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
   4  *
   5  * The Elliptic Curve Public-Key Crypto Library (ECC Code) included
   6  * herein is developed by SUN MICROSYSTEMS, INC., and is contributed
   7  * to the OpenSSL project.
   8  *
   9  * The ECC Code is licensed pursuant to the OpenSSL open source
  10  * license provided below.
  11  *
  12  * The software is originally written by Sheueling Chang Shantz and
  13  * Douglas Stebila of Sun Microsystems Laboratories.
  14  *
  15  */
  16 /* ====================================================================
  17  * Copyright (c) 1998-2003 The OpenSSL Project.  All rights reserved.
  18  *
  19  * Redistribution and use in source and binary forms, with or without
  20  * modification, are permitted provided that the following conditions
  21  * are met:
  22  *
  23  * 1. Redistributions of source code must retain the above copyright
  24  *    notice, this list of conditions and the following disclaimer.
  25  *
  26  * 2. Redistributions in binary form must reproduce the above copyright
  27  *    notice, this list of conditions and the following disclaimer in
  28  *    the documentation and/or other materials provided with the
  29  *    distribution.
  30  *
  31  * 3. All advertising materials mentioning features or use of this
  32  *    software must display the following acknowledgment:
  33  *    "This product includes software developed by the OpenSSL Project
  34  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  35  *
  36  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  37  *    endorse or promote products derived from this software without
  38  *    prior written permission. For written permission, please contact
  39  *    openssl-core@openssl.org.
  40  *
  41  * 5. Products derived from this software may not be called "OpenSSL"
  42  *    nor may "OpenSSL" appear in their names without prior written
  43  *    permission of the OpenSSL Project.
  44  *
  45  * 6. Redistributions of any form whatsoever must retain the following
  46  *    acknowledgment:
  47  *    "This product includes software developed by the OpenSSL Project
  48  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  51  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  53  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  54  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  56  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  57  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  59  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  60  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  61  * OF THE POSSIBILITY OF SUCH DAMAGE.
  62  * ====================================================================
  63  *
  64  * This product includes cryptographic software written by Eric Young
  65  * (eay@cryptsoft.com).  This product includes software written by Tim
  66  * Hudson (tjh@cryptsoft.com).
  67  *
  68  */
  69
  70 #include <openssl/err.h>
  71
  72 #include "ec_lcl.h"
  73
  74
  75 const EC_METHOD *EC_GF2m_simple_method(void)
  76         {
  77         static const EC_METHOD ret = {
  78                 NID_X9_62_characteristic_two_field,
  79                 ec_GF2m_simple_group_init,
  80                 ec_GF2m_simple_group_finish,
  81                 ec_GF2m_simple_group_clear_finish,
  82                 ec_GF2m_simple_group_copy,
  83                 ec_GF2m_simple_group_set_curve,
  84                 ec_GF2m_simple_group_get_curve,
  85                 ec_GF2m_simple_group_get_degree,
  86                 ec_GF2m_simple_group_check_discriminant,
  87                 ec_GF2m_simple_point_init,
  88                 ec_GF2m_simple_point_finish,
  89                 ec_GF2m_simple_point_clear_finish,
  90                 ec_GF2m_simple_point_copy,
  91                 ec_GF2m_simple_point_set_to_infinity,
  92                 0 /* set_Jprojective_coordinates_GFp */,
  93                 0 /* get_Jprojective_coordinates_GFp */,
  94                 ec_GF2m_simple_point_set_affine_coordinates,
  95                 ec_GF2m_simple_point_get_affine_coordinates,
  96                 ec_GF2m_simple_set_compressed_coordinates,
  97                 ec_GF2m_simple_point2oct,
  98                 ec_GF2m_simple_oct2point,
  99                 ec_GF2m_simple_add,
 100                 ec_GF2m_simple_dbl,
 101                 ec_GF2m_simple_invert,
 102                 ec_GF2m_simple_is_at_infinity,
 103                 ec_GF2m_simple_is_on_curve,
 104                 ec_GF2m_simple_cmp,
 105                 ec_GF2m_simple_make_affine,
 106                 ec_GF2m_simple_points_make_affine,
 107
 108                 /* the following three method functions are defined in ec2_mult.c */
 109                 ec_GF2m_simple_mul,
 110                 ec_GF2m_precompute_mult,
 111                 ec_GF2m_have_precompute_mult,
 112
 113                 ec_GF2m_simple_field_mul,
 114                 ec_GF2m_simple_field_sqr,
 115                 ec_GF2m_simple_field_div,
 116                 0 /* field_encode */,
 117                 0 /* field_decode */,
 118                 0 /* field_set_to_one */ };
 119
 120         return &ret;
 121         }
 122
 123
 124 /* Initialize a GF(2^m)-based EC_GROUP structure.
 125  * Note that all other members are handled by EC_GROUP_new.
 126  */
 127 int ec_GF2m_simple_group_init(EC_GROUP *group)
 128         {
 129         BN_init(&group->field);
 130         BN_init(&group->a);
 131         BN_init(&group->b);
 132         return 1;
 133         }
 134
 135
 136 /* Free a GF(2^m)-based EC_GROUP structure.
 137  * Note that all other members are handled by EC_GROUP_free.
 138  */
 139 void ec_GF2m_simple_group_finish(EC_GROUP *group)
 140         {
 141         BN_free(&group->field);
 142         BN_free(&group->a);
 143         BN_free(&group->b);
 144         }
 145
 146
 147 /* Clear and free a GF(2^m)-based EC_GROUP structure.
 148  * Note that all other members are handled by EC_GROUP_clear_free.
 149  */
 150 void ec_GF2m_simple_group_clear_finish(EC_GROUP *group)
 151         {
 152         BN_clear_free(&group->field);
 153         BN_clear_free(&group->a);
 154         BN_clear_free(&group->b);
 155         group->poly[0] = 0;
 156         group->poly[1] = 0;
 157         group->poly[2] = 0;
 158         group->poly[3] = 0;
 159         group->poly[4] = 0;
 160         }
 161
 162
 163 /* Copy a GF(2^m)-based EC_GROUP structure.
 164  * Note that all other members are handled by EC_GROUP_copy.
 165  */
 166 int ec_GF2m_simple_group_copy(EC_GROUP *dest, const EC_GROUP *src)
 167         {
 168         int i;
 169         if (!BN_copy(&dest->field, &src->field)) return 0;
 170         if (!BN_copy(&dest->a, &src->a)) return 0;
 171         if (!BN_copy(&dest->b, &src->b)) return 0;
 172         dest->poly[0] = src->poly[0];
 173         dest->poly[1] = src->poly[1];
 174         dest->poly[2] = src->poly[2];
 175         dest->poly[3] = src->poly[3];
 176         dest->poly[4] = src->poly[4];
 177         bn_wexpand(&dest->a, (int)(dest->poly[0] + BN_BITS2 - 1) / BN_BITS2);
 178         bn_wexpand(&dest->b, (int)(dest->poly[0] + BN_BITS2 - 1) / BN_BITS2);
 179         for (i = dest->a.top; i < dest->a.dmax; i++) dest->a.d[i] = 0;
 180         for (i = dest->b.top; i < dest->b.dmax; i++) dest->b.d[i] = 0;
 181         return 1;
 182         }
 183
 184
 185 /* Set the curve parameters of an EC_GROUP structure. */
 186 int ec_GF2m_simple_group_set_curve(EC_GROUP *group,
 187         const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
 188         {
 189         int ret = 0, i;
 190
 191         /* group->field */
 192         if (!BN_copy(&group->field, p)) goto err;
 193         i = BN_GF2m_poly2arr(&group->field, group->poly, 5);
 194         if ((i != 5) && (i != 3))
 195                 {
 196                 ECerr(EC_F_EC_GF2M_SIMPLE_GROUP_SET_CURVE, EC_R_UNSUPPORTED_FIELD);
 197                 goto err;
 198                 }
 199
 200         /* group->a */
 201         if (!BN_GF2m_mod_arr(&group->a, a, group->poly)) goto err;
 202         bn_wexpand(&group->a, (int)(group->poly[0] + BN_BITS2 - 1) / BN_BITS2);
 203         for (i = group->a.top; i < group->a.dmax; i++) group->a.d[i] = 0;
 204
 205         /* group->b */
 206         if (!BN_GF2m_mod_arr(&group->b, b, group->poly)) goto err;
 207         bn_wexpand(&group->b, (int)(group->poly[0] + BN_BITS2 - 1) / BN_BITS2);
 208         for (i = group->b.top; i < group->b.dmax; i++) group->b.d[i] = 0;
 209
 210         ret = 1;
 211   err:
 212         return ret;
 213         }
 214
 215
 216 /* Get the curve parameters of an EC_GROUP structure.
 217  * If p, a, or b are NULL then there values will not be set but the method will return with success.
 218  */
 219 int ec_GF2m_simple_group_get_curve(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx)
 220         {
 221         int ret = 0;
 222
 223         if (p != NULL)
 224                 {
 225                 if (!BN_copy(p, &group->field)) return 0;
 226                 }
 227
 228         if (a != NULL)
 229                 {
 230                 if (!BN_copy(a, &group->a)) goto err;
 231                 }
 232
 233         if (b != NULL)
 234                 {
 235                 if (!BN_copy(b, &group->b)) goto err;
 236                 }
 237
 238         ret = 1;
 239
 240   err:
 241         return ret;
 242         }
 243
 244
 245 /* Gets the degree of the field.  For a curve over GF(2^m) this is the value m. */
 246 int ec_GF2m_simple_group_get_degree(const EC_GROUP *group)
 247         {
 248         return BN_num_bits(&group->field)-1;
 249         }
 250
 251
 252 /* Checks the discriminant of the curve.
 253  * y^2 + x*y = x^3 + a*x^2 + b is an elliptic curve <=> b != 0 (mod p)
 254  */
 255 int ec_GF2m_simple_group_check_discriminant(const EC_GROUP *group, BN_CTX *ctx)
 256         {
 257         int ret = 0;
 258         BIGNUM *b;
 259         BN_CTX *new_ctx = NULL;
 260
 261         if (ctx == NULL)
 262                 {
 263                 ctx = new_ctx = BN_CTX_new();
 264                 if (ctx == NULL)
 265                         {
 266                         ECerr(EC_F_EC_GF2M_SIMPLE_GROUP_CHECK_DISCRIMINANT, ERR_R_MALLOC_FAILURE);
 267                         goto err;
 268                         }
 269                 }
 270         BN_CTX_start(ctx);
 271         b = BN_CTX_get(ctx);
 272         if (b == NULL) goto err;
 273
 274         if (!BN_GF2m_mod_arr(b, &group->b, group->poly)) goto err;
 275
 276         /* check the discriminant:
 277          * y^2 + x*y = x^3 + a*x^2 + b is an elliptic curve <=> b != 0 (mod p)
 278          */
 279         if (BN_is_zero(b)) goto err;
 280
 281         ret = 1;
 282
 283 err:
 284         BN_CTX_end(ctx);
 285         if (new_ctx != NULL)
 286                 BN_CTX_free(new_ctx);
 287         return ret;
 288         }
 289
 290
 291 /* Initializes an EC_POINT. */
 292 int ec_GF2m_simple_point_init(EC_POINT *point)
 293         {
 294         BN_init(&point->X);
 295         BN_init(&point->Y);
 296         BN_init(&point->Z);
 297         return 1;
 298         }
 299
 300
 301 /* Frees an EC_POINT. */
 302 void ec_GF2m_simple_point_finish(EC_POINT *point)
 303         {
 304         BN_free(&point->X);
 305         BN_free(&point->Y);
 306         BN_free(&point->Z);
 307         }
 308
 309
 310 /* Clears and frees an EC_POINT. */
 311 void ec_GF2m_simple_point_clear_finish(EC_POINT *point)
 312         {
 313         BN_clear_free(&point->X);
 314         BN_clear_free(&point->Y);
 315         BN_clear_free(&point->Z);
 316         point->Z_is_one = 0;
 317         }
 318
 319
 320 /* Copy the contents of one EC_POINT into another.  Assumes dest is initialized. */
 321 int ec_GF2m_simple_point_copy(EC_POINT *dest, const EC_POINT *src)
 322         {
 323         if (!BN_copy(&dest->X, &src->X)) return 0;
 324         if (!BN_copy(&dest->Y, &src->Y)) return 0;
 325         if (!BN_copy(&dest->Z, &src->Z)) return 0;
 326         dest->Z_is_one = src->Z_is_one;
 327
 328         return 1;
 329         }
 330
 331
 332 /* Set an EC_POINT to the point at infinity.
 333  * A point at infinity is represented by having Z=0.
 334  */
 335 int ec_GF2m_simple_point_set_to_infinity(const EC_GROUP *group, EC_POINT *point)
 336         {
 337         point->Z_is_one = 0;
 338         return (BN_zero(&point->Z));
 339         }
 340
 341
 342 /* Set the coordinates of an EC_POINT using affine coordinates.
 343  * Note that the simple implementation only uses affine coordinates.
 344  */
 345 int ec_GF2m_simple_point_set_affine_coordinates(const EC_GROUP *group, EC_POINT *point,
 346         const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx)
 347         {
 348         int ret = 0;
 349         if (x == NULL || y == NULL)
 350                 {
 351                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES, ERR_R_PASSED_NULL_PARAMETER);
 352                 return 0;
 353                 }
 354
 355         if (!BN_copy(&point->X, x)) goto err;
 356         BN_set_sign(&point->X, 0);
 357         if (!BN_copy(&point->Y, y)) goto err;
 358         BN_set_sign(&point->Y, 0);
 359         if (!BN_copy(&point->Z, BN_value_one())) goto err;
 360         BN_set_sign(&point->Z, 0);
 361         point->Z_is_one = 1;
 362         ret = 1;
 363
 364   err:
 365         return ret;
 366         }
 367
 368
 369 /* Gets the affine coordinates of an EC_POINT.
 370  * Note that the simple implementation only uses affine coordinates.
 371  */
 372 int ec_GF2m_simple_point_get_affine_coordinates(const EC_GROUP *group, const EC_POINT *point,
 373         BIGNUM *x, BIGNUM *y, BN_CTX *ctx)
 374         {
 375         int ret = 0;
 376
 377         if (EC_POINT_is_at_infinity(group, point))
 378                 {
 379                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES, EC_R_POINT_AT_INFINITY);
 380                 return 0;
 381                 }
 382
 383         if (BN_cmp(&point->Z, BN_value_one()))
 384                 {
 385                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 386                 return 0;
 387                 }
 388         if (x != NULL)
 389                 {
 390                 if (!BN_copy(x, &point->X)) goto err;
 391                 BN_set_sign(x, 0);
 392                 }
 393         if (y != NULL)
 394                 {
 395                 if (!BN_copy(y, &point->Y)) goto err;
 396                 BN_set_sign(y, 0);
 397                 }
 398         ret = 1;
 399
 400  err:
 401         return ret;
 402         }
 403
 404
 405 /* Include patented algorithms. */
 406 #include "ec2_smpt.c"
 407
 408
 409 /* Converts an EC_POINT to an octet string.
 410  * If buf is NULL, the encoded length will be returned.
 411  * If the length len of buf is smaller than required an error will be returned.
 412  *
 413  * The point compression section of this function is patented by Certicom Corp.
 414  * under US Patent 6,141,420.  Point compression is disabled by default and can
 415  * be enabled by defining the preprocessor macro OPENSSL_EC_BIN_PT_COMP at
 416  * Configure-time.
 417  */
 418 size_t ec_GF2m_simple_point2oct(const EC_GROUP *group, const EC_POINT *point, point_conversion_form_t form,
 419         unsigned char *buf, size_t len, BN_CTX *ctx)
 420         {
 421         size_t ret;
 422         BN_CTX *new_ctx = NULL;
 423         int used_ctx = 0;
 424         BIGNUM *x, *y, *yxi;
 425         size_t field_len, i, skip;
 426
 427 #ifndef OPENSSL_EC_BIN_PT_COMP
 428         if ((form == POINT_CONVERSION_COMPRESSED) || (form == POINT_CONVERSION_HYBRID))
 429                 {
 430                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_DISABLED);
 431                 goto err;
 432                 }
 433 #endif
 434
 435         if ((form != POINT_CONVERSION_COMPRESSED)
 436                 && (form != POINT_CONVERSION_UNCOMPRESSED)
 437                 && (form != POINT_CONVERSION_HYBRID))
 438                 {
 439                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_INVALID_FORM);
 440                 goto err;
 441                 }
 442
 443         if (EC_POINT_is_at_infinity(group, point))
 444                 {
 445                 /* encodes to a single 0 octet */
 446                 if (buf != NULL)
 447                         {
 448                         if (len < 1)
 449                                 {
 450                                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_BUFFER_TOO_SMALL);
 451                                 return 0;
 452                                 }
 453                         buf[0] = 0;
 454                         }
 455                 return 1;
 456                 }
 457
 458
 459         /* ret := required output buffer length */
 460         field_len = (EC_GROUP_get_degree(group) + 7) / 8;
 461         ret = (form == POINT_CONVERSION_COMPRESSED) ? 1 + field_len : 1 + 2*field_len;
 462
 463         /* if 'buf' is NULL, just return required length */
 464         if (buf != NULL)
 465                 {
 466                 if (len < ret)
 467                         {
 468                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_BUFFER_TOO_SMALL);
 469                         goto err;
 470                         }
 471
 472                 if (ctx == NULL)
 473                         {
 474                         ctx = new_ctx = BN_CTX_new();
 475                         if (ctx == NULL)
 476                                 return 0;
 477                         }
 478
 479                 BN_CTX_start(ctx);
 480                 used_ctx = 1;
 481                 x = BN_CTX_get(ctx);
 482                 y = BN_CTX_get(ctx);
 483                 yxi = BN_CTX_get(ctx);
 484                 if (yxi == NULL) goto err;
 485
 486                 if (!EC_POINT_get_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
 487
 488                 buf[0] = form;
 489 #ifdef OPENSSL_EC_BIN_PT_COMP
 490                 if ((form != POINT_CONVERSION_UNCOMPRESSED) && !BN_is_zero(x))
 491                         {
 492                         if (!group->meth->field_div(group, yxi, y, x, ctx)) goto err;
 493                         if (BN_is_odd(yxi)) buf[0]++;
 494                         }
 495 #endif
 496
 497                 i = 1;
 498
 499                 skip = field_len - BN_num_bytes(x);
 500                 if (skip > field_len)
 501                         {
 502                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
 503                         goto err;
 504                         }
 505                 while (skip > 0)
 506                         {
 507                         buf[i++] = 0;
 508                         skip--;
 509                         }
 510                 skip = BN_bn2bin(x, buf + i);
 511                 i += skip;
 512                 if (i != 1 + field_len)
 513                         {
 514                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
 515                         goto err;
 516                         }
 517
 518                 if (form == POINT_CONVERSION_UNCOMPRESSED || form == POINT_CONVERSION_HYBRID)
 519                         {
 520                         skip = field_len - BN_num_bytes(y);
 521                         if (skip > field_len)
 522                                 {
 523                                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
 524                                 goto err;
 525                                 }
 526                         while (skip > 0)
 527                                 {
 528                                 buf[i++] = 0;
 529                                 skip--;
 530                                 }
 531                         skip = BN_bn2bin(y, buf + i);
 532                         i += skip;
 533                         }
 534
 535                 if (i != ret)
 536                         {
 537                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
 538                         goto err;
 539                         }
 540                 }
 541
 542         if (used_ctx)
 543                 BN_CTX_end(ctx);
 544         if (new_ctx != NULL)
 545                 BN_CTX_free(new_ctx);
 546         return ret;
 547
 548  err:
 549         if (used_ctx)
 550                 BN_CTX_end(ctx);
 551         if (new_ctx != NULL)
 552                 BN_CTX_free(new_ctx);
 553         return 0;
 554         }
 555
 556
 557 /* Converts an octet string representation to an EC_POINT.
 558  * Note that the simple implementation only uses affine coordinates.
 559  */
 560 int ec_GF2m_simple_oct2point(const EC_GROUP *group, EC_POINT *point,
 561         const unsigned char *buf, size_t len, BN_CTX *ctx)
 562         {
 563         point_conversion_form_t form;
 564         int y_bit;
 565         BN_CTX *new_ctx = NULL;
 566         BIGNUM *x, *y, *yxi;
 567         size_t field_len, enc_len;
 568         int ret = 0;
 569
 570         if (len == 0)
 571                 {
 572                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_BUFFER_TOO_SMALL);
 573                 return 0;
 574                 }
 575         form = buf[0];
 576         y_bit = form & 1;
 577         form = form & ~1;
 578         if ((form != 0) && (form != POINT_CONVERSION_COMPRESSED)
 579                 && (form != POINT_CONVERSION_UNCOMPRESSED)
 580                 && (form != POINT_CONVERSION_HYBRID))
 581                 {
 582                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 583                 return 0;
 584                 }
 585         if ((form == 0 || form == POINT_CONVERSION_UNCOMPRESSED) && y_bit)
 586                 {
 587                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 588                 return 0;
 589                 }
 590
 591         if (form == 0)
 592                 {
 593                 if (len != 1)
 594                         {
 595                         ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 596                         return 0;
 597                         }
 598
 599                 return EC_POINT_set_to_infinity(group, point);
 600                 }
 601
 602         field_len = (EC_GROUP_get_degree(group) + 7) / 8;
 603         enc_len = (form == POINT_CONVERSION_COMPRESSED) ? 1 + field_len : 1 + 2*field_len;
 604
 605         if (len != enc_len)
 606                 {
 607                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 608                 return 0;
 609                 }
 610
 611         if (ctx == NULL)
 612                 {
 613                 ctx = new_ctx = BN_CTX_new();
 614                 if (ctx == NULL)
 615                         return 0;
 616                 }
 617
 618         BN_CTX_start(ctx);
 619         x = BN_CTX_get(ctx);
 620         y = BN_CTX_get(ctx);
 621         yxi = BN_CTX_get(ctx);
 622         if (yxi == NULL) goto err;
 623
 624         if (!BN_bin2bn(buf + 1, field_len, x)) goto err;
 625         if (BN_ucmp(x, &group->field) >= 0)
 626                 {
 627                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 628                 goto err;
 629                 }
 630
 631         if (form == POINT_CONVERSION_COMPRESSED)
 632                 {
 633                 if (!EC_POINT_set_compressed_coordinates_GF2m(group, point, x, y_bit, ctx)) goto err;
 634                 }
 635         else
 636                 {
 637                 if (!BN_bin2bn(buf + 1 + field_len, field_len, y)) goto err;
 638                 if (BN_ucmp(y, &group->field) >= 0)
 639                         {
 640                         ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 641                         goto err;
 642                         }
 643                 if (form == POINT_CONVERSION_HYBRID)
 644                         {
 645                         if (!group->meth->field_div(group, yxi, y, x, ctx)) goto err;
 646                         if (y_bit != BN_is_odd(yxi))
 647                                 {
 648                                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 649                                 goto err;
 650                                 }
 651                         }
 652
 653                 if (!EC_POINT_set_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
 654                 }
 655
 656         if (!EC_POINT_is_on_curve(group, point, ctx)) /* test required by X9.62 */
 657                 {
 658                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_POINT_IS_NOT_ON_CURVE);
 659                 goto err;
 660                 }
 661
 662         ret = 1;
 663
 664  err:
 665         BN_CTX_end(ctx);
 666         if (new_ctx != NULL)
 667                 BN_CTX_free(new_ctx);
 668         return ret;
 669         }
 670
 671
 672 /* Computes a + b and stores the result in r.  r could be a or b, a could be b.
 673  * Uses algorithm A.10.2 of IEEE P1363.
 674  */
 675 int ec_GF2m_simple_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
 676         {
 677         BN_CTX *new_ctx = NULL;
 678         BIGNUM *x0, *y0, *x1, *y1, *x2, *y2, *s, *t;
 679         int ret = 0;
 680
 681         if (EC_POINT_is_at_infinity(group, a))
 682                 {
 683                 if (!EC_POINT_copy(r, b)) return 0;
 684                 return 1;
 685                 }
 686
 687         if (EC_POINT_is_at_infinity(group, b))
 688                 {
 689                 if (!EC_POINT_copy(r, a)) return 0;
 690                 return 1;
 691                 }
 692
 693         if (ctx == NULL)
 694                 {
 695                 ctx = new_ctx = BN_CTX_new();
 696                 if (ctx == NULL)
 697                         return 0;
 698                 }
 699
 700         BN_CTX_start(ctx);
 701         x0 = BN_CTX_get(ctx);
 702         y0 = BN_CTX_get(ctx);
 703         x1 = BN_CTX_get(ctx);
 704         y1 = BN_CTX_get(ctx);
 705         x2 = BN_CTX_get(ctx);
 706         y2 = BN_CTX_get(ctx);
 707         s = BN_CTX_get(ctx);
 708         t = BN_CTX_get(ctx);
 709         if (t == NULL) goto err;
 710
 711         if (a->Z_is_one)
 712                 {
 713                 if (!BN_copy(x0, &a->X)) goto err;
 714                 if (!BN_copy(y0, &a->Y)) goto err;
 715                 }
 716         else
 717                 {
 718                 if (!EC_POINT_get_affine_coordinates_GF2m(group, a, x0, y0, ctx)) goto err;
 719                 }
 720         if (b->Z_is_one)
 721                 {
 722                 if (!BN_copy(x1, &b->X)) goto err;
 723                 if (!BN_copy(y1, &b->Y)) goto err;
 724                 }
 725         else
 726                 {
 727                 if (!EC_POINT_get_affine_coordinates_GF2m(group, b, x1, y1, ctx)) goto err;
 728                 }
 729
 730
 731         if (BN_GF2m_cmp(x0, x1))
 732                 {
 733                 if (!BN_GF2m_add(t, x0, x1)) goto err;
 734                 if (!BN_GF2m_add(s, y0, y1)) goto err;
 735                 if (!group->meth->field_div(group, s, s, t, ctx)) goto err;
 736                 if (!group->meth->field_sqr(group, x2, s, ctx)) goto err;
 737                 if (!BN_GF2m_add(x2, x2, &group->a)) goto err;
 738                 if (!BN_GF2m_add(x2, x2, s)) goto err;
 739                 if (!BN_GF2m_add(x2, x2, t)) goto err;
 740                 }
 741         else
 742                 {
 743                 if (BN_GF2m_cmp(y0, y1) || BN_is_zero(x1))
 744                         {
 745                         if (!EC_POINT_set_to_infinity(group, r)) goto err;
 746                         ret = 1;
 747                         goto err;
 748                         }
 749                 if (!group->meth->field_div(group, s, y1, x1, ctx)) goto err;
 750                 if (!BN_GF2m_add(s, s, x1)) goto err;
 751
 752                 if (!group->meth->field_sqr(group, x2, s, ctx)) goto err;
 753                 if (!BN_GF2m_add(x2, x2, s)) goto err;
 754                 if (!BN_GF2m_add(x2, x2, &group->a)) goto err;
 755                 }
 756
 757         if (!BN_GF2m_add(y2, x1, x2)) goto err;
 758         if (!group->meth->field_mul(group, y2, y2, s, ctx)) goto err;
 759         if (!BN_GF2m_add(y2, y2, x2)) goto err;
 760         if (!BN_GF2m_add(y2, y2, y1)) goto err;
 761
 762         if (!EC_POINT_set_affine_coordinates_GF2m(group, r, x2, y2, ctx)) goto err;
 763
 764         ret = 1;
 765
 766  err:
 767         BN_CTX_end(ctx);
 768         if (new_ctx != NULL)
 769                 BN_CTX_free(new_ctx);
 770         return ret;
 771         }
 772
 773
 774 /* Computes 2 * a and stores the result in r.  r could be a.
 775  * Uses algorithm A.10.2 of IEEE P1363.
 776  */
 777 int ec_GF2m_simple_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx)
 778         {
 779         return ec_GF2m_simple_add(group, r, a, a, ctx);
 780         }
 781
 782
 783 int ec_GF2m_simple_invert(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
 784         {
 785         if (EC_POINT_is_at_infinity(group, point) || BN_is_zero(&point->Y))
 786                 /* point is its own inverse */
 787                 return 1;
 788
 789         if (!EC_POINT_make_affine(group, point, ctx)) return 0;
 790         return BN_GF2m_add(&point->Y, &point->X, &point->Y);
 791         }
 792
 793
 794 /* Indicates whether the given point is the point at infinity. */
 795 int ec_GF2m_simple_is_at_infinity(const EC_GROUP *group, const EC_POINT *point)
 796         {
 797         return BN_is_zero(&point->Z);
 798         }
 799
 800
 801 /* Determines whether the given EC_POINT is an actual point on the curve defined
 802  * in the EC_GROUP.  A point is valid if it satisfies the Weierstrass equation:
 803  *      y^2 + x*y = x^3 + a*x^2 + b.
 804  */
 805 int ec_GF2m_simple_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx)
 806         {
 807         BN_CTX *new_ctx = NULL;
 808         BIGNUM *rh, *lh, *tmp1;
 809         int ret = -1;
 810
 811         if (EC_POINT_is_at_infinity(group, point))
 812                 return 1;
 813
 814         /* only support affine coordinates */
 815         if (!point->Z_is_one) goto err;
 816
 817         if (ctx == NULL)
 818                 {
 819                 ctx = new_ctx = BN_CTX_new();
 820                 if (ctx == NULL)
 821                         return -1;
 822                 }
 823
 824         BN_CTX_start(ctx);
 825         rh = BN_CTX_get(ctx);
 826         lh = BN_CTX_get(ctx);
 827         tmp1 = BN_CTX_get(ctx);
 828         if (tmp1 == NULL) goto err;
 829
 830         /* We have a curve defined by a Weierstrass equation
 831          *      y^2 + x*y = x^3 + a*x^2 + b.
 832          * To test this, we add up the right-hand side in 'rh'
 833          * and the left-hand side in 'lh'.
 834          */
 835
 836         /* rh := X^3 */
 837         if (!group->meth->field_sqr(group, tmp1, &point->X, ctx)) goto err;
 838         if (!group->meth->field_mul(group, rh, tmp1, &point->X, ctx)) goto err;
 839
 840         /* rh := rh + a*X^2 */
 841         if (!group->meth->field_mul(group, tmp1, tmp1, &group->a, ctx)) goto err;
 842         if (!BN_GF2m_add(rh, rh, tmp1)) goto err;
 843
 844         /* rh := rh + b */
 845         if (!BN_GF2m_add(rh, rh, &group->b)) goto err;
 846
 847         /* lh := Y^2 */
 848         if (!group->meth->field_sqr(group, lh, &point->Y, ctx)) goto err;
 849
 850         /* lh := lh + x*y */
 851         if (!group->meth->field_mul(group, tmp1, &point->X, &point->Y, ctx)) goto err;
 852         if (!BN_GF2m_add(lh, lh, tmp1)) goto err;
 853
 854         ret = (0 == BN_GF2m_cmp(lh, rh));
 855
 856  err:
 857         if (ctx) BN_CTX_end(ctx);
 858         if (new_ctx) BN_CTX_free(new_ctx);
 859         return ret;
 860         }
 861
 862
 863 /* Indicates whether two points are equal.
 864  * Return values:
 865  *  -1   error
 866  *   0   equal (in affine coordinates)
 867  *   1   not equal
 868  */
 869 int ec_GF2m_simple_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
 870         {
 871         BIGNUM *aX, *aY, *bX, *bY;
 872         BN_CTX *new_ctx = NULL;
 873         int ret = -1;
 874
 875         if (EC_POINT_is_at_infinity(group, a))
 876                 {
 877                 return EC_POINT_is_at_infinity(group, b) ? 0 : 1;
 878                 }
 879
 880         if (a->Z_is_one && b->Z_is_one)
 881                 {
 882                 return ((BN_cmp(&a->X, &b->X) == 0) && BN_cmp(&a->Y, &b->Y) == 0) ? 0 : 1;
 883                 }
 884
 885         if (ctx == NULL)
 886                 {
 887                 ctx = new_ctx = BN_CTX_new();
 888                 if (ctx == NULL)
 889                         return -1;
 890                 }
 891
 892         BN_CTX_start(ctx);
 893         aX = BN_CTX_get(ctx);
 894         aY = BN_CTX_get(ctx);
 895         bX = BN_CTX_get(ctx);
 896         bY = BN_CTX_get(ctx);
 897         if (bY == NULL) goto err;
 898
 899         if (!EC_POINT_get_affine_coordinates_GF2m(group, a, aX, aY, ctx)) goto err;
 900         if (!EC_POINT_get_affine_coordinates_GF2m(group, b, bX, bY, ctx)) goto err;
 901         ret = ((BN_cmp(aX, bX) == 0) && BN_cmp(aY, bY) == 0) ? 0 : 1;
 902
 903   err:
 904         if (ctx) BN_CTX_end(ctx);
 905         if (new_ctx) BN_CTX_free(new_ctx);
 906         return ret;
 907         }
 908
 909
 910 /* Forces the given EC_POINT to internally use affine coordinates. */
 911 int ec_GF2m_simple_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
 912         {
 913         BN_CTX *new_ctx = NULL;
 914         BIGNUM *x, *y;
 915         int ret = 0;
 916
 917         if (point->Z_is_one || EC_POINT_is_at_infinity(group, point))
 918                 return 1;
 919
 920         if (ctx == NULL)
 921                 {
 922                 ctx = new_ctx = BN_CTX_new();
 923                 if (ctx == NULL)
 924                         return 0;
 925                 }
 926
 927         BN_CTX_start(ctx);
 928         x = BN_CTX_get(ctx);
 929         y = BN_CTX_get(ctx);
 930         if (y == NULL) goto err;
 931
 932         if (!EC_POINT_get_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
 933         if (!BN_copy(&point->X, x)) goto err;
 934         if (!BN_copy(&point->Y, y)) goto err;
 935         if (!BN_one(&point->Z)) goto err;
 936
 937         ret = 1;
 938
 939   err:
 940         if (ctx) BN_CTX_end(ctx);
 941         if (new_ctx) BN_CTX_free(new_ctx);
 942         return ret;
 943         }
 944
 945
 946 /* Forces each of the EC_POINTs in the given array to use affine coordinates. */
 947 int ec_GF2m_simple_points_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[], BN_CTX *ctx)
 948         {
 949         size_t i;
 950
 951         for (i = 0; i < num; i++)
 952                 {
 953                 if (!group->meth->make_affine(group, points[i], ctx)) return 0;
 954                 }
 955
 956         return 1;
 957         }
 958
 959
 960 /* Wrapper to simple binary polynomial field multiplication implementation. */
 961 int ec_GF2m_simple_field_mul(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
 962         {
 963         return BN_GF2m_mod_mul_arr(r, a, b, group->poly, ctx);
 964         }
 965
 966
 967 /* Wrapper to simple binary polynomial field squaring implementation. */
 968 int ec_GF2m_simple_field_sqr(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, BN_CTX *ctx)
 969         {
 970         return BN_GF2m_mod_sqr_arr(r, a, group->poly, ctx);
 971         }
 972
 973
 974 /* Wrapper to simple binary polynomial field division implementation. */
 975 int ec_GF2m_simple_field_div(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
 976         {
 977         return BN_GF2m_mod_div(r, a, b, &group->field, ctx);
 978         }