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-2005 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 #ifndef OPENSSL_NO_EC2M
  75
  76
  77 const EC_METHOD *EC_GF2m_simple_method(void)
  78         {
  79         static const EC_METHOD ret = {
  80                 NID_X9_62_characteristic_two_field,
  81                 ec_GF2m_simple_group_init,
  82                 ec_GF2m_simple_group_finish,
  83                 ec_GF2m_simple_group_clear_finish,
  84                 ec_GF2m_simple_group_copy,
  85                 ec_GF2m_simple_group_set_curve,
  86                 ec_GF2m_simple_group_get_curve,
  87                 ec_GF2m_simple_group_get_degree,
  88                 ec_GF2m_simple_group_check_discriminant,
  89                 ec_GF2m_simple_point_init,
  90                 ec_GF2m_simple_point_finish,
  91                 ec_GF2m_simple_point_clear_finish,
  92                 ec_GF2m_simple_point_copy,
  93                 ec_GF2m_simple_point_set_to_infinity,
  94                 0 /* set_Jprojective_coordinates_GFp */,
  95                 0 /* get_Jprojective_coordinates_GFp */,
  96                 ec_GF2m_simple_point_set_affine_coordinates,
  97                 ec_GF2m_simple_point_get_affine_coordinates,
  98                 ec_GF2m_simple_set_compressed_coordinates,
  99                 ec_GF2m_simple_point2oct,
 100                 ec_GF2m_simple_oct2point,
 101                 ec_GF2m_simple_add,
 102                 ec_GF2m_simple_dbl,
 103                 ec_GF2m_simple_invert,
 104                 ec_GF2m_simple_is_at_infinity,
 105                 ec_GF2m_simple_is_on_curve,
 106                 ec_GF2m_simple_cmp,
 107                 ec_GF2m_simple_make_affine,
 108                 ec_GF2m_simple_points_make_affine,
 109
 110                 /* the following three method functions are defined in ec2_mult.c */
 111                 ec_GF2m_simple_mul,
 112                 ec_GF2m_precompute_mult,
 113                 ec_GF2m_have_precompute_mult,
 114
 115                 ec_GF2m_simple_field_mul,
 116                 ec_GF2m_simple_field_sqr,
 117                 ec_GF2m_simple_field_div,
 118                 0 /* field_encode */,
 119                 0 /* field_decode */,
 120                 0 /* field_set_to_one */ };
 121
 122         return &ret;
 123         }
 124
 125
 126 /* Initialize a GF(2^m)-based EC_GROUP structure.
 127  * Note that all other members are handled by EC_GROUP_new.
 128  */
 129 int ec_GF2m_simple_group_init(EC_GROUP *group)
 130         {
 131         BN_init(&group->field);
 132         BN_init(&group->a);
 133         BN_init(&group->b);
 134         return 1;
 135         }
 136
 137
 138 /* Free a GF(2^m)-based EC_GROUP structure.
 139  * Note that all other members are handled by EC_GROUP_free.
 140  */
 141 void ec_GF2m_simple_group_finish(EC_GROUP *group)
 142         {
 143         BN_free(&group->field);
 144         BN_free(&group->a);
 145         BN_free(&group->b);
 146         }
 147
 148
 149 /* Clear and free a GF(2^m)-based EC_GROUP structure.
 150  * Note that all other members are handled by EC_GROUP_clear_free.
 151  */
 152 void ec_GF2m_simple_group_clear_finish(EC_GROUP *group)
 153         {
 154         BN_clear_free(&group->field);
 155         BN_clear_free(&group->a);
 156         BN_clear_free(&group->b);
 157         group->poly[0] = 0;
 158         group->poly[1] = 0;
 159         group->poly[2] = 0;
 160         group->poly[3] = 0;
 161         group->poly[4] = 0;
 162         group->poly[5] = -1;
 163         }
 164
 165
 166 /* Copy a GF(2^m)-based EC_GROUP structure.
 167  * Note that all other members are handled by EC_GROUP_copy.
 168  */
 169 int ec_GF2m_simple_group_copy(EC_GROUP *dest, const EC_GROUP *src)
 170         {
 171         int i;
 172         if (!BN_copy(&dest->field, &src->field)) return 0;
 173         if (!BN_copy(&dest->a, &src->a)) return 0;
 174         if (!BN_copy(&dest->b, &src->b)) return 0;
 175         dest->poly[0] = src->poly[0];
 176         dest->poly[1] = src->poly[1];
 177         dest->poly[2] = src->poly[2];
 178         dest->poly[3] = src->poly[3];
 179         dest->poly[4] = src->poly[4];
 180         dest->poly[5] = src->poly[5];
 181         if (bn_wexpand(&dest->a, (int)(dest->poly[0] + BN_BITS2 - 1) / BN_BITS2) == NULL) return 0;
 182         if (bn_wexpand(&dest->b, (int)(dest->poly[0] + BN_BITS2 - 1) / BN_BITS2) == NULL) return 0;
 183         for (i = dest->a.top; i < dest->a.dmax; i++) dest->a.d[i] = 0;
 184         for (i = dest->b.top; i < dest->b.dmax; i++) dest->b.d[i] = 0;
 185         return 1;
 186         }
 187
 188
 189 /* Set the curve parameters of an EC_GROUP structure. */
 190 int ec_GF2m_simple_group_set_curve(EC_GROUP *group,
 191         const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
 192         {
 193         int ret = 0, i;
 194
 195         /* group->field */
 196         if (!BN_copy(&group->field, p)) goto err;
 197         i = BN_GF2m_poly2arr(&group->field, group->poly, 6) - 1;
 198         if ((i != 5) && (i != 3))
 199                 {
 200                 ECerr(EC_F_EC_GF2M_SIMPLE_GROUP_SET_CURVE, EC_R_UNSUPPORTED_FIELD);
 201                 goto err;
 202                 }
 203
 204         /* group->a */
 205         if (!BN_GF2m_mod_arr(&group->a, a, group->poly)) goto err;
 206         if(bn_wexpand(&group->a, (int)(group->poly[0] + BN_BITS2 - 1) / BN_BITS2) == NULL) goto err;
 207         for (i = group->a.top; i < group->a.dmax; i++) group->a.d[i] = 0;
 208
 209         /* group->b */
 210         if (!BN_GF2m_mod_arr(&group->b, b, group->poly)) goto err;
 211         if(bn_wexpand(&group->b, (int)(group->poly[0] + BN_BITS2 - 1) / BN_BITS2) == NULL) goto err;
 212         for (i = group->b.top; i < group->b.dmax; i++) group->b.d[i] = 0;
 213
 214         ret = 1;
 215   err:
 216         return ret;
 217         }
 218
 219
 220 /* Get the curve parameters of an EC_GROUP structure.
 221  * If p, a, or b are NULL then there values will not be set but the method will return with success.
 222  */
 223 int ec_GF2m_simple_group_get_curve(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx)
 224         {
 225         int ret = 0;
 226
 227         if (p != NULL)
 228                 {
 229                 if (!BN_copy(p, &group->field)) return 0;
 230                 }
 231
 232         if (a != NULL)
 233                 {
 234                 if (!BN_copy(a, &group->a)) goto err;
 235                 }
 236
 237         if (b != NULL)
 238                 {
 239                 if (!BN_copy(b, &group->b)) goto err;
 240                 }
 241
 242         ret = 1;
 243
 244   err:
 245         return ret;
 246         }
 247
 248
 249 /* Gets the degree of the field.  For a curve over GF(2^m) this is the value m. */
 250 int ec_GF2m_simple_group_get_degree(const EC_GROUP *group)
 251         {
 252         return BN_num_bits(&group->field)-1;
 253         }
 254
 255
 256 /* Checks the discriminant of the curve.
 257  * y^2 + x*y = x^3 + a*x^2 + b is an elliptic curve <=> b != 0 (mod p)
 258  */
 259 int ec_GF2m_simple_group_check_discriminant(const EC_GROUP *group, BN_CTX *ctx)
 260         {
 261         int ret = 0;
 262         BIGNUM *b;
 263         BN_CTX *new_ctx = NULL;
 264
 265         if (ctx == NULL)
 266                 {
 267                 ctx = new_ctx = BN_CTX_new();
 268                 if (ctx == NULL)
 269                         {
 270                         ECerr(EC_F_EC_GF2M_SIMPLE_GROUP_CHECK_DISCRIMINANT, ERR_R_MALLOC_FAILURE);
 271                         goto err;
 272                         }
 273                 }
 274         BN_CTX_start(ctx);
 275         b = BN_CTX_get(ctx);
 276         if (b == NULL) goto err;
 277
 278         if (!BN_GF2m_mod_arr(b, &group->b, group->poly)) goto err;
 279
 280         /* check the discriminant:
 281          * y^2 + x*y = x^3 + a*x^2 + b is an elliptic curve <=> b != 0 (mod p)
 282          */
 283         if (BN_is_zero(b)) goto err;
 284
 285         ret = 1;
 286
 287 err:
 288         if (ctx != NULL)
 289                 BN_CTX_end(ctx);
 290         if (new_ctx != NULL)
 291                 BN_CTX_free(new_ctx);
 292         return ret;
 293         }
 294
 295
 296 /* Initializes an EC_POINT. */
 297 int ec_GF2m_simple_point_init(EC_POINT *point)
 298         {
 299         BN_init(&point->X);
 300         BN_init(&point->Y);
 301         BN_init(&point->Z);
 302         return 1;
 303         }
 304
 305
 306 /* Frees an EC_POINT. */
 307 void ec_GF2m_simple_point_finish(EC_POINT *point)
 308         {
 309         BN_free(&point->X);
 310         BN_free(&point->Y);
 311         BN_free(&point->Z);
 312         }
 313
 314
 315 /* Clears and frees an EC_POINT. */
 316 void ec_GF2m_simple_point_clear_finish(EC_POINT *point)
 317         {
 318         BN_clear_free(&point->X);
 319         BN_clear_free(&point->Y);
 320         BN_clear_free(&point->Z);
 321         point->Z_is_one = 0;
 322         }
 323
 324
 325 /* Copy the contents of one EC_POINT into another.  Assumes dest is initialized. */
 326 int ec_GF2m_simple_point_copy(EC_POINT *dest, const EC_POINT *src)
 327         {
 328         if (!BN_copy(&dest->X, &src->X)) return 0;
 329         if (!BN_copy(&dest->Y, &src->Y)) return 0;
 330         if (!BN_copy(&dest->Z, &src->Z)) return 0;
 331         dest->Z_is_one = src->Z_is_one;
 332
 333         return 1;
 334         }
 335
 336
 337 /* Set an EC_POINT to the point at infinity.
 338  * A point at infinity is represented by having Z=0.
 339  */
 340 int ec_GF2m_simple_point_set_to_infinity(const EC_GROUP *group, EC_POINT *point)
 341         {
 342         point->Z_is_one = 0;
 343         BN_zero(&point->Z);
 344         return 1;
 345         }
 346
 347
 348 /* Set the coordinates of an EC_POINT using affine coordinates.
 349  * Note that the simple implementation only uses affine coordinates.
 350  */
 351 int ec_GF2m_simple_point_set_affine_coordinates(const EC_GROUP *group, EC_POINT *point,
 352         const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx)
 353         {
 354         int ret = 0;
 355         if (x == NULL || y == NULL)
 356                 {
 357                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES, ERR_R_PASSED_NULL_PARAMETER);
 358                 return 0;
 359                 }
 360
 361         if (!BN_copy(&point->X, x)) goto err;
 362         BN_set_negative(&point->X, 0);
 363         if (!BN_copy(&point->Y, y)) goto err;
 364         BN_set_negative(&point->Y, 0);
 365         if (!BN_copy(&point->Z, BN_value_one())) goto err;
 366         BN_set_negative(&point->Z, 0);
 367         point->Z_is_one = 1;
 368         ret = 1;
 369
 370   err:
 371         return ret;
 372         }
 373
 374
 375 /* Gets the affine coordinates of an EC_POINT.
 376  * Note that the simple implementation only uses affine coordinates.
 377  */
 378 int ec_GF2m_simple_point_get_affine_coordinates(const EC_GROUP *group, const EC_POINT *point,
 379         BIGNUM *x, BIGNUM *y, BN_CTX *ctx)
 380         {
 381         int ret = 0;
 382
 383         if (EC_POINT_is_at_infinity(group, point))
 384                 {
 385                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES, EC_R_POINT_AT_INFINITY);
 386                 return 0;
 387                 }
 388
 389         if (BN_cmp(&point->Z, BN_value_one()))
 390                 {
 391                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 392                 return 0;
 393                 }
 394         if (x != NULL)
 395                 {
 396                 if (!BN_copy(x, &point->X)) goto err;
 397                 BN_set_negative(x, 0);
 398                 }
 399         if (y != NULL)
 400                 {
 401                 if (!BN_copy(y, &point->Y)) goto err;
 402                 BN_set_negative(y, 0);
 403                 }
 404         ret = 1;
 405
 406  err:
 407         return ret;
 408         }
 409
 410
 411 /* Calculates and sets the affine coordinates of an EC_POINT from the given
 412  * compressed coordinates.  Uses algorithm 2.3.4 of SEC 1.
 413  * Note that the simple implementation only uses affine coordinates.
 414  *
 415  * The method is from the following publication:
 416  *
 417  *     Harper, Menezes, Vanstone:
 418  *     "Public-Key Cryptosystems with Very Small Key Lengths",
 419  *     EUROCRYPT '92, Springer-Verlag LNCS 658,
 420  *     published February 1993
 421  *
 422  * US Patents 6,141,420 and 6,618,483 (Vanstone, Mullin, Agnew) describe
 423  * the same method, but claim no priority date earlier than July 29, 1994
 424  * (and additionally fail to cite the EUROCRYPT '92 publication as prior art).
 425  */
 426 int ec_GF2m_simple_set_compressed_coordinates(const EC_GROUP *group, EC_POINT *point,
 427         const BIGNUM *x_, int y_bit, BN_CTX *ctx)
 428         {
 429         BN_CTX *new_ctx = NULL;
 430         BIGNUM *tmp, *x, *y, *z;
 431         int ret = 0, z0;
 432
 433         /* clear error queue */
 434         ERR_clear_error();
 435
 436         if (ctx == NULL)
 437                 {
 438                 ctx = new_ctx = BN_CTX_new();
 439                 if (ctx == NULL)
 440                         return 0;
 441                 }
 442
 443         y_bit = (y_bit != 0) ? 1 : 0;
 444
 445         BN_CTX_start(ctx);
 446         tmp = BN_CTX_get(ctx);
 447         x = BN_CTX_get(ctx);
 448         y = BN_CTX_get(ctx);
 449         z = BN_CTX_get(ctx);
 450         if (z == NULL) goto err;
 451
 452         if (!BN_GF2m_mod_arr(x, x_, group->poly)) goto err;
 453         if (BN_is_zero(x))
 454                 {
 455                 if (!BN_GF2m_mod_sqrt_arr(y, &group->b, group->poly, ctx)) goto err;
 456                 }
 457         else
 458                 {
 459                 if (!group->meth->field_sqr(group, tmp, x, ctx)) goto err;
 460                 if (!group->meth->field_div(group, tmp, &group->b, tmp, ctx)) goto err;
 461                 if (!BN_GF2m_add(tmp, &group->a, tmp)) goto err;
 462                 if (!BN_GF2m_add(tmp, x, tmp)) goto err;
 463                 if (!BN_GF2m_mod_solve_quad_arr(z, tmp, group->poly, ctx))
 464                         {
 465                         unsigned long err = ERR_peek_last_error();
 466
 467                         if (ERR_GET_LIB(err) == ERR_LIB_BN && ERR_GET_REASON(err) == BN_R_NO_SOLUTION)
 468                                 {
 469                                 ERR_clear_error();
 470                                 ECerr(EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES, EC_R_INVALID_COMPRESSED_POINT);
 471                                 }
 472                         else
 473                                 ECerr(EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES, ERR_R_BN_LIB);
 474                         goto err;
 475                         }
 476                 z0 = (BN_is_odd(z)) ? 1 : 0;
 477                 if (!group->meth->field_mul(group, y, x, z, ctx)) goto err;
 478                 if (z0 != y_bit)
 479                         {
 480                         if (!BN_GF2m_add(y, y, x)) goto err;
 481                         }
 482                 }
 483
 484         if (!EC_POINT_set_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
 485
 486         ret = 1;
 487
 488  err:
 489         BN_CTX_end(ctx);
 490         if (new_ctx != NULL)
 491                 BN_CTX_free(new_ctx);
 492         return ret;
 493         }
 494
 495
 496 /* Converts an EC_POINT to an octet string.
 497  * If buf is NULL, the encoded length will be returned.
 498  * If the length len of buf is smaller than required an error will be returned.
 499  */
 500 size_t ec_GF2m_simple_point2oct(const EC_GROUP *group, const EC_POINT *point, point_conversion_form_t form,
 501         unsigned char *buf, size_t len, BN_CTX *ctx)
 502         {
 503         size_t ret;
 504         BN_CTX *new_ctx = NULL;
 505         int used_ctx = 0;
 506         BIGNUM *x, *y, *yxi;
 507         size_t field_len, i, skip;
 508
 509         if ((form != POINT_CONVERSION_COMPRESSED)
 510                 && (form != POINT_CONVERSION_UNCOMPRESSED)
 511                 && (form != POINT_CONVERSION_HYBRID))
 512                 {
 513                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_INVALID_FORM);
 514                 goto err;
 515                 }
 516
 517         if (EC_POINT_is_at_infinity(group, point))
 518                 {
 519                 /* encodes to a single 0 octet */
 520                 if (buf != NULL)
 521                         {
 522                         if (len < 1)
 523                                 {
 524                                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_BUFFER_TOO_SMALL);
 525                                 return 0;
 526                                 }
 527                         buf[0] = 0;
 528                         }
 529                 return 1;
 530                 }
 531
 532
 533         /* ret := required output buffer length */
 534         field_len = (EC_GROUP_get_degree(group) + 7) / 8;
 535         ret = (form == POINT_CONVERSION_COMPRESSED) ? 1 + field_len : 1 + 2*field_len;
 536
 537         /* if 'buf' is NULL, just return required length */
 538         if (buf != NULL)
 539                 {
 540                 if (len < ret)
 541                         {
 542                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_BUFFER_TOO_SMALL);
 543                         goto err;
 544                         }
 545
 546                 if (ctx == NULL)
 547                         {
 548                         ctx = new_ctx = BN_CTX_new();
 549                         if (ctx == NULL)
 550                                 return 0;
 551                         }
 552
 553                 BN_CTX_start(ctx);
 554                 used_ctx = 1;
 555                 x = BN_CTX_get(ctx);
 556                 y = BN_CTX_get(ctx);
 557                 yxi = BN_CTX_get(ctx);
 558                 if (yxi == NULL) goto err;
 559
 560                 if (!EC_POINT_get_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
 561
 562                 buf[0] = form;
 563                 if ((form != POINT_CONVERSION_UNCOMPRESSED) && !BN_is_zero(x))
 564                         {
 565                         if (!group->meth->field_div(group, yxi, y, x, ctx)) goto err;
 566                         if (BN_is_odd(yxi)) buf[0]++;
 567                         }
 568
 569                 i = 1;
 570
 571                 skip = field_len - BN_num_bytes(x);
 572                 if (skip > field_len)
 573                         {
 574                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
 575                         goto err;
 576                         }
 577                 while (skip > 0)
 578                         {
 579                         buf[i++] = 0;
 580                         skip--;
 581                         }
 582                 skip = BN_bn2bin(x, buf + i);
 583                 i += skip;
 584                 if (i != 1 + field_len)
 585                         {
 586                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
 587                         goto err;
 588                         }
 589
 590                 if (form == POINT_CONVERSION_UNCOMPRESSED || form == POINT_CONVERSION_HYBRID)
 591                         {
 592                         skip = field_len - BN_num_bytes(y);
 593                         if (skip > field_len)
 594                                 {
 595                                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
 596                                 goto err;
 597                                 }
 598                         while (skip > 0)
 599                                 {
 600                                 buf[i++] = 0;
 601                                 skip--;
 602                                 }
 603                         skip = BN_bn2bin(y, buf + i);
 604                         i += skip;
 605                         }
 606
 607                 if (i != ret)
 608                         {
 609                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
 610                         goto err;
 611                         }
 612                 }
 613
 614         if (used_ctx)
 615                 BN_CTX_end(ctx);
 616         if (new_ctx != NULL)
 617                 BN_CTX_free(new_ctx);
 618         return ret;
 619
 620  err:
 621         if (used_ctx)
 622                 BN_CTX_end(ctx);
 623         if (new_ctx != NULL)
 624                 BN_CTX_free(new_ctx);
 625         return 0;
 626         }
 627
 628
 629 /* Converts an octet string representation to an EC_POINT.
 630  * Note that the simple implementation only uses affine coordinates.
 631  */
 632 int ec_GF2m_simple_oct2point(const EC_GROUP *group, EC_POINT *point,
 633         const unsigned char *buf, size_t len, BN_CTX *ctx)
 634         {
 635         point_conversion_form_t form;
 636         int y_bit;
 637         BN_CTX *new_ctx = NULL;
 638         BIGNUM *x, *y, *yxi;
 639         size_t field_len, enc_len;
 640         int ret = 0;
 641
 642         if (len == 0)
 643                 {
 644                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_BUFFER_TOO_SMALL);
 645                 return 0;
 646                 }
 647         form = buf[0];
 648         y_bit = form & 1;
 649         form = form & ~1U;
 650         if ((form != 0) && (form != POINT_CONVERSION_COMPRESSED)
 651                 && (form != POINT_CONVERSION_UNCOMPRESSED)
 652                 && (form != POINT_CONVERSION_HYBRID))
 653                 {
 654                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 655                 return 0;
 656                 }
 657         if ((form == 0 || form == POINT_CONVERSION_UNCOMPRESSED) && y_bit)
 658                 {
 659                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 660                 return 0;
 661                 }
 662
 663         if (form == 0)
 664                 {
 665                 if (len != 1)
 666                         {
 667                         ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 668                         return 0;
 669                         }
 670
 671                 return EC_POINT_set_to_infinity(group, point);
 672                 }
 673
 674         field_len = (EC_GROUP_get_degree(group) + 7) / 8;
 675         enc_len = (form == POINT_CONVERSION_COMPRESSED) ? 1 + field_len : 1 + 2*field_len;
 676
 677         if (len != enc_len)
 678                 {
 679                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 680                 return 0;
 681                 }
 682
 683         if (ctx == NULL)
 684                 {
 685                 ctx = new_ctx = BN_CTX_new();
 686                 if (ctx == NULL)
 687                         return 0;
 688                 }
 689
 690         BN_CTX_start(ctx);
 691         x = BN_CTX_get(ctx);
 692         y = BN_CTX_get(ctx);
 693         yxi = BN_CTX_get(ctx);
 694         if (yxi == NULL) goto err;
 695
 696         if (!BN_bin2bn(buf + 1, field_len, x)) goto err;
 697         if (BN_ucmp(x, &group->field) >= 0)
 698                 {
 699                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 700                 goto err;
 701                 }
 702
 703         if (form == POINT_CONVERSION_COMPRESSED)
 704                 {
 705                 if (!EC_POINT_set_compressed_coordinates_GF2m(group, point, x, y_bit, ctx)) goto err;
 706                 }
 707         else
 708                 {
 709                 if (!BN_bin2bn(buf + 1 + field_len, field_len, y)) goto err;
 710                 if (BN_ucmp(y, &group->field) >= 0)
 711                         {
 712                         ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 713                         goto err;
 714                         }
 715                 if (form == POINT_CONVERSION_HYBRID)
 716                         {
 717                         if (!group->meth->field_div(group, yxi, y, x, ctx)) goto err;
 718                         if (y_bit != BN_is_odd(yxi))
 719                                 {
 720                                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
 721                                 goto err;
 722                                 }
 723                         }
 724
 725                 if (!EC_POINT_set_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
 726                 }
 727
 728         if (!EC_POINT_is_on_curve(group, point, ctx)) /* test required by X9.62 */
 729                 {
 730                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_POINT_IS_NOT_ON_CURVE);
 731                 goto err;
 732                 }
 733
 734         ret = 1;
 735
 736  err:
 737         BN_CTX_end(ctx);
 738         if (new_ctx != NULL)
 739                 BN_CTX_free(new_ctx);
 740         return ret;
 741         }
 742
 743
 744 /* Computes a + b and stores the result in r.  r could be a or b, a could be b.
 745  * Uses algorithm A.10.2 of IEEE P1363.
 746  */
 747 int ec_GF2m_simple_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
 748         {
 749         BN_CTX *new_ctx = NULL;
 750         BIGNUM *x0, *y0, *x1, *y1, *x2, *y2, *s, *t;
 751         int ret = 0;
 752
 753         if (EC_POINT_is_at_infinity(group, a))
 754                 {
 755                 if (!EC_POINT_copy(r, b)) return 0;
 756                 return 1;
 757                 }
 758
 759         if (EC_POINT_is_at_infinity(group, b))
 760                 {
 761                 if (!EC_POINT_copy(r, a)) return 0;
 762                 return 1;
 763                 }
 764
 765         if (ctx == NULL)
 766                 {
 767                 ctx = new_ctx = BN_CTX_new();
 768                 if (ctx == NULL)
 769                         return 0;
 770                 }
 771
 772         BN_CTX_start(ctx);
 773         x0 = BN_CTX_get(ctx);
 774         y0 = BN_CTX_get(ctx);
 775         x1 = BN_CTX_get(ctx);
 776         y1 = BN_CTX_get(ctx);
 777         x2 = BN_CTX_get(ctx);
 778         y2 = BN_CTX_get(ctx);
 779         s = BN_CTX_get(ctx);
 780         t = BN_CTX_get(ctx);
 781         if (t == NULL) goto err;
 782
 783         if (a->Z_is_one)
 784                 {
 785                 if (!BN_copy(x0, &a->X)) goto err;
 786                 if (!BN_copy(y0, &a->Y)) goto err;
 787                 }
 788         else
 789                 {
 790                 if (!EC_POINT_get_affine_coordinates_GF2m(group, a, x0, y0, ctx)) goto err;
 791                 }
 792         if (b->Z_is_one)
 793                 {
 794                 if (!BN_copy(x1, &b->X)) goto err;
 795                 if (!BN_copy(y1, &b->Y)) goto err;
 796                 }
 797         else
 798                 {
 799                 if (!EC_POINT_get_affine_coordinates_GF2m(group, b, x1, y1, ctx)) goto err;
 800                 }
 801
 802
 803         if (BN_GF2m_cmp(x0, x1))
 804                 {
 805                 if (!BN_GF2m_add(t, x0, x1)) goto err;
 806                 if (!BN_GF2m_add(s, y0, y1)) goto err;
 807                 if (!group->meth->field_div(group, s, s, t, ctx)) goto err;
 808                 if (!group->meth->field_sqr(group, x2, s, ctx)) goto err;
 809                 if (!BN_GF2m_add(x2, x2, &group->a)) goto err;
 810                 if (!BN_GF2m_add(x2, x2, s)) goto err;
 811                 if (!BN_GF2m_add(x2, x2, t)) goto err;
 812                 }
 813         else
 814                 {
 815                 if (BN_GF2m_cmp(y0, y1) || BN_is_zero(x1))
 816                         {
 817                         if (!EC_POINT_set_to_infinity(group, r)) goto err;
 818                         ret = 1;
 819                         goto err;
 820                         }
 821                 if (!group->meth->field_div(group, s, y1, x1, ctx)) goto err;
 822                 if (!BN_GF2m_add(s, s, x1)) goto err;
 823
 824                 if (!group->meth->field_sqr(group, x2, s, ctx)) goto err;
 825                 if (!BN_GF2m_add(x2, x2, s)) goto err;
 826                 if (!BN_GF2m_add(x2, x2, &group->a)) goto err;
 827                 }
 828
 829         if (!BN_GF2m_add(y2, x1, x2)) goto err;
 830         if (!group->meth->field_mul(group, y2, y2, s, ctx)) goto err;
 831         if (!BN_GF2m_add(y2, y2, x2)) goto err;
 832         if (!BN_GF2m_add(y2, y2, y1)) goto err;
 833
 834         if (!EC_POINT_set_affine_coordinates_GF2m(group, r, x2, y2, ctx)) goto err;
 835
 836         ret = 1;
 837
 838  err:
 839         BN_CTX_end(ctx);
 840         if (new_ctx != NULL)
 841                 BN_CTX_free(new_ctx);
 842         return ret;
 843         }
 844
 845
 846 /* Computes 2 * a and stores the result in r.  r could be a.
 847  * Uses algorithm A.10.2 of IEEE P1363.
 848  */
 849 int ec_GF2m_simple_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx)
 850         {
 851         return ec_GF2m_simple_add(group, r, a, a, ctx);
 852         }
 853
 854
 855 int ec_GF2m_simple_invert(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
 856         {
 857         if (EC_POINT_is_at_infinity(group, point) || BN_is_zero(&point->Y))
 858                 /* point is its own inverse */
 859                 return 1;
 860
 861         if (!EC_POINT_make_affine(group, point, ctx)) return 0;
 862         return BN_GF2m_add(&point->Y, &point->X, &point->Y);
 863         }
 864
 865
 866 /* Indicates whether the given point is the point at infinity. */
 867 int ec_GF2m_simple_is_at_infinity(const EC_GROUP *group, const EC_POINT *point)
 868         {
 869         return BN_is_zero(&point->Z);
 870         }
 871
 872
 873 /* Determines whether the given EC_POINT is an actual point on the curve defined
 874  * in the EC_GROUP.  A point is valid if it satisfies the Weierstrass equation:
 875  *      y^2 + x*y = x^3 + a*x^2 + b.
 876  */
 877 int ec_GF2m_simple_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx)
 878         {
 879         int ret = -1;
 880         BN_CTX *new_ctx = NULL;
 881         BIGNUM *lh, *y2;
 882         int (*field_mul)(const EC_GROUP *, BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *);
 883         int (*field_sqr)(const EC_GROUP *, BIGNUM *, const BIGNUM *, BN_CTX *);
 884
 885         if (EC_POINT_is_at_infinity(group, point))
 886                 return 1;
 887
 888         field_mul = group->meth->field_mul;
 889         field_sqr = group->meth->field_sqr;
 890
 891         /* only support affine coordinates */
 892         if (!point->Z_is_one) goto err;
 893
 894         if (ctx == NULL)
 895                 {
 896                 ctx = new_ctx = BN_CTX_new();
 897                 if (ctx == NULL)
 898                         return -1;
 899                 }
 900
 901         BN_CTX_start(ctx);
 902         y2 = BN_CTX_get(ctx);
 903         lh = BN_CTX_get(ctx);
 904         if (lh == NULL) goto err;
 905
 906         /* We have a curve defined by a Weierstrass equation
 907          *      y^2 + x*y = x^3 + a*x^2 + b.
 908          *  <=> x^3 + a*x^2 + x*y + b + y^2 = 0
 909          *  <=> ((x + a) * x + y ) * x + b + y^2 = 0
 910          */
 911         if (!BN_GF2m_add(lh, &point->X, &group->a)) goto err;
 912         if (!field_mul(group, lh, lh, &point->X, ctx)) goto err;
 913         if (!BN_GF2m_add(lh, lh, &point->Y)) goto err;
 914         if (!field_mul(group, lh, lh, &point->X, ctx)) goto err;
 915         if (!BN_GF2m_add(lh, lh, &group->b)) goto err;
 916         if (!field_sqr(group, y2, &point->Y, ctx)) goto err;
 917         if (!BN_GF2m_add(lh, lh, y2)) goto err;
 918         ret = BN_is_zero(lh);
 919  err:
 920         if (ctx) BN_CTX_end(ctx);
 921         if (new_ctx) BN_CTX_free(new_ctx);
 922         return ret;
 923         }
 924
 925
 926 /* Indicates whether two points are equal.
 927  * Return values:
 928  *  -1   error
 929  *   0   equal (in affine coordinates)
 930  *   1   not equal
 931  */
 932 int ec_GF2m_simple_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
 933         {
 934         BIGNUM *aX, *aY, *bX, *bY;
 935         BN_CTX *new_ctx = NULL;
 936         int ret = -1;
 937
 938         if (EC_POINT_is_at_infinity(group, a))
 939                 {
 940                 return EC_POINT_is_at_infinity(group, b) ? 0 : 1;
 941                 }
 942
 943         if (EC_POINT_is_at_infinity(group, b))
 944                 return 1;
 945
 946         if (a->Z_is_one && b->Z_is_one)
 947                 {
 948                 return ((BN_cmp(&a->X, &b->X) == 0) && BN_cmp(&a->Y, &b->Y) == 0) ? 0 : 1;
 949                 }
 950
 951         if (ctx == NULL)
 952                 {
 953                 ctx = new_ctx = BN_CTX_new();
 954                 if (ctx == NULL)
 955                         return -1;
 956                 }
 957
 958         BN_CTX_start(ctx);
 959         aX = BN_CTX_get(ctx);
 960         aY = BN_CTX_get(ctx);
 961         bX = BN_CTX_get(ctx);
 962         bY = BN_CTX_get(ctx);
 963         if (bY == NULL) goto err;
 964
 965         if (!EC_POINT_get_affine_coordinates_GF2m(group, a, aX, aY, ctx)) goto err;
 966         if (!EC_POINT_get_affine_coordinates_GF2m(group, b, bX, bY, ctx)) goto err;
 967         ret = ((BN_cmp(aX, bX) == 0) && BN_cmp(aY, bY) == 0) ? 0 : 1;
 968
 969   err:
 970         if (ctx) BN_CTX_end(ctx);
 971         if (new_ctx) BN_CTX_free(new_ctx);
 972         return ret;
 973         }
 974
 975
 976 /* Forces the given EC_POINT to internally use affine coordinates. */
 977 int ec_GF2m_simple_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
 978         {
 979         BN_CTX *new_ctx = NULL;
 980         BIGNUM *x, *y;
 981         int ret = 0;
 982
 983         if (point->Z_is_one || EC_POINT_is_at_infinity(group, point))
 984                 return 1;
 985
 986         if (ctx == NULL)
 987                 {
 988                 ctx = new_ctx = BN_CTX_new();
 989                 if (ctx == NULL)
 990                         return 0;
 991                 }
 992
 993         BN_CTX_start(ctx);
 994         x = BN_CTX_get(ctx);
 995         y = BN_CTX_get(ctx);
 996         if (y == NULL) goto err;
 997
 998         if (!EC_POINT_get_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
 999         if (!BN_copy(&point->X, x)) goto err;
1000         if (!BN_copy(&point->Y, y)) goto err;
1001         if (!BN_one(&point->Z)) goto err;
1002
1003         ret = 1;
1004
1005   err:
1006         if (ctx) BN_CTX_end(ctx);
1007         if (new_ctx) BN_CTX_free(new_ctx);
1008         return ret;
1009         }
1010
1011
1012 /* Forces each of the EC_POINTs in the given array to use affine coordinates. */
1013 int ec_GF2m_simple_points_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[], BN_CTX *ctx)
1014         {
1015         size_t i;
1016
1017         for (i = 0; i < num; i++)
1018                 {
1019                 if (!group->meth->make_affine(group, points[i], ctx)) return 0;
1020                 }
1021
1022         return 1;
1023         }
1024
1025
1026 /* Wrapper to simple binary polynomial field multiplication implementation. */
1027 int ec_GF2m_simple_field_mul(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
1028         {
1029         return BN_GF2m_mod_mul_arr(r, a, b, group->poly, ctx);
1030         }
1031
1032
1033 /* Wrapper to simple binary polynomial field squaring implementation. */
1034 int ec_GF2m_simple_field_sqr(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, BN_CTX *ctx)
1035         {
1036         return BN_GF2m_mod_sqr_arr(r, a, group->poly, ctx);
1037         }
1038
1039
1040 /* Wrapper to simple binary polynomial field division implementation. */
1041 int ec_GF2m_simple_field_div(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
1042         {
1043         return BN_GF2m_mod_div(r, a, b, &group->field, ctx);
1044         }
1045
1046 #endif