crypto/ec/ec_lib.c

   1 /* crypto/ec/ec_lib.c */
   2 /* ====================================================================
   3  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  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
  15  *    distribution.
  16  *
  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/)"
  21  *
  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.
  26  *
  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.
  30  *
  31  * 6. Redistributions of any form whatsoever must retain the following
  32  *    acknowledgment:
  33  *    "This product includes software developed by the OpenSSL Project
  34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  35  *
  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  * ====================================================================
  49  *
  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).
  53  *
  54  */
  55
  56 #include <string.h>
  57
  58 #include <openssl/err.h>
  59
  60 #include "ec_lcl.h"
  61
  62
  63 /* functions for EC_GROUP objects */
  64
  65 EC_GROUP *EC_GROUP_new(const EC_METHOD *meth)
  66         {
  67         EC_GROUP *ret;
  68
  69         if (meth == NULL)
  70                 {
  71                 ECerr(EC_F_EC_GROUP_NEW, ERR_R_PASSED_NULL_PARAMETER);
  72                 return NULL;
  73                 }
  74         if (meth->group_init == 0)
  75                 {
  76                 ECerr(EC_F_EC_GROUP_NEW, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
  77                 return NULL;
  78                 }
  79
  80         ret = OPENSSL_malloc(sizeof *ret);
  81         if (ret == NULL)
  82                 {
  83                 ECerr(EC_F_EC_GROUP_NEW, ERR_R_MALLOC_FAILURE);
  84                 return NULL;
  85                 }
  86
  87         ret->meth = meth;
  88
  89         ret->extra_data = NULL;
  90         ret->extra_data_dup_func = 0;
  91         ret->extra_data_free_func = 0;
  92         ret->extra_data_clear_free_func = 0;
  93
  94         if (!meth->group_init(ret))
  95                 {
  96                 OPENSSL_free(ret);
  97                 return NULL;
  98                 }
  99
 100         return ret;
 101         }
 102
 103
 104 int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
 105         {
 106         if (group->meth->group_set_curve_GFp == 0)
 107                 {
 108                 ECerr(EC_F_EC_GROUP_SET_CURVE_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 109                 return 0;
 110                 }
 111         return group->meth->group_set_curve_GFp(group, p, a, b, ctx);
 112         }
 113
 114
 115 void EC_GROUP_free(EC_GROUP *group)
 116         {
 117         if (group->meth->group_finish != 0)
 118                 group->meth->group_finish(group);
 119
 120         EC_GROUP_free_extra_data(group);
 121
 122         OPENSSL_free(group);
 123         }
 124
 125
 126 void EC_GROUP_clear_free(EC_GROUP *group)
 127         {
 128         if (group->meth->group_clear_finish != 0)
 129                 group->meth->group_clear_finish(group);
 130         else if (group->meth != NULL && group->meth->group_finish != 0)
 131                 group->meth->group_finish(group);
 132
 133         EC_GROUP_clear_free_extra_data(group);
 134
 135         memset(group, 0, sizeof *group);
 136         OPENSSL_free(group);
 137         }
 138
 139
 140 int EC_GROUP_copy(EC_GROUP *dest, const EC_GROUP *src)
 141         {
 142         if (dest->meth->group_copy == 0)
 143                 {
 144                 ECerr(EC_F_EC_GROUP_COPY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 145                 return 0;
 146                 }
 147         if (dest->meth != src->meth)
 148                 {
 149                 ECerr(EC_F_EC_GROUP_COPY, EC_R_INCOMPATIBLE_OBJECTS);
 150                 return 0;
 151                 }
 152
 153         EC_GROUP_clear_free_extra_data(dest);
 154         if (src->extra_data_dup_func)
 155                 {
 156                 if (src->extra_data != NULL)
 157                         {
 158                         dest->extra_data = src->extra_data_dup_func(src->extra_data);
 159                         if (dest->extra_data == NULL)
 160                                 return 0;
 161                         }
 162
 163                 dest->extra_data_dup_func = src->extra_data_dup_func;
 164                 dest->extra_data_free_func = src->extra_data_free_func;
 165                 dest->extra_data_clear_free_func = src->extra_data_clear_free_func;
 166                 }
 167
 168         return dest->meth->group_copy(dest, src);
 169         }
 170
 171
 172 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor)
 173         {
 174         if (group->meth->group_set_generator == 0)
 175                 {
 176                 ECerr(EC_F_EC_GROUP_SET_GENERATOR, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 177                 return 0;
 178                 }
 179         return group->meth->group_set_generator(group, generator, order, cofactor);
 180         }
 181
 182
 183 /* TODO: 'set' and 'get' functions for EC_GROUPs */
 184
 185
 186 /* this has 'package' visibility */
 187 int EC_GROUP_set_extra_data(EC_GROUP *group, void *extra_data, void *(*extra_data_dup_func)(void *),
 188         void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *))
 189         {
 190         if ((group->extra_data != NULL)
 191                 || (group->extra_data_dup_func != 0)
 192                 || (group->extra_data_free_func != 0)
 193                 || (group->extra_data_clear_free_func != 0))
 194                 {
 195                 ECerr(EC_F_EC_GROUP_SET_EXTRA_DATA, EC_R_SLOT_FULL);
 196                 return 0;
 197                 }
 198
 199         group->extra_data = extra_data;
 200         group->extra_data_dup_func = extra_data_dup_func;
 201         group->extra_data_free_func = extra_data_free_func;
 202         group->extra_data_clear_free_func = extra_data_clear_free_func;
 203         return 1;
 204         }
 205
 206
 207 /* this has 'package' visibility */
 208 void *EC_GROUP_get_extra_data(EC_GROUP *group, void *(*extra_data_dup_func)(void *),
 209         void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *))
 210         {
 211         if ((group->extra_data_dup_func != extra_data_dup_func)
 212                 || (group->extra_data_free_func != extra_data_free_func)
 213                 || (group->extra_data_clear_free_func != extra_data_clear_free_func))
 214                 {
 215                 ECerr(EC_F_EC_GROUP_GET_EXTRA_DATA, EC_R_NO_SUCH_EXTRA_DATA);
 216                 return NULL;
 217                 }
 218
 219         return group->extra_data;
 220         }
 221
 222
 223 /* this has 'package' visibility */
 224 void EC_GROUP_free_extra_data(EC_GROUP *group)
 225         {
 226         if (group->extra_data_free_func)
 227                 group->extra_data_free_func(group->extra_data);
 228         group->extra_data = NULL;
 229         group->extra_data_dup_func = 0;
 230         group->extra_data_free_func = 0;
 231         group->extra_data_clear_free_func = 0;
 232         }
 233
 234
 235 /* this has 'package' visibility */
 236 void EC_GROUP_clear_free_extra_data(EC_GROUP *group)
 237         {
 238         if (group->extra_data_clear_free_func)
 239                 group->extra_data_clear_free_func(group->extra_data);
 240         else if (group->extra_data_free_func)
 241                 group->extra_data_free_func(group->extra_data);
 242         group->extra_data = NULL;
 243         group->extra_data_dup_func = 0;
 244         group->extra_data_free_func = 0;
 245         group->extra_data_clear_free_func = 0;
 246         }
 247
 248
 249
 250 /* functions for EC_POINT objects */
 251
 252 EC_POINT *EC_POINT_new(const EC_GROUP *group)
 253         {
 254         EC_POINT *ret;
 255
 256         if (group == NULL)
 257                 {
 258                 ECerr(EC_F_EC_POINT_NEW, ERR_R_PASSED_NULL_PARAMETER);
 259                 return NULL;
 260                 }
 261         if (group->meth->point_init == 0)
 262                 {
 263                 ECerr(EC_F_EC_POINT_NEW, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 264                 return NULL;
 265                 }
 266
 267         ret = OPENSSL_malloc(sizeof *ret);
 268         if (ret == NULL)
 269                 {
 270                 ECerr(EC_F_EC_POINT_NEW, ERR_R_MALLOC_FAILURE);
 271                 return NULL;
 272                 }
 273
 274         ret->meth = group->meth;
 275
 276         if (!ret->meth->point_init(ret))
 277                 {
 278                 OPENSSL_free(ret);
 279                 return NULL;
 280                 }
 281
 282         return ret;
 283         }
 284
 285
 286 void EC_POINT_free(EC_POINT *point)
 287         {
 288         if (point->meth->point_finish != 0)
 289                 point->meth->point_finish(point);
 290         OPENSSL_free(point);
 291         }
 292
 293
 294 void EC_POINT_clear_free(EC_POINT *point)
 295         {
 296         if (point->meth->point_clear_finish != 0)
 297                 point->meth->point_clear_finish(point);
 298         else if (point->meth != NULL && point->meth->point_finish != 0)
 299                 point->meth->point_finish(point);
 300         memset(point, 0, sizeof *point);
 301         OPENSSL_free(point);
 302         }
 303
 304
 305 int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src)
 306         {
 307         if (dest->meth->point_copy == 0)
 308                 {
 309                 ECerr(EC_F_EC_POINT_COPY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 310                 return 0;
 311                 }
 312         if (dest->meth != src->meth)
 313                 {
 314                 ECerr(EC_F_EC_POINT_COPY, EC_R_INCOMPATIBLE_OBJECTS);
 315                 return 0;
 316                 }
 317         return dest->meth->point_copy(dest, src);
 318         }
 319
 320
 321 int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point)
 322         {
 323         if (group->meth->point_set_to_infinity == 0)
 324                 {
 325                 ECerr(EC_F_EC_POINT_SET_TO_INFINITY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 326                 return 0;
 327                 }
 328         if (group->meth != point->meth)
 329                 {
 330                 ECerr(EC_F_EC_POINT_SET_TO_INFINITY, EC_R_INCOMPATIBLE_OBJECTS);
 331                 return 0;
 332                 }
 333         return group->meth->point_set_to_infinity(group, point);
 334         }
 335
 336
 337 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
 338         const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx)
 339         {
 340         if (group->meth->point_set_affine_coordinates_GFp == 0)
 341                 {
 342                 ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 343                 return 0;
 344                 }
 345         if (group->meth != point->meth)
 346                 {
 347                 ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
 348                 return 0;
 349                 }
 350         return group->meth->point_set_affine_coordinates_GFp(group, point, x, y, ctx);
 351         }
 352
 353
 354 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, const EC_POINT *point,
 355         BIGNUM *x, BIGNUM *y, BN_CTX *ctx)
 356         {
 357         if (group->meth->point_get_affine_coordinates_GFp == 0)
 358                 {
 359                 ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 360                 return 0;
 361                 }
 362         if (group->meth != point->meth)
 363                 {
 364                 ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
 365                 return 0;
 366                 }
 367         return group->meth->point_get_affine_coordinates_GFp(group, point, x, y, ctx);
 368         }
 369
 370
 371 /* TODO: other 'set' and 'get' functions for EC_POINTs */
 372
 373
 374 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *point, point_conversion_form_t form,
 375         unsigned char *buf, size_t len, BN_CTX *ctx)
 376         {
 377         if (group->meth->point2oct == 0)
 378                 {
 379                 ECerr(EC_F_EC_POINT_POINT2OCT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 380                 return 0;
 381                 }
 382         if (group->meth != point->meth)
 383                 {
 384                 ECerr(EC_F_EC_POINT_POINT2OCT, EC_R_INCOMPATIBLE_OBJECTS);
 385                 return 0;
 386                 }
 387         return group->meth->point2oct(group, point, form, buf, len, ctx);
 388         }
 389
 390
 391 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *point,
 392         const unsigned char *buf, size_t len, BN_CTX *ctx)
 393         {
 394         if (group->meth->oct2point == 0)
 395                 {
 396                 ECerr(EC_F_EC_POINT_OCT2POINT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 397                 return 0;
 398                 }
 399         if (group->meth != point->meth)
 400                 {
 401                 ECerr(EC_F_EC_POINT_OCT2POINT, EC_R_INCOMPATIBLE_OBJECTS);
 402                 return 0;
 403                 }
 404         return group->meth->oct2point(group, point, buf, len, ctx);
 405         }
 406
 407
 408 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
 409         {
 410         if (group->meth->add == 0)
 411                 {
 412                 ECerr(EC_F_EC_POINT_ADD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 413                 return 0;
 414                 }
 415         if ((group->meth != r->meth) || (r->meth != a->meth) || (a->meth != b->meth))
 416                 {
 417                 ECerr(EC_F_EC_POINT_ADD, EC_R_INCOMPATIBLE_OBJECTS);
 418                 return 0;
 419                 }
 420         return group->meth->add(group, r, a, b, ctx);
 421         }
 422
 423
 424 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx)
 425         {
 426         if (group->meth->dbl == 0)
 427                 {
 428                 ECerr(EC_F_EC_POINT_DBL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 429                 return 0;
 430                 }
 431         if ((group->meth != r->meth) || (r->meth != a->meth))
 432                 {
 433                 ECerr(EC_F_EC_POINT_DBL, EC_R_INCOMPATIBLE_OBJECTS);
 434                 return 0;
 435                 }
 436         return group->meth->dbl(group, r, a, ctx);
 437         }
 438
 439
 440 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *point)
 441         {
 442         if (group->meth->is_at_infinity == 0)
 443                 {
 444                 ECerr(EC_F_EC_POINT_IS_AT_INFINITY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 445                 return 0;
 446                 }
 447         if (group->meth != point->meth)
 448                 {
 449                 ECerr(EC_F_EC_POINT_IS_AT_INFINITY, EC_R_INCOMPATIBLE_OBJECTS);
 450                 return 0;
 451                 }
 452         return group->meth->is_at_infinity(group, point);
 453         }
 454
 455
 456 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx)
 457         {
 458         if (group->meth->is_on_curve == 0)
 459                 {
 460                 ECerr(EC_F_EC_POINT_IS_ON_CURVE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 461                 return 0;
 462                 }
 463         if (group->meth != point->meth)
 464                 {
 465                 ECerr(EC_F_EC_POINT_IS_ON_CURVE, EC_R_INCOMPATIBLE_OBJECTS);
 466                 return 0;
 467                 }
 468         return group->meth->is_on_curve(group, point, ctx);
 469         }
 470
 471
 472 int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
 473         {
 474         if (group->meth->make_affine == 0)
 475                 {
 476                 ECerr(EC_F_EC_POINT_MAKE_AFFINE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 477                 return 0;
 478                 }
 479         if (group->meth != point->meth)
 480                 {
 481                 ECerr(EC_F_EC_POINT_MAKE_AFFINE, EC_R_INCOMPATIBLE_OBJECTS);
 482                 return 0;
 483                 }
 484         return group->meth->make_affine(group, point, ctx);
 485         }