1d9e397b599b13d642138480a28c14db7a136bf0Adam Langley/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 2d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * All rights reserved. 3d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 4d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * This package is an SSL implementation written 5d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * by Eric Young (eay@cryptsoft.com). 6d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * The implementation was written so as to conform with Netscapes SSL. 7d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 8d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * This library is free for commercial and non-commercial use as long as 9d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * the following conditions are aheared to. The following conditions 10d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * apply to all code found in this distribution, be it the RC4, RSA, 11d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * lhash, DES, etc., code; not just the SSL code. The SSL documentation 12d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * included with this distribution is covered by the same copyright terms 13d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * except that the holder is Tim Hudson (tjh@cryptsoft.com). 14d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 15d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * Copyright remains Eric Young's, and as such any Copyright notices in 16d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * the code are not to be removed. 17d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * If this package is used in a product, Eric Young should be given attribution 18d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * as the author of the parts of the library used. 19d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * This can be in the form of a textual message at program startup or 20d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * in documentation (online or textual) provided with the package. 21d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 22d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * Redistribution and use in source and binary forms, with or without 23d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * modification, are permitted provided that the following conditions 24d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * are met: 25d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 1. Redistributions of source code must retain the copyright 26d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * notice, this list of conditions and the following disclaimer. 27d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 2. Redistributions in binary form must reproduce the above copyright 28d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * notice, this list of conditions and the following disclaimer in the 29d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * documentation and/or other materials provided with the distribution. 30d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 3. All advertising materials mentioning features or use of this software 31d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * must display the following acknowledgement: 32d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * "This product includes cryptographic software written by 33d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * Eric Young (eay@cryptsoft.com)" 34d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * The word 'cryptographic' can be left out if the rouines from the library 35d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * being used are not cryptographic related :-). 36d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 4. If you include any Windows specific code (or a derivative thereof) from 37d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * the apps directory (application code) you must include an acknowledgement: 38d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 39d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 40d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 41d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 43d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 44d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 45d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 46d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 48d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 49d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 50d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * SUCH DAMAGE. 51d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * 52d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * The licence and distribution terms for any publically available version or 53d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * derivative of this code cannot be changed. i.e. this code cannot simply be 54d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * copied and put under another distribution licence 55d9e397b599b13d642138480a28c14db7a136bf0Adam Langley * [including the GNU Public Licence.] */ 56d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 57d9e397b599b13d642138480a28c14db7a136bf0Adam Langley#include <openssl/bio.h> 58d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 59d9e397b599b13d642138480a28c14db7a136bf0Adam Langley#include <limits.h> 60d9e397b599b13d642138480a28c14db7a136bf0Adam Langley#include <string.h> 61d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 6269939df2891f62f7f00ff2ac275f1cd81a67454cRobert Sloan#include "../internal.h" 6369939df2891f62f7f00ff2ac275f1cd81a67454cRobert Sloan 64d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 658f860b133896bf655e4342ecefe692d52df81d48Robert Sloan// hexdump_ctx contains the state of a hexdump. 66d9e397b599b13d642138480a28c14db7a136bf0Adam Langleystruct hexdump_ctx { 67d9e397b599b13d642138480a28c14db7a136bf0Adam Langley BIO *bio; 688f860b133896bf655e4342ecefe692d52df81d48Robert Sloan char right_chars[18]; // the contents of the right-hand side, ASCII dump. 698f860b133896bf655e4342ecefe692d52df81d48Robert Sloan unsigned used; // number of bytes in the current line. 708f860b133896bf655e4342ecefe692d52df81d48Robert Sloan size_t n; // number of bytes total. 71d9e397b599b13d642138480a28c14db7a136bf0Adam Langley unsigned indent; 72d9e397b599b13d642138480a28c14db7a136bf0Adam Langley}; 73d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 74d9e397b599b13d642138480a28c14db7a136bf0Adam Langleystatic void hexbyte(char *out, uint8_t b) { 75d9e397b599b13d642138480a28c14db7a136bf0Adam Langley static const char hextable[] = "0123456789abcdef"; 76d9e397b599b13d642138480a28c14db7a136bf0Adam Langley out[0] = hextable[b>>4]; 77d9e397b599b13d642138480a28c14db7a136bf0Adam Langley out[1] = hextable[b&0x0f]; 78d9e397b599b13d642138480a28c14db7a136bf0Adam Langley} 79d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 80d9e397b599b13d642138480a28c14db7a136bf0Adam Langleystatic char to_char(uint8_t b) { 81d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (b < 32 || b > 126) { 82d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return '.'; 83d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 84d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return b; 85d9e397b599b13d642138480a28c14db7a136bf0Adam Langley} 86d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 878f860b133896bf655e4342ecefe692d52df81d48Robert Sloan// hexdump_write adds |len| bytes of |data| to the current hex dump described by 888f860b133896bf655e4342ecefe692d52df81d48Robert Sloan// |ctx|. 89d9e397b599b13d642138480a28c14db7a136bf0Adam Langleystatic int hexdump_write(struct hexdump_ctx *ctx, const uint8_t *data, 90d9e397b599b13d642138480a28c14db7a136bf0Adam Langley size_t len) { 91d9e397b599b13d642138480a28c14db7a136bf0Adam Langley char buf[10]; 92d9e397b599b13d642138480a28c14db7a136bf0Adam Langley unsigned l; 93d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 948f860b133896bf655e4342ecefe692d52df81d48Robert Sloan // Output lines look like: 958f860b133896bf655e4342ecefe692d52df81d48Robert Sloan // 00000010 2e 2f 30 31 32 33 34 35 36 37 38 ... 3c 3d // |./0123456789:;<=| 968f860b133896bf655e4342ecefe692d52df81d48Robert Sloan // ^ offset ^ extra space ^ ASCII of line 97d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 987c0d06c221ce9edf44bbf978b909b38a0aee2084David Benjamin for (size_t i = 0; i < len; i++) { 99d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (ctx->used == 0) { 1008f860b133896bf655e4342ecefe692d52df81d48Robert Sloan // The beginning of a line. 101d9e397b599b13d642138480a28c14db7a136bf0Adam Langley BIO_indent(ctx->bio, ctx->indent, UINT_MAX); 102d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 103d9e397b599b13d642138480a28c14db7a136bf0Adam Langley hexbyte(&buf[0], ctx->n >> 24); 104d9e397b599b13d642138480a28c14db7a136bf0Adam Langley hexbyte(&buf[2], ctx->n >> 16); 105d9e397b599b13d642138480a28c14db7a136bf0Adam Langley hexbyte(&buf[4], ctx->n >> 8); 106d9e397b599b13d642138480a28c14db7a136bf0Adam Langley hexbyte(&buf[6], ctx->n); 107d9e397b599b13d642138480a28c14db7a136bf0Adam Langley buf[8] = buf[9] = ' '; 108d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (BIO_write(ctx->bio, buf, 10) < 0) { 109d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 0; 110d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 111d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 112d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 113d9e397b599b13d642138480a28c14db7a136bf0Adam Langley hexbyte(buf, data[i]); 114d9e397b599b13d642138480a28c14db7a136bf0Adam Langley buf[2] = ' '; 115d9e397b599b13d642138480a28c14db7a136bf0Adam Langley l = 3; 116d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (ctx->used == 7) { 1178f860b133896bf655e4342ecefe692d52df81d48Robert Sloan // There's an additional space after the 8th byte. 118d9e397b599b13d642138480a28c14db7a136bf0Adam Langley buf[3] = ' '; 119d9e397b599b13d642138480a28c14db7a136bf0Adam Langley l = 4; 120d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } else if (ctx->used == 15) { 1218f860b133896bf655e4342ecefe692d52df81d48Robert Sloan // At the end of the line there's an extra space and the bar for the 1228f860b133896bf655e4342ecefe692d52df81d48Robert Sloan // right column. 123d9e397b599b13d642138480a28c14db7a136bf0Adam Langley buf[3] = ' '; 124d9e397b599b13d642138480a28c14db7a136bf0Adam Langley buf[4] = '|'; 125d9e397b599b13d642138480a28c14db7a136bf0Adam Langley l = 5; 126d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 127d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 128d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (BIO_write(ctx->bio, buf, l) < 0) { 129d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 0; 130d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 131d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx->right_chars[ctx->used] = to_char(data[i]); 132d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx->used++; 133d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx->n++; 134d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (ctx->used == 16) { 135d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx->right_chars[16] = '|'; 136d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx->right_chars[17] = '\n'; 137d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (BIO_write(ctx->bio, ctx->right_chars, sizeof(ctx->right_chars)) < 0) { 138d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 0; 139d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 140d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx->used = 0; 141d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 142d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 143d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 144d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 1; 145d9e397b599b13d642138480a28c14db7a136bf0Adam Langley} 146d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 1478f860b133896bf655e4342ecefe692d52df81d48Robert Sloan// finish flushes any buffered data in |ctx|. 148d9e397b599b13d642138480a28c14db7a136bf0Adam Langleystatic int finish(struct hexdump_ctx *ctx) { 1498f860b133896bf655e4342ecefe692d52df81d48Robert Sloan // See the comments in |hexdump| for the details of this format. 150d9e397b599b13d642138480a28c14db7a136bf0Adam Langley const unsigned n_bytes = ctx->used; 151d9e397b599b13d642138480a28c14db7a136bf0Adam Langley unsigned l; 152d9e397b599b13d642138480a28c14db7a136bf0Adam Langley char buf[5]; 153d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 154d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (n_bytes == 0) { 155d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 1; 156d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 157d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 15869939df2891f62f7f00ff2ac275f1cd81a67454cRobert Sloan OPENSSL_memset(buf, ' ', 4); 159d9e397b599b13d642138480a28c14db7a136bf0Adam Langley buf[4] = '|'; 160d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 161d9e397b599b13d642138480a28c14db7a136bf0Adam Langley for (; ctx->used < 16; ctx->used++) { 162d9e397b599b13d642138480a28c14db7a136bf0Adam Langley l = 3; 163d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (ctx->used == 7) { 164d9e397b599b13d642138480a28c14db7a136bf0Adam Langley l = 4; 165d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } else if (ctx->used == 15) { 166d9e397b599b13d642138480a28c14db7a136bf0Adam Langley l = 5; 167d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 168d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (BIO_write(ctx->bio, buf, l) < 0) { 169d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 0; 170d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 171d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 172d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 173d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx->right_chars[n_bytes] = '|'; 174d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx->right_chars[n_bytes + 1] = '\n'; 175d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (BIO_write(ctx->bio, ctx->right_chars, n_bytes + 2) < 0) { 176d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 0; 177d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 178d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 1; 179d9e397b599b13d642138480a28c14db7a136bf0Adam Langley} 180d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 181d9e397b599b13d642138480a28c14db7a136bf0Adam Langleyint BIO_hexdump(BIO *bio, const uint8_t *data, size_t len, unsigned indent) { 182d9e397b599b13d642138480a28c14db7a136bf0Adam Langley struct hexdump_ctx ctx; 18369939df2891f62f7f00ff2ac275f1cd81a67454cRobert Sloan OPENSSL_memset(&ctx, 0, sizeof(ctx)); 184d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx.bio = bio; 185d9e397b599b13d642138480a28c14db7a136bf0Adam Langley ctx.indent = indent; 186d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 187d9e397b599b13d642138480a28c14db7a136bf0Adam Langley if (!hexdump_write(&ctx, data, len) || !finish(&ctx)) { 188d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 0; 189d9e397b599b13d642138480a28c14db7a136bf0Adam Langley } 190d9e397b599b13d642138480a28c14db7a136bf0Adam Langley 191d9e397b599b13d642138480a28c14db7a136bf0Adam Langley return 1; 192d9e397b599b13d642138480a28c14db7a136bf0Adam Langley} 193