mirror of
https://github.com/Mbed-TLS/mbedtls.git
synced 2026-03-20 11:11:08 +01:00
3c67824964
In `test_suite_debug`, test `mbedtls_debug_snprintf()`, which uses `mbedtls_vsnprintf()` like `mbedtls_debug_print_msg()`. Do this instead of testing `mbedtls_snprintf()`, which might be subtly different (older Windows runtimes had slightly different behavior for vsnprintf() vs snprintf(); TF-PSA-Crypto might pick up a different function if the platform configuration is different in TF-PSA-Crypto and Mbed TLS). Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
109 lines
4.6 KiB
C
109 lines
4.6 KiB
C
/**
|
|
* \file debug_internal.h
|
|
*
|
|
* \brief Internal part of the public "debug.h".
|
|
*/
|
|
/*
|
|
* Copyright The Mbed TLS Contributors
|
|
* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
|
|
*/
|
|
#ifndef MBEDTLS_DEBUG_INTERNAL_H
|
|
#define MBEDTLS_DEBUG_INTERNAL_H
|
|
|
|
#include "mbedtls/debug.h"
|
|
|
|
/* This should be equivalent to mbedtls_snprintf(). But it might not be due
|
|
* to platform shenanigans. For example, Mbed TLS and TF-PSA-Crypto could
|
|
* have inconsistent platform definitions. On Mingw, some code might
|
|
* be built with a different setting of __USE_MINGW_ANSI_STDIO, resulting
|
|
* in an old non-C99 printf being used somewhere.
|
|
*
|
|
* Our library assumes that mbedtls_snprintf() and other printf functions
|
|
* are consistent throughout. This function is not an official API and
|
|
* is not meant to be used inside the library. It is provided to help
|
|
* debugging printf inconsistencies issues. If you need it, good luck!
|
|
*/
|
|
int mbedtls_debug_snprintf(char *dest, size_t maxlen,
|
|
const char *format, ...) MBEDTLS_PRINTF_ATTRIBUTE(3, 4);
|
|
/**
|
|
* \brief 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.
|
|
*
|
|
* \param ssl SSL context
|
|
* \param level error level of the debug message
|
|
* \param file file the message has occurred in
|
|
* \param line line number the message has occurred at
|
|
* \param format format specifier, in printf format
|
|
* \param ... variables used by the format specifier
|
|
*
|
|
* \attention This function is intended for INTERNAL usage within the
|
|
* library only.
|
|
*/
|
|
void mbedtls_debug_print_msg(const mbedtls_ssl_context *ssl, int level,
|
|
const char *file, int line,
|
|
const char *format, ...) MBEDTLS_PRINTF_ATTRIBUTE(5, 6);
|
|
|
|
/**
|
|
* \brief 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.
|
|
*
|
|
* \param ssl SSL context
|
|
* \param level error level of the debug message
|
|
* \param file file the error has occurred in
|
|
* \param line line number the error has occurred in
|
|
* \param text the name of the function that returned the error
|
|
* \param ret the return code value
|
|
*
|
|
* \attention This function is intended for INTERNAL usage within the
|
|
* library only.
|
|
*/
|
|
void mbedtls_debug_print_ret(const mbedtls_ssl_context *ssl, int level,
|
|
const char *file, int line,
|
|
const char *text, int ret);
|
|
|
|
/**
|
|
* \brief 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.
|
|
*
|
|
* \param ssl SSL context
|
|
* \param level error level of the debug message
|
|
* \param file file the error has occurred in
|
|
* \param line line number the error has occurred in
|
|
* \param text a name or label for the buffer being dumped. Normally the
|
|
* variable or buffer name
|
|
* \param buf the buffer to be outputted
|
|
* \param len length of the buffer
|
|
*
|
|
* \attention This function is intended for INTERNAL usage within the
|
|
* library only.
|
|
*/
|
|
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);
|
|
|
|
#if defined(MBEDTLS_X509_CRT_PARSE_C) && !defined(MBEDTLS_X509_REMOVE_INFO)
|
|
/**
|
|
* \brief Print a X.509 certificate structure to the debug output. This
|
|
* function is always used through the MBEDTLS_SSL_DEBUG_CRT() macro,
|
|
* which supplies the ssl context, file and line number parameters.
|
|
*
|
|
* \param ssl SSL context
|
|
* \param level error level of the debug message
|
|
* \param file file the error has occurred in
|
|
* \param line line number the error has occurred in
|
|
* \param text a name or label for the certificate being output
|
|
* \param crt X.509 certificate structure
|
|
*
|
|
* \attention This function is intended for INTERNAL usage within the
|
|
* library only.
|
|
*/
|
|
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);
|
|
#endif
|
|
|
|
#endif /* MBEDTLS_DEBUG_INTERNAL_H */
|