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