debug.h File Reference

Functions for controlling and providing debug output from the library. More...

#include "config.h"
#include "ssl.h"

Include dependency graph for debug.h:

Go to the source code of this file.

Macros
#define	MBEDTLS_SSL_DEBUG_MSG(level, args)   do { } while( 0 )
#define	MBEDTLS_SSL_DEBUG_RET(level, text, ret)   do { } while( 0 )
#define	MBEDTLS_SSL_DEBUG_BUF(level, text, buf, len)   do { } while( 0 )
#define	MBEDTLS_SSL_DEBUG_MPI(level, text, X)   do { } while( 0 )
#define	MBEDTLS_SSL_DEBUG_ECP(level, text, X)   do { } while( 0 )
#define	MBEDTLS_SSL_DEBUG_CRT(level, text, crt)   do { } while( 0 )
#define	MBEDTLS_SSL_DEBUG_ECDH(level, ecdh, attr)   do { } while( 0 )

Functions
void	mbedtls_debug_set_threshold (int threshold)
	Set the threshold error level to handle globally all debug output. Debug messages that have a level over the threshold value are discarded. (Default value: 0 = No debug ) More...
void	mbedtls_debug_print_msg (const mbedtls_ssl_context *ssl, int level, const char *file, int line, const char *format,...)
	Print a message to the debug output. This function is always used through the MBEDTLS_SSL_DEBUG_MSG() macro, which supplies the ssl context, file and line number parameters. More...
void	mbedtls_debug_print_ret (const mbedtls_ssl_context *ssl, int level, const char *file, int line, const char *text, int ret)
	Print the return value of a function to the debug output. This function is always used through the MBEDTLS_SSL_DEBUG_RET() macro, which supplies the ssl context, file and line number parameters. More...
void	mbedtls_debug_print_buf (const mbedtls_ssl_context *ssl, int level, const char *file, int line, const char *text, const unsigned char *buf, size_t len)
	Output a buffer of size len bytes to the debug output. This function is always used through the MBEDTLS_SSL_DEBUG_BUF() macro, which supplies the ssl context, file and line number parameters. More...

Detailed Description

Functions for controlling and providing debug output from the library.

Macro Definition Documentation

MBEDTLS_SSL_DEBUG_BUF

#define MBEDTLS_SSL_DEBUG_BUF	(		level,
			text,
			buf,
			len
	)		do { } while( 0 )

MBEDTLS_SSL_DEBUG_CRT

#define MBEDTLS_SSL_DEBUG_CRT	(		level,
			text,
			crt
	)		do { } while( 0 )

MBEDTLS_SSL_DEBUG_ECDH

#define MBEDTLS_SSL_DEBUG_ECDH	(		level,
			ecdh,
			attr
	)		do { } while( 0 )

MBEDTLS_SSL_DEBUG_ECP

#define MBEDTLS_SSL_DEBUG_ECP	(		level,
			text,
			X
	)		do { } while( 0 )

MBEDTLS_SSL_DEBUG_MPI

#define MBEDTLS_SSL_DEBUG_MPI	(		level,
			text,
			X
	)		do { } while( 0 )

MBEDTLS_SSL_DEBUG_MSG

#define MBEDTLS_SSL_DEBUG_MSG	(		level,
			args
	)		do { } while( 0 )

MBEDTLS_SSL_DEBUG_RET

#define MBEDTLS_SSL_DEBUG_RET	(		level,
			text,
			ret
	)		do { } while( 0 )

Function Documentation

mbedtls_debug_print_buf()

void mbedtls_debug_print_buf	(	const mbedtls_ssl_context *	ssl,
		int	level,
		const char *	file,
		int	line,
		const char *	text,
		const unsigned char *	buf,
		size_t	len
	)

Output a buffer of size len bytes to the debug output. This function is always used through the MBEDTLS_SSL_DEBUG_BUF() macro, which supplies the ssl context, file and line number parameters.

Parameters

ssl	SSL context
level	error level of the debug message
file	file the error has occurred in
line	line number the error has occurred in
text	a name or label for the buffer being dumped. Normally the variable or buffer name
buf	the buffer to be outputted
len	length of the buffer

Attention

This function is intended for INTERNAL usage within the library only.

mbedtls_debug_print_msg()

void mbedtls_debug_print_msg	(	const mbedtls_ssl_context *	ssl,
		int	level,
		const char *	file,
		int	line,
		const char *	format,
			...
	)

Print a message to the debug output. This function is always used through the MBEDTLS_SSL_DEBUG_MSG() macro, which supplies the ssl context, file and line number parameters.

Parameters

ssl	SSL context
level	error level of the debug message
file	file the message has occurred in
line	line number the message has occurred at
format	format specifier, in printf format
...	variables used by the format specifier

Attention

This function is intended for INTERNAL usage within the library only.

mbedtls_debug_print_ret()

void mbedtls_debug_print_ret	(	const mbedtls_ssl_context *	ssl,
		int	level,
		const char *	file,
		int	line,
		const char *	text,
		int	ret
	)

Print the return value of a function to the debug output. This function is always used through the MBEDTLS_SSL_DEBUG_RET() macro, which supplies the ssl context, file and line number parameters.

Parameters

ssl	SSL context
level	error level of the debug message
file	file the error has occurred in
line	line number the error has occurred in
text	the name of the function that returned the error
ret	the return code value

Attention

This function is intended for INTERNAL usage within the library only.

mbedtls_debug_set_threshold()

void mbedtls_debug_set_threshold

(

int

threshold

)

Set the threshold error level to handle globally all debug output. Debug messages that have a level over the threshold value are discarded. (Default value: 0 = No debug )

Parameters

threshold

theshold level of messages to filter on. Messages at a higher level will be discarded. Debug levels 0 No debug 1 Error 2 State change 3 Informational 4 Verbose