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