Skip to content

Revamp Debug Selection and Output in wolfProvider #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ColtonWilley merged 2 commits into from
Aug 15, 2025
Merged

Revamp Debug Selection and Output in wolfProvider #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5557df8
Revamp debug selection and output rebase
aidangarske Aug 13, 2025
d5710e6
Add braces and udpdate readme
aidangarske Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ It will retrieve the dependencies and compile them as necessary. To use other th
OPENSSL_TAG=openssl-3.5.0 WOLFSSL_TAG=v5.8.0-stable WOLFPROV_DEBUG=1 scripts/build-wolfprovider.sh
```

Or you can set them with variables like so:

```
./scripts/build-wolfprovider.sh --debug --openssl-ver=openssl-3.5.0 --wolfssl-ver=v5.8.0-stable
```

To clean the build, use the following:
```
./scripts/build-wolfprovider.sh --clean
Expand Down Expand Up @@ -153,3 +159,8 @@ To run the command tests:
To run the cipher suite testing:
* `./scripts/test-wp-cs.sh`


## Debugging

To enable wolfProvider debug logging, build with `--debug` which enables exit messages, error messages, and informational messages. If you want to filter logging a certain way or increase detail level, set `WOLFPROV_LOG_LEVEL_FILTER` and `WOLFPROV_LOG_COMPONENTS_FILTER` in `include/wolfprovider/wp_logging.h` as needed. See comments in that file for examples.

142 changes: 120 additions & 22 deletions include/wolfprovider/wp_logging.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,37 +67,91 @@
* WOLFPROV_LOG_PRINTF Define to Use printf instead of fprintf (to stderr)
* for logs. Not applicable if using WOLFPROV_USER_LOG
* or custom logging callback.
*
* COMPILE-TIME MACRO CONFIGURATIONS:
* Define these macros in this header to control logging at compile time:
* NOTE: wolfProvider needs to be built with --debug to enable the logging first
* before we can set the log level and components.
*
* WOLFPROV_LOG_LEVEL_FILTER Sets the log level. Use WP_LOG_* constants from enum below.
* Examples:
* - WP_LOG_ERROR (only errors)
* - (WP_LOG_ERROR | WP_LOG_ENTER) (errors and function enter)
* - (WP_LOG_ERROR | WP_LOG_LEAVE) (errors and function leave)
* - (WP_LOG_LEVEL_ALL) (all levels)
*
* WOLFPROV_LOG_COMPONENTS_FILTER Set component bitmask to filter specific
* algorithms. Use WP_LOG_* constants from enum below.
* Examples:
* - WP_LOG_HKDF (HKDF only)
* - (WP_LOG_AES | WP_LOG_DES) (ciphers only)
* - (WP_LOG_ECC | WP_LOG_RSA | WP_LOG_HKDF) (multiple algorithms)
* - WP_LOG_CIPHER (all cipher operations)
*
* EXAMPLES:
* #define WOLFPROV_LOG_LEVEL_FILTER (WP_LOG_ERROR | WP_LOG_ENTER | WP_LOG_LEAVE | WP_LOG_INFO)
* #define WOLFPROV_LOG_COMPONENTS_FILTER WP_LOG_HKDF
* // Shows level (ERROR + ENTER/LEAVE + INFO) for HKDF operations only
*
* #define WOLFPROV_LOG_LEVEL_FILTER (WP_LOG_LEVEL_ALL)
* #define WOLFPROV_LOG_COMPONENTS_FILTER (WP_LOG_ECC | WP_LOG_RSA | WP_LOG_HKDF)
* // Shows level (ERROR + ENTER/LEAVE + INFO + VERBOSE + DEBUG + TRACE) for ECC, RSA, and HKDF only
*/
enum wolfProv_LogType {
WP_LOG_ERROR = 0x0001, /* logs errors */
WP_LOG_ENTER = 0x0002, /* logs function enter*/
WP_LOG_LEAVE = 0x0004, /* logs function leave */
WP_LOG_INFO = 0x0008, /* logs informative messages */
WP_LOG_VERBOSE = 0x0010, /* logs encrypted/decrypted/digested data */

/* default log level when logging is turned on, all but verbose */
WP_LOG_LEVEL_DEFAULT = (WP_LOG_ERROR
| WP_LOG_ENTER
| WP_LOG_LEAVE
| WP_LOG_INFO),
WP_LOG_ERROR = 0x0001, /* logs errors */
WP_LOG_ENTER = 0x0002, /* logs function enter*/
WP_LOG_LEAVE = 0x0004, /* logs function leave */
WP_LOG_INFO = 0x0008, /* logs informative messages */
WP_LOG_VERBOSE = 0x0010, /* logs encrypted/decrypted/digested data */
WP_LOG_DEBUG = 0x0020, /* logs debug-level detailed information */
WP_LOG_TRACE = 0x0040, /* logs trace-level ultra-detailed information */

/* default log level when logging is turned on */
WP_LOG_LEVEL_DEFAULT = (WP_LOG_ERROR | WP_LOG_LEAVE | WP_LOG_INFO),

/* log all, including verbose */
WP_LOG_LEVEL_ALL = (WP_LOG_ERROR
| WP_LOG_ENTER
| WP_LOG_LEAVE
| WP_LOG_INFO
| WP_LOG_VERBOSE)
| WP_LOG_VERBOSE
| WP_LOG_DEBUG
| WP_LOG_TRACE)
};

enum wolfProv_LogComponents {
WP_LOG_RNG = 0x0001, /* random number generation */
WP_LOG_DIGEST = 0x0002, /* digest (SHA-1/2/3) */
WP_LOG_MAC = 0x0004, /* mac functions: HMAC, CMAC */
WP_LOG_CIPHER = 0x0008, /* cipher (AES, 3DES) */
WP_LOG_PK = 0x0010, /* public key algorithms (RSA, ECC) */
WP_LOG_KE = 0x0020, /* key agreement (DH, ECDH) */
WP_LOG_KDF = 0x0040, /* password base key derivation algorithms */
WP_LOG_PROVIDER = 0x0080, /* all provider specific logs */
/* Legacy component categories */
WP_LOG_RNG = 0x0001, /* random number generation */
WP_LOG_DIGEST = 0x0002, /* digest (SHA-1/2/3) */
WP_LOG_MAC = 0x0004, /* mac functions: HMAC, CMAC */
WP_LOG_CIPHER = 0x0008, /* cipher (AES, 3DES) */
WP_LOG_PK = 0x0010, /* public key algorithms (RSA, ECC) */
WP_LOG_KE = 0x0020, /* key agreement (DH, ECDH) */
WP_LOG_KDF = 0x0040, /* password base key derivation algorithms */
WP_LOG_PROVIDER = 0x0080, /* all provider specific logs */

/* Granular algorithm family categories */
WP_LOG_RSA = 0x0001, /* RSA operations */
WP_LOG_ECC = 0x0002, /* ECC operations */
WP_LOG_DH = 0x0004, /* Diffie-Hellman operations */
WP_LOG_AES = 0x0008, /* AES cipher operations */
WP_LOG_DES = 0x0010, /* 3DES cipher operations */
WP_LOG_SHA = 0x0020, /* SHA digest operations */
WP_LOG_MD5 = 0x0040, /* MD5 digest operations */
WP_LOG_HMAC = 0x0080, /* HMAC operations */
WP_LOG_CMAC = 0x0100, /* CMAC operations */
WP_LOG_HKDF = 0x0200, /* HKDF operations */
WP_LOG_PBKDF2 = 0x0400, /* PBKDF2 operations */
WP_LOG_KRB5KDF = 0x0800, /* KRB5KDF operations */
WP_LOG_DRBG = 0x1000, /* DRBG operations */
WP_LOG_ECDSA = 0x2000, /* ECDSA signature operations */
WP_LOG_ECDH = 0x4000, /* ECDH key exchange operations */
WP_LOG_ED25519 = 0x8000, /* Ed25519 operations */
WP_LOG_ED448 = 0x10000, /* Ed448 operations */
WP_LOG_X25519 = 0x20000, /* X25519 operations */
WP_LOG_X448 = 0x40000, /* X448 operations */
WP_LOG_QUERY = 0x80000, /* wolfprov_query operations */
WP_LOG_TLS1_PRF = 0x100000, /* TLS1 PRF operations */

/* log all compoenents */
WP_LOG_COMPONENTS_ALL = (WP_LOG_RNG
Expand All @@ -107,12 +161,52 @@ enum wolfProv_LogComponents {
| WP_LOG_PK
| WP_LOG_KE
| WP_LOG_KDF
| WP_LOG_PROVIDER),
| WP_LOG_PROVIDER
| WP_LOG_RSA
| WP_LOG_ECC
| WP_LOG_DH
| WP_LOG_AES
| WP_LOG_DES
| WP_LOG_SHA
| WP_LOG_MD5
| WP_LOG_HMAC
| WP_LOG_CMAC
| WP_LOG_HKDF
| WP_LOG_PBKDF2
| WP_LOG_KRB5KDF
| WP_LOG_DRBG
| WP_LOG_ECDSA
| WP_LOG_ECDH
| WP_LOG_ED25519
| WP_LOG_ED448
| WP_LOG_X25519
| WP_LOG_X448
| WP_LOG_QUERY
| WP_LOG_TLS1_PRF),

/* default compoenents logged */
WP_LOG_COMPONENTS_DEFAULT = WP_LOG_COMPONENTS_ALL
};

/* Manually set the log level */
#ifndef WOLFPROV_LOG_LEVEL_FILTER
#define WOLFPROV_LOG_LEVEL_FILTER WP_LOG_LEVEL_DEFAULT
#endif

/* Manually set the components */
#ifndef WOLFPROV_LOG_COMPONENTS_FILTER
#define WOLFPROV_LOG_COMPONENTS_FILTER WP_LOG_COMPONENTS_DEFAULT
#endif

/* Conditional logging macro that checks compile-time configuration */
#ifdef WOLFPROV_DEBUG
#define WOLFPROV_COMPILE_TIME_CHECK(component, level) \
((WOLFPROV_LOG_LEVEL_FILTER & (level)) && \
(WOLFPROV_LOG_COMPONENTS_FILTER & (component)))
#else
#define WOLFPROV_COMPILE_TIME_CHECK(component, level) 0
#endif

typedef void (*wolfProv_Logging_cb)(const int logLevel, const int component,
const char *const logMessage);
int wolfProv_SetLoggingCb(wolfProv_Logging_cb logF);
Expand Down Expand Up @@ -156,6 +250,8 @@ void WOLFPROV_ENTER(int type, const char* msg);
void WOLFPROV_LEAVE_EX(int type, const char* func, const char* msg, int ret);
void WOLFPROV_MSG(int type, const char* fmt, ...);
void WOLFPROV_MSG_VERBOSE(int type, const char* fmt, ...);
void WOLFPROV_MSG_DEBUG(int type, const char* fmt, ...);
void WOLFPROV_MSG_TRACE(int type, const char* fmt, ...);
void WOLFPROV_ERROR_LINE(int type, int err, const char* file, int line);
void WOLFPROV_ERROR_MSG_LINE(int type, const char* msg, const char* file,
int line);
Expand All @@ -166,12 +262,14 @@ void WOLFPROV_ERROR_FUNC_NULL_LINE(int type, const char* funcName,
void WOLFPROV_BUFFER(int type, const unsigned char* buffer,
unsigned int length);

#else
#else /* WOLFPROV_DEBUG */

#define WOLFPROV_ENTER(t, m)
#define WOLFPROV_LEAVE(t, m, r)
#define WOLFPROV_MSG(t, m, ...)
#define WOLFPROV_MSG_VERBOSE(t, m, ...)
#define WOLFPROV_MSG_DEBUG(t, m, ...)
#define WOLFPROV_MSG_TRACE(t, m, ...)
#define WOLFPROV_ERROR(t, e)
#define WOLFPROV_ERROR_MSG(t, e)
#define WOLFPROV_ERROR_FUNC(t, f, r)
Expand Down
Loading
Loading