crypto/bio/b_dump.c

   1 /* crypto/bio/b_dump.c */
   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 "internal/cryptlib.h"
  65 #include "bio_lcl.h"
  66
  67 #define TRUNCATE
  68 #define DUMP_WIDTH      16
  69 #define DUMP_WIDTH_LESS_INDENT(i) (DUMP_WIDTH-((i-(i>6?6:i)+3)/4))
  70
  71 int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
  72                 void *u, const char *s, int len)
  73 {
  74     return BIO_dump_indent_cb(cb, u, s, len, 0);
  75 }
  76
  77 int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
  78                        void *u, const char *s, int len, int indent)
  79 {
  80     int ret = 0;
  81     char buf[288 + 1], tmp[20], str[128 + 1];
  82     int i, j, rows, trc;
  83     unsigned char ch;
  84     int dump_width;
  85
  86     trc = 0;
  87
  88 #ifdef TRUNCATE
  89     for (; (len > 0) && ((s[len - 1] == ' ') || (s[len - 1] == '\0')); len--)
  90         trc++;
  91 #endif
  92
  93     if (indent < 0)
  94         indent = 0;
  95     if (indent) {
  96         if (indent > 128)
  97             indent = 128;
  98         memset(str, ' ', indent);
  99     }
 100     str[indent] = '\0';
 101
 102     dump_width = DUMP_WIDTH_LESS_INDENT(indent);
 103     rows = (len / dump_width);
 104     if ((rows * dump_width) < len)
 105         rows++;
 106     for (i = 0; i < rows; i++) {
 107         BUF_strlcpy(buf, str, sizeof buf);
 108         BIO_snprintf(tmp, sizeof tmp, "%04x - ", i * dump_width);
 109         BUF_strlcat(buf, tmp, sizeof buf);
 110         for (j = 0; j < dump_width; j++) {
 111             if (((i * dump_width) + j) >= len) {
 112                 BUF_strlcat(buf, "   ", sizeof buf);
 113             } else {
 114                 ch = ((unsigned char)*(s + i * dump_width + j)) & 0xff;
 115                 BIO_snprintf(tmp, sizeof tmp, "%02x%c", ch,
 116                              j == 7 ? '-' : ' ');
 117                 BUF_strlcat(buf, tmp, sizeof buf);
 118             }
 119         }
 120         BUF_strlcat(buf, "  ", sizeof buf);
 121         for (j = 0; j < dump_width; j++) {
 122             if (((i * dump_width) + j) >= len)
 123                 break;
 124             ch = ((unsigned char)*(s + i * dump_width + j)) & 0xff;
 125 #ifndef CHARSET_EBCDIC
 126             BIO_snprintf(tmp, sizeof tmp, "%c",
 127                          ((ch >= ' ') && (ch <= '~')) ? ch : '.');
 128 #else
 129             BIO_snprintf(tmp, sizeof tmp, "%c",
 130                          ((ch >= os_toascii[' ']) && (ch <= os_toascii['~']))
 131                          ? os_toebcdic[ch]
 132                          : '.');
 133 #endif
 134             BUF_strlcat(buf, tmp, sizeof buf);
 135         }
 136         BUF_strlcat(buf, "\n", sizeof buf);
 137         /*
 138          * if this is the last call then update the ddt_dump thing so that we
 139          * will move the selection point in the debug window
 140          */
 141         ret += cb((void *)buf, strlen(buf), u);
 142     }
 143 #ifdef TRUNCATE
 144     if (trc > 0) {
 145         BIO_snprintf(buf, sizeof buf, "%s%04x - <SPACES/NULS>\n", str,
 146                      len + trc);
 147         ret += cb((void *)buf, strlen(buf), u);
 148     }
 149 #endif
 150     return (ret);
 151 }
 152
 153 #ifndef OPENSSL_NO_STDIO
 154 static int write_fp(const void *data, size_t len, void *fp)
 155 {
 156     return UP_fwrite(data, len, 1, fp);
 157 }
 158
 159 int BIO_dump_fp(FILE *fp, const char *s, int len)
 160 {
 161     return BIO_dump_cb(write_fp, fp, s, len);
 162 }
 163
 164 int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent)
 165 {
 166     return BIO_dump_indent_cb(write_fp, fp, s, len, indent);
 167 }
 168 #endif
 169
 170 static int write_bio(const void *data, size_t len, void *bp)
 171 {
 172     return BIO_write((BIO *)bp, (const char *)data, len);
 173 }
 174
 175 int BIO_dump(BIO *bp, const char *s, int len)
 176 {
 177     return BIO_dump_cb(write_bio, bp, s, len);
 178 }
 179
 180 int BIO_dump_indent(BIO *bp, const char *s, int len, int indent)
 181 {
 182     return BIO_dump_indent_cb(write_bio, bp, s, len, indent);
 183 }
 184
 185 int BIO_hex_string(BIO *out, int indent, int width, unsigned char *data,
 186                    int datalen)
 187 {
 188     int i, j = 0;
 189
 190     if (datalen < 1)
 191         return 1;
 192
 193     for (i = 0; i < datalen - 1; i++) {
 194         if (i && !j)
 195             BIO_printf(out, "%*s", indent, "");
 196
 197         BIO_printf(out, "%02X:", data[i]);
 198
 199         j = (j + 1) % width;
 200         if (!j)
 201             BIO_printf(out, "\n");
 202     }
 203
 204     if (i && !j)
 205         BIO_printf(out, "%*s", indent, "");
 206     BIO_printf(out, "%02X", data[datalen - 1]);
 207     return 1;
 208 }