bn/bn_lib.c: add BN_FLG_FIXED_TOP flag.
[openssl.git] / crypto / bn / bn_lib.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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_COMPAT < 0x00908000L
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 int BN_num_bits(const BIGNUM *a)
136 {
137     int i = a->top - 1;
138     bn_check_top(a);
139
140     if (BN_is_zero(a))
141         return 0;
142     return ((i * BN_BITS2) + BN_num_bits_word(a->d[i]));
143 }
144
145 static void bn_free_d(BIGNUM *a)
146 {
147     if (BN_get_flags(a, BN_FLG_SECURE))
148         OPENSSL_secure_free(a->d);
149     else
150         OPENSSL_free(a->d);
151 }
152
153
154 void BN_clear_free(BIGNUM *a)
155 {
156     int i;
157
158     if (a == NULL)
159         return;
160     bn_check_top(a);
161     if (a->d != NULL) {
162         OPENSSL_cleanse(a->d, a->dmax * sizeof(a->d[0]));
163         if (!BN_get_flags(a, BN_FLG_STATIC_DATA))
164             bn_free_d(a);
165     }
166     i = BN_get_flags(a, BN_FLG_MALLOCED);
167     OPENSSL_cleanse(a, sizeof(*a));
168     if (i)
169         OPENSSL_free(a);
170 }
171
172 void BN_free(BIGNUM *a)
173 {
174     if (a == NULL)
175         return;
176     bn_check_top(a);
177     if (!BN_get_flags(a, BN_FLG_STATIC_DATA))
178         bn_free_d(a);
179     if (a->flags & BN_FLG_MALLOCED)
180         OPENSSL_free(a);
181     else {
182 #if OPENSSL_API_COMPAT < 0x00908000L
183         a->flags |= BN_FLG_FREE;
184 #endif
185         a->d = NULL;
186     }
187 }
188
189 void bn_init(BIGNUM *a)
190 {
191     static BIGNUM nilbn;
192
193     *a = nilbn;
194     bn_check_top(a);
195 }
196
197 BIGNUM *BN_new(void)
198 {
199     BIGNUM *ret;
200
201     if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
202         BNerr(BN_F_BN_NEW, ERR_R_MALLOC_FAILURE);
203         return (NULL);
204     }
205     ret->flags = BN_FLG_MALLOCED;
206     bn_check_top(ret);
207     return (ret);
208 }
209
210  BIGNUM *BN_secure_new(void)
211  {
212      BIGNUM *ret = BN_new();
213      if (ret != NULL)
214          ret->flags |= BN_FLG_SECURE;
215      return (ret);
216  }
217
218 /* This is used by bn_expand2() */
219 /* The caller MUST check that words > b->dmax before calling this */
220 static BN_ULONG *bn_expand_internal(const BIGNUM *b, int words)
221 {
222     BN_ULONG *A, *a = NULL;
223     const BN_ULONG *B;
224     int i;
225
226     if (words > (INT_MAX / (4 * BN_BITS2))) {
227         BNerr(BN_F_BN_EXPAND_INTERNAL, BN_R_BIGNUM_TOO_LONG);
228         return NULL;
229     }
230     if (BN_get_flags(b, BN_FLG_STATIC_DATA)) {
231         BNerr(BN_F_BN_EXPAND_INTERNAL, BN_R_EXPAND_ON_STATIC_BIGNUM_DATA);
232         return (NULL);
233     }
234     if (BN_get_flags(b, BN_FLG_SECURE))
235         a = A = OPENSSL_secure_zalloc(words * sizeof(*a));
236     else
237         a = A = OPENSSL_zalloc(words * sizeof(*a));
238     if (A == NULL) {
239         BNerr(BN_F_BN_EXPAND_INTERNAL, ERR_R_MALLOC_FAILURE);
240         return (NULL);
241     }
242
243 #if 1
244     B = b->d;
245     /* Check if the previous number needs to be copied */
246     if (B != NULL) {
247         for (i = b->top >> 2; i > 0; i--, A += 4, B += 4) {
248             /*
249              * The fact that the loop is unrolled
250              * 4-wise is a tribute to Intel. It's
251              * the one that doesn't have enough
252              * registers to accommodate more data.
253              * I'd unroll it 8-wise otherwise:-)
254              *
255              *              <appro@fy.chalmers.se>
256              */
257             BN_ULONG a0, a1, a2, a3;
258             a0 = B[0];
259             a1 = B[1];
260             a2 = B[2];
261             a3 = B[3];
262             A[0] = a0;
263             A[1] = a1;
264             A[2] = a2;
265             A[3] = a3;
266         }
267         switch (b->top & 3) {
268         case 3:
269             A[2] = B[2];
270             /* fall thru */
271         case 2:
272             A[1] = B[1];
273             /* fall thru */
274         case 1:
275             A[0] = B[0];
276             /* fall thru */
277         case 0:
278             /* Without the "case 0" some old optimizers got this wrong. */
279             ;
280         }
281     }
282 #else
283     memset(A, 0, sizeof(*A) * words);
284     memcpy(A, b->d, sizeof(b->d[0]) * b->top);
285 #endif
286
287     return (a);
288 }
289
290 /*
291  * This is an internal function that should not be used in applications. It
292  * ensures that 'b' has enough room for a 'words' word number and initialises
293  * any unused part of b->d with leading zeros. It is mostly used by the
294  * various BIGNUM routines. If there is an error, NULL is returned. If not,
295  * 'b' is returned.
296  */
297
298 BIGNUM *bn_expand2(BIGNUM *b, int words)
299 {
300     if (words > b->dmax) {
301         BN_ULONG *a = bn_expand_internal(b, words);
302         if (!a)
303             return NULL;
304         if (b->d) {
305             OPENSSL_cleanse(b->d, b->dmax * sizeof(b->d[0]));
306             bn_free_d(b);
307         }
308         b->d = a;
309         b->dmax = words;
310     }
311
312     return b;
313 }
314
315 BIGNUM *BN_dup(const BIGNUM *a)
316 {
317     BIGNUM *t;
318
319     if (a == NULL)
320         return NULL;
321     bn_check_top(a);
322
323     t = BN_get_flags(a, BN_FLG_SECURE) ? BN_secure_new() : BN_new();
324     if (t == NULL)
325         return NULL;
326     if (!BN_copy(t, a)) {
327         BN_free(t);
328         return NULL;
329     }
330     bn_check_top(t);
331     return t;
332 }
333
334 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b)
335 {
336     int i;
337     BN_ULONG *A;
338     const BN_ULONG *B;
339
340     bn_check_top(b);
341
342     if (a == b)
343         return (a);
344     if (bn_wexpand(a, b->top) == NULL)
345         return (NULL);
346
347 #if 1
348     A = a->d;
349     B = b->d;
350     for (i = b->top >> 2; i > 0; i--, A += 4, B += 4) {
351         BN_ULONG a0, a1, a2, a3;
352         a0 = B[0];
353         a1 = B[1];
354         a2 = B[2];
355         a3 = B[3];
356         A[0] = a0;
357         A[1] = a1;
358         A[2] = a2;
359         A[3] = a3;
360     }
361     /* ultrix cc workaround, see comments in bn_expand_internal */
362     switch (b->top & 3) {
363     case 3:
364         A[2] = B[2];
365         /* fall thru */
366     case 2:
367         A[1] = B[1];
368         /* fall thru */
369     case 1:
370         A[0] = B[0];
371         /* fall thru */
372     case 0:;
373     }
374 #else
375     memcpy(a->d, b->d, sizeof(b->d[0]) * b->top);
376 #endif
377
378     a->neg = b->neg;
379     a->top = b->top;
380     a->flags |= b->flags & BN_FLG_FIXED_TOP;
381     bn_check_top(a);
382     return (a);
383 }
384
385 #define FLAGS_DATA(flags) ((flags) & (BN_FLG_STATIC_DATA \
386                                     | BN_FLG_CONSTTIME   \
387                                     | BN_FLG_SECURE      \
388                                     | BN_FLG_FIXED_TOP))
389 #define FLAGS_STRUCT(flags) ((flags) & (BN_FLG_MALLOCED))
390
391 void BN_swap(BIGNUM *a, BIGNUM *b)
392 {
393     int flags_old_a, flags_old_b;
394     BN_ULONG *tmp_d;
395     int tmp_top, tmp_dmax, tmp_neg;
396
397     bn_check_top(a);
398     bn_check_top(b);
399
400     flags_old_a = a->flags;
401     flags_old_b = b->flags;
402
403     tmp_d = a->d;
404     tmp_top = a->top;
405     tmp_dmax = a->dmax;
406     tmp_neg = a->neg;
407
408     a->d = b->d;
409     a->top = b->top;
410     a->dmax = b->dmax;
411     a->neg = b->neg;
412
413     b->d = tmp_d;
414     b->top = tmp_top;
415     b->dmax = tmp_dmax;
416     b->neg = tmp_neg;
417
418     a->flags = FLAGS_STRUCT(flags_old_a) | FLAGS_DATA(flags_old_b);
419     b->flags = FLAGS_STRUCT(flags_old_b) | FLAGS_DATA(flags_old_a);
420     bn_check_top(a);
421     bn_check_top(b);
422 }
423
424 void BN_clear(BIGNUM *a)
425 {
426     bn_check_top(a);
427     if (a->d != NULL)
428         OPENSSL_cleanse(a->d, sizeof(*a->d) * a->dmax);
429     a->neg = 0;
430     a->top = 0;
431     a->flags &= ~BN_FLG_FIXED_TOP;
432 }
433
434 BN_ULONG BN_get_word(const BIGNUM *a)
435 {
436     if (a->top > 1)
437         return BN_MASK2;
438     else if (a->top == 1)
439         return a->d[0];
440     /* a->top == 0 */
441     return 0;
442 }
443
444 int BN_set_word(BIGNUM *a, BN_ULONG w)
445 {
446     bn_check_top(a);
447     if (bn_expand(a, (int)sizeof(BN_ULONG) * 8) == NULL)
448         return (0);
449     a->neg = 0;
450     a->d[0] = w;
451     a->top = (w ? 1 : 0);
452     a->flags &= ~BN_FLG_FIXED_TOP;
453     bn_check_top(a);
454     return (1);
455 }
456
457 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret)
458 {
459     unsigned int i, m;
460     unsigned int n;
461     BN_ULONG l;
462     BIGNUM *bn = NULL;
463
464     if (ret == NULL)
465         ret = bn = BN_new();
466     if (ret == NULL)
467         return (NULL);
468     bn_check_top(ret);
469     /* Skip leading zero's. */
470     for ( ; len > 0 && *s == 0; s++, len--)
471         continue;
472     n = len;
473     if (n == 0) {
474         ret->top = 0;
475         return (ret);
476     }
477     i = ((n - 1) / BN_BYTES) + 1;
478     m = ((n - 1) % (BN_BYTES));
479     if (bn_wexpand(ret, (int)i) == NULL) {
480         BN_free(bn);
481         return NULL;
482     }
483     ret->top = i;
484     ret->neg = 0;
485     l = 0;
486     while (n--) {
487         l = (l << 8L) | *(s++);
488         if (m-- == 0) {
489             ret->d[--i] = l;
490             l = 0;
491             m = BN_BYTES - 1;
492         }
493     }
494     /*
495      * need to call this due to clear byte at top if avoiding having the top
496      * bit set (-ve number)
497      */
498     bn_correct_top(ret);
499     return (ret);
500 }
501
502 /* ignore negative */
503 static int bn2binpad(const BIGNUM *a, unsigned char *to, int tolen)
504 {
505     int n;
506     size_t i, inc, lasti, j;
507     BN_ULONG l;
508
509     n = BN_num_bytes(a);
510     if (tolen == -1)
511         tolen = n;
512     else if (tolen < n)
513         return -1;
514
515     if (n == 0) {
516         OPENSSL_cleanse(to, tolen);
517         return tolen;
518     }
519
520     lasti = n - 1;
521     for (i = 0, inc = 1, j = tolen; j > 0;) {
522         l = a->d[i / BN_BYTES];
523         to[--j] = (unsigned char)(l >> (8 * (i % BN_BYTES)) & (0 - inc));
524         inc = (i - lasti) >> (8 * sizeof(i) - 1);
525         i += inc; /* stay on top limb */
526     }
527
528     return tolen;
529 }
530
531 int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen)
532 {
533     if (tolen < 0)
534         return -1;
535     return bn2binpad(a, to, tolen);
536 }
537
538 int BN_bn2bin(const BIGNUM *a, unsigned char *to)
539 {
540     return bn2binpad(a, to, -1);
541 }
542
543 BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret)
544 {
545     unsigned int i, m;
546     unsigned int n;
547     BN_ULONG l;
548     BIGNUM *bn = NULL;
549
550     if (ret == NULL)
551         ret = bn = BN_new();
552     if (ret == NULL)
553         return (NULL);
554     bn_check_top(ret);
555     s += len;
556     /* Skip trailing zeroes. */
557     for ( ; len > 0 && s[-1] == 0; s--, len--)
558         continue;
559     n = len;
560     if (n == 0) {
561         ret->top = 0;
562         return ret;
563     }
564     i = ((n - 1) / BN_BYTES) + 1;
565     m = ((n - 1) % (BN_BYTES));
566     if (bn_wexpand(ret, (int)i) == NULL) {
567         BN_free(bn);
568         return NULL;
569     }
570     ret->top = i;
571     ret->neg = 0;
572     l = 0;
573     while (n--) {
574         s--;
575         l = (l << 8L) | *s;
576         if (m-- == 0) {
577             ret->d[--i] = l;
578             l = 0;
579             m = BN_BYTES - 1;
580         }
581     }
582     /*
583      * need to call this due to clear byte at top if avoiding having the top
584      * bit set (-ve number)
585      */
586     bn_correct_top(ret);
587     return ret;
588 }
589
590 int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen)
591 {
592     int i;
593     BN_ULONG l;
594     bn_check_top(a);
595     i = BN_num_bytes(a);
596     if (tolen < i)
597         return -1;
598     /* Add trailing zeroes if necessary */
599     if (tolen > i)
600         memset(to + i, 0, tolen - i);
601     to += i;
602     while (i--) {
603         l = a->d[i / BN_BYTES];
604         to--;
605         *to = (unsigned char)(l >> (8 * (i % BN_BYTES))) & 0xff;
606     }
607     return tolen;
608 }
609
610 int BN_ucmp(const BIGNUM *a, const BIGNUM *b)
611 {
612     int i;
613     BN_ULONG t1, t2, *ap, *bp;
614
615     bn_check_top(a);
616     bn_check_top(b);
617
618     i = a->top - b->top;
619     if (i != 0)
620         return (i);
621     ap = a->d;
622     bp = b->d;
623     for (i = a->top - 1; i >= 0; i--) {
624         t1 = ap[i];
625         t2 = bp[i];
626         if (t1 != t2)
627             return ((t1 > t2) ? 1 : -1);
628     }
629     return (0);
630 }
631
632 int BN_cmp(const BIGNUM *a, const BIGNUM *b)
633 {
634     int i;
635     int gt, lt;
636     BN_ULONG t1, t2;
637
638     if ((a == NULL) || (b == NULL)) {
639         if (a != NULL)
640             return (-1);
641         else if (b != NULL)
642             return (1);
643         else
644             return (0);
645     }
646
647     bn_check_top(a);
648     bn_check_top(b);
649
650     if (a->neg != b->neg) {
651         if (a->neg)
652             return (-1);
653         else
654             return (1);
655     }
656     if (a->neg == 0) {
657         gt = 1;
658         lt = -1;
659     } else {
660         gt = -1;
661         lt = 1;
662     }
663
664     if (a->top > b->top)
665         return (gt);
666     if (a->top < b->top)
667         return (lt);
668     for (i = a->top - 1; i >= 0; i--) {
669         t1 = a->d[i];
670         t2 = b->d[i];
671         if (t1 > t2)
672             return (gt);
673         if (t1 < t2)
674             return (lt);
675     }
676     return (0);
677 }
678
679 int BN_set_bit(BIGNUM *a, int n)
680 {
681     int i, j, k;
682
683     if (n < 0)
684         return 0;
685
686     i = n / BN_BITS2;
687     j = n % BN_BITS2;
688     if (a->top <= i) {
689         if (bn_wexpand(a, i + 1) == NULL)
690             return (0);
691         for (k = a->top; k < i + 1; k++)
692             a->d[k] = 0;
693         a->top = i + 1;
694         a->flags &= ~BN_FLG_FIXED_TOP;
695     }
696
697     a->d[i] |= (((BN_ULONG)1) << j);
698     bn_check_top(a);
699     return (1);
700 }
701
702 int BN_clear_bit(BIGNUM *a, int n)
703 {
704     int i, j;
705
706     bn_check_top(a);
707     if (n < 0)
708         return 0;
709
710     i = n / BN_BITS2;
711     j = n % BN_BITS2;
712     if (a->top <= i)
713         return (0);
714
715     a->d[i] &= (~(((BN_ULONG)1) << j));
716     bn_correct_top(a);
717     return (1);
718 }
719
720 int BN_is_bit_set(const BIGNUM *a, int n)
721 {
722     int i, j;
723
724     bn_check_top(a);
725     if (n < 0)
726         return 0;
727     i = n / BN_BITS2;
728     j = n % BN_BITS2;
729     if (a->top <= i)
730         return 0;
731     return (int)(((a->d[i]) >> j) & ((BN_ULONG)1));
732 }
733
734 int BN_mask_bits(BIGNUM *a, int n)
735 {
736     int b, w;
737
738     bn_check_top(a);
739     if (n < 0)
740         return 0;
741
742     w = n / BN_BITS2;
743     b = n % BN_BITS2;
744     if (w >= a->top)
745         return 0;
746     if (b == 0)
747         a->top = w;
748     else {
749         a->top = w + 1;
750         a->d[w] &= ~(BN_MASK2 << b);
751     }
752     bn_correct_top(a);
753     return (1);
754 }
755
756 void BN_set_negative(BIGNUM *a, int b)
757 {
758     if (b && !BN_is_zero(a))
759         a->neg = 1;
760     else
761         a->neg = 0;
762 }
763
764 int bn_cmp_words(const BN_ULONG *a, const BN_ULONG *b, int n)
765 {
766     int i;
767     BN_ULONG aa, bb;
768
769     aa = a[n - 1];
770     bb = b[n - 1];
771     if (aa != bb)
772         return ((aa > bb) ? 1 : -1);
773     for (i = n - 2; i >= 0; i--) {
774         aa = a[i];
775         bb = b[i];
776         if (aa != bb)
777             return ((aa > bb) ? 1 : -1);
778     }
779     return (0);
780 }
781
782 /*
783  * Here follows a specialised variants of bn_cmp_words().  It has the
784  * capability of performing the operation on arrays of different sizes. The
785  * sizes of those arrays is expressed through cl, which is the common length
786  * ( basically, min(len(a),len(b)) ), and dl, which is the delta between the
787  * two lengths, calculated as len(a)-len(b). All lengths are the number of
788  * BN_ULONGs...
789  */
790
791 int bn_cmp_part_words(const BN_ULONG *a, const BN_ULONG *b, int cl, int dl)
792 {
793     int n, i;
794     n = cl - 1;
795
796     if (dl < 0) {
797         for (i = dl; i < 0; i++) {
798             if (b[n - i] != 0)
799                 return -1;      /* a < b */
800         }
801     }
802     if (dl > 0) {
803         for (i = dl; i > 0; i--) {
804             if (a[n + i] != 0)
805                 return 1;       /* a > b */
806         }
807     }
808     return bn_cmp_words(a, b, cl);
809 }
810
811 /*
812  * Constant-time conditional swap of a and b.
813  * a and b are swapped if condition is not 0.  The code assumes that at most one bit of condition is set.
814  * nwords is the number of words to swap.  The code assumes that at least nwords are allocated in both a and b,
815  * and that no more than nwords are used by either a or b.
816  * a and b cannot be the same number
817  */
818 void BN_consttime_swap(BN_ULONG condition, BIGNUM *a, BIGNUM *b, int nwords)
819 {
820     BN_ULONG t;
821     int i;
822
823     bn_wcheck_size(a, nwords);
824     bn_wcheck_size(b, nwords);
825
826     assert(a != b);
827     assert((condition & (condition - 1)) == 0);
828     assert(sizeof(BN_ULONG) >= sizeof(int));
829
830     condition = ((condition - 1) >> (BN_BITS2 - 1)) - 1;
831
832     t = (a->top ^ b->top) & condition;
833     a->top ^= t;
834     b->top ^= t;
835
836     t = (a->neg ^ b->neg) & condition;
837     a->neg ^= t;
838     b->neg ^= t;
839
840     /*-
841      * Idea behind BN_FLG_STATIC_DATA is actually to
842      * indicate that data may not be written to.
843      * Intention is actually to treat it as it's
844      * read-only data, and some (if not most) of it does
845      * reside in read-only segment. In other words
846      * observation of BN_FLG_STATIC_DATA in
847      * BN_consttime_swap should be treated as fatal
848      * condition. It would either cause SEGV or
849      * effectively cause data corruption.
850      * BN_FLG_MALLOCED refers to BN structure itself,
851      * and hence must be preserved. Remaining flags are
852      * BN_FLG_CONSTIME and BN_FLG_SECURE. Latter must be
853      * preserved, because it determines how x->d was
854      * allocated and hence how to free it. This leaves
855      * BN_FLG_CONSTTIME that one can do something about.
856      * To summarize it's sufficient to mask and swap
857      * BN_FLG_CONSTTIME alone. BN_FLG_STATIC_DATA should
858      * be treated as fatal.
859      */
860     t = ((a->flags ^ b->flags) & BN_FLG_CONSTTIME) & condition;
861     a->flags ^= t;
862     b->flags ^= t;
863
864 #define BN_CONSTTIME_SWAP(ind) \
865         do { \
866                 t = (a->d[ind] ^ b->d[ind]) & condition; \
867                 a->d[ind] ^= t; \
868                 b->d[ind] ^= t; \
869         } while (0)
870
871     switch (nwords) {
872     default:
873         for (i = 10; i < nwords; i++)
874             BN_CONSTTIME_SWAP(i);
875         /* Fallthrough */
876     case 10:
877         BN_CONSTTIME_SWAP(9);   /* Fallthrough */
878     case 9:
879         BN_CONSTTIME_SWAP(8);   /* Fallthrough */
880     case 8:
881         BN_CONSTTIME_SWAP(7);   /* Fallthrough */
882     case 7:
883         BN_CONSTTIME_SWAP(6);   /* Fallthrough */
884     case 6:
885         BN_CONSTTIME_SWAP(5);   /* Fallthrough */
886     case 5:
887         BN_CONSTTIME_SWAP(4);   /* Fallthrough */
888     case 4:
889         BN_CONSTTIME_SWAP(3);   /* Fallthrough */
890     case 3:
891         BN_CONSTTIME_SWAP(2);   /* Fallthrough */
892     case 2:
893         BN_CONSTTIME_SWAP(1);   /* Fallthrough */
894     case 1:
895         BN_CONSTTIME_SWAP(0);
896     }
897 #undef BN_CONSTTIME_SWAP
898 }
899
900 /* Bits of security, see SP800-57 */
901
902 int BN_security_bits(int L, int N)
903 {
904     int secbits, bits;
905     if (L >= 15360)
906         secbits = 256;
907     else if (L >= 7680)
908         secbits = 192;
909     else if (L >= 3072)
910         secbits = 128;
911     else if (L >= 2048)
912         secbits = 112;
913     else if (L >= 1024)
914         secbits = 80;
915     else
916         return 0;
917     if (N == -1)
918         return secbits;
919     bits = N / 2;
920     if (bits < 80)
921         return 0;
922     return bits >= secbits ? secbits : bits;
923 }
924
925 void BN_zero_ex(BIGNUM *a)
926 {
927     a->neg = 0;
928     a->top = 0;
929     a->flags &= ~BN_FLG_FIXED_TOP;
930 }
931
932 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w)
933 {
934     return ((a->top == 1) && (a->d[0] == w)) || ((w == 0) && (a->top == 0));
935 }
936
937 int BN_is_zero(const BIGNUM *a)
938 {
939     return a->top == 0;
940 }
941
942 int BN_is_one(const BIGNUM *a)
943 {
944     return BN_abs_is_word(a, 1) && !a->neg;
945 }
946
947 int BN_is_word(const BIGNUM *a, const BN_ULONG w)
948 {
949     return BN_abs_is_word(a, w) && (!w || !a->neg);
950 }
951
952 int BN_is_odd(const BIGNUM *a)
953 {
954     return (a->top > 0) && (a->d[0] & 1);
955 }
956
957 int BN_is_negative(const BIGNUM *a)
958 {
959     return (a->neg != 0);
960 }
961
962 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
963                      BN_CTX *ctx)
964 {
965     return BN_mod_mul_montgomery(r, a, &(mont->RR), mont, ctx);
966 }
967
968 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags)
969 {
970     dest->d = b->d;
971     dest->top = b->top;
972     dest->dmax = b->dmax;
973     dest->neg = b->neg;
974     dest->flags = ((dest->flags & BN_FLG_MALLOCED)
975                    | (b->flags & ~BN_FLG_MALLOCED)
976                    | BN_FLG_STATIC_DATA | flags);
977 }
978
979 BN_GENCB *BN_GENCB_new(void)
980 {
981     BN_GENCB *ret;
982
983     if ((ret = OPENSSL_malloc(sizeof(*ret))) == NULL) {
984         BNerr(BN_F_BN_GENCB_NEW, ERR_R_MALLOC_FAILURE);
985         return (NULL);
986     }
987
988     return ret;
989 }
990
991 void BN_GENCB_free(BN_GENCB *cb)
992 {
993     if (cb == NULL)
994         return;
995     OPENSSL_free(cb);
996 }
997
998 void BN_set_flags(BIGNUM *b, int n)
999 {
1000     b->flags |= n;
1001 }
1002
1003 int BN_get_flags(const BIGNUM *b, int n)
1004 {
1005     return b->flags & n;
1006 }
1007
1008 /* Populate a BN_GENCB structure with an "old"-style callback */
1009 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
1010                       void *cb_arg)
1011 {
1012     BN_GENCB *tmp_gencb = gencb;
1013     tmp_gencb->ver = 1;
1014     tmp_gencb->arg = cb_arg;
1015     tmp_gencb->cb.cb_1 = callback;
1016 }
1017
1018 /* Populate a BN_GENCB structure with a "new"-style callback */
1019 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
1020                   void *cb_arg)
1021 {
1022     BN_GENCB *tmp_gencb = gencb;
1023     tmp_gencb->ver = 2;
1024     tmp_gencb->arg = cb_arg;
1025     tmp_gencb->cb.cb_2 = callback;
1026 }
1027
1028 void *BN_GENCB_get_arg(BN_GENCB *cb)
1029 {
1030     return cb->arg;
1031 }
1032
1033 BIGNUM *bn_wexpand(BIGNUM *a, int words)
1034 {
1035     return (words <= a->dmax) ? a : bn_expand2(a, words);
1036 }
1037
1038 void bn_correct_top(BIGNUM *a)
1039 {
1040     BN_ULONG *ftl;
1041     int tmp_top = a->top;
1042
1043     if (tmp_top > 0) {
1044         for (ftl = &(a->d[tmp_top]); tmp_top > 0; tmp_top--) {
1045             ftl--;
1046             if (*ftl != 0)
1047                 break;
1048         }
1049         a->top = tmp_top;
1050     }
1051     if (a->top == 0)
1052         a->neg = 0;
1053     a->flags &= ~BN_FLG_FIXED_TOP;
1054     bn_pollute(a);
1055 }