xref: /openbsd-src/lib/libcrypto/bio/b_dump.c (revision 1ad61ae0a79a724d2d3ec69e69c8e1d1ff6b53a0)
1 /* $OpenBSD: b_dump.c,v 1.26 2023/07/29 02:32:00 tb Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 /*
60  * Stolen from tjh's ssl/ssl_trc.c stuff.
61  */
62 
63 #include <stdio.h>
64 #include <string.h>
65 
66 #include <openssl/bio.h>
67 
68 #define TRUNCATE
69 #define DUMP_WIDTH	16
70 #define DUMP_WIDTH_LESS_INDENT(i) (DUMP_WIDTH - ((i - (i > 6 ? 6 : i) + 3) / 4))
71 
72 int
73 BIO_dump_cb(int (*cb)(const void *data, size_t len, void *u),
74     void *u, const char *s, int len)
75 {
76 	return BIO_dump_indent_cb(cb, u, s, len, 0);
77 }
78 
79 int
80 BIO_dump_indent_cb(int (*cb)(const void *data, size_t len, void *u),
81     void *u, const char *s, int len, int indent)
82 {
83 	char buf[288 + 1], tmp[20], str[128 + 1];
84 	int i, j, rows, trc, written;
85 	unsigned char ch;
86 	int dump_width;
87 	int ret = 0;
88 
89 	trc = 0;
90 
91 #ifdef TRUNCATE
92 	for (; (len > 0) && ((s[len - 1] == ' ') || (s[len - 1] == '\0')); len--)
93 		trc++;
94 #endif
95 
96 	if (indent < 0)
97 		indent = 0;
98 	if (indent > 64)
99 		indent = 64;
100 	memset(str, ' ', indent);
101 	str[indent] = '\0';
102 
103 	if ((dump_width = DUMP_WIDTH_LESS_INDENT(indent)) <= 0)
104 		return -1;
105 	rows = (len / dump_width);
106 	if ((rows * dump_width) < len)
107 		rows++;
108 	for (i = 0; i < rows; i++) {
109 		strlcpy(buf, str, sizeof buf);
110 		snprintf(tmp, sizeof tmp, "%04x - ", i*dump_width);
111 		strlcat(buf, tmp, sizeof buf);
112 		for (j = 0; j < dump_width; j++) {
113 			if (((i*dump_width) + j) >= len) {
114 				strlcat(buf, "   ", sizeof buf);
115 			} else {
116 				ch = ((unsigned char)*(s + i*dump_width + j)) & 0xff;
117 				snprintf(tmp, sizeof tmp, "%02x%c", ch,
118 				    j == 7 ? '-' : ' ');
119 				strlcat(buf, tmp, sizeof buf);
120 			}
121 		}
122 		strlcat(buf, "  ", sizeof buf);
123 		for (j = 0; j < dump_width; j++) {
124 			if (((i*dump_width) + j) >= len)
125 				break;
126 			ch = ((unsigned char)*(s + i * dump_width + j)) & 0xff;
127 			snprintf(tmp, sizeof tmp, "%c",
128 			    ((ch >= ' ') && (ch <= '~')) ? ch : '.');
129 			strlcat(buf, tmp, sizeof buf);
130 		}
131 		strlcat(buf, "\n", sizeof buf);
132 		/* if this is the last call then update the ddt_dump thing so
133 		 * that we will move the selection point in the debug window
134 		 */
135 		if ((written = cb((void *)buf, strlen(buf), u)) < 0)
136 			return -1;
137 		ret += written;
138 
139 	}
140 #ifdef TRUNCATE
141 	if (trc > 0) {
142 		snprintf(buf, sizeof buf, "%s%04x - <SPACES/NULS>\n",
143 		    str, len + trc);
144 		if ((written = cb((void *)buf, strlen(buf), u)) < 0)
145 			return -1;
146 		ret += written;
147 	}
148 #endif
149 	return (ret);
150 }
151 
152 static int
153 write_fp(const void *data, size_t len, void *fp)
154 {
155 	return fwrite(data, 1, len, fp);
156 }
157 
158 int
159 BIO_dump_fp(FILE *fp, const char *s, int len)
160 {
161 	return BIO_dump_cb(write_fp, fp, s, len);
162 }
163 LCRYPTO_ALIAS(BIO_dump_fp);
164 
165 int
166 BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent)
167 {
168 	return BIO_dump_indent_cb(write_fp, fp, s, len, indent);
169 }
170 LCRYPTO_ALIAS(BIO_dump_indent_fp);
171 
172 static int
173 write_bio(const void *data, size_t len, void *bp)
174 {
175 	return BIO_write((BIO *)bp, (const char *)data, len);
176 }
177 
178 int
179 BIO_dump(BIO *bp, const char *s, int len)
180 {
181 	return BIO_dump_cb(write_bio, bp, s, len);
182 }
183 LCRYPTO_ALIAS(BIO_dump);
184 
185 int
186 BIO_dump_indent(BIO *bp, const char *s, int len, int indent)
187 {
188 	return BIO_dump_indent_cb(write_bio, bp, s, len, indent);
189 }
190 LCRYPTO_ALIAS(BIO_dump_indent);
191