232 lines
7.7 KiB
C
232 lines
7.7 KiB
C
/* logging.h
|
|
*
|
|
* Copyright (C) 2006-2023 wolfSSL Inc.
|
|
*
|
|
* This file is part of wolfSSL.
|
|
*
|
|
* wolfSSL is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* wolfSSL is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
|
|
*/
|
|
|
|
/*!
|
|
\file wolfssl/wolfcrypt/logging.h
|
|
*/
|
|
|
|
|
|
/* submitted by eof */
|
|
|
|
|
|
#ifndef WOLFSSL_LOGGING_H
|
|
#define WOLFSSL_LOGGING_H
|
|
|
|
#include <wolfssl/wolfcrypt/types.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
enum wc_LogLevels {
|
|
ERROR_LOG = 0,
|
|
INFO_LOG,
|
|
ENTER_LOG,
|
|
LEAVE_LOG,
|
|
OTHER_LOG
|
|
};
|
|
|
|
#ifdef WOLFSSL_FUNC_TIME
|
|
/* WARNING: This code is only to be used for debugging performance.
|
|
* The code is not thread-safe.
|
|
* Do not use WOLFSSL_FUNC_TIME in production code.
|
|
*/
|
|
enum wc_FuncNum {
|
|
WC_FUNC_HELLO_REQUEST_SEND = 0,
|
|
WC_FUNC_HELLO_REQUEST_DO,
|
|
WC_FUNC_CLIENT_HELLO_SEND,
|
|
WC_FUNC_CLIENT_HELLO_DO,
|
|
WC_FUNC_SERVER_HELLO_SEND,
|
|
WC_FUNC_SERVER_HELLO_DO,
|
|
WC_FUNC_ENCRYPTED_EXTENSIONS_SEND,
|
|
WC_FUNC_ENCRYPTED_EXTENSIONS_DO,
|
|
WC_FUNC_CERTIFICATE_REQUEST_SEND,
|
|
WC_FUNC_CERTIFICATE_REQUEST_DO,
|
|
WC_FUNC_CERTIFICATE_SEND,
|
|
WC_FUNC_CERTIFICATE_DO,
|
|
WC_FUNC_CERTIFICATE_VERIFY_SEND,
|
|
WC_FUNC_CERTIFICATE_VERIFY_DO,
|
|
WC_FUNC_FINISHED_SEND,
|
|
WC_FUNC_FINISHED_DO,
|
|
WC_FUNC_KEY_UPDATE_SEND,
|
|
WC_FUNC_KEY_UPDATE_DO,
|
|
WC_FUNC_EARLY_DATA_SEND,
|
|
WC_FUNC_EARLY_DATA_DO,
|
|
WC_FUNC_NEW_SESSION_TICKET_SEND,
|
|
WC_FUNC_NEW_SESSION_TICKET_DO,
|
|
WC_FUNC_SERVER_HELLO_DONE_SEND,
|
|
WC_FUNC_SERVER_HELLO_DONE_DO,
|
|
WC_FUNC_TICKET_SEND,
|
|
WC_FUNC_TICKET_DO,
|
|
WC_FUNC_CLIENT_KEY_EXCHANGE_SEND,
|
|
WC_FUNC_CLIENT_KEY_EXCHANGE_DO,
|
|
WC_FUNC_CERTIFICATE_STATUS_SEND,
|
|
WC_FUNC_CERTIFICATE_STATUS_DO,
|
|
WC_FUNC_SERVER_KEY_EXCHANGE_SEND,
|
|
WC_FUNC_SERVER_KEY_EXCHANGE_DO,
|
|
WC_FUNC_END_OF_EARLY_DATA_SEND,
|
|
WC_FUNC_END_OF_EARLY_DATA_DO,
|
|
WC_FUNC_COUNT
|
|
};
|
|
#endif
|
|
|
|
typedef void (*wolfSSL_Logging_cb)(const int logLevel,
|
|
const char *const logMessage);
|
|
|
|
WOLFSSL_API int wolfSSL_SetLoggingCb(wolfSSL_Logging_cb log_function);
|
|
WOLFSSL_API wolfSSL_Logging_cb wolfSSL_GetLoggingCb(void);
|
|
|
|
/* turn logging on, only if compiled in */
|
|
WOLFSSL_API int wolfSSL_Debugging_ON(void);
|
|
/* turn logging off */
|
|
WOLFSSL_API void wolfSSL_Debugging_OFF(void);
|
|
|
|
WOLFSSL_API void wolfSSL_SetLoggingPrefix(const char* prefix);
|
|
|
|
#ifdef HAVE_WC_INTROSPECTION
|
|
WOLFSSL_API const char *wolfSSL_configure_args(void);
|
|
WOLFSSL_API const char *wolfSSL_global_cflags(void);
|
|
#endif
|
|
|
|
|
|
#if (defined(OPENSSL_EXTRA) && !defined(_WIN32) && \
|
|
!defined(NO_ERROR_QUEUE)) || defined(DEBUG_WOLFSSL_VERBOSE) \
|
|
|| defined(HAVE_MEMCACHED)
|
|
#define WOLFSSL_HAVE_ERROR_QUEUE
|
|
#endif
|
|
|
|
#if defined(OPENSSL_EXTRA) || defined(DEBUG_WOLFSSL_VERBOSE) || defined(HAVE_MEMCACHED)
|
|
WOLFSSL_LOCAL int wc_LoggingInit(void);
|
|
WOLFSSL_LOCAL int wc_LoggingCleanup(void);
|
|
WOLFSSL_LOCAL int wc_AddErrorNode(int error, int line, char* buf,
|
|
char* file);
|
|
WOLFSSL_LOCAL int wc_PeekErrorNode(int idx, const char **file,
|
|
const char **reason, int *line);
|
|
WOLFSSL_LOCAL void wc_RemoveErrorNode(int idx);
|
|
WOLFSSL_LOCAL void wc_ClearErrorNodes(void);
|
|
WOLFSSL_LOCAL int wc_PullErrorNode(const char **file, const char **reason,
|
|
int *line);
|
|
WOLFSSL_API int wc_SetLoggingHeap(void* h);
|
|
WOLFSSL_API int wc_ERR_remove_state(void);
|
|
WOLFSSL_LOCAL unsigned long wc_PeekErrorNodeLineData(
|
|
const char **file, int *line, const char **data, int *flags,
|
|
int (*ignore_err)(int err));
|
|
WOLFSSL_LOCAL unsigned long wc_GetErrorNodeErr(void);
|
|
#if !defined(NO_FILESYSTEM) && !defined(NO_STDIO_FILESYSTEM)
|
|
WOLFSSL_API void wc_ERR_print_errors_fp(XFILE fp);
|
|
WOLFSSL_API void wc_ERR_print_errors_cb(int (*cb)(const char *str,
|
|
size_t len, void *u), void *u);
|
|
#endif
|
|
#endif /* OPENSSL_EXTRA || DEBUG_WOLFSSL_VERBOSE || HAVE_MEMCACHED */
|
|
|
|
#ifdef WOLFSSL_FUNC_TIME
|
|
/* WARNING: This code is only to be used for debugging performance.
|
|
* The code is not thread-safe.
|
|
* Do not use WOLFSSL_FUNC_TIME in production code.
|
|
*/
|
|
WOLFSSL_API void WOLFSSL_START(int funcNum);
|
|
WOLFSSL_API void WOLFSSL_END(int funcNum);
|
|
WOLFSSL_API void WOLFSSL_TIME(int count);
|
|
#else
|
|
#define WOLFSSL_START(n) WC_DO_NOTHING
|
|
#define WOLFSSL_END(n) WC_DO_NOTHING
|
|
#define WOLFSSL_TIME(n) WC_DO_NOTHING
|
|
#endif
|
|
|
|
#if defined(DEBUG_WOLFSSL) && !defined(WOLFSSL_DEBUG_ERRORS_ONLY)
|
|
#if defined(_WIN32)
|
|
#if defined(INTIME_RTOS)
|
|
#define __func__ NULL
|
|
#else
|
|
#define __func__ __FUNCTION__
|
|
#endif
|
|
#endif
|
|
|
|
/* a is prepended to m and b is appended, creating a log msg a + m + b */
|
|
#define WOLFSSL_LOG_CAT(a, m, b) #a " " m " " #b
|
|
|
|
WOLFSSL_API void WOLFSSL_ENTER(const char* msg);
|
|
WOLFSSL_API void WOLFSSL_LEAVE(const char* msg, int ret);
|
|
#define WOLFSSL_STUB(m) \
|
|
WOLFSSL_MSG(WOLFSSL_LOG_CAT(wolfSSL Stub, m, not implemented))
|
|
WOLFSSL_API int WOLFSSL_IS_DEBUG_ON(void);
|
|
#if defined(XVSNPRINTF)
|
|
WOLFSSL_API void WOLFSSL_MSG_EX(const char* fmt, ...);
|
|
#define HAVE_WOLFSSL_MSG_EX
|
|
#else
|
|
__inline void WOLFSSL_MSG_EX(const char *fmt, ...) { (void)(fmt); return; }
|
|
#endif
|
|
WOLFSSL_API void WOLFSSL_MSG(const char* msg);
|
|
WOLFSSL_API void WOLFSSL_BUFFER(const byte* buffer, word32 length);
|
|
|
|
#else
|
|
|
|
#define WOLFSSL_ENTER(m) WC_DO_NOTHING
|
|
#define WOLFSSL_LEAVE(m, r) WC_DO_NOTHING
|
|
#define WOLFSSL_STUB(m) WC_DO_NOTHING
|
|
#define WOLFSSL_IS_DEBUG_ON() 0
|
|
|
|
__inline void WOLFSSL_MSG_EX(const char *fmt, ...) { (void)(fmt); return; }
|
|
#define WOLFSSL_MSG(m) WC_DO_NOTHING
|
|
#define WOLFSSL_BUFFER(b, l) WC_DO_NOTHING
|
|
|
|
#endif /* DEBUG_WOLFSSL && !WOLFSSL_DEBUG_ERRORS_ONLY */
|
|
|
|
#if defined(DEBUG_WOLFSSL) || defined(OPENSSL_ALL) || defined(WOLFSSL_NGINX) ||\
|
|
defined(WOLFSSL_HAPROXY) || defined(OPENSSL_EXTRA)
|
|
|
|
#ifdef WOLFSSL_HAVE_ERROR_QUEUE
|
|
WOLFSSL_API void WOLFSSL_ERROR_LINE(int err, const char* func, unsigned int line,
|
|
const char* file, void* ctx);
|
|
#define WOLFSSL_ERROR(x) \
|
|
WOLFSSL_ERROR_LINE((x), __func__, __LINE__, __FILE__, NULL)
|
|
#else
|
|
WOLFSSL_API void WOLFSSL_ERROR(int err);
|
|
#endif /* WOLFSSL_HAVE_ERROR_QUEUE */
|
|
|
|
WOLFSSL_API void WOLFSSL_ERROR_MSG(const char* msg);
|
|
#else
|
|
#define WOLFSSL_ERROR(e) (void)(e)
|
|
#define WOLFSSL_ERROR_MSG(m) (void)(m)
|
|
#endif /* DEBUG_WOLFSSL | OPENSSL_ALL || WOLFSSL_NGINX || WOLFSSL_HAPROXY ||
|
|
OPENSSL_EXTRA */
|
|
|
|
#ifdef WOLFSSL_VERBOSE_ERRORS
|
|
#define WOLFSSL_ERROR_VERBOSE(e) WOLFSSL_ERROR(e)
|
|
#else
|
|
#define WOLFSSL_ERROR_VERBOSE(e) (void)(e)
|
|
#endif /* WOLFSSL_VERBOSE_ERRORS */
|
|
|
|
#ifdef HAVE_STACK_SIZE_VERBOSE
|
|
extern WOLFSSL_API THREAD_LS_T unsigned char *StackSizeCheck_myStack;
|
|
extern WOLFSSL_API THREAD_LS_T size_t StackSizeCheck_stackSize;
|
|
extern WOLFSSL_API THREAD_LS_T size_t StackSizeCheck_stackSizeHWM;
|
|
extern WOLFSSL_API THREAD_LS_T size_t *StackSizeCheck_stackSizeHWM_ptr;
|
|
extern WOLFSSL_API THREAD_LS_T void *StackSizeCheck_stackOffsetPointer;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* WOLFSSL_LOGGING_H */
|
|
|