mbed TLS v1.3.16
Macros | Functions
debug.h File Reference

Debug functions. More...

#include "config.h"
#include "ssl.h"
#include "ecp.h"
Include dependency graph for debug.h:

Go to the source code of this file.

Macros

#define POLARSSL_DEBUG_LOG_FULL   0
 Include file:line in log lines. More...
 
#define POLARSSL_DEBUG_LOG_RAW   1
 Only log raw debug lines. More...
 
#define SSL_DEBUG_MSG(level, args)   debug_print_msg_free( ssl, level, __FILE__, __LINE__, debug_fmt args );
 
#define SSL_DEBUG_RET(level, text, ret)   debug_print_ret( ssl, level, __FILE__, __LINE__, text, ret );
 
#define SSL_DEBUG_BUF(level, text, buf, len)   debug_print_buf( ssl, level, __FILE__, __LINE__, text, buf, len );
 
#define SSL_DEBUG_MPI(level, text, X)   debug_print_mpi( ssl, level, __FILE__, __LINE__, text, X );
 
#define SSL_DEBUG_ECP(level, text, X)   debug_print_ecp( ssl, level, __FILE__, __LINE__, text, X );
 
#define SSL_DEBUG_CRT(level, text, crt)   debug_print_crt( ssl, level, __FILE__, __LINE__, text, crt );
 
SECTION: Module settings

The configuration options you can set for this module are in this section.

Either change them in config.h or define them on the compiler command line.

#define POLARSSL_DEBUG_DFL_MODE   POLARSSL_DEBUG_LOG_FULL
 Default log: Full or Raw. More...
 

Functions

void debug_set_log_mode (int log_mode)
 Set the log mode for the debug functions globally (Default value: POLARSSL_DEBUG_DFL_MODE) More...
 
void debug_set_threshold (int threshold)
 Set the level threshold to handle globally. More...
 
char * debug_fmt (const char *format,...)
 
void debug_print_msg_free (const ssl_context *ssl, int level, const char *file, int line, char *text)
 
void debug_print_msg (const ssl_context *ssl, int level, const char *file, int line, const char *text)
 
void debug_print_ret (const ssl_context *ssl, int level, const char *file, int line, const char *text, int ret)
 
void debug_print_buf (const ssl_context *ssl, int level, const char *file, int line, const char *text, unsigned char *buf, size_t len)
 
void debug_print_mpi (const ssl_context *ssl, int level, const char *file, int line, const char *text, const mpi *X)
 
void debug_print_ecp (const ssl_context *ssl, int level, const char *file, int line, const char *text, const ecp_point *X)
 
void debug_print_crt (const ssl_context *ssl, int level, const char *file, int line, const char *text, const x509_crt *crt)
 

Detailed Description

Debug functions.

Copyright (C) 2006-2011, ARM Limited, All Rights Reserved

This file is part of mbed TLS (https://tls.mbed.org)

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.

Definition in file debug.h.

Macro Definition Documentation

#define POLARSSL_DEBUG_DFL_MODE   POLARSSL_DEBUG_LOG_FULL

Default log: Full or Raw.

Definition at line 53 of file debug.h.

#define POLARSSL_DEBUG_LOG_FULL   0

Include file:line in log lines.

Definition at line 41 of file debug.h.

#define POLARSSL_DEBUG_LOG_RAW   1

Only log raw debug lines.

Definition at line 42 of file debug.h.

#define SSL_DEBUG_BUF (   level,
  text,
  buf,
  len 
)    debug_print_buf( ssl, level, __FILE__, __LINE__, text, buf, len );

Definition at line 65 of file debug.h.

#define SSL_DEBUG_CRT (   level,
  text,
  crt 
)    debug_print_crt( ssl, level, __FILE__, __LINE__, text, crt );

Definition at line 79 of file debug.h.

#define SSL_DEBUG_ECP (   level,
  text,
 
)    debug_print_ecp( ssl, level, __FILE__, __LINE__, text, X );

Definition at line 74 of file debug.h.

#define SSL_DEBUG_MPI (   level,
  text,
 
)    debug_print_mpi( ssl, level, __FILE__, __LINE__, text, X );

Definition at line 69 of file debug.h.

#define SSL_DEBUG_MSG (   level,
  args 
)    debug_print_msg_free( ssl, level, __FILE__, __LINE__, debug_fmt args );

Definition at line 59 of file debug.h.

#define SSL_DEBUG_RET (   level,
  text,
  ret 
)    debug_print_ret( ssl, level, __FILE__, __LINE__, text, ret );

Definition at line 62 of file debug.h.

Function Documentation

char* debug_fmt ( const char *  format,
  ... 
)
void debug_print_buf ( const ssl_context ssl,
int  level,
const char *  file,
int  line,
const char *  text,
unsigned char *  buf,
size_t  len 
)
void debug_print_crt ( const ssl_context ssl,
int  level,
const char *  file,
int  line,
const char *  text,
const x509_crt crt 
)
void debug_print_ecp ( const ssl_context ssl,
int  level,
const char *  file,
int  line,
const char *  text,
const ecp_point X 
)
void debug_print_mpi ( const ssl_context ssl,
int  level,
const char *  file,
int  line,
const char *  text,
const mpi X 
)
void debug_print_msg ( const ssl_context ssl,
int  level,
const char *  file,
int  line,
const char *  text 
)
void debug_print_msg_free ( const ssl_context ssl,
int  level,
const char *  file,
int  line,
char *  text 
)
void debug_print_ret ( const ssl_context ssl,
int  level,
const char *  file,
int  line,
const char *  text,
int  ret 
)
void debug_set_log_mode ( int  log_mode)

Set the log mode for the debug functions globally (Default value: POLARSSL_DEBUG_DFL_MODE)

Parameters
log_modeThe log mode to use (POLARSSL_DEBUG_LOG_FULL or POLARSSL_DEBUG_LOG_RAW)
void debug_set_threshold ( int  threshold)

Set the level threshold to handle globally.

Messages that have a level over the threshold value are ignored. (Default value: 0 (No debug))

Parameters
thresholdmaximum level of messages to pass on