Make BN_num_bits() consttime upon BN_FLG_CONSTTIME
[openssl.git] / crypto / bn / bn_lib.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <assert.h>
11 #include <limits.h>
12 #include "internal/cryptlib.h"
13 #include "bn_lcl.h"
14 #include <openssl/opensslconf.h>
15 #include "internal/constant_time_locl.h"
16
17 /* This stuff appears to be completely unused, so is deprecated */
18 #if !OPENSSL_API_0_9_8
19 /*-
20  * For a 32 bit machine
21  * 2 -   4 ==  128
22  * 3 -   8 ==  256
23  * 4 -  16 ==  512
24  * 5 -  32 == 1024
25  * 6 -  64 == 2048
26  * 7 - 128 == 4096
27  * 8 - 256 == 8192
28  */
29 static int bn_limit_bits = 0;
30 static int bn_limit_num = 8;    /* (1<<bn_limit_bits) */
31 static int bn_limit_bits_low = 0;
32 static int bn_limit_num_low = 8; /* (1<<bn_limit_bits_low) */
33 static int bn_limit_bits_high = 0;
34 static int bn_limit_num_high = 8; /* (1<<bn_limit_bits_high) */
35 static int bn_limit_bits_mont = 0;
36 static int bn_limit_num_mont = 8; /* (1<<bn_limit_bits_mont) */
37
38 void BN_set_params(int mult, int high, int low, int mont)
39 {
40     if (mult >= 0) {
41         if (mult > (int)(sizeof(int) * 8) - 1)
42             mult = sizeof(int) * 8 - 1;
43         bn_limit_bits = mult;
44         bn_limit_num = 1 << mult;
45     }
46     if (high >= 0) {
47         if (high > (int)(sizeof(int) * 8) - 1)
48             high = sizeof(int) * 8 - 1;
49         bn_limit_bits_high = high;
50         bn_limit_num_high = 1 << high;
51     }
52     if (low >= 0) {
53         if (low > (int)(sizeof(int) * 8) - 1)
54             low = sizeof(int) * 8 - 1;
55         bn_limit_bits_low = low;
56         bn_limit_num_low = 1 << low;
57     }
58     if (mont >= 0) {
59         if (mont > (int)(sizeof(int) * 8) - 1)
60             mont = sizeof(int) * 8 - 1;
61         bn_limit_bits_mont = mont;
62         bn_limit_num_mont = 1 << mont;
63     }
64 }
65
66 int BN_get_params(int which)
67 {
68     if (which == 0)
69         return bn_limit_bits;
70     else if (which == 1)
71         return bn_limit_bits_high;
72     else if (which == 2)
73         return bn_limit_bits_low;
74     else if (which == 3)
75         return bn_limit_bits_mont;
76     else
77         return 0;
78 }
79 #endif
80
81 const BIGNUM *BN_value_one(void)
82 {
83     static const BN_ULONG data_one = 1L;
84     static const BIGNUM const_one =
85         { (BN_ULONG *)&data_one, 1, 1, 0, BN_FLG_STATIC_DATA };
86
87     return &const_one;
88 }
89
90 int BN_num_bits_word(BN_ULONG l)
91 {
92     BN_ULONG x, mask;
93     int bits = (l != 0);
94
95 #if BN_BITS2 > 32
96     x = l >> 32;
97     mask = (0 - x) & BN_MASK2;
98     mask = (0 - (mask >> (BN_BITS2 - 1)));
99     bits += 32 & mask;
100     l ^= (x ^ l) & mask;
101 #endif
102
103     x = l >> 16;
104     mask = (0 - x) & BN_MASK2;
105     mask = (0 - (mask >> (BN_BITS2 - 1)));
106     bits += 16 & mask;
107     l ^= (x ^ l) & mask;
108
109     x = l >> 8;
110     mask = (0 - x) & BN_MASK2;
111     mask = (0 - (mask >> (BN_BITS2 - 1)));
112     bits += 8 & mask;
113     l ^= (x ^ l) & mask;
114
115     x = l >> 4;
116     mask = (0 - x) & BN_MASK2;
117     mask = (0 - (mask >> (BN_BITS2 - 1)));
118     bits += 4 & mask;
119     l ^= (x ^ l) & mask;
120
121     x = l >> 2;
122     mask = (0 - x) & BN_MASK2;
123     mask = (0 - (mask >> (BN_BITS2 - 1)));
124     bits += 2 & mask;
125     l ^= (x ^ l) & mask;
126
127     x = l >> 1;
128     mask = (0 - x) & BN_MASK2;
129     mask = (0 - (mask >> (BN_BITS2 - 1)));
130     bits += 1 & mask;
131
132     return bits;
133 }
134
135 /*
136  * This function still leaks `a->dmax`: it's caller's responsibility to
137  * expand the input `a` in advance to a public length.
138  */
139 static ossl_inline
140 int bn_num_bits_consttime(const BIGNUM *a)
141 {
142     int j, ret;
143     unsigned int mask, past_i;
144     int i = a->top - 1;
145     bn_check_top(a);
146
147     for (j = 0, past_i = 0, ret = 0; j < a->dmax; j++) {
148         mask = constant_time_eq_int(i, j); /* 0xff..ff if i==j, 0x0 otherwise */
149
150         ret += BN_BITS2 & (~mask & ~past_i);
151         ret += BN_num_bits_word(a->d[j]) & mask;
152
153         past_i |= mask; /* past_i will become 0xff..ff after i==j */
154     }
155
156     /*
157      * if BN_is_zero(a) => i is -1 and ret contains garbage, so we mask the
158      * final result.
159      */
160     mask = ~(constant_time_eq_int(i, ((int)-1)));
161
162     return ret & mask;
163 }
164
165 int BN_num_bits(const BIGNUM *a)
166 {
167     int i = a->top - 1;
168     bn_check_top(a);
169
170     if (a->flags & BN_FLG_CONSTTIME) {
171         /*
172          * We assume that BIGNUMs flagged as CONSTTIME have also been expanded
173          * so that a->dmax is not leaking secret information.
174          *
175          * In other words, it's the caller's responsibility to ensure `a` has
176          * been preallocated in advance to a public length if we hit this
177          * branch.
178          *
179          */
180         return bn_num_bits_consttime(a);
181     }
182
183     if (BN_is_zero(a))
184         return 0;
185
186     return ((i * BN_BITS2) + BN_num_bits_word(a->d[i]));
187 }
188
189 static void bn_free_d(BIGNUM *a, int clear)
190 {
191     if (BN_get_flags(a, BN_FLG_SECURE))
192         OPENSSL_secure_clear_free(a->d, a->dmax * sizeof(a->d[0]));
193     else if (clear != 0)
194         OPENSSL_clear_free(a->d, a->dmax * sizeof(a->d[0]));
195     else
196         OPENSSL_free(a->d);
197 }
198
199
200 void BN_clear_free(BIGNUM *a)
201 {
202     if (a == NULL)
203         return;
204     if (a->d != NULL && !BN_get_flags(a, BN_FLG_STATIC_DATA))
205         bn_free_d(a, 1);
206     if (BN_get_flags(a, BN_FLG_MALLOCED)) {
207         OPENSSL_cleanse(a, sizeof(*a));
208         OPENSSL_free(a);
209     }
210 }
211
212 void BN_free(BIGNUM *a)
213 {
214     if (a == NULL)
215         return;
216     if (!BN_get_flags(a, BN_FLG_STATIC_DATA))
217         bn_free_d(a, 0);
218     if (a->flags & BN_FLG_MALLOCED)
219         OPENSSL_free(a);
220 }
221
222 void bn_init(BIGNUM *a)
223 {
224     static BIGNUM nilbn;
225
226     *a = nilbn;
227     bn_check_top(a);
228 }
229
230 BIGNUM *BN_new(void)
231 {
232     BIGNUM *ret;
233
234     if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
235         BNerr(BN_F_BN_NEW, ERR_R_MALLOC_FAILURE);
236         return NULL;
237     }
238     ret->flags = BN_FLG_MALLOCED;
239     bn_check_top(ret);
240     return ret;
241 }
242
243  BIGNUM *BN_secure_new(void)
244  {
245      BIGNUM *ret = BN_new();
246      if (ret != NULL)
247          ret->flags |= BN_FLG_SECURE;
248      return ret;
249  }
250
251 /* This is used by bn_expand2() */
252 /* The caller MUST check that words > b->dmax before calling this */
253 static BN_ULONG *bn_expand_internal(const BIGNUM *b, int words)
254 {
255     BN_ULONG *a = NULL;
256
257     if (words > (INT_MAX / (4 * BN_BITS2))) {
258         BNerr(BN_F_BN_EXPAND_INTERNAL, BN_R_BIGNUM_TOO_LONG);
259         return NULL;
260     }
261     if (BN_get_flags(b, BN_FLG_STATIC_DATA)) {
262         BNerr(BN_F_BN_EXPAND_INTERNAL, BN_R_EXPAND_ON_STATIC_BIGNUM_DATA);
263         return NULL;
264     }
265     if (BN_get_flags(b, BN_FLG_SECURE))
266         a = OPENSSL_secure_zalloc(words * sizeof(*a));
267     else
268         a = OPENSSL_zalloc(words * sizeof(*a));
269     if (a == NULL) {
270         BNerr(BN_F_BN_EXPAND_INTERNAL, ERR_R_MALLOC_FAILURE);
271         return NULL;
272     }
273
274     assert(b->top <= words);
275     if (b->top > 0)
276         memcpy(a, b->d, sizeof(*a) * b->top);
277
278     return a;
279 }
280
281 /*
282  * This is an internal function that should not be used in applications. It
283  * ensures that 'b' has enough room for a 'words' word number and initialises
284  * any unused part of b->d with leading zeros. It is mostly used by the
285  * various BIGNUM routines. If there is an error, NULL is returned. If not,
286  * 'b' is returned.
287  */
288
289 BIGNUM *bn_expand2(BIGNUM *b, int words)
290 {
291     if (words > b->dmax) {
292         BN_ULONG *a = bn_expand_internal(b, words);
293         if (!a)
294             return NULL;
295         if (b->d != NULL)
296             bn_free_d(b, 1);
297         b->d = a;
298         b->dmax = words;
299     }
300
301     return b;
302 }
303
304 BIGNUM *BN_dup(const BIGNUM *a)
305 {
306     BIGNUM *t;
307
308     if (a == NULL)
309         return NULL;
310     bn_check_top(a);
311
312     t = BN_get_flags(a, BN_FLG_SECURE) ? BN_secure_new() : BN_new();
313     if (t == NULL)
314         return NULL;
315     if (!BN_copy(t, a)) {
316         BN_free(t);
317         return NULL;
318     }
319     bn_check_top(t);
320     return t;
321 }
322
323 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b)
324 {
325     bn_check_top(b);
326
327     if (a == b)
328         return a;
329     if (bn_wexpand(a, b->top) == NULL)
330         return NULL;
331
332     if (b->top > 0)
333         memcpy(a->d, b->d, sizeof(b->d[0]) * b->top);
334
335     a->neg = b->neg;
336     a->top = b->top;
337     a->flags |= b->flags & BN_FLG_FIXED_TOP;
338     bn_check_top(a);
339     return a;
340 }
341
342 #define FLAGS_DATA(flags) ((flags) & (BN_FLG_STATIC_DATA \
343                                     | BN_FLG_CONSTTIME   \
344                                     | BN_FLG_SECURE      \
345                                     | BN_FLG_FIXED_TOP))
346 #define FLAGS_STRUCT(flags) ((flags) & (BN_FLG_MALLOCED))
347
348 void BN_swap(BIGNUM *a, BIGNUM *b)
349 {
350     int flags_old_a, flags_old_b;
351     BN_ULONG *tmp_d;
352     int tmp_top, tmp_dmax, tmp_neg;
353
354     bn_check_top(a);
355     bn_check_top(b);
356
357     flags_old_a = a->flags;
358     flags_old_b = b->flags;
359
360     tmp_d = a->d;
361     tmp_top = a->top;
362     tmp_dmax = a->dmax;
363     tmp_neg = a->neg;
364
365     a->d = b->d;
366     a->top = b->top;
367     a->dmax = b->dmax;
368     a->neg = b->neg;
369
370     b->d = tmp_d;
371     b->top = tmp_top;
372     b->dmax = tmp_dmax;
373     b->neg = tmp_neg;
374
375     a->flags = FLAGS_STRUCT(flags_old_a) | FLAGS_DATA(flags_old_b);
376     b->flags = FLAGS_STRUCT(flags_old_b) | FLAGS_DATA(flags_old_a);
377     bn_check_top(a);
378     bn_check_top(b);
379 }
380
381 void BN_clear(BIGNUM *a)
382 {
383     if (a == NULL)
384         return;
385     bn_check_top(a);
386     if (a->d != NULL)
387         OPENSSL_cleanse(a->d, sizeof(*a->d) * a->dmax);
388     a->neg = 0;
389     a->top = 0;
390     a->flags &= ~BN_FLG_FIXED_TOP;
391 }
392
393 BN_ULONG BN_get_word(const BIGNUM *a)
394 {
395     if (a->top > 1)
396         return BN_MASK2;
397     else if (a->top == 1)
398         return a->d[0];
399     /* a->top == 0 */
400     return 0;
401 }
402
403 int BN_set_word(BIGNUM *a, BN_ULONG w)
404 {
405     bn_check_top(a);
406     if (bn_expand(a, (int)sizeof(BN_ULONG) * 8) == NULL)
407         return 0;
408     a->neg = 0;
409     a->d[0] = w;
410     a->top = (w ? 1 : 0);
411     a->flags &= ~BN_FLG_FIXED_TOP;
412     bn_check_top(a);
413     return 1;
414 }
415
416 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret)
417 {
418     unsigned int i, m;
419     unsigned int n;
420     BN_ULONG l;
421     BIGNUM *bn = NULL;
422
423     if (ret == NULL)
424         ret = bn = BN_new();
425     if (ret == NULL)
426         return NULL;
427     bn_check_top(ret);
428     /* Skip leading zero's. */
429     for ( ; len > 0 && *s == 0; s++, len--)
430         continue;
431     n = len;
432     if (n == 0) {
433         ret->top = 0;
434         return ret;
435     }
436     i = ((n - 1) / BN_BYTES) + 1;
437     m = ((n - 1) % (BN_BYTES));
438     if (bn_wexpand(ret, (int)i) == NULL) {
439         BN_free(bn);
440         return NULL;
441     }
442     ret->top = i;
443     ret->neg = 0;
444     l = 0;
445     while (n--) {
446         l = (l << 8L) | *(s++);
447         if (m-- == 0) {
448             ret->d[--i] = l;
449             l = 0;
450             m = BN_BYTES - 1;
451         }
452     }
453     /*
454      * need to call this due to clear byte at top if avoiding having the top
455      * bit set (-ve number)
456      */
457     bn_correct_top(ret);
458     return ret;
459 }
460
461 /* ignore negative */
462 static int bn2binpad(const BIGNUM *a, unsigned char *to, int tolen)
463 {
464     int n;
465     size_t i, lasti, j, atop, mask;
466     BN_ULONG l;
467
468     /*
469      * In case |a| is fixed-top, BN_num_bytes can return bogus length,
470      * but it's assumed that fixed-top inputs ought to be "nominated"
471      * even for padded output, so it works out...
472      */
473     n = BN_num_bytes(a);
474     if (tolen == -1) {
475         tolen = n;
476     } else if (tolen < n) {     /* uncommon/unlike case */
477         BIGNUM temp = *a;
478
479         bn_correct_top(&temp);
480         n = BN_num_bytes(&temp);
481         if (tolen < n)
482             return -1;
483     }
484
485     /* Swipe through whole available data and don't give away padded zero. */
486     atop = a->dmax * BN_BYTES;
487     if (atop == 0) {
488         OPENSSL_cleanse(to, tolen);
489         return tolen;
490     }
491
492     lasti = atop - 1;
493     atop = a->top * BN_BYTES;
494     for (i = 0, j = 0, to += tolen; j < (size_t)tolen; j++) {
495         l = a->d[i / BN_BYTES];
496         mask = 0 - ((j - atop) >> (8 * sizeof(i) - 1));
497         *--to = (unsigned char)(l >> (8 * (i % BN_BYTES)) & mask);
498         i += (i - lasti) >> (8 * sizeof(i) - 1); /* stay on last limb */
499     }
500
501     return tolen;
502 }
503
504 int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen)
505 {
506     if (tolen < 0)
507         return -1;
508     return bn2binpad(a, to, tolen);
509 }
510
511 int BN_bn2bin(const BIGNUM *a, unsigned char *to)
512 {
513     return bn2binpad(a, to, -1);
514 }
515
516 BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret)
517 {
518     unsigned int i, m;
519     unsigned int n;
520     BN_ULONG l;
521     BIGNUM *bn = NULL;
522
523     if (ret == NULL)
524         ret = bn = BN_new();
525     if (ret == NULL)
526         return NULL;
527     bn_check_top(ret);
528     s += len;
529     /* Skip trailing zeroes. */
530     for ( ; len > 0 && s[-1] == 0; s--, len--)
531         continue;
532     n = len;
533     if (n == 0) {
534         ret->top = 0;
535         return ret;
536     }
537     i = ((n - 1) / BN_BYTES) + 1;
538     m = ((n - 1) % (BN_BYTES));
539     if (bn_wexpand(ret, (int)i) == NULL) {
540         BN_free(bn);
541         return NULL;
542     }
543     ret->top = i;
544     ret->neg = 0;
545     l = 0;
546     while (n--) {
547         s--;
548         l = (l << 8L) | *s;
549         if (m-- == 0) {
550             ret->d[--i] = l;
551             l = 0;
552             m = BN_BYTES - 1;
553         }
554     }
555     /*
556      * need to call this due to clear byte at top if avoiding having the top
557      * bit set (-ve number)
558      */
559     bn_correct_top(ret);
560     return ret;
561 }
562
563 int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen)
564 {
565     int i;
566     BN_ULONG l;
567     bn_check_top(a);
568     i = BN_num_bytes(a);
569     if (tolen < i)
570         return -1;
571     /* Add trailing zeroes if necessary */
572     if (tolen > i)
573         memset(to + i, 0, tolen - i);
574     to += i;
575     while (i--) {
576         l = a->d[i / BN_BYTES];
577         to--;
578         *to = (unsigned char)(l >> (8 * (i % BN_BYTES))) & 0xff;
579     }
580     return tolen;
581 }
582
583 BIGNUM *BN_native2bn(const unsigned char *s, int len, BIGNUM *ret)
584 {
585 #ifdef B_ENDIAN
586     return BN_bin2bn(s, len, ret);
587 #else
588     return BN_lebin2bn(s, len, ret);
589 #endif
590 }
591
592 int BN_bn2nativepad(const BIGNUM *a, unsigned char *to, int tolen)
593 {
594 #ifdef B_ENDIAN
595     return BN_bn2binpad(a, to, tolen);
596 #else
597     return BN_bn2lebinpad(a, to, tolen);
598 #endif
599 }
600
601 int BN_ucmp(const BIGNUM *a, const BIGNUM *b)
602 {
603     int i;
604     BN_ULONG t1, t2, *ap, *bp;
605
606     bn_check_top(a);
607     bn_check_top(b);
608
609     i = a->top - b->top;
610     if (i != 0)
611         return i;
612     ap = a->d;
613     bp = b->d;
614     for (i = a->top - 1; i >= 0; i--) {
615         t1 = ap[i];
616         t2 = bp[i];
617         if (t1 != t2)
618             return ((t1 > t2) ? 1 : -1);
619     }
620     return 0;
621 }
622
623 int BN_cmp(const BIGNUM *a, const BIGNUM *b)
624 {
625     int i;
626     int gt, lt;
627     BN_ULONG t1, t2;
628
629     if ((a == NULL) || (b == NULL)) {
630         if (a != NULL)
631             return -1;
632         else if (b != NULL)
633             return 1;
634         else
635             return 0;
636     }
637
638     bn_check_top(a);
639     bn_check_top(b);
640
641     if (a->neg != b->neg) {
642         if (a->neg)
643             return -1;
644         else
645             return 1;
646     }
647     if (a->neg == 0) {
648         gt = 1;
649         lt = -1;
650     } else {
651         gt = -1;
652         lt = 1;
653     }
654
655     if (a->top > b->top)
656         return gt;
657     if (a->top < b->top)
658         return lt;
659     for (i = a->top - 1; i >= 0; i--) {
660         t1 = a->d[i];
661         t2 = b->d[i];
662         if (t1 > t2)
663             return gt;
664         if (t1 < t2)
665             return lt;
666     }
667     return 0;
668 }
669
670 int BN_set_bit(BIGNUM *a, int n)
671 {
672     int i, j, k;
673
674     if (n < 0)
675         return 0;
676
677     i = n / BN_BITS2;
678     j = n % BN_BITS2;
679     if (a->top <= i) {
680         if (bn_wexpand(a, i + 1) == NULL)
681             return 0;
682         for (k = a->top; k < i + 1; k++)
683             a->d[k] = 0;
684         a->top = i + 1;
685         a->flags &= ~BN_FLG_FIXED_TOP;
686     }
687
688     a->d[i] |= (((BN_ULONG)1) << j);
689     bn_check_top(a);
690     return 1;
691 }
692
693 int BN_clear_bit(BIGNUM *a, int n)
694 {
695     int i, j;
696
697     bn_check_top(a);
698     if (n < 0)
699         return 0;
700
701     i = n / BN_BITS2;
702     j = n % BN_BITS2;
703     if (a->top <= i)
704         return 0;
705
706     a->d[i] &= (~(((BN_ULONG)1) << j));
707     bn_correct_top(a);
708     return 1;
709 }
710
711 int BN_is_bit_set(const BIGNUM *a, int n)
712 {
713     int i, j;
714
715     bn_check_top(a);
716     if (n < 0)
717         return 0;
718     i = n / BN_BITS2;
719     j = n % BN_BITS2;
720     if (a->top <= i)
721         return 0;
722     return (int)(((a->d[i]) >> j) & ((BN_ULONG)1));
723 }
724
725 int BN_mask_bits(BIGNUM *a, int n)
726 {
727     int b, w;
728
729     bn_check_top(a);
730     if (n < 0)
731         return 0;
732
733     w = n / BN_BITS2;
734     b = n % BN_BITS2;
735     if (w >= a->top)
736         return 0;
737     if (b == 0)
738         a->top = w;
739     else {
740         a->top = w + 1;
741         a->d[w] &= ~(BN_MASK2 << b);
742     }
743     bn_correct_top(a);
744     return 1;
745 }
746
747 void BN_set_negative(BIGNUM *a, int b)
748 {
749     if (b && !BN_is_zero(a))
750         a->neg = 1;
751     else
752         a->neg = 0;
753 }
754
755 int bn_cmp_words(const BN_ULONG *a, const BN_ULONG *b, int n)
756 {
757     int i;
758     BN_ULONG aa, bb;
759
760     if (n == 0)
761         return 0;
762
763     aa = a[n - 1];
764     bb = b[n - 1];
765     if (aa != bb)
766         return ((aa > bb) ? 1 : -1);
767     for (i = n - 2; i >= 0; i--) {
768         aa = a[i];
769         bb = b[i];
770         if (aa != bb)
771             return ((aa > bb) ? 1 : -1);
772     }
773     return 0;
774 }
775
776 /*
777  * Here follows a specialised variants of bn_cmp_words().  It has the
778  * capability of performing the operation on arrays of different sizes. The
779  * sizes of those arrays is expressed through cl, which is the common length
780  * ( basically, min(len(a),len(b)) ), and dl, which is the delta between the
781  * two lengths, calculated as len(a)-len(b). All lengths are the number of
782  * BN_ULONGs...
783  */
784
785 int bn_cmp_part_words(const BN_ULONG *a, const BN_ULONG *b, int cl, int dl)
786 {
787     int n, i;
788     n = cl - 1;
789
790     if (dl < 0) {
791         for (i = dl; i < 0; i++) {
792             if (b[n - i] != 0)
793                 return -1;      /* a < b */
794         }
795     }
796     if (dl > 0) {
797         for (i = dl; i > 0; i--) {
798             if (a[n + i] != 0)
799                 return 1;       /* a > b */
800         }
801     }
802     return bn_cmp_words(a, b, cl);
803 }
804
805 /*-
806  * Constant-time conditional swap of a and b.
807  * a and b are swapped if condition is not 0.
808  * nwords is the number of words to swap.
809  * Assumes that at least nwords are allocated in both a and b.
810  * Assumes that no more than nwords are used by either a or b.
811  */
812 void BN_consttime_swap(BN_ULONG condition, BIGNUM *a, BIGNUM *b, int nwords)
813 {
814     BN_ULONG t;
815     int i;
816
817     if (a == b)
818         return;
819
820     bn_wcheck_size(a, nwords);
821     bn_wcheck_size(b, nwords);
822
823     condition = ((~condition & ((condition - 1))) >> (BN_BITS2 - 1)) - 1;
824
825     t = (a->top ^ b->top) & condition;
826     a->top ^= t;
827     b->top ^= t;
828
829     t = (a->neg ^ b->neg) & condition;
830     a->neg ^= t;
831     b->neg ^= t;
832
833     /*-
834      * BN_FLG_STATIC_DATA: indicates that data may not be written to. Intention
835      * is actually to treat it as it's read-only data, and some (if not most)
836      * of it does reside in read-only segment. In other words observation of
837      * BN_FLG_STATIC_DATA in BN_consttime_swap should be treated as fatal
838      * condition. It would either cause SEGV or effectively cause data
839      * corruption.
840      *
841      * BN_FLG_MALLOCED: refers to BN structure itself, and hence must be
842      * preserved.
843      *
844      * BN_FLG_SECURE: must be preserved, because it determines how x->d was
845      * allocated and hence how to free it.
846      *
847      * BN_FLG_CONSTTIME: sufficient to mask and swap
848      *
849      * BN_FLG_FIXED_TOP: indicates that we haven't called bn_correct_top() on
850      * the data, so the d array may be padded with additional 0 values (i.e.
851      * top could be greater than the minimal value that it could be). We should
852      * be swapping it
853      */
854
855 #define BN_CONSTTIME_SWAP_FLAGS (BN_FLG_CONSTTIME | BN_FLG_FIXED_TOP)
856
857     t = ((a->flags ^ b->flags) & BN_CONSTTIME_SWAP_FLAGS) & condition;
858     a->flags ^= t;
859     b->flags ^= t;
860
861     /* conditionally swap the data */
862     for (i = 0; i < nwords; i++) {
863         t = (a->d[i] ^ b->d[i]) & condition;
864         a->d[i] ^= t;
865         b->d[i] ^= t;
866     }
867 }
868
869 #undef BN_CONSTTIME_SWAP_FLAGS
870
871 /* Bits of security, see SP800-57 */
872
873 int BN_security_bits(int L, int N)
874 {
875     int secbits, bits;
876     if (L >= 15360)
877         secbits = 256;
878     else if (L >= 7680)
879         secbits = 192;
880     else if (L >= 3072)
881         secbits = 128;
882     else if (L >= 2048)
883         secbits = 112;
884     else if (L >= 1024)
885         secbits = 80;
886     else
887         return 0;
888     if (N == -1)
889         return secbits;
890     bits = N / 2;
891     if (bits < 80)
892         return 0;
893     return bits >= secbits ? secbits : bits;
894 }
895
896 void BN_zero_ex(BIGNUM *a)
897 {
898     a->neg = 0;
899     a->top = 0;
900     a->flags &= ~BN_FLG_FIXED_TOP;
901 }
902
903 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w)
904 {
905     return ((a->top == 1) && (a->d[0] == w)) || ((w == 0) && (a->top == 0));
906 }
907
908 int BN_is_zero(const BIGNUM *a)
909 {
910     return a->top == 0;
911 }
912
913 int BN_is_one(const BIGNUM *a)
914 {
915     return BN_abs_is_word(a, 1) && !a->neg;
916 }
917
918 int BN_is_word(const BIGNUM *a, const BN_ULONG w)
919 {
920     return BN_abs_is_word(a, w) && (!w || !a->neg);
921 }
922
923 int BN_is_odd(const BIGNUM *a)
924 {
925     return (a->top > 0) && (a->d[0] & 1);
926 }
927
928 int BN_is_negative(const BIGNUM *a)
929 {
930     return (a->neg != 0);
931 }
932
933 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
934                      BN_CTX *ctx)
935 {
936     return BN_mod_mul_montgomery(r, a, &(mont->RR), mont, ctx);
937 }
938
939 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags)
940 {
941     dest->d = b->d;
942     dest->top = b->top;
943     dest->dmax = b->dmax;
944     dest->neg = b->neg;
945     dest->flags = ((dest->flags & BN_FLG_MALLOCED)
946                    | (b->flags & ~BN_FLG_MALLOCED)
947                    | BN_FLG_STATIC_DATA | flags);
948 }
949
950 BN_GENCB *BN_GENCB_new(void)
951 {
952     BN_GENCB *ret;
953
954     if ((ret = OPENSSL_malloc(sizeof(*ret))) == NULL) {
955         BNerr(BN_F_BN_GENCB_NEW, ERR_R_MALLOC_FAILURE);
956         return NULL;
957     }
958
959     return ret;
960 }
961
962 void BN_GENCB_free(BN_GENCB *cb)
963 {
964     if (cb == NULL)
965         return;
966     OPENSSL_free(cb);
967 }
968
969 void BN_set_flags(BIGNUM *b, int n)
970 {
971     b->flags |= n;
972 }
973
974 int BN_get_flags(const BIGNUM *b, int n)
975 {
976     return b->flags & n;
977 }
978
979 /* Populate a BN_GENCB structure with an "old"-style callback */
980 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
981                       void *cb_arg)
982 {
983     BN_GENCB *tmp_gencb = gencb;
984     tmp_gencb->ver = 1;
985     tmp_gencb->arg = cb_arg;
986     tmp_gencb->cb.cb_1 = callback;
987 }
988
989 /* Populate a BN_GENCB structure with a "new"-style callback */
990 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
991                   void *cb_arg)
992 {
993     BN_GENCB *tmp_gencb = gencb;
994     tmp_gencb->ver = 2;
995     tmp_gencb->arg = cb_arg;
996     tmp_gencb->cb.cb_2 = callback;
997 }
998
999 void *BN_GENCB_get_arg(BN_GENCB *cb)
1000 {
1001     return cb->arg;
1002 }
1003
1004 BIGNUM *bn_wexpand(BIGNUM *a, int words)
1005 {
1006     return (words <= a->dmax) ? a : bn_expand2(a, words);
1007 }
1008
1009 void bn_correct_top(BIGNUM *a)
1010 {
1011     BN_ULONG *ftl;
1012     int tmp_top = a->top;
1013
1014     if (tmp_top > 0) {
1015         for (ftl = &(a->d[tmp_top]); tmp_top > 0; tmp_top--) {
1016             ftl--;
1017             if (*ftl != 0)
1018                 break;
1019         }
1020         a->top = tmp_top;
1021     }
1022     if (a->top == 0)
1023         a->neg = 0;
1024     a->flags &= ~BN_FLG_FIXED_TOP;
1025     bn_pollute(a);
1026 }