xref: /freebsd/crypto/openssl/crypto/bio/bio_dump.c (revision e7be843b4a162e68651d3911f0357ed464915629)
1 /*
2  * Copyright 1995-2025 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 /*
11  * Stolen from tjh's ssl/ssl_trc.c stuff.
12  */
13 
14 #include <stdio.h>
15 #include "bio_local.h"
16 
17 #define DUMP_WIDTH      16
18 #define DUMP_WIDTH_LESS_INDENT(i) (DUMP_WIDTH - ((i - (i > 6 ? 6 : i) + 3) / 4))
19 
20 #define SPACE(buf, pos, n)   (sizeof(buf) - (pos) > (n))
21 
BIO_dump_cb(int (* cb)(const void * data,size_t len,void * u),void * u,const void * s,int len)22 int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
23                 void *u, const void *s, int len)
24 {
25     return BIO_dump_indent_cb(cb, u, s, len, 0);
26 }
27 
BIO_dump_indent_cb(int (* cb)(const void * data,size_t len,void * u),void * u,const void * v,int len,int indent)28 int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
29                        void *u, const void *v, int len, int indent)
30 {
31     const unsigned char *s = v;
32     int res, ret = 0;
33     char buf[288 + 1];
34     int i, j, rows, n;
35     unsigned char ch;
36     int dump_width;
37 
38     if (indent < 0)
39         indent = 0;
40     else if (indent > 64)
41         indent = 64;
42 
43     dump_width = DUMP_WIDTH_LESS_INDENT(indent);
44     rows = len / dump_width;
45     if ((rows * dump_width) < len)
46         rows++;
47     for (i = 0; i < rows; i++) {
48         n = BIO_snprintf(buf, sizeof(buf), "%*s%04x - ", indent, "",
49                          i * dump_width);
50         if (n < 0)
51             return -1;
52         for (j = 0; j < dump_width; j++) {
53             if (SPACE(buf, n, 3)) {
54                 if (((i * dump_width) + j) >= len) {
55                     strcpy(buf + n, "   ");
56                 } else {
57                     ch = *(s + i * dump_width + j) & 0xff;
58                     BIO_snprintf(buf + n, 4, "%02x%c", ch,
59                                  j == 7 ? '-' : ' ');
60                 }
61                 n += 3;
62             }
63         }
64         if (SPACE(buf, n, 2)) {
65             strcpy(buf + n, "  ");
66             n += 2;
67         }
68         for (j = 0; j < dump_width; j++) {
69             if (((i * dump_width) + j) >= len)
70                 break;
71             if (SPACE(buf, n, 1)) {
72                 ch = *(s + i * dump_width + j) & 0xff;
73 #ifndef CHARSET_EBCDIC
74                 buf[n++] = ((ch >= ' ') && (ch <= '~')) ? ch : '.';
75 #else
76                 buf[n++] = ((ch >= os_toascii[' ']) && (ch <= os_toascii['~']))
77                            ? os_toebcdic[ch]
78                            : '.';
79 #endif
80                 buf[n] = '\0';
81             }
82         }
83         if (SPACE(buf, n, 1)) {
84             buf[n++] = '\n';
85             buf[n] = '\0';
86         }
87         /*
88          * if this is the last call then update the ddt_dump thing so that we
89          * will move the selection point in the debug window
90          */
91         res = cb((void *)buf, n, u);
92         if (res < 0)
93             return res;
94         ret += res;
95     }
96     return ret;
97 }
98 
99 #ifndef OPENSSL_NO_STDIO
write_fp(const void * data,size_t len,void * fp)100 static int write_fp(const void *data, size_t len, void *fp)
101 {
102     return UP_fwrite(data, len, 1, fp);
103 }
104 
BIO_dump_fp(FILE * fp,const void * s,int len)105 int BIO_dump_fp(FILE *fp, const void *s, int len)
106 {
107     return BIO_dump_cb(write_fp, fp, s, len);
108 }
109 
BIO_dump_indent_fp(FILE * fp,const void * s,int len,int indent)110 int BIO_dump_indent_fp(FILE *fp, const void *s, int len, int indent)
111 {
112     return BIO_dump_indent_cb(write_fp, fp, s, len, indent);
113 }
114 #endif
115 
write_bio(const void * data,size_t len,void * bp)116 static int write_bio(const void *data, size_t len, void *bp)
117 {
118     return BIO_write((BIO *)bp, (const char *)data, len);
119 }
120 
BIO_dump(BIO * bp,const void * s,int len)121 int BIO_dump(BIO *bp, const void *s, int len)
122 {
123     return BIO_dump_cb(write_bio, bp, s, len);
124 }
125 
BIO_dump_indent(BIO * bp,const void * s,int len,int indent)126 int BIO_dump_indent(BIO *bp, const void *s, int len, int indent)
127 {
128     return BIO_dump_indent_cb(write_bio, bp, s, len, indent);
129 }
130 
BIO_hex_string(BIO * out,int indent,int width,const void * data,int datalen)131 int BIO_hex_string(BIO *out, int indent, int width, const void *data,
132                    int datalen)
133 {
134     const unsigned char *d = data;
135     int i, j = 0;
136 
137     if (datalen < 1)
138         return 1;
139 
140     for (i = 0; i < datalen - 1; i++) {
141         if (i && !j)
142             BIO_printf(out, "%*s", indent, "");
143 
144         BIO_printf(out, "%02X:", d[i]);
145 
146         if (++j >= width) {
147             j = 0;
148             BIO_printf(out, "\n");
149         }
150     }
151 
152     if (i && !j)
153         BIO_printf(out, "%*s", indent, "");
154     BIO_printf(out, "%02X", d[datalen - 1]);
155     return 1;
156 }
157