mbed TLS v2.16.1
debug.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8  * SPDX-License-Identifier: GPL-2.0
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  *
24  * This file is part of mbed TLS (https://tls.mbed.org)
25  */
26 #ifndef MBEDTLS_DEBUG_H
27 #define MBEDTLS_DEBUG_H
28 
29 #if !defined(MBEDTLS_CONFIG_FILE)
30 #include "config.h"
31 #else
32 #include MBEDTLS_CONFIG_FILE
33 #endif
34 
35 #include "ssl.h"
36 
37 #if defined(MBEDTLS_ECP_C)
38 #include "ecp.h"
39 #endif
40 
41 #if defined(MBEDTLS_DEBUG_C)
42 
43 #define MBEDTLS_DEBUG_STRIP_PARENS( ... ) __VA_ARGS__
44 
45 #define MBEDTLS_SSL_DEBUG_MSG( level, args ) \
46  mbedtls_debug_print_msg( ssl, level, __FILE__, __LINE__, \
47  MBEDTLS_DEBUG_STRIP_PARENS args )
48 
49 #define MBEDTLS_SSL_DEBUG_RET( level, text, ret ) \
50  mbedtls_debug_print_ret( ssl, level, __FILE__, __LINE__, text, ret )
51 
52 #define MBEDTLS_SSL_DEBUG_BUF( level, text, buf, len ) \
53  mbedtls_debug_print_buf( ssl, level, __FILE__, __LINE__, text, buf, len )
54 
55 #if defined(MBEDTLS_BIGNUM_C)
56 #define MBEDTLS_SSL_DEBUG_MPI( level, text, X ) \
57  mbedtls_debug_print_mpi( ssl, level, __FILE__, __LINE__, text, X )
58 #endif
59 
60 #if defined(MBEDTLS_ECP_C)
61 #define MBEDTLS_SSL_DEBUG_ECP( level, text, X ) \
62  mbedtls_debug_print_ecp( ssl, level, __FILE__, __LINE__, text, X )
63 #endif
64 
65 #if defined(MBEDTLS_X509_CRT_PARSE_C)
66 #define MBEDTLS_SSL_DEBUG_CRT( level, text, crt ) \
67  mbedtls_debug_print_crt( ssl, level, __FILE__, __LINE__, text, crt )
68 #endif
69 
70 #if defined(MBEDTLS_ECDH_C)
71 #define MBEDTLS_SSL_DEBUG_ECDH( level, ecdh, attr ) \
72  mbedtls_debug_printf_ecdh( ssl, level, __FILE__, __LINE__, ecdh, attr )
73 #endif
74 
75 #else /* MBEDTLS_DEBUG_C */
76 
77 #define MBEDTLS_SSL_DEBUG_MSG( level, args ) do { } while( 0 )
78 #define MBEDTLS_SSL_DEBUG_RET( level, text, ret ) do { } while( 0 )
79 #define MBEDTLS_SSL_DEBUG_BUF( level, text, buf, len ) do { } while( 0 )
80 #define MBEDTLS_SSL_DEBUG_MPI( level, text, X ) do { } while( 0 )
81 #define MBEDTLS_SSL_DEBUG_ECP( level, text, X ) do { } while( 0 )
82 #define MBEDTLS_SSL_DEBUG_CRT( level, text, crt ) do { } while( 0 )
83 #define MBEDTLS_SSL_DEBUG_ECDH( level, ecdh, attr ) do { } while( 0 )
84 
85 #endif /* MBEDTLS_DEBUG_C */
86 
87 #ifdef __cplusplus
88 extern "C" {
89 #endif
90 
106 void mbedtls_debug_set_threshold( int threshold );
107 
123 void mbedtls_debug_print_msg( const mbedtls_ssl_context *ssl, int level,
124  const char *file, int line,
125  const char *format, ... );
126 
142 void mbedtls_debug_print_ret( const mbedtls_ssl_context *ssl, int level,
143  const char *file, int line,
144  const char *text, int ret );
145 
163 void mbedtls_debug_print_buf( const mbedtls_ssl_context *ssl, int level,
164  const char *file, int line, const char *text,
165  const unsigned char *buf, size_t len );
166 
167 #if defined(MBEDTLS_BIGNUM_C)
168 
184 void mbedtls_debug_print_mpi( const mbedtls_ssl_context *ssl, int level,
185  const char *file, int line,
186  const char *text, const mbedtls_mpi *X );
187 #endif
188 
189 #if defined(MBEDTLS_ECP_C)
190 
206 void mbedtls_debug_print_ecp( const mbedtls_ssl_context *ssl, int level,
207  const char *file, int line,
208  const char *text, const mbedtls_ecp_point *X );
209 #endif
210 
211 #if defined(MBEDTLS_X509_CRT_PARSE_C)
212 
227 void mbedtls_debug_print_crt( const mbedtls_ssl_context *ssl, int level,
228  const char *file, int line,
229  const char *text, const mbedtls_x509_crt *crt );
230 #endif
231 
232 #if defined(MBEDTLS_ECDH_C)
233 typedef enum
234 {
239 
256 void mbedtls_debug_printf_ecdh( const mbedtls_ssl_context *ssl, int level,
257  const char *file, int line,
258  const mbedtls_ecdh_context *ecdh,
260 #endif
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 
266 #endif /* debug.h */
267 
void mbedtls_debug_print_crt(const mbedtls_ssl_context *ssl, int level, const char *file, int line, const char *text, const mbedtls_x509_crt *crt)
Print a X.509 certificate structure to the debug output. This function is always used through the MBE...
void mbedtls_debug_print_mpi(const mbedtls_ssl_context *ssl, int level, const char *file, int line, const char *text, const mbedtls_mpi *X)
Print a MPI variable to the debug output. This function is always used through the MBEDTLS_SSL_DEBUG_...
This file provides an API for Elliptic Curves over GF(P) (ECP).
mbedtls_debug_ecdh_attr
Definition: debug.h:233
Configuration options (set of defines)
void mbedtls_debug_set_threshold(int threshold)
Set the threshold error level to handle globally all debug output. Debug messages that have a level o...
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 MB...
void mbedtls_debug_printf_ecdh(const mbedtls_ssl_context *ssl, int level, const char *file, int line, const mbedtls_ecdh_context *ecdh, mbedtls_debug_ecdh_attr attr)
Print a field of the ECDH structure in the SSL context to the debug output. This function is always u...
The ECDH context structure.
Definition: ecdh.h:112
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()...
MPI structure.
Definition: bignum.h:182
SSL/TLS functions.
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:126
void mbedtls_debug_print_ecp(const mbedtls_ssl_context *ssl, int level, const char *file, int line, const char *text, const mbedtls_ecp_point *X)
Print an ECP point to the debug output. This function is always used through the MBEDTLS_SSL_DEBUG_EC...
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 MBEDT...