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 #include <openssl/bio.h>
58
59 #include <limits.h>
60
61
62 /* hexdump_ctx contains the state of a hexdump. */
63 struct hexdump_ctx {
64 BIO *bio;
65 char right_chars[18]; /* the contents of the right-hand side, ASCII dump. */
66 unsigned used; /* number of bytes in the current line. */
67 size_t n; /* number of bytes total. */
68 unsigned indent;
69 };
70
hexbyte(char * out,uint8_t b)71 static void hexbyte(char *out, uint8_t b) {
72 static const char hextable[] = "0123456789abcdef";
73 out[0] = hextable[b>>4];
74 out[1] = hextable[b&0x0f];
75 }
76
to_char(uint8_t b)77 static char to_char(uint8_t b) {
78 if (b < 32 || b > 126) {
79 return '.';
80 }
81 return b;
82 }
83
84 /* hexdump adds |len| bytes of |data| to the current hex dump described by
85 * |ctx|. */
hexdump(struct hexdump_ctx * ctx,const uint8_t * data,size_t len)86 static int hexdump(struct hexdump_ctx *ctx, const uint8_t *data, size_t len) {
87 size_t i;
88 char buf[10];
89 unsigned l;
90
91 /* Output lines look like:
92 * 00000010 2e 2f 30 31 32 33 34 35 36 37 38 ... 3c 3d // |./0123456789:;<=|
93 * ^ offset ^ extra space ^ ASCII of line
94 */
95
96 for (i = 0; i < len; i++) {
97 if (ctx->used == 0) {
98 /* The beginning of a line. */
99 BIO_indent(ctx->bio, ctx->indent, UINT_MAX);
100
101 hexbyte(&buf[0], ctx->n >> 24);
102 hexbyte(&buf[2], ctx->n >> 16);
103 hexbyte(&buf[4], ctx->n >> 8);
104 hexbyte(&buf[6], ctx->n);
105 buf[8] = buf[9] = ' ';
106 if (BIO_write(ctx->bio, buf, 10) < 0) {
107 return 0;
108 }
109 }
110
111 hexbyte(buf, data[i]);
112 buf[2] = ' ';
113 l = 3;
114 if (ctx->used == 7) {
115 /* There's an additional space after the 8th byte. */
116 buf[3] = ' ';
117 l = 4;
118 } else if (ctx->used == 15) {
119 /* At the end of the line there's an extra space and the bar for the
120 * right column. */
121 buf[3] = ' ';
122 buf[4] = '|';
123 l = 5;
124 }
125
126 if (BIO_write(ctx->bio, buf, l) < 0) {
127 return 0;
128 }
129 ctx->right_chars[ctx->used] = to_char(data[i]);
130 ctx->used++;
131 ctx->n++;
132 if (ctx->used == 16) {
133 ctx->right_chars[16] = '|';
134 ctx->right_chars[17] = '\n';
135 if (BIO_write(ctx->bio, ctx->right_chars, sizeof(ctx->right_chars)) < 0) {
136 return 0;
137 }
138 ctx->used = 0;
139 }
140 }
141
142 return 1;
143 }
144
145 /* finish flushes any buffered data in |ctx|. */
finish(struct hexdump_ctx * ctx)146 static int finish(struct hexdump_ctx *ctx) {
147 /* See the comments in |hexdump| for the details of this format. */
148 const unsigned n_bytes = ctx->used;
149 unsigned l;
150 char buf[5];
151
152 if (n_bytes == 0) {
153 return 1;
154 }
155
156 memset(buf, ' ', 4);
157 buf[4] = '|';
158
159 for (; ctx->used < 16; ctx->used++) {
160 l = 3;
161 if (ctx->used == 7) {
162 l = 4;
163 } else if (ctx->used == 15) {
164 l = 5;
165 }
166 if (BIO_write(ctx->bio, buf, l) < 0) {
167 return 0;
168 }
169 }
170
171 ctx->right_chars[n_bytes] = '|';
172 ctx->right_chars[n_bytes + 1] = '\n';
173 if (BIO_write(ctx->bio, ctx->right_chars, n_bytes + 2) < 0) {
174 return 0;
175 }
176 return 1;
177 }
178
BIO_hexdump(BIO * bio,const uint8_t * data,size_t len,unsigned indent)179 int BIO_hexdump(BIO *bio, const uint8_t *data, size_t len, unsigned indent) {
180 struct hexdump_ctx ctx;
181 memset(&ctx, 0, sizeof(ctx));
182 ctx.bio = bio;
183 ctx.indent = indent;
184
185 if (!hexdump(&ctx, data, len) || !finish(&ctx)) {
186 return 0;
187 }
188
189 return 1;
190 }
191