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