Skip to content

Add a verbose logging tier and move the highest-volume traces onto it #11387

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

Open
dgarske wants to merge 1 commit into
base: master
Choose a base branch
from
+90 −86
Open

Add a verbose logging tier and move the highest-volume traces onto it #11387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 10 additions & 1 deletion .github/workflows/check-headers.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
# Only run from the wolfssl org to avoid burning forks' CI minutes.
if: github.repository_owner == 'wolfssl'
runs-on: ubuntu-24.04
timeout-minutes: 10
timeout-minutes: 25
steps:
- uses: actions/checkout@v5

Expand All @@ -44,3 +44,12 @@ jobs:

- name: Run check-headers
run: ./.github/scripts/check-headers.sh

# WOLFSSL_VERBOSE_LOGGING gates a branch of logging.h that no other
# configuration compiles, so a typo there would reach users rather than
# CI. Build only - enabling the tier while running tests would restore
# the log volume it exists to avoid.
- name: Compile the verbose logging tier
run: |
./configure --enable-all CPPFLAGS=-DWOLFSSL_VERBOSE_LOGGING
make -j$(nproc)
8 changes: 2 additions & 6 deletions src/bio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1329,9 +1329,7 @@ int wolfSSL_BIO_supports_pending(const WOLFSSL_BIO *bio)
/* Return the number of pending bytes in read and write buffers */
size_t wolfSSL_BIO_ctrl_pending(WOLFSSL_BIO *bio)
{
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_BIO_ctrl_pending");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_BIO_ctrl_pending");

for (; bio != NULL; bio = bio->next) {
if (bio->method != NULL && bio->method->ctrlCb != NULL) {
Expand Down Expand Up @@ -2352,9 +2350,7 @@ int wolfSSL_BIO_get_mem_data(WOLFSSL_BIO* bio, void* p)
{
WOLFSSL_BIO* mem_bio;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_BIO_get_mem_data");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_BIO_get_mem_data");

if (bio == NULL)
return WOLFSSL_FATAL_ERROR;
Expand Down
4 changes: 3 additions & 1 deletion src/internal.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29733,7 +29733,9 @@ int RetrySendAlert(WOLFSSL* ssl)
int ret = 0;
int type;
int severity;
WOLFSSL_ENTER("RetrySendAlert");
/* Called on every I/O and returns immediately when no alert is pending, so
* this fires constantly and says nothing. */
WOLFSSL_ENTER_VERBOSE("RetrySendAlert");

if (ssl == NULL) {
return BAD_FUNC_ARG;
Expand Down
3 changes: 2 additions & 1 deletion src/ssl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ static struct SystemCryptoPolicy crypto_policy;
* OPENSSL_COMPATIBLE_DEFAULTS:
* Default behavior compatible with OpenSSL default: off
* NO_WOLFSSL_STUB: Disable stubs for unimplemented funcs default: off
* WOLFSSL_DEBUG_OPENSSL: Debug logging for OpenSSL compat layer default: off
* WOLFSSL_DEBUG_OPENSSL:
* Alias for WOLFSSL_VERBOSE_LOGGING default: off
* WOLFSSL_HAVE_ERROR_QUEUE: OpenSSL-compatible error queue default: off
* WOLFSSL_ERROR_CODE_OPENSSL: Use OpenSSL-compatible error codes default: off
* WOLFSSL_CIPHER_INTERNALNAME:
Expand Down
44 changes: 11 additions & 33 deletions src/ssl_asn1.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2123,9 +2123,7 @@ void wolfSSL_ASN1_OBJECT_free(WOLFSSL_ASN1_OBJECT* obj)
if (obj != NULL) {
/* Check for dynamically allocated copy of encoded data. */
if ((obj->dynamic & WOLFSSL_ASN1_DYNAMIC_DATA) != 0) {
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_MSG("Freeing ASN1 data");
#endif
WOLFSSL_MSG_VERBOSE("Freeing ASN1 data");
XFREE((void*)obj->obj, obj->heap, DYNAMIC_TYPE_ASN1);
obj->obj = NULL;
}
Expand All @@ -2138,9 +2136,7 @@ void wolfSSL_ASN1_OBJECT_free(WOLFSSL_ASN1_OBJECT* obj)
#endif
/* Check whether object was dynamically allocated. */
if ((obj->dynamic & WOLFSSL_ASN1_DYNAMIC) != 0) {
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_MSG("Freeing ASN1 OBJECT");
#endif
WOLFSSL_MSG_VERBOSE("Freeing ASN1 OBJECT");
XFREE(obj, NULL, DYNAMIC_TYPE_ASN1);
}
}
Expand Down Expand Up @@ -2632,9 +2628,7 @@ WOLFSSL_ASN1_STRING* wolfSSL_ASN1_STRING_new(void)
{
WOLFSSL_ASN1_STRING* asn1;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_ASN1_STRING_new");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_ASN1_STRING_new");

asn1 = (WOLFSSL_ASN1_STRING*)XMALLOC(sizeof(WOLFSSL_ASN1_STRING), NULL,
DYNAMIC_TYPE_OPENSSL);
Expand All @@ -2655,9 +2649,7 @@ WOLFSSL_ASN1_STRING* wolfSSL_ASN1_STRING_type_new(int type)
{
WOLFSSL_ASN1_STRING* asn1;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_ASN1_STRING_type_new");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_ASN1_STRING_type_new");

asn1 = wolfSSL_ASN1_STRING_new();
if (asn1 != NULL) {
Expand All @@ -2673,9 +2665,7 @@ WOLFSSL_ASN1_STRING* wolfSSL_ASN1_STRING_type_new(int type)
*/
void wolfSSL_ASN1_STRING_free(WOLFSSL_ASN1_STRING* asn1)
{
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_ASN1_STRING_free");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_ASN1_STRING_free");

/* Check we have an object to free. */
if (asn1 != NULL) {
Expand Down Expand Up @@ -3158,9 +3148,7 @@ int wolfSSL_ASN1_STRING_type(const WOLFSSL_ASN1_STRING* asn1)
{
int type = 0;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_ASN1_STRING_type");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_ASN1_STRING_type");

if (asn1 != NULL) {
type = asn1->type;
Expand Down Expand Up @@ -3200,9 +3188,7 @@ unsigned char* wolfSSL_ASN1_STRING_data(WOLFSSL_ASN1_STRING* asn)
{
char* data = NULL;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_ASN1_STRING_data");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_ASN1_STRING_data");

if (asn != NULL) {
data = asn->data;
Expand All @@ -3221,9 +3207,7 @@ int wolfSSL_ASN1_STRING_length(const WOLFSSL_ASN1_STRING* asn)
{
int len = 0;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_ASN1_STRING_length");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_ASN1_STRING_length");

if (asn) {
len = asn->length;
Expand All @@ -3248,9 +3232,7 @@ int wolfSSL_ASN1_STRING_set(WOLFSSL_ASN1_STRING* asn1, const void* data, int sz)
{
int ret = 1;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_ASN1_STRING_set");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_ASN1_STRING_set");

/* Validate parameters. */
if ((asn1 == NULL) || ((data == NULL) && (sz != 0))) {
Expand Down Expand Up @@ -5722,9 +5704,7 @@ int wc_OBJ_sn2nid(const char *sn)
const char* sName = NULL;
int i;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_OBJ_nid2obj");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_OBJ_nid2obj");

for (i = 0; i < (int)wolfssl_object_info_sz; i++) {
if (wolfssl_object_info[i].nid == id) {
Expand Down Expand Up @@ -6110,9 +6090,7 @@ int wc_OBJ_sn2nid(const char *sn)
word32 idx = 0;
int ret;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_OBJ_obj2nid");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_OBJ_obj2nid");

if (o == NULL) {
return WOLFSSL_FATAL_ERROR;
Expand Down
24 changes: 6 additions & 18 deletions src/ssl_bn.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,7 @@ int wolfssl_bn_set_value(WOLFSSL_BIGNUM** bn, mp_int* mpi)
int ret = 1;
WOLFSSL_BIGNUM* a = NULL;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfssl_bn_set_value");
#endif
WOLFSSL_ENTER_VERBOSE("wolfssl_bn_set_value");

/* Validate parameters. */
if ((bn == NULL) || (mpi == NULL)) {
Expand Down Expand Up @@ -193,9 +191,7 @@ WOLFSSL_BIGNUM* wolfSSL_BN_new(void)
{
WOLFSSL_BIGNUM* bn = NULL;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_BN_new");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_BN_new");

/* Allocate memory for big number. */
bn = (WOLFSSL_BIGNUM*)XMALLOC(sizeof(WOLFSSL_BIGNUM), NULL,
Expand All @@ -222,9 +218,7 @@ WOLFSSL_BIGNUM* wolfSSL_BN_new(void)
*/
void wolfSSL_BN_init(WOLFSSL_BIGNUM* bn)
{
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_BN_init");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_BN_init");

/* Validate parameter. */
if (bn != NULL) {
Expand All @@ -242,9 +236,7 @@ void wolfSSL_BN_init(WOLFSSL_BIGNUM* bn)
*/
void wolfSSL_BN_free(WOLFSSL_BIGNUM* bn)
{
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_BN_free");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_BN_free");

/* Validate parameter. */
if (bn != NULL) {
Expand All @@ -267,9 +259,7 @@ void wolfSSL_BN_free(WOLFSSL_BIGNUM* bn)
*/
void wolfSSL_BN_clear_free(WOLFSSL_BIGNUM* bn)
{
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_BN_clear_free");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_BN_clear_free");

/* Validate parameter. */
if (bn != NULL) {
Expand All @@ -289,9 +279,7 @@ void wolfSSL_BN_clear_free(WOLFSSL_BIGNUM* bn)
*/
void wolfSSL_BN_clear(WOLFSSL_BIGNUM* bn)
{
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_BN_clear");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_BN_clear");

/* Validate parameter. */
if (!BN_IS_NULL(bn)) {
Expand Down
8 changes: 4 additions & 4 deletions src/ssl_sk.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ WOLFSSL_STACK* wolfSSL_sk_new_node(void* heap)
{
WOLFSSL_STACK* node;

WOLFSSL_ENTER("wolfSSL_sk_new_node");
WOLFSSL_ENTER_VERBOSE("wolfSSL_sk_new_node");

node = (WOLFSSL_STACK*)XMALLOC(sizeof(WOLFSSL_STACK), heap,
DYNAMIC_TYPE_OPENSSL);
Expand Down Expand Up @@ -596,7 +596,7 @@ WOLFSSL_STACK* wolfSSL_shallow_sk_dup(WOLFSSL_STACK* stack)
*/
void wolfSSL_sk_free(WOLFSSL_STACK* stack)
{
WOLFSSL_ENTER("wolfSSL_sk_free");
WOLFSSL_ENTER_VERBOSE("wolfSSL_sk_free");

while (stack != NULL) {
WOLFSSL_STACK* next = stack->next;
Expand Down Expand Up @@ -702,7 +702,7 @@ void* wolfSSL_sk_value(const WOLFSSL_STACK* sk, int i)
*/
int wolfSSL_sk_push(WOLFSSL_STACK* stack, const void *data)
{
WOLFSSL_ENTER("wolfSSL_sk_push");
WOLFSSL_ENTER_VERBOSE("wolfSSL_sk_push");

return wolfSSL_sk_insert(stack, data, -1);
}
Expand All @@ -719,7 +719,7 @@ int wolfSSL_sk_insert(WOLFSSL_STACK *stack, const void *data, int idx)
{
int ret;
WOLFSSL_STACK* node;
WOLFSSL_ENTER("wolfSSL_sk_insert");
WOLFSSL_ENTER_VERBOSE("wolfSSL_sk_insert");

/* Validate parameters. */
if (stack == NULL) {
Expand Down
28 changes: 10 additions & 18 deletions src/x509.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11798,7 +11798,7 @@ WOLF_STACK_OF(WOLFSSL_X509_OBJECT)* wolfSSL_sk_X509_OBJECT_deep_copy(
#if defined(OPENSSL_EXTRA) || defined(OPENSSL_EXTRA_X509_SMALL)
void wolfSSL_X509_NAME_free(WOLFSSL_X509_NAME *name)
{
WOLFSSL_ENTER("wolfSSL_X509_NAME_free");
WOLFSSL_ENTER_VERBOSE("wolfSSL_X509_NAME_free");
FreeX509Name(name);
if (name != NULL) {
XFREE(name, name->heap, DYNAMIC_TYPE_X509);
Expand All @@ -11814,7 +11814,7 @@ WOLF_STACK_OF(WOLFSSL_X509_OBJECT)* wolfSSL_sk_X509_OBJECT_deep_copy(
{
WOLFSSL_X509_NAME* name;

WOLFSSL_ENTER("wolfSSL_X509_NAME_new_ex");
WOLFSSL_ENTER_VERBOSE("wolfSSL_X509_NAME_new_ex");

name = (WOLFSSL_X509_NAME*)XMALLOC(sizeof(WOLFSSL_X509_NAME), heap,
DYNAMIC_TYPE_X509);
Expand Down Expand Up @@ -14530,7 +14530,7 @@ int wolfSSL_write_X509_CRL(WOLFSSL_X509_CRL* crl, const char* path, int type)

void wolfSSL_X509_NAME_ENTRY_free(WOLFSSL_X509_NAME_ENTRY* ne)
{
WOLFSSL_ENTER("wolfSSL_X509_NAME_ENTRY_free");
WOLFSSL_ENTER_VERBOSE("wolfSSL_X509_NAME_ENTRY_free");
if (ne != NULL) {
wolfSSL_ASN1_OBJECT_free(ne->object);
if (ne->value != NULL) {
Expand Down Expand Up @@ -14628,9 +14628,7 @@ int wolfSSL_write_X509_CRL(WOLFSSL_X509_CRL* crl, const char* path, int type)
{
WOLFSSL_X509_NAME_ENTRY* ne;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_X509_NAME_ENTRY_create_by_NID");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_X509_NAME_ENTRY_create_by_NID");

if (!data) {
WOLFSSL_MSG("Bad parameter");
Expand Down Expand Up @@ -14665,9 +14663,7 @@ WOLFSSL_ASN1_OBJECT* wolfSSL_X509_NAME_ENTRY_get_object(
{
WOLFSSL_ASN1_OBJECT* object = NULL;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_X509_NAME_ENTRY_get_object");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_X509_NAME_ENTRY_get_object");

if (ne != NULL) {
/* Create object from nid - reuse existing object if possible. */
Expand Down Expand Up @@ -14788,9 +14784,7 @@ WOLFSSL_ASN1_OBJECT* wolfSSL_X509_NAME_ENTRY_get_object(
WOLFSSL_X509_NAME_ENTRY* current = NULL;
int ret, i;

#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_X509_NAME_add_entry");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_X509_NAME_add_entry");

if (name == NULL || entry == NULL || entry->value == NULL) {
WOLFSSL_MSG("NULL argument passed in");
Expand All @@ -14810,7 +14804,7 @@ WOLFSSL_ASN1_OBJECT* wolfSSL_X509_NAME_ENTRY_get_object(
/* iterate through and find first open spot */
for (i = 0; i < MAX_NAME_ENTRIES; i++) {
if (name->entry[i].set == 0) { /* not set so overwritten */
WOLFSSL_MSG("Found place for name entry");
WOLFSSL_MSG_VERBOSE("Found place for name entry");
break;
}
}
Expand Down Expand Up @@ -14905,7 +14899,7 @@ WOLFSSL_ASN1_OBJECT* wolfSSL_X509_NAME_ENTRY_get_object(
{
int ret;
WOLFSSL_X509_NAME_ENTRY* entry;
WOLFSSL_ENTER("wolfSSL_X509_NAME_add_entry_by_NID");
WOLFSSL_ENTER_VERBOSE("wolfSSL_X509_NAME_add_entry_by_NID");
entry = wolfSSL_X509_NAME_ENTRY_create_by_NID(NULL, nid, type, bytes,
len);
if (entry == NULL)
Expand Down Expand Up @@ -14995,9 +14989,7 @@ WOLFSSL_ASN1_OBJECT* wolfSSL_X509_NAME_ENTRY_get_object(
WOLFSSL_X509_NAME_ENTRY *wolfSSL_X509_NAME_get_entry(
const WOLFSSL_X509_NAME *name, int loc)
{
#ifdef WOLFSSL_DEBUG_OPENSSL
WOLFSSL_ENTER("wolfSSL_X509_NAME_get_entry");
#endif
WOLFSSL_ENTER_VERBOSE("wolfSSL_X509_NAME_get_entry");

if (name == NULL) {
return NULL;
Expand Down Expand Up @@ -15211,7 +15203,7 @@ WOLF_STACK_OF(WOLFSSL_X509_NAME)* wolfSSL_sk_X509_NAME_new(
WOLFSSL_STACK* sk;
(void)cb;

WOLFSSL_ENTER("wolfSSL_sk_X509_NAME_new");
WOLFSSL_ENTER_VERBOSE("wolfSSL_sk_X509_NAME_new");

sk = wolfSSL_sk_new_node(NULL);
if (sk != NULL) {
Expand Down
2 changes: 1 addition & 1 deletion wolfcrypt/src/asn.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15479,7 +15479,7 @@ static int GetCertName(DecodedCert* cert, char* full, byte* hash, int nameType,
WOLFSSL_X509_NAME* dName = NULL;
#endif /* WOLFSSL_X509_NAME_AVAILABLE */

WOLFSSL_MSG("Getting Cert Name");
WOLFSSL_MSG_VERBOSE("Getting Cert Name");

/* For OCSP, RFC2560 section 4.1.1 states the issuer hash should be
* calculated over the entire DER encoding of the Name field, including
Expand Down
Loading
Loading