Fix bug in DSA, EC methods.
[openssl.git] / 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
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         if (ctx != NULL)
285                 BN_CTX_end(ctx);
286         if (new_ctx != NULL)
287                 BN_CTX_free(new_ctx);
288         return ret;
289         }
290
291
292 /* Initializes an EC_POINT. */
293 int ec_GF2m_simple_point_init(EC_POINT *point)
294         {
295         BN_init(&point->X);
296         BN_init(&point->Y);
297         BN_init(&point->Z);
298         return 1;
299         }
300
301
302 /* Frees an EC_POINT. */
303 void ec_GF2m_simple_point_finish(EC_POINT *point)
304         {
305         BN_free(&point->X);
306         BN_free(&point->Y);
307         BN_free(&point->Z);
308         }
309
310
311 /* Clears and frees an EC_POINT. */
312 void ec_GF2m_simple_point_clear_finish(EC_POINT *point)
313         {
314         BN_clear_free(&point->X);
315         BN_clear_free(&point->Y);
316         BN_clear_free(&point->Z);
317         point->Z_is_one = 0;
318         }
319
320
321 /* Copy the contents of one EC_POINT into another.  Assumes dest is initialized. */
322 int ec_GF2m_simple_point_copy(EC_POINT *dest, const EC_POINT *src)
323         {
324         if (!BN_copy(&dest->X, &src->X)) return 0;
325         if (!BN_copy(&dest->Y, &src->Y)) return 0;
326         if (!BN_copy(&dest->Z, &src->Z)) return 0;
327         dest->Z_is_one = src->Z_is_one;
328
329         return 1;
330         }
331
332
333 /* Set an EC_POINT to the point at infinity.  
334  * A point at infinity is represented by having Z=0.
335  */
336 int ec_GF2m_simple_point_set_to_infinity(const EC_GROUP *group, EC_POINT *point)
337         {
338         point->Z_is_one = 0;
339         BN_zero(&point->Z);
340         return 1;
341         }
342
343
344 /* Set the coordinates of an EC_POINT using affine coordinates. 
345  * Note that the simple implementation only uses affine coordinates.
346  */
347 int ec_GF2m_simple_point_set_affine_coordinates(const EC_GROUP *group, EC_POINT *point,
348         const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx)
349         {
350         int ret = 0;    
351         if (x == NULL || y == NULL)
352                 {
353                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES, ERR_R_PASSED_NULL_PARAMETER);
354                 return 0;
355                 }
356
357         if (!BN_copy(&point->X, x)) goto err;
358         BN_set_negative(&point->X, 0);
359         if (!BN_copy(&point->Y, y)) goto err;
360         BN_set_negative(&point->Y, 0);
361         if (!BN_copy(&point->Z, BN_value_one())) goto err;
362         BN_set_negative(&point->Z, 0);
363         point->Z_is_one = 1;
364         ret = 1;
365
366   err:
367         return ret;
368         }
369
370
371 /* Gets the affine coordinates of an EC_POINT. 
372  * Note that the simple implementation only uses affine coordinates.
373  */
374 int ec_GF2m_simple_point_get_affine_coordinates(const EC_GROUP *group, const EC_POINT *point,
375         BIGNUM *x, BIGNUM *y, BN_CTX *ctx)
376         {
377         int ret = 0;
378
379         if (EC_POINT_is_at_infinity(group, point))
380                 {
381                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES, EC_R_POINT_AT_INFINITY);
382                 return 0;
383                 }
384
385         if (BN_cmp(&point->Z, BN_value_one())) 
386                 {
387                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
388                 return 0;
389                 }
390         if (x != NULL)
391                 {
392                 if (!BN_copy(x, &point->X)) goto err;
393                 BN_set_negative(x, 0);
394                 }
395         if (y != NULL)
396                 {
397                 if (!BN_copy(y, &point->Y)) goto err;
398                 BN_set_negative(y, 0);
399                 }
400         ret = 1;
401                 
402  err:
403         return ret;
404         }
405
406
407 /* Calculates and sets the affine coordinates of an EC_POINT from the given
408  * compressed coordinates.  Uses algorithm 2.3.4 of SEC 1. 
409  * Note that the simple implementation only uses affine coordinates.
410  *
411  * The method is from the following publication:
412  * 
413  *     Harper, Menezes, Vanstone:
414  *     "Public-Key Cryptosystems with Very Small Key Lengths",
415  *     EUROCRYPT '92, Springer-Verlag LNCS 658,
416  *     published February 1993
417  *
418  * US Patents 6,141,420 and 6,618,483 (Vanstone, Mullin, Agnew) describe
419  * the same method, but claim no priority date earlier than July 29, 1994
420  * (and additionally fail to cite the EUROCRYPT '92 publication as prior art).
421  */
422 int ec_GF2m_simple_set_compressed_coordinates(const EC_GROUP *group, EC_POINT *point,
423         const BIGNUM *x_, int y_bit, BN_CTX *ctx)
424         {
425         BN_CTX *new_ctx = NULL;
426         BIGNUM *tmp, *x, *y, *z;
427         int ret = 0, z0;
428
429         /* clear error queue */
430         ERR_clear_error();
431
432         if (ctx == NULL)
433                 {
434                 ctx = new_ctx = BN_CTX_new();
435                 if (ctx == NULL)
436                         return 0;
437                 }
438
439         y_bit = (y_bit != 0) ? 1 : 0;
440
441         BN_CTX_start(ctx);
442         tmp = BN_CTX_get(ctx);
443         x = BN_CTX_get(ctx);
444         y = BN_CTX_get(ctx);
445         z = BN_CTX_get(ctx);
446         if (z == NULL) goto err;
447
448         if (!BN_GF2m_mod_arr(x, x_, group->poly)) goto err;
449         if (BN_is_zero(x))
450                 {
451                 if (!BN_GF2m_mod_sqrt_arr(y, &group->b, group->poly, ctx)) goto err;
452                 }
453         else
454                 {
455                 if (!group->meth->field_sqr(group, tmp, x, ctx)) goto err;
456                 if (!group->meth->field_div(group, tmp, &group->b, tmp, ctx)) goto err;
457                 if (!BN_GF2m_add(tmp, &group->a, tmp)) goto err;
458                 if (!BN_GF2m_add(tmp, x, tmp)) goto err;
459                 if (!BN_GF2m_mod_solve_quad_arr(z, tmp, group->poly, ctx))
460                         {
461                         unsigned long err = ERR_peek_last_error();
462                         
463                         if (ERR_GET_LIB(err) == ERR_LIB_BN && ERR_GET_REASON(err) == BN_R_NO_SOLUTION)
464                                 {
465                                 ERR_clear_error();
466                                 ECerr(EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES, EC_R_INVALID_COMPRESSED_POINT);
467                                 }
468                         else
469                                 ECerr(EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES, ERR_R_BN_LIB);
470                         goto err;
471                         }
472                 z0 = (BN_is_odd(z)) ? 1 : 0;
473                 if (!group->meth->field_mul(group, y, x, z, ctx)) goto err;
474                 if (z0 != y_bit)
475                         {
476                         if (!BN_GF2m_add(y, y, x)) goto err;
477                         }
478                 }
479
480         if (!EC_POINT_set_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
481
482         ret = 1;
483
484  err:
485         BN_CTX_end(ctx);
486         if (new_ctx != NULL)
487                 BN_CTX_free(new_ctx);
488         return ret;
489         }
490
491
492 /* Converts an EC_POINT to an octet string.  
493  * If buf is NULL, the encoded length will be returned.
494  * If the length len of buf is smaller than required an error will be returned.
495  */
496 size_t ec_GF2m_simple_point2oct(const EC_GROUP *group, const EC_POINT *point, point_conversion_form_t form,
497         unsigned char *buf, size_t len, BN_CTX *ctx)
498         {
499         size_t ret;
500         BN_CTX *new_ctx = NULL;
501         int used_ctx = 0;
502         BIGNUM *x, *y, *yxi;
503         size_t field_len, i, skip;
504
505         if ((form != POINT_CONVERSION_COMPRESSED)
506                 && (form != POINT_CONVERSION_UNCOMPRESSED)
507                 && (form != POINT_CONVERSION_HYBRID))
508                 {
509                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_INVALID_FORM);
510                 goto err;
511                 }
512
513         if (EC_POINT_is_at_infinity(group, point))
514                 {
515                 /* encodes to a single 0 octet */
516                 if (buf != NULL)
517                         {
518                         if (len < 1)
519                                 {
520                                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_BUFFER_TOO_SMALL);
521                                 return 0;
522                                 }
523                         buf[0] = 0;
524                         }
525                 return 1;
526                 }
527
528
529         /* ret := required output buffer length */
530         field_len = (EC_GROUP_get_degree(group) + 7) / 8;
531         ret = (form == POINT_CONVERSION_COMPRESSED) ? 1 + field_len : 1 + 2*field_len;
532
533         /* if 'buf' is NULL, just return required length */
534         if (buf != NULL)
535                 {
536                 if (len < ret)
537                         {
538                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, EC_R_BUFFER_TOO_SMALL);
539                         goto err;
540                         }
541
542                 if (ctx == NULL)
543                         {
544                         ctx = new_ctx = BN_CTX_new();
545                         if (ctx == NULL)
546                                 return 0;
547                         }
548
549                 BN_CTX_start(ctx);
550                 used_ctx = 1;
551                 x = BN_CTX_get(ctx);
552                 y = BN_CTX_get(ctx);
553                 yxi = BN_CTX_get(ctx);
554                 if (yxi == NULL) goto err;
555
556                 if (!EC_POINT_get_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
557
558                 buf[0] = form;
559                 if ((form != POINT_CONVERSION_UNCOMPRESSED) && !BN_is_zero(x))
560                         {
561                         if (!group->meth->field_div(group, yxi, y, x, ctx)) goto err;
562                         if (BN_is_odd(yxi)) buf[0]++;
563                         }
564
565                 i = 1;
566                 
567                 skip = field_len - BN_num_bytes(x);
568                 if (skip > field_len)
569                         {
570                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
571                         goto err;
572                         }
573                 while (skip > 0)
574                         {
575                         buf[i++] = 0;
576                         skip--;
577                         }
578                 skip = BN_bn2bin(x, buf + i);
579                 i += skip;
580                 if (i != 1 + field_len)
581                         {
582                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
583                         goto err;
584                         }
585
586                 if (form == POINT_CONVERSION_UNCOMPRESSED || form == POINT_CONVERSION_HYBRID)
587                         {
588                         skip = field_len - BN_num_bytes(y);
589                         if (skip > field_len)
590                                 {
591                                 ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
592                                 goto err;
593                                 }
594                         while (skip > 0)
595                                 {
596                                 buf[i++] = 0;
597                                 skip--;
598                                 }
599                         skip = BN_bn2bin(y, buf + i);
600                         i += skip;
601                         }
602
603                 if (i != ret)
604                         {
605                         ECerr(EC_F_EC_GF2M_SIMPLE_POINT2OCT, ERR_R_INTERNAL_ERROR);
606                         goto err;
607                         }
608                 }
609         
610         if (used_ctx)
611                 BN_CTX_end(ctx);
612         if (new_ctx != NULL)
613                 BN_CTX_free(new_ctx);
614         return ret;
615
616  err:
617         if (used_ctx)
618                 BN_CTX_end(ctx);
619         if (new_ctx != NULL)
620                 BN_CTX_free(new_ctx);
621         return 0;
622         }
623
624
625 /* Converts an octet string representation to an EC_POINT. 
626  * Note that the simple implementation only uses affine coordinates.
627  */
628 int ec_GF2m_simple_oct2point(const EC_GROUP *group, EC_POINT *point,
629         const unsigned char *buf, size_t len, BN_CTX *ctx)
630         {
631         point_conversion_form_t form;
632         int y_bit;
633         BN_CTX *new_ctx = NULL;
634         BIGNUM *x, *y, *yxi;
635         size_t field_len, enc_len;
636         int ret = 0;
637
638         if (len == 0)
639                 {
640                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_BUFFER_TOO_SMALL);
641                 return 0;
642                 }
643         form = buf[0];
644         y_bit = form & 1;
645         form = form & ~1U;
646         if ((form != 0) && (form != POINT_CONVERSION_COMPRESSED)
647                 && (form != POINT_CONVERSION_UNCOMPRESSED)
648                 && (form != POINT_CONVERSION_HYBRID))
649                 {
650                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
651                 return 0;
652                 }
653         if ((form == 0 || form == POINT_CONVERSION_UNCOMPRESSED) && y_bit)
654                 {
655                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
656                 return 0;
657                 }
658
659         if (form == 0)
660                 {
661                 if (len != 1)
662                         {
663                         ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
664                         return 0;
665                         }
666
667                 return EC_POINT_set_to_infinity(group, point);
668                 }
669         
670         field_len = (EC_GROUP_get_degree(group) + 7) / 8;
671         enc_len = (form == POINT_CONVERSION_COMPRESSED) ? 1 + field_len : 1 + 2*field_len;
672
673         if (len != enc_len)
674                 {
675                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
676                 return 0;
677                 }
678
679         if (ctx == NULL)
680                 {
681                 ctx = new_ctx = BN_CTX_new();
682                 if (ctx == NULL)
683                         return 0;
684                 }
685
686         BN_CTX_start(ctx);
687         x = BN_CTX_get(ctx);
688         y = BN_CTX_get(ctx);
689         yxi = BN_CTX_get(ctx);
690         if (yxi == NULL) goto err;
691
692         if (!BN_bin2bn(buf + 1, field_len, x)) goto err;
693         if (BN_ucmp(x, &group->field) >= 0)
694                 {
695                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
696                 goto err;
697                 }
698
699         if (form == POINT_CONVERSION_COMPRESSED)
700                 {
701                 if (!EC_POINT_set_compressed_coordinates_GF2m(group, point, x, y_bit, ctx)) goto err;
702                 }
703         else
704                 {
705                 if (!BN_bin2bn(buf + 1 + field_len, field_len, y)) goto err;
706                 if (BN_ucmp(y, &group->field) >= 0)
707                         {
708                         ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
709                         goto err;
710                         }
711                 if (form == POINT_CONVERSION_HYBRID)
712                         {
713                         if (!group->meth->field_div(group, yxi, y, x, ctx)) goto err;
714                         if (y_bit != BN_is_odd(yxi))
715                                 {
716                                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_INVALID_ENCODING);
717                                 goto err;
718                                 }
719                         }
720
721                 if (!EC_POINT_set_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
722                 }
723         
724         if (!EC_POINT_is_on_curve(group, point, ctx)) /* test required by X9.62 */
725                 {
726                 ECerr(EC_F_EC_GF2M_SIMPLE_OCT2POINT, EC_R_POINT_IS_NOT_ON_CURVE);
727                 goto err;
728                 }
729
730         ret = 1;
731         
732  err:
733         BN_CTX_end(ctx);
734         if (new_ctx != NULL)
735                 BN_CTX_free(new_ctx);
736         return ret;
737         }
738
739
740 /* Computes a + b and stores the result in r.  r could be a or b, a could be b.
741  * Uses algorithm A.10.2 of IEEE P1363.
742  */
743 int ec_GF2m_simple_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
744         {
745         BN_CTX *new_ctx = NULL;
746         BIGNUM *x0, *y0, *x1, *y1, *x2, *y2, *s, *t;
747         int ret = 0;
748         
749         if (EC_POINT_is_at_infinity(group, a))
750                 {
751                 if (!EC_POINT_copy(r, b)) return 0;
752                 return 1;
753                 }
754
755         if (EC_POINT_is_at_infinity(group, b))
756                 {
757                 if (!EC_POINT_copy(r, a)) return 0;
758                 return 1;
759                 }
760
761         if (ctx == NULL)
762                 {
763                 ctx = new_ctx = BN_CTX_new();
764                 if (ctx == NULL)
765                         return 0;
766                 }
767
768         BN_CTX_start(ctx);
769         x0 = BN_CTX_get(ctx);
770         y0 = BN_CTX_get(ctx);
771         x1 = BN_CTX_get(ctx);
772         y1 = BN_CTX_get(ctx);
773         x2 = BN_CTX_get(ctx);
774         y2 = BN_CTX_get(ctx);
775         s = BN_CTX_get(ctx);
776         t = BN_CTX_get(ctx);
777         if (t == NULL) goto err;
778
779         if (a->Z_is_one) 
780                 {
781                 if (!BN_copy(x0, &a->X)) goto err;
782                 if (!BN_copy(y0, &a->Y)) goto err;
783                 }
784         else
785                 {
786                 if (!EC_POINT_get_affine_coordinates_GF2m(group, a, x0, y0, ctx)) goto err;
787                 }
788         if (b->Z_is_one) 
789                 {
790                 if (!BN_copy(x1, &b->X)) goto err;
791                 if (!BN_copy(y1, &b->Y)) goto err;
792                 }
793         else
794                 {
795                 if (!EC_POINT_get_affine_coordinates_GF2m(group, b, x1, y1, ctx)) goto err;
796                 }
797
798
799         if (BN_GF2m_cmp(x0, x1))
800                 {
801                 if (!BN_GF2m_add(t, x0, x1)) goto err;
802                 if (!BN_GF2m_add(s, y0, y1)) goto err;
803                 if (!group->meth->field_div(group, s, s, t, ctx)) goto err;
804                 if (!group->meth->field_sqr(group, x2, s, ctx)) goto err;
805                 if (!BN_GF2m_add(x2, x2, &group->a)) goto err;
806                 if (!BN_GF2m_add(x2, x2, s)) goto err;
807                 if (!BN_GF2m_add(x2, x2, t)) goto err;
808                 }
809         else
810                 {
811                 if (BN_GF2m_cmp(y0, y1) || BN_is_zero(x1))
812                         {
813                         if (!EC_POINT_set_to_infinity(group, r)) goto err;
814                         ret = 1;
815                         goto err;
816                         }
817                 if (!group->meth->field_div(group, s, y1, x1, ctx)) goto err;
818                 if (!BN_GF2m_add(s, s, x1)) goto err;
819                 
820                 if (!group->meth->field_sqr(group, x2, s, ctx)) goto err;
821                 if (!BN_GF2m_add(x2, x2, s)) goto err;
822                 if (!BN_GF2m_add(x2, x2, &group->a)) goto err;
823                 }
824
825         if (!BN_GF2m_add(y2, x1, x2)) goto err;
826         if (!group->meth->field_mul(group, y2, y2, s, ctx)) goto err;
827         if (!BN_GF2m_add(y2, y2, x2)) goto err;
828         if (!BN_GF2m_add(y2, y2, y1)) goto err;
829
830         if (!EC_POINT_set_affine_coordinates_GF2m(group, r, x2, y2, ctx)) goto err;
831
832         ret = 1;
833
834  err:
835         BN_CTX_end(ctx);
836         if (new_ctx != NULL)
837                 BN_CTX_free(new_ctx);
838         return ret;
839         }
840
841
842 /* Computes 2 * a and stores the result in r.  r could be a.
843  * Uses algorithm A.10.2 of IEEE P1363.
844  */
845 int ec_GF2m_simple_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx)
846         {
847         return ec_GF2m_simple_add(group, r, a, a, ctx);
848         }
849
850
851 int ec_GF2m_simple_invert(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
852         {
853         if (EC_POINT_is_at_infinity(group, point) || BN_is_zero(&point->Y))
854                 /* point is its own inverse */
855                 return 1;
856         
857         if (!EC_POINT_make_affine(group, point, ctx)) return 0;
858         return BN_GF2m_add(&point->Y, &point->X, &point->Y);
859         }
860
861
862 /* Indicates whether the given point is the point at infinity. */
863 int ec_GF2m_simple_is_at_infinity(const EC_GROUP *group, const EC_POINT *point)
864         {
865         return BN_is_zero(&point->Z);
866         }
867
868
869 /* Determines whether the given EC_POINT is an actual point on the curve defined
870  * in the EC_GROUP.  A point is valid if it satisfies the Weierstrass equation:
871  *      y^2 + x*y = x^3 + a*x^2 + b.
872  */
873 int ec_GF2m_simple_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx)
874         {
875         int ret = -1;
876         BN_CTX *new_ctx = NULL;
877         BIGNUM *lh, *y2;
878         int (*field_mul)(const EC_GROUP *, BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *);
879         int (*field_sqr)(const EC_GROUP *, BIGNUM *, const BIGNUM *, BN_CTX *);
880
881         if (EC_POINT_is_at_infinity(group, point))
882                 return 1;
883
884         field_mul = group->meth->field_mul;
885         field_sqr = group->meth->field_sqr;     
886
887         /* only support affine coordinates */
888         if (!point->Z_is_one) goto err;
889
890         if (ctx == NULL)
891                 {
892                 ctx = new_ctx = BN_CTX_new();
893                 if (ctx == NULL)
894                         return -1;
895                 }
896
897         BN_CTX_start(ctx);
898         y2 = BN_CTX_get(ctx);
899         lh = BN_CTX_get(ctx);
900         if (lh == NULL) goto err;
901
902         /* We have a curve defined by a Weierstrass equation
903          *      y^2 + x*y = x^3 + a*x^2 + b.
904          *  <=> x^3 + a*x^2 + x*y + b + y^2 = 0
905          *  <=> ((x + a) * x + y ) * x + b + y^2 = 0
906          */
907         if (!BN_GF2m_add(lh, &point->X, &group->a)) goto err;
908         if (!field_mul(group, lh, lh, &point->X, ctx)) goto err;
909         if (!BN_GF2m_add(lh, lh, &point->Y)) goto err;
910         if (!field_mul(group, lh, lh, &point->X, ctx)) goto err;
911         if (!BN_GF2m_add(lh, lh, &group->b)) goto err;
912         if (!field_sqr(group, y2, &point->Y, ctx)) goto err;
913         if (!BN_GF2m_add(lh, lh, y2)) goto err;
914         ret = BN_is_zero(lh);
915  err:
916         if (ctx) BN_CTX_end(ctx);
917         if (new_ctx) BN_CTX_free(new_ctx);
918         return ret;
919         }
920
921
922 /* Indicates whether two points are equal.
923  * Return values:
924  *  -1   error
925  *   0   equal (in affine coordinates)
926  *   1   not equal
927  */
928 int ec_GF2m_simple_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx)
929         {
930         BIGNUM *aX, *aY, *bX, *bY;
931         BN_CTX *new_ctx = NULL;
932         int ret = -1;
933
934         if (EC_POINT_is_at_infinity(group, a))
935                 {
936                 return EC_POINT_is_at_infinity(group, b) ? 0 : 1;
937                 }
938         
939         if (a->Z_is_one && b->Z_is_one)
940                 {
941                 return ((BN_cmp(&a->X, &b->X) == 0) && BN_cmp(&a->Y, &b->Y) == 0) ? 0 : 1;
942                 }
943
944         if (ctx == NULL)
945                 {
946                 ctx = new_ctx = BN_CTX_new();
947                 if (ctx == NULL)
948                         return -1;
949                 }
950
951         BN_CTX_start(ctx);
952         aX = BN_CTX_get(ctx);
953         aY = BN_CTX_get(ctx);
954         bX = BN_CTX_get(ctx);
955         bY = BN_CTX_get(ctx);
956         if (bY == NULL) goto err;
957
958         if (!EC_POINT_get_affine_coordinates_GF2m(group, a, aX, aY, ctx)) goto err;
959         if (!EC_POINT_get_affine_coordinates_GF2m(group, b, bX, bY, ctx)) goto err;
960         ret = ((BN_cmp(aX, bX) == 0) && BN_cmp(aY, bY) == 0) ? 0 : 1;
961
962   err:  
963         if (ctx) BN_CTX_end(ctx);
964         if (new_ctx) BN_CTX_free(new_ctx);
965         return ret;
966         }
967
968
969 /* Forces the given EC_POINT to internally use affine coordinates. */
970 int ec_GF2m_simple_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx)
971         {
972         BN_CTX *new_ctx = NULL;
973         BIGNUM *x, *y;
974         int ret = 0;
975
976         if (point->Z_is_one || EC_POINT_is_at_infinity(group, point))
977                 return 1;
978         
979         if (ctx == NULL)
980                 {
981                 ctx = new_ctx = BN_CTX_new();
982                 if (ctx == NULL)
983                         return 0;
984                 }
985
986         BN_CTX_start(ctx);
987         x = BN_CTX_get(ctx);
988         y = BN_CTX_get(ctx);
989         if (y == NULL) goto err;
990         
991         if (!EC_POINT_get_affine_coordinates_GF2m(group, point, x, y, ctx)) goto err;
992         if (!BN_copy(&point->X, x)) goto err;
993         if (!BN_copy(&point->Y, y)) goto err;
994         if (!BN_one(&point->Z)) goto err;
995         
996         ret = 1;                
997
998   err:
999         if (ctx) BN_CTX_end(ctx);
1000         if (new_ctx) BN_CTX_free(new_ctx);
1001         return ret;
1002         }
1003
1004
1005 /* Forces each of the EC_POINTs in the given array to use affine coordinates. */
1006 int ec_GF2m_simple_points_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[], BN_CTX *ctx)
1007         {
1008         size_t i;
1009
1010         for (i = 0; i < num; i++)
1011                 {
1012                 if (!group->meth->make_affine(group, points[i], ctx)) return 0;
1013                 }
1014
1015         return 1;
1016         }
1017
1018
1019 /* Wrapper to simple binary polynomial field multiplication implementation. */
1020 int ec_GF2m_simple_field_mul(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
1021         {
1022         return BN_GF2m_mod_mul_arr(r, a, b, group->poly, ctx);
1023         }
1024
1025
1026 /* Wrapper to simple binary polynomial field squaring implementation. */
1027 int ec_GF2m_simple_field_sqr(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, BN_CTX *ctx)
1028         {
1029         return BN_GF2m_mod_sqr_arr(r, a, group->poly, ctx);
1030         }
1031
1032
1033 /* Wrapper to simple binary polynomial field division implementation. */
1034 int ec_GF2m_simple_field_div(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
1035         {
1036         return BN_GF2m_mod_div(r, a, b, &group->field, ctx);
1037         }