8c574e164eb10c07b264bdc7df0e6b99ad4f0257
[openssl.git] / crypto / bio / b_print.c
1 /*
2  * Copyright 1995-2016 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 <stdio.h>
11 #include <string.h>
12 #include <ctype.h>
13 #include <assert.h>
14 #include <limits.h>
15 #include "internal/cryptlib.h"
16 #ifndef NO_SYS_TYPES_H
17 # include <sys/types.h>
18 #endif
19 #include <openssl/bn.h>         /* To get BN_LLONG properly defined */
20 #include <openssl/bio.h>
21
22 #if defined(BN_LLONG) || defined(SIXTY_FOUR_BIT)
23 # ifndef HAVE_LONG_LONG
24 #  define HAVE_LONG_LONG 1
25 # endif
26 #endif
27
28 /*
29  * Copyright Patrick Powell 1995
30  * This code is based on code written by Patrick Powell <papowell@astart.com>
31  * It may be used for any purpose as long as this notice remains intact
32  * on all source code distributions.
33  */
34
35 #ifdef HAVE_LONG_DOUBLE
36 # define LDOUBLE long double
37 #else
38 # define LDOUBLE double
39 #endif
40
41 #ifdef HAVE_LONG_LONG
42 # if defined(_WIN32) && !defined(__GNUC__)
43 #  define LLONG __int64
44 # else
45 #  define LLONG long long
46 # endif
47 #else
48 # define LLONG long
49 #endif
50
51 static int fmtstr(char **, char **, size_t *, size_t *,
52                   const char *, int, int, int);
53 static int fmtint(char **, char **, size_t *, size_t *,
54                   LLONG, int, int, int, int);
55 static int fmtfp(char **, char **, size_t *, size_t *,
56                  LDOUBLE, int, int, int);
57 static int doapr_outch(char **, char **, size_t *, size_t *, int);
58 static int _dopr(char **sbuffer, char **buffer,
59                  size_t *maxlen, size_t *retlen, int *truncated,
60                  const char *format, va_list args);
61
62 /* format read states */
63 #define DP_S_DEFAULT    0
64 #define DP_S_FLAGS      1
65 #define DP_S_MIN        2
66 #define DP_S_DOT        3
67 #define DP_S_MAX        4
68 #define DP_S_MOD        5
69 #define DP_S_CONV       6
70 #define DP_S_DONE       7
71
72 /* format flags - Bits */
73 #define DP_F_MINUS      (1 << 0)
74 #define DP_F_PLUS       (1 << 1)
75 #define DP_F_SPACE      (1 << 2)
76 #define DP_F_NUM        (1 << 3)
77 #define DP_F_ZERO       (1 << 4)
78 #define DP_F_UP         (1 << 5)
79 #define DP_F_UNSIGNED   (1 << 6)
80
81 /* conversion flags */
82 #define DP_C_SHORT      1
83 #define DP_C_LONG       2
84 #define DP_C_LDOUBLE    3
85 #define DP_C_LLONG      4
86
87 /* some handy macros */
88 #define char_to_int(p) (p - '0')
89 #define OSSL_MAX(p,q) ((p >= q) ? p : q)
90
91 static int
92 _dopr(char **sbuffer,
93       char **buffer,
94       size_t *maxlen,
95       size_t *retlen, int *truncated, const char *format, va_list args)
96 {
97     char ch;
98     LLONG value;
99     LDOUBLE fvalue;
100     char *strvalue;
101     int min;
102     int max;
103     int state;
104     int flags;
105     int cflags;
106     size_t currlen;
107
108     state = DP_S_DEFAULT;
109     flags = currlen = cflags = min = 0;
110     max = -1;
111     ch = *format++;
112
113     while (state != DP_S_DONE) {
114         if (ch == '\0' || (buffer == NULL && currlen >= *maxlen))
115             state = DP_S_DONE;
116
117         switch (state) {
118         case DP_S_DEFAULT:
119             if (ch == '%')
120                 state = DP_S_FLAGS;
121             else
122                 if(!doapr_outch(sbuffer, buffer, &currlen, maxlen, ch))
123                     return 0;
124             ch = *format++;
125             break;
126         case DP_S_FLAGS:
127             switch (ch) {
128             case '-':
129                 flags |= DP_F_MINUS;
130                 ch = *format++;
131                 break;
132             case '+':
133                 flags |= DP_F_PLUS;
134                 ch = *format++;
135                 break;
136             case ' ':
137                 flags |= DP_F_SPACE;
138                 ch = *format++;
139                 break;
140             case '#':
141                 flags |= DP_F_NUM;
142                 ch = *format++;
143                 break;
144             case '0':
145                 flags |= DP_F_ZERO;
146                 ch = *format++;
147                 break;
148             default:
149                 state = DP_S_MIN;
150                 break;
151             }
152             break;
153         case DP_S_MIN:
154             if (isdigit((unsigned char)ch)) {
155                 min = 10 * min + char_to_int(ch);
156                 ch = *format++;
157             } else if (ch == '*') {
158                 min = va_arg(args, int);
159                 ch = *format++;
160                 state = DP_S_DOT;
161             } else
162                 state = DP_S_DOT;
163             break;
164         case DP_S_DOT:
165             if (ch == '.') {
166                 state = DP_S_MAX;
167                 ch = *format++;
168             } else
169                 state = DP_S_MOD;
170             break;
171         case DP_S_MAX:
172             if (isdigit((unsigned char)ch)) {
173                 if (max < 0)
174                     max = 0;
175                 max = 10 * max + char_to_int(ch);
176                 ch = *format++;
177             } else if (ch == '*') {
178                 max = va_arg(args, int);
179                 ch = *format++;
180                 state = DP_S_MOD;
181             } else
182                 state = DP_S_MOD;
183             break;
184         case DP_S_MOD:
185             switch (ch) {
186             case 'h':
187                 cflags = DP_C_SHORT;
188                 ch = *format++;
189                 break;
190             case 'l':
191                 if (*format == 'l') {
192                     cflags = DP_C_LLONG;
193                     format++;
194                 } else
195                     cflags = DP_C_LONG;
196                 ch = *format++;
197                 break;
198             case 'q':
199                 cflags = DP_C_LLONG;
200                 ch = *format++;
201                 break;
202             case 'L':
203                 cflags = DP_C_LDOUBLE;
204                 ch = *format++;
205                 break;
206             default:
207                 break;
208             }
209             state = DP_S_CONV;
210             break;
211         case DP_S_CONV:
212             switch (ch) {
213             case 'd':
214             case 'i':
215                 switch (cflags) {
216                 case DP_C_SHORT:
217                     value = (short int)va_arg(args, int);
218                     break;
219                 case DP_C_LONG:
220                     value = va_arg(args, long int);
221                     break;
222                 case DP_C_LLONG:
223                     value = va_arg(args, LLONG);
224                     break;
225                 default:
226                     value = va_arg(args, int);
227                     break;
228                 }
229                 if (!fmtint(sbuffer, buffer, &currlen, maxlen, value, 10, min,
230                             max, flags))
231                     return 0;
232                 break;
233             case 'X':
234                 flags |= DP_F_UP;
235                 /* FALLTHROUGH */
236             case 'x':
237             case 'o':
238             case 'u':
239                 flags |= DP_F_UNSIGNED;
240                 switch (cflags) {
241                 case DP_C_SHORT:
242                     value = (unsigned short int)va_arg(args, unsigned int);
243                     break;
244                 case DP_C_LONG:
245                     value = (LLONG) va_arg(args, unsigned long int);
246                     break;
247                 case DP_C_LLONG:
248                     value = va_arg(args, unsigned LLONG);
249                     break;
250                 default:
251                     value = (LLONG) va_arg(args, unsigned int);
252                     break;
253                 }
254                 if (!fmtint(sbuffer, buffer, &currlen, maxlen, value,
255                             ch == 'o' ? 8 : (ch == 'u' ? 10 : 16),
256                             min, max, flags))
257                     return 0;
258                 break;
259             case 'f':
260                 if (cflags == DP_C_LDOUBLE)
261                     fvalue = va_arg(args, LDOUBLE);
262                 else
263                     fvalue = va_arg(args, double);
264                 if (!fmtfp(sbuffer, buffer, &currlen, maxlen, fvalue, min, max,
265                            flags))
266                     return 0;
267                 break;
268             case 'E':
269                 flags |= DP_F_UP;
270             case 'e':
271                 if (cflags == DP_C_LDOUBLE)
272                     fvalue = va_arg(args, LDOUBLE);
273                 else
274                     fvalue = va_arg(args, double);
275                 break;
276             case 'G':
277                 flags |= DP_F_UP;
278             case 'g':
279                 if (cflags == DP_C_LDOUBLE)
280                     fvalue = va_arg(args, LDOUBLE);
281                 else
282                     fvalue = va_arg(args, double);
283                 break;
284             case 'c':
285                 if(!doapr_outch(sbuffer, buffer, &currlen, maxlen,
286                             va_arg(args, int)))
287                     return 0;
288                 break;
289             case 's':
290                 strvalue = va_arg(args, char *);
291                 if (max < 0) {
292                     if (buffer)
293                         max = INT_MAX;
294                     else
295                         max = *maxlen;
296                 }
297                 if (!fmtstr(sbuffer, buffer, &currlen, maxlen, strvalue,
298                             flags, min, max))
299                     return 0;
300                 break;
301             case 'p':
302                 value = (size_t)va_arg(args, void *);
303                 if (!fmtint(sbuffer, buffer, &currlen, maxlen,
304                             value, 16, min, max, flags | DP_F_NUM))
305                     return 0;
306                 break;
307             case 'n':          /* XXX */
308                 if (cflags == DP_C_SHORT) {
309                     short int *num;
310                     num = va_arg(args, short int *);
311                     *num = currlen;
312                 } else if (cflags == DP_C_LONG) { /* XXX */
313                     long int *num;
314                     num = va_arg(args, long int *);
315                     *num = (long int)currlen;
316                 } else if (cflags == DP_C_LLONG) { /* XXX */
317                     LLONG *num;
318                     num = va_arg(args, LLONG *);
319                     *num = (LLONG) currlen;
320                 } else {
321                     int *num;
322                     num = va_arg(args, int *);
323                     *num = currlen;
324                 }
325                 break;
326             case '%':
327                 if(!doapr_outch(sbuffer, buffer, &currlen, maxlen, ch))
328                     return 0;
329                 break;
330             case 'w':
331                 /* not supported yet, treat as next char */
332                 ch = *format++;
333                 break;
334             default:
335                 /* unknown, skip */
336                 break;
337             }
338             ch = *format++;
339             state = DP_S_DEFAULT;
340             flags = cflags = min = 0;
341             max = -1;
342             break;
343         case DP_S_DONE:
344             break;
345         default:
346             break;
347         }
348     }
349     *truncated = (currlen > *maxlen - 1);
350     if (*truncated)
351         currlen = *maxlen - 1;
352     if(!doapr_outch(sbuffer, buffer, &currlen, maxlen, '\0'))
353         return 0;
354     *retlen = currlen - 1;
355     return 1;
356 }
357
358 static int
359 fmtstr(char **sbuffer,
360        char **buffer,
361        size_t *currlen,
362        size_t *maxlen, const char *value, int flags, int min, int max)
363 {
364     int padlen;
365     size_t strln;
366     int cnt = 0;
367
368     if (value == 0)
369         value = "<NULL>";
370
371     strln = strlen(value);
372     if (strln > INT_MAX)
373         strln = INT_MAX;
374
375     padlen = min - strln;
376     if (min < 0 || padlen < 0)
377         padlen = 0;
378     if (flags & DP_F_MINUS)
379         padlen = -padlen;
380
381     while ((padlen > 0) && (cnt < max)) {
382         if(!doapr_outch(sbuffer, buffer, currlen, maxlen, ' '))
383             return 0;
384         --padlen;
385         ++cnt;
386     }
387     while (*value && (cnt < max)) {
388         if(!doapr_outch(sbuffer, buffer, currlen, maxlen, *value++))
389             return 0;
390         ++cnt;
391     }
392     while ((padlen < 0) && (cnt < max)) {
393         if(!doapr_outch(sbuffer, buffer, currlen, maxlen, ' '))
394             return 0;
395         ++padlen;
396         ++cnt;
397     }
398     return 1;
399 }
400
401 static int
402 fmtint(char **sbuffer,
403        char **buffer,
404        size_t *currlen,
405        size_t *maxlen, LLONG value, int base, int min, int max, int flags)
406 {
407     int signvalue = 0;
408     const char *prefix = "";
409     unsigned LLONG uvalue;
410     char convert[DECIMAL_SIZE(value) + 3];
411     int place = 0;
412     int spadlen = 0;
413     int zpadlen = 0;
414     int caps = 0;
415
416     if (max < 0)
417         max = 0;
418     uvalue = value;
419     if (!(flags & DP_F_UNSIGNED)) {
420         if (value < 0) {
421             signvalue = '-';
422             uvalue = -value;
423         } else if (flags & DP_F_PLUS)
424             signvalue = '+';
425         else if (flags & DP_F_SPACE)
426             signvalue = ' ';
427     }
428     if (flags & DP_F_NUM) {
429         if (base == 8)
430             prefix = "0";
431         if (base == 16)
432             prefix = "0x";
433     }
434     if (flags & DP_F_UP)
435         caps = 1;
436     do {
437         convert[place++] = (caps ? "0123456789ABCDEF" : "0123456789abcdef")
438             [uvalue % (unsigned)base];
439         uvalue = (uvalue / (unsigned)base);
440     } while (uvalue && (place < (int)sizeof(convert)));
441     if (place == sizeof(convert))
442         place--;
443     convert[place] = 0;
444
445     zpadlen = max - place;
446     spadlen =
447         min - OSSL_MAX(max, place) - (signvalue ? 1 : 0) - strlen(prefix);
448     if (zpadlen < 0)
449         zpadlen = 0;
450     if (spadlen < 0)
451         spadlen = 0;
452     if (flags & DP_F_ZERO) {
453         zpadlen = OSSL_MAX(zpadlen, spadlen);
454         spadlen = 0;
455     }
456     if (flags & DP_F_MINUS)
457         spadlen = -spadlen;
458
459     /* spaces */
460     while (spadlen > 0) {
461         if(!doapr_outch(sbuffer, buffer, currlen, maxlen, ' '))
462             return 0;
463         --spadlen;
464     }
465
466     /* sign */
467     if (signvalue)
468         if(!doapr_outch(sbuffer, buffer, currlen, maxlen, signvalue))
469             return 0;
470
471     /* prefix */
472     while (*prefix) {
473         if(!doapr_outch(sbuffer, buffer, currlen, maxlen, *prefix))
474             return 0;
475         prefix++;
476     }
477
478     /* zeros */
479     if (zpadlen > 0) {
480         while (zpadlen > 0) {
481             if(!doapr_outch(sbuffer, buffer, currlen, maxlen, '0'))
482                 return 0;
483             --zpadlen;
484         }
485     }
486     /* digits */
487     while (place > 0) {
488         if (!doapr_outch(sbuffer, buffer, currlen, maxlen, convert[--place]))
489             return 0;
490     }
491
492     /* left justified spaces */
493     while (spadlen < 0) {
494         if (!doapr_outch(sbuffer, buffer, currlen, maxlen, ' '))
495             return 0;
496         ++spadlen;
497     }
498     return 1;
499 }
500
501 static LDOUBLE abs_val(LDOUBLE value)
502 {
503     LDOUBLE result = value;
504     if (value < 0)
505         result = -value;
506     return result;
507 }
508
509 static LDOUBLE pow_10(int in_exp)
510 {
511     LDOUBLE result = 1;
512     while (in_exp) {
513         result *= 10;
514         in_exp--;
515     }
516     return result;
517 }
518
519 static long roundv(LDOUBLE value)
520 {
521     long intpart;
522     intpart = (long)value;
523     value = value - intpart;
524     if (value >= 0.5)
525         intpart++;
526     return intpart;
527 }
528
529 static int
530 fmtfp(char **sbuffer,
531       char **buffer,
532       size_t *currlen,
533       size_t *maxlen, LDOUBLE fvalue, int min, int max, int flags)
534 {
535     int signvalue = 0;
536     LDOUBLE ufvalue;
537     char iconvert[20];
538     char fconvert[20];
539     int iplace = 0;
540     int fplace = 0;
541     int padlen = 0;
542     int zpadlen = 0;
543     long intpart;
544     long fracpart;
545     long max10;
546
547     if (max < 0)
548         max = 6;
549     ufvalue = abs_val(fvalue);
550     if (fvalue < 0)
551         signvalue = '-';
552     else if (flags & DP_F_PLUS)
553         signvalue = '+';
554     else if (flags & DP_F_SPACE)
555         signvalue = ' ';
556
557     intpart = (long)ufvalue;
558
559     /*
560      * sorry, we only support 9 digits past the decimal because of our
561      * conversion method
562      */
563     if (max > 9)
564         max = 9;
565
566     /*
567      * we "cheat" by converting the fractional part to integer by multiplying
568      * by a factor of 10
569      */
570     max10 = roundv(pow_10(max));
571     fracpart = roundv(pow_10(max) * (ufvalue - intpart));
572
573     if (fracpart >= max10) {
574         intpart++;
575         fracpart -= max10;
576     }
577
578     /* convert integer part */
579     do {
580         iconvert[iplace++] = "0123456789"[intpart % 10];
581         intpart = (intpart / 10);
582     } while (intpart && (iplace < (int)sizeof(iconvert)));
583     if (iplace == sizeof iconvert)
584         iplace--;
585     iconvert[iplace] = 0;
586
587     /* convert fractional part */
588     do {
589         fconvert[fplace++] = "0123456789"[fracpart % 10];
590         fracpart = (fracpart / 10);
591     } while (fplace < max);
592     if (fplace == sizeof fconvert)
593         fplace--;
594     fconvert[fplace] = 0;
595
596     /* -1 for decimal point, another -1 if we are printing a sign */
597     padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
598     zpadlen = max - fplace;
599     if (zpadlen < 0)
600         zpadlen = 0;
601     if (padlen < 0)
602         padlen = 0;
603     if (flags & DP_F_MINUS)
604         padlen = -padlen;
605
606     if ((flags & DP_F_ZERO) && (padlen > 0)) {
607         if (signvalue) {
608             if (!doapr_outch(sbuffer, buffer, currlen, maxlen, signvalue))
609                 return 0;
610             --padlen;
611             signvalue = 0;
612         }
613         while (padlen > 0) {
614             if (!doapr_outch(sbuffer, buffer, currlen, maxlen, '0'))
615                 return 0;
616             --padlen;
617         }
618     }
619     while (padlen > 0) {
620         if (!doapr_outch(sbuffer, buffer, currlen, maxlen, ' '))
621             return 0;
622         --padlen;
623     }
624     if (signvalue && !doapr_outch(sbuffer, buffer, currlen, maxlen, signvalue))
625         return 0;
626
627     while (iplace > 0) {
628         if (!doapr_outch(sbuffer, buffer, currlen, maxlen, iconvert[--iplace]))
629             return 0;
630     }
631
632     /*
633      * Decimal point. This should probably use locale to find the correct
634      * char to print out.
635      */
636     if (max > 0 || (flags & DP_F_NUM)) {
637         if (!doapr_outch(sbuffer, buffer, currlen, maxlen, '.'))
638             return 0;
639
640         while (fplace > 0) {
641             if(!doapr_outch(sbuffer, buffer, currlen, maxlen,
642                             fconvert[--fplace]))
643                 return 0;
644         }
645     }
646     while (zpadlen > 0) {
647         if (!doapr_outch(sbuffer, buffer, currlen, maxlen, '0'))
648             return 0;
649         --zpadlen;
650     }
651
652     while (padlen < 0) {
653         if (!doapr_outch(sbuffer, buffer, currlen, maxlen, ' '))
654             return 0;
655         ++padlen;
656     }
657     return 1;
658 }
659
660 #define BUFFER_INC  1024
661
662 static int
663 doapr_outch(char **sbuffer,
664             char **buffer, size_t *currlen, size_t *maxlen, int c)
665 {
666     /* If we haven't at least one buffer, someone has doe a big booboo */
667     assert(*sbuffer != NULL || buffer != NULL);
668
669     /* |currlen| must always be <= |*maxlen| */
670     assert(*currlen <= *maxlen);
671
672     if (buffer && *currlen == *maxlen) {
673         if (*maxlen > INT_MAX - BUFFER_INC)
674             return 0;
675
676         *maxlen += BUFFER_INC;
677         if (*buffer == NULL) {
678             *buffer = OPENSSL_malloc(*maxlen);
679             if (*buffer == NULL)
680                 return 0;
681             if (*currlen > 0) {
682                 assert(*sbuffer != NULL);
683                 memcpy(*buffer, *sbuffer, *currlen);
684             }
685             *sbuffer = NULL;
686         } else {
687             char *tmpbuf;
688             tmpbuf = OPENSSL_realloc(*buffer, *maxlen);
689             if (tmpbuf == NULL)
690                 return 0;
691             *buffer = tmpbuf;
692         }
693     }
694
695     if (*currlen < *maxlen) {
696         if (*sbuffer)
697             (*sbuffer)[(*currlen)++] = (char)c;
698         else
699             (*buffer)[(*currlen)++] = (char)c;
700     }
701
702     return 1;
703 }
704
705 /***************************************************************************/
706
707 int BIO_printf(BIO *bio, const char *format, ...)
708 {
709     va_list args;
710     int ret;
711
712     va_start(args, format);
713
714     ret = BIO_vprintf(bio, format, args);
715
716     va_end(args);
717     return (ret);
718 }
719
720 int BIO_vprintf(BIO *bio, const char *format, va_list args)
721 {
722     int ret;
723     size_t retlen;
724     char hugebuf[1024 * 2];     /* Was previously 10k, which is unreasonable
725                                  * in small-stack environments, like threads
726                                  * or DOS programs. */
727     char *hugebufp = hugebuf;
728     size_t hugebufsize = sizeof(hugebuf);
729     char *dynbuf = NULL;
730     int ignored;
731
732     dynbuf = NULL;
733     if (!_dopr(&hugebufp, &dynbuf, &hugebufsize, &retlen, &ignored, format,
734                 args)) {
735         OPENSSL_free(dynbuf);
736         return -1;
737     }
738     if (dynbuf) {
739         ret = BIO_write(bio, dynbuf, (int)retlen);
740         OPENSSL_free(dynbuf);
741     } else {
742         ret = BIO_write(bio, hugebuf, (int)retlen);
743     }
744     return (ret);
745 }
746
747 /*
748  * As snprintf is not available everywhere, we provide our own
749  * implementation. This function has nothing to do with BIOs, but it's
750  * closely related to BIO_printf, and we need *some* name prefix ... (XXX the
751  * function should be renamed, but to what?)
752  */
753 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
754 {
755     va_list args;
756     int ret;
757
758     va_start(args, format);
759
760     ret = BIO_vsnprintf(buf, n, format, args);
761
762     va_end(args);
763     return (ret);
764 }
765
766 int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
767 {
768     size_t retlen;
769     int truncated;
770
771     if(!_dopr(&buf, NULL, &n, &retlen, &truncated, format, args))
772         return -1;
773
774     if (truncated)
775         /*
776          * In case of truncation, return -1 like traditional snprintf.
777          * (Current drafts for ISO/IEC 9899 say snprintf should return the
778          * number of characters that would have been written, had the buffer
779          * been large enough.)
780          */
781         return -1;
782     else
783         return (retlen <= INT_MAX) ? (int)retlen : -1;
784 }