mbed TLS v2.23.0: debug.h Source File

mbed TLS v2.23.0

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: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 *
22 * This file is part of mbed TLS (https://tls.mbed.org)
23 */
24 #ifndef MBEDTLS_DEBUG_H
25 #define MBEDTLS_DEBUG_H
26
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "mbedtls/config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32
33 #include "mbedtls/ssl.h"
34
35 #if defined(MBEDTLS_ECP_C)
36 #include "mbedtls/ecp.h"
37 #endif
38
39 #if defined(MBEDTLS_DEBUG_C)
40
41 #define MBEDTLS_DEBUG_STRIP_PARENS( ... ) __VA_ARGS__
42
43 #define MBEDTLS_SSL_DEBUG_MSG( level, args ) \
44 mbedtls_debug_print_msg( ssl, level, __FILE__, __LINE__, \
45 MBEDTLS_DEBUG_STRIP_PARENS args )
46
47 #define MBEDTLS_SSL_DEBUG_RET( level, text, ret ) \
48 mbedtls_debug_print_ret( ssl, level, __FILE__, __LINE__, text, ret )
49
50 #define MBEDTLS_SSL_DEBUG_BUF( level, text, buf, len ) \
51 mbedtls_debug_print_buf( ssl, level, __FILE__, __LINE__, text, buf, len )
52
53 #if defined(MBEDTLS_BIGNUM_C)
54 #define MBEDTLS_SSL_DEBUG_MPI( level, text, X ) \
55 mbedtls_debug_print_mpi( ssl, level, __FILE__, __LINE__, text, X )
56 #endif
57
58 #if defined(MBEDTLS_ECP_C)
59 #define MBEDTLS_SSL_DEBUG_ECP( level, text, X ) \
60 mbedtls_debug_print_ecp( ssl, level, __FILE__, __LINE__, text, X )
61 #endif
62
63 #if defined(MBEDTLS_X509_CRT_PARSE_C)
64 #define MBEDTLS_SSL_DEBUG_CRT( level, text, crt ) \
65 mbedtls_debug_print_crt( ssl, level, __FILE__, __LINE__, text, crt )
66 #endif
67
68 #if defined(MBEDTLS_ECDH_C)
69 #define MBEDTLS_SSL_DEBUG_ECDH( level, ecdh, attr ) \
70 mbedtls_debug_printf_ecdh( ssl, level, __FILE__, __LINE__, ecdh, attr )
71 #endif
72
73 #else /* MBEDTLS_DEBUG_C */
74
75 #define MBEDTLS_SSL_DEBUG_MSG( level, args ) do { } while( 0 )
76 #define MBEDTLS_SSL_DEBUG_RET( level, text, ret ) do { } while( 0 )
77 #define MBEDTLS_SSL_DEBUG_BUF( level, text, buf, len ) do { } while( 0 )
78 #define MBEDTLS_SSL_DEBUG_MPI( level, text, X ) do { } while( 0 )
79 #define MBEDTLS_SSL_DEBUG_ECP( level, text, X ) do { } while( 0 )
80 #define MBEDTLS_SSL_DEBUG_CRT( level, text, crt ) do { } while( 0 )
81 #define MBEDTLS_SSL_DEBUG_ECDH( level, ecdh, attr ) do { } while( 0 )
82
83 #endif /* MBEDTLS_DEBUG_C */
84
85 #ifdef __cplusplus
86 extern "C" {
87 #endif
88
104 void mbedtls_debug_set_threshold( int threshold );
105
121 void mbedtls_debug_print_msg( const mbedtls_ssl_context *ssl, int level,
122 const char *file, int line,
123 const char *format, ... );
124
140 void mbedtls_debug_print_ret( const mbedtls_ssl_context *ssl, int level,
141 const char *file, int line,
142 const char *text, int ret );
143
161 void mbedtls_debug_print_buf( const mbedtls_ssl_context *ssl, int level,
162 const char *file, int line, const char *text,
163 const unsigned char *buf, size_t len );
164
165 #if defined(MBEDTLS_BIGNUM_C)
166
182 void mbedtls_debug_print_mpi( const mbedtls_ssl_context *ssl, int level,
183 const char *file, int line,
184 const char *text, const mbedtls_mpi *X );
185 #endif
186
187 #if defined(MBEDTLS_ECP_C)
188
204 void mbedtls_debug_print_ecp( const mbedtls_ssl_context *ssl, int level,
205 const char *file, int line,
206 const char *text, const mbedtls_ecp_point *X );
207 #endif
208
209 #if defined(MBEDTLS_X509_CRT_PARSE_C)
210
225 void mbedtls_debug_print_crt( const mbedtls_ssl_context *ssl, int level,
226 const char *file, int line,
227 const char *text, const mbedtls_x509_crt *crt );
228 #endif
229
230 #if defined(MBEDTLS_ECDH_C)
231 typedef enum
232 {
233 MBEDTLS_DEBUG_ECDH_Q,
234 MBEDTLS_DEBUG_ECDH_QP,
235 MBEDTLS_DEBUG_ECDH_Z,
236 } mbedtls_debug_ecdh_attr;
237
254 void mbedtls_debug_printf_ecdh( const mbedtls_ssl_context *ssl, int level,
255 const char *file, int line,
256 const mbedtls_ecdh_context *ecdh,
257 mbedtls_debug_ecdh_attr attr );
258 #endif
259
260 #ifdef __cplusplus
261 }
262 #endif
263
264 #endif /* debug.h */
mbedtls_debug_print_ecp
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...
ecp.h
This file provides an API for Elliptic Curves over GF(P) (ECP).
mbedtls_mpi
MPI structure.
Definition: bignum.h:187
mbedtls_ecdh_context
The ECDH context structure.
Definition: ecdh.h:107
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 MB...
MBEDTLS_DEBUG_ECDH_Z
@ MBEDTLS_DEBUG_ECDH_Z
Definition: debug.h:235
mbedtls_debug_print_crt
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...
mbedtls_debug_ecdh_attr
mbedtls_debug_ecdh_attr
Definition: debug.h:232
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 o...
mbedtls_x509_crt
Definition: x509_crt.h:55
mbedtls_ssl_context
Definition: ssl.h:1146
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()...
MBEDTLS_DEBUG_ECDH_QP
@ MBEDTLS_DEBUG_ECDH_QP
Definition: debug.h:234
MBEDTLS_DEBUG_ECDH_Q
@ MBEDTLS_DEBUG_ECDH_Q
Definition: debug.h:233
ssl.h
SSL/TLS functions.
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 MBEDT...
config.h
Configuration options (set of defines)
mbedtls_debug_printf_ecdh
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...
mbedtls_debug_print_mpi
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_...
mbedtls_ecp_point
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:135