debug.c 9.59 KB
Newer Older
1 2 3
/*
 *  Debugging routines
 *
Manuel Pégourié-Gonnard's avatar
Manuel Pégourié-Gonnard committed
4
 *  Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
Paul Bakker's avatar
Paul Bakker committed
5
 *
Manuel Pégourié-Gonnard's avatar
Manuel Pégourié-Gonnard committed
6
 *  This file is part of mbed TLS (https://polarssl.org)
Paul Bakker's avatar
Paul Bakker committed
7
 *
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

23
#if !defined(POLARSSL_CONFIG_FILE)
24
#include "polarssl/config.h"
25 26 27
#else
#include POLARSSL_CONFIG_FILE
#endif
28

29
#if defined(POLARSSL_DEBUG_C)
30

31
#include "polarssl/debug.h"
32 33

#include <stdarg.h>
34
#include <stdio.h>
35
#include <string.h>
36

37 38
#if defined(_MSC_VER) && !defined(EFIX64) && !defined(EFI32)
#if !defined  snprintf
39 40 41
#define  snprintf  _snprintf
#endif

42
#if !defined vsnprintf
43 44
#define vsnprintf _vsnprintf
#endif
45
#endif /* _MSC_VER */
46

47
static int debug_log_mode = POLARSSL_DEBUG_DFL_MODE;
48
static int debug_threshold = 0;
49 50 51 52 53 54

void debug_set_log_mode( int log_mode )
{
    debug_log_mode = log_mode;
}

55 56 57 58 59
void debug_set_threshold( int threshold )
{
    debug_threshold = threshold;
}

60 61 62 63 64 65 66 67 68 69 70 71 72 73
char *debug_fmt( const char *format, ... )
{
    va_list argp;
    static char str[512];
    int maxlen = sizeof( str ) - 1;

    va_start( argp, format );
    vsnprintf( str, maxlen, format, argp );
    va_end( argp );

    str[maxlen] = '\0';
    return( str );
}

74 75
void debug_print_msg( const ssl_context *ssl, int level,
                      const char *file, int line, const char *text )
76 77 78 79
{
    char str[512];
    int maxlen = sizeof( str ) - 1;

80
    if( ssl->f_dbg == NULL || level > debug_threshold )
81 82
        return;

83 84
    if( debug_log_mode == POLARSSL_DEBUG_LOG_RAW )
    {
Paul Bakker's avatar
Paul Bakker committed
85
        ssl->f_dbg( ssl->p_dbg, level, text );
86 87 88
        return;
    }

89 90 91 92 93
    snprintf( str, maxlen, "%s(%04d): %s\n", file, line, text );
    str[maxlen] = '\0';
    ssl->f_dbg( ssl->p_dbg, level, str );
}

94 95 96
void debug_print_ret( const ssl_context *ssl, int level,
                      const char *file, int line,
                      const char *text, int ret )
97 98 99
{
    char str[512];
    int maxlen = sizeof( str ) - 1;
100
    size_t idx = 0;
101

102
    if( ssl->f_dbg == NULL || level > debug_threshold )
103 104
        return;

105 106 107 108 109
    if( debug_log_mode == POLARSSL_DEBUG_LOG_FULL )
        idx = snprintf( str, maxlen, "%s(%04d): ", file, line );

    snprintf( str + idx, maxlen - idx, "%s() returned %d (-0x%04x)\n",
              text, ret, -ret );
110 111 112 113 114

    str[maxlen] = '\0';
    ssl->f_dbg( ssl->p_dbg, level, str );
}

115 116
void debug_print_buf( const ssl_context *ssl, int level,
                      const char *file, int line, const char *text,
117
                      unsigned char *buf, size_t len )
118 119
{
    char str[512];
120
    char txt[17];
121
    size_t i, maxlen = sizeof( str ) - 1, idx = 0;
122

123
    if( ssl->f_dbg == NULL || level > debug_threshold )
124 125
        return;

126 127 128
    if( debug_log_mode == POLARSSL_DEBUG_LOG_FULL )
        idx = snprintf( str, maxlen, "%s(%04d): ", file, line );

129
    snprintf( str + idx, maxlen - idx, "dumping '%s' (%u bytes)\n",
130
              text, (unsigned int) len );
131 132 133 134

    str[maxlen] = '\0';
    ssl->f_dbg( ssl->p_dbg, level, str );

135
    idx = 0;
136
    memset( txt, 0, sizeof( txt ) );
137 138 139 140 141 142 143 144
    for( i = 0; i < len; i++ )
    {
        if( i >= 4096 )
            break;

        if( i % 16 == 0 )
        {
            if( i > 0 )
145
            {
146
                snprintf( str + idx, maxlen - idx, "  %s\n", txt );
147
                ssl->f_dbg( ssl->p_dbg, level, str );
148

149
                idx = 0;
150
                memset( txt, 0, sizeof( txt ) );
151
            }
152

153 154 155
            if( debug_log_mode == POLARSSL_DEBUG_LOG_FULL )
                idx = snprintf( str, maxlen, "%s(%04d): ", file, line );

156 157
            idx += snprintf( str + idx, maxlen - idx, "%04x: ",
                             (unsigned int) i );
158 159 160

        }

161 162
        idx += snprintf( str + idx, maxlen - idx, " %02x",
                         (unsigned int) buf[i] );
163
        txt[i % 16] = ( buf[i] > 31 && buf[i] < 127 ) ? buf[i] : '.' ;
164 165 166
    }

    if( len > 0 )
167
    {
168 169 170 171
        for( /* i = i */; i % 16 != 0; i++ )
            idx += snprintf( str + idx, maxlen - idx, "   " );

        snprintf( str + idx, maxlen - idx, "  %s\n", txt );
172 173
        ssl->f_dbg( ssl->p_dbg, level, str );
    }
174 175
}

176 177 178 179 180 181 182 183
#if defined(POLARSSL_ECP_C)
void debug_print_ecp( const ssl_context *ssl, int level,
                      const char *file, int line,
                      const char *text, const ecp_point *X )
{
    char str[512];
    int maxlen = sizeof( str ) - 1;

184 185 186
    if( ssl->f_dbg == NULL || level > debug_threshold )
        return;

187 188 189 190 191 192 193 194 195 196
    snprintf( str, maxlen, "%s(X)", text );
    str[maxlen] = '\0';
    debug_print_mpi( ssl, level, file, line, str, &X->X );

    snprintf( str, maxlen, "%s(Y)", text );
    str[maxlen] = '\0';
    debug_print_mpi( ssl, level, file, line, str, &X->Y );
}
#endif /* POLARSSL_ECP_C */

197
#if defined(POLARSSL_BIGNUM_C)
198 199 200
void debug_print_mpi( const ssl_context *ssl, int level,
                      const char *file, int line,
                      const char *text, const mpi *X )
201 202
{
    char str[512];
203
    int j, k, maxlen = sizeof( str ) - 1, zeros = 1;
204
    size_t i, n, idx = 0;
205

206
    if( ssl->f_dbg == NULL || X == NULL || level > debug_threshold )
207 208
        return;

209
    for( n = X->n - 1; n > 0; n-- )
210 211 212
        if( X->p[n] != 0 )
            break;

213
    for( j = ( sizeof(t_uint) << 3 ) - 1; j >= 0; j-- )
214 215 216
        if( ( ( X->p[n] >> j ) & 1 ) != 0 )
            break;

217 218 219 220 221
    if( debug_log_mode == POLARSSL_DEBUG_LOG_FULL )
        idx = snprintf( str, maxlen, "%s(%04d): ", file, line );

    snprintf( str + idx, maxlen - idx, "value of '%s' (%d bits) is:\n",
              text, (int) ( ( n * ( sizeof(t_uint) << 3 ) ) + j + 1 ) );
222 223 224 225

    str[maxlen] = '\0';
    ssl->f_dbg( ssl->p_dbg, level, str );

226
    idx = 0;
227
    for( i = n + 1, j = 0; i > 0; i-- )
228
    {
229
        if( zeros && X->p[i - 1] == 0 )
230 231
            continue;

232
        for( k = sizeof( t_uint ) - 1; k >= 0; k-- )
233
        {
234
            if( zeros && ( ( X->p[i - 1] >> ( k << 3 ) ) & 0xFF ) == 0 )
235 236 237
                continue;
            else
                zeros = 0;
238

239 240 241
            if( j % 16 == 0 )
            {
                if( j > 0 )
242
                {
243
                    snprintf( str + idx, maxlen - idx, "\n" );
244
                    ssl->f_dbg( ssl->p_dbg, level, str );
245
                    idx = 0;
246
                }
247

248 249 250
                if( debug_log_mode == POLARSSL_DEBUG_LOG_FULL )
                    idx = snprintf( str, maxlen, "%s(%04d): ", file, line );
            }
251

252
            idx += snprintf( str + idx, maxlen - idx, " %02x", (unsigned int)
253
                             ( X->p[i - 1] >> ( k << 3 ) ) & 0xFF );
254 255

            j++;
256
        }
257 258 259 260 261

    }

    if( zeros == 1 )
    {
262 263
        if( debug_log_mode == POLARSSL_DEBUG_LOG_FULL )
        {
264
            idx = snprintf( str, maxlen, "%s(%04d): ", file, line );
265

266
        }
267
        idx += snprintf( str + idx, maxlen - idx, " 00" );
268 269
    }

270 271
    snprintf( str + idx, maxlen - idx, "\n" );
    ssl->f_dbg( ssl->p_dbg, level, str );
272
}
273
#endif /* POLARSSL_BIGNUM_C */
274

275
#if defined(POLARSSL_X509_CRT_PARSE_C)
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
static void debug_print_pk( const ssl_context *ssl, int level,
                            const char *file, int line,
                            const char *text, const pk_context *pk )
{
    size_t i;
    pk_debug_item items[POLARSSL_PK_DEBUG_MAX_ITEMS];
    char name[16];

    memset( items, 0, sizeof( items ) );

    if( pk_debug( pk, items ) != 0 )
    {
        debug_print_msg( ssl, level, file, line, "invalid PK context" );
        return;
    }

Paul Bakker's avatar
Paul Bakker committed
292
    for( i = 0; i < POLARSSL_PK_DEBUG_MAX_ITEMS; i++ )
293 294 295 296 297 298 299 300 301
    {
        if( items[i].type == POLARSSL_PK_DEBUG_NONE )
            return;

        snprintf( name, sizeof( name ), "%s%s", text, items[i].name );
        name[sizeof( name ) - 1] = '\0';

        if( items[i].type == POLARSSL_PK_DEBUG_MPI )
            debug_print_mpi( ssl, level, file, line, name, items[i].value );
Manuel Pégourié-Gonnard's avatar
Manuel Pégourié-Gonnard committed
302 303 304
        else
#if defined(POLARSSL_ECP_C)
        if( items[i].type == POLARSSL_PK_DEBUG_ECP )
305 306
            debug_print_ecp( ssl, level, file, line, name, items[i].value );
        else
Manuel Pégourié-Gonnard's avatar
Manuel Pégourié-Gonnard committed
307
#endif
308 309 310 311
            debug_print_msg( ssl, level, file, line, "should not happen" );
    }
}

312 313
void debug_print_crt( const ssl_context *ssl, int level,
                      const char *file, int line,
314
                      const char *text, const x509_crt *crt )
315
{
316
    char str[1024], prefix[64];
317
    int i = 0, maxlen = sizeof( prefix ) - 1, idx = 0;
318

319
    if( ssl->f_dbg == NULL || crt == NULL || level > debug_threshold )
320 321
        return;

322 323 324 325 326 327 328 329
    if( debug_log_mode == POLARSSL_DEBUG_LOG_FULL )
    {
        snprintf( prefix, maxlen, "%s(%04d): ", file, line );
        prefix[maxlen] = '\0';
    }
    else
        prefix[0] = '\0';

330 331
    maxlen = sizeof( str ) - 1;

Paul Bakker's avatar
Paul Bakker committed
332
    while( crt != NULL )
333
    {
334
        char buf[1024];
335
        x509_crt_info( buf, sizeof( buf ) - 1, prefix, crt );
336

337 338 339 340 341
        if( debug_log_mode == POLARSSL_DEBUG_LOG_FULL )
            idx = snprintf( str, maxlen, "%s(%04d): ", file, line );

        snprintf( str + idx, maxlen - idx, "%s #%d:\n%s",
                  text, ++i, buf );
342 343 344 345

        str[maxlen] = '\0';
        ssl->f_dbg( ssl->p_dbg, level, str );

346
        debug_print_pk( ssl, level, file, line, "crt->", &crt->pk );
347 348 349 350

        crt = crt->next;
    }
}
351
#endif /* POLARSSL_X509_CRT_PARSE_C */
352

353
#endif /* POLARSSL_DEBUG_C */