mbed TLS v2.7.17
debug.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 #ifndef MBEDTLS_DEBUG_H
50 #define MBEDTLS_DEBUG_H
51 
52 #if !defined(MBEDTLS_CONFIG_FILE)
53 #include "config.h"
54 #else
55 #include MBEDTLS_CONFIG_FILE
56 #endif
57 
58 #include "ssl.h"
59 
60 #if defined(MBEDTLS_ECP_C)
61 #include "ecp.h"
62 #endif
63 
64 #if defined(MBEDTLS_DEBUG_C)
65 
66 #define MBEDTLS_DEBUG_STRIP_PARENS( ... ) __VA_ARGS__
67 
68 #define MBEDTLS_SSL_DEBUG_MSG( level, args ) \
69  mbedtls_debug_print_msg( ssl, level, __FILE__, __LINE__, \
70  MBEDTLS_DEBUG_STRIP_PARENS args )
71 
72 #define MBEDTLS_SSL_DEBUG_RET( level, text, ret ) \
73  mbedtls_debug_print_ret( ssl, level, __FILE__, __LINE__, text, ret )
74 
75 #define MBEDTLS_SSL_DEBUG_BUF( level, text, buf, len ) \
76  mbedtls_debug_print_buf( ssl, level, __FILE__, __LINE__, text, buf, len )
77 
78 #if defined(MBEDTLS_BIGNUM_C)
79 #define MBEDTLS_SSL_DEBUG_MPI( level, text, X ) \
80  mbedtls_debug_print_mpi( ssl, level, __FILE__, __LINE__, text, X )
81 #endif
82 
83 #if defined(MBEDTLS_ECP_C)
84 #define MBEDTLS_SSL_DEBUG_ECP( level, text, X ) \
85  mbedtls_debug_print_ecp( ssl, level, __FILE__, __LINE__, text, X )
86 #endif
87 
88 #if defined(MBEDTLS_X509_CRT_PARSE_C)
89 #define MBEDTLS_SSL_DEBUG_CRT( level, text, crt ) \
90  mbedtls_debug_print_crt( ssl, level, __FILE__, __LINE__, text, crt )
91 #endif
92 
93 #else /* MBEDTLS_DEBUG_C */
94 
95 #define MBEDTLS_SSL_DEBUG_MSG( level, args ) do { } while( 0 )
96 #define MBEDTLS_SSL_DEBUG_RET( level, text, ret ) do { } while( 0 )
97 #define MBEDTLS_SSL_DEBUG_BUF( level, text, buf, len ) do { } while( 0 )
98 #define MBEDTLS_SSL_DEBUG_MPI( level, text, X ) do { } while( 0 )
99 #define MBEDTLS_SSL_DEBUG_ECP( level, text, X ) do { } while( 0 )
100 #define MBEDTLS_SSL_DEBUG_CRT( level, text, crt ) do { } while( 0 )
101 
102 #endif /* MBEDTLS_DEBUG_C */
103 
104 #ifdef __cplusplus
105 extern "C" {
106 #endif
107 
123 void mbedtls_debug_set_threshold( int threshold );
124 
140 void mbedtls_debug_print_msg( const mbedtls_ssl_context *ssl, int level,
141  const char *file, int line,
142  const char *format, ... );
143 
159 void mbedtls_debug_print_ret( const mbedtls_ssl_context *ssl, int level,
160  const char *file, int line,
161  const char *text, int ret );
162 
180 void mbedtls_debug_print_buf( const mbedtls_ssl_context *ssl, int level,
181  const char *file, int line, const char *text,
182  const unsigned char *buf, size_t len );
183 
184 #if defined(MBEDTLS_BIGNUM_C)
185 
201 void mbedtls_debug_print_mpi( const mbedtls_ssl_context *ssl, int level,
202  const char *file, int line,
203  const char *text, const mbedtls_mpi *X );
204 #endif
205 
206 #if defined(MBEDTLS_ECP_C)
207 
223 void mbedtls_debug_print_ecp( const mbedtls_ssl_context *ssl, int level,
224  const char *file, int line,
225  const char *text, const mbedtls_ecp_point *X );
226 #endif
227 
228 #if defined(MBEDTLS_X509_CRT_PARSE_C)
229 
244 void mbedtls_debug_print_crt( const mbedtls_ssl_context *ssl, int level,
245  const char *file, int line,
246  const char *text, const mbedtls_x509_crt *crt );
247 #endif
248 
249 #ifdef __cplusplus
250 }
251 #endif
252 
253 #endif /* debug.h */
254 
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_...
Elliptic curves over GF(p)
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_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:205
SSL/TLS functions.
ECP point structure (jacobian coordinates)
Definition: ecp.h:139
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...