Commit 6e810f2d authored by Richard Levitte's avatar Richard Levitte
Browse files

Adapt BN_CTX_DEBUG to the new generic trace API 



Co-authored-by: default avatarDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>

Reviewed-by: default avatarPaul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/8198)
parent 5f8a5f46

crypto/bn/bn_ctx.c

+31 −41
Original line number Diff line number Diff line
@@ -7,6 +7,7 @@ 
 * https://www.openssl.org/source/license.html

 */



#include <openssl/trace.h>

#include "internal/cryptlib.h"

#include "bn_lcl.h"
@@ -87,48 +88,38 @@ struct bignum_ctx { 
    int flags;

};



/* Enable this to find BN_CTX bugs */

#ifdef BN_CTX_DEBUG

static const char *ctxdbg_cur = NULL;

static void ctxdbg(BN_CTX *ctx)

/* Debugging functionality */

static void ctxdbg(BIO *channel, const char *text, BN_CTX *ctx)

{

    unsigned int bnidx = 0, fpidx = 0;

    BN_POOL_ITEM *item = ctx->pool.head;

    BN_STACK *stack = &ctx->stack;

    fprintf(stderr, "(%16p): ", ctx);



    BIO_printf(channel, "%s\n", text);

    BIO_printf(channel, "  (%16p): ", (void*)ctx);

    while (bnidx < ctx->used) {

        fprintf(stderr, "%03x ", item->vals[bnidx++ % BN_CTX_POOL_SIZE].dmax);

        BIO_printf(channel, "%03x ",

                   item->vals[bnidx++ % BN_CTX_POOL_SIZE].dmax);

        if (!(bnidx % BN_CTX_POOL_SIZE))

            item = item->next;

    }

    fprintf(stderr, "\n");

    BIO_printf(channel, "\n");

    bnidx = 0;

    fprintf(stderr, "          : ");

    BIO_printf(channel, "   %16s : ", "");

    while (fpidx < stack->depth) {

        while (bnidx++ < stack->indexes[fpidx])

            fprintf(stderr, "    ");

        fprintf(stderr, "^^^ ");

            BIO_printf(channel, "    ");

        BIO_printf(channel, "^^^ ");

        bnidx++;

        fpidx++;

    }

    fprintf(stderr, "\n");

    BIO_printf(channel, "\n");

}



# define CTXDBG_ENTRY(str, ctx)  do { \

                                ctxdbg_cur = (str); \

                                fprintf(stderr,"Starting %s\n", ctxdbg_cur); \

                                ctxdbg(ctx); \

                                } while(0)

# define CTXDBG_EXIT(ctx)        do { \

                                fprintf(stderr,"Ending %s\n", ctxdbg_cur); \

                                ctxdbg(ctx); \

                                } while(0)

# define CTXDBG_RET(ctx,ret)

#else

# define CTXDBG_ENTRY(str, ctx)

# define CTXDBG_EXIT(ctx)

# define CTXDBG_RET(ctx,ret)

#endif

#define CTXDBG(str, ctx)            \

    OSSL_TRACE_BEGIN(BN_CTX) {      \

        ctxdbg(trc_out, str, ctx);  \

    } OSSL_TRACE_END(BN_CTX)





BN_CTX *BN_CTX_new(void)
@@ -158,21 +149,20 @@ void BN_CTX_free(BN_CTX *ctx) 
{

    if (ctx == NULL)

        return;

#ifdef BN_CTX_DEBUG

    {

    OSSL_TRACE_BEGIN(BN_CTX) {

        BN_POOL_ITEM *pool = ctx->pool.head;

        fprintf(stderr, "BN_CTX_free, stack-size=%d, pool-bignums=%d\n",

        BIO_printf(trc_out,

                   "BN_CTX_free(): stack-size=%d, pool-bignums=%d\n",

                   ctx->stack.size, ctx->pool.size);

        fprintf(stderr, "dmaxs: ");

        BIO_printf(trc_out, "  dmaxs: ");

        while (pool) {

            unsigned loop = 0;

            while (loop < BN_CTX_POOL_SIZE)

                fprintf(stderr, "%02x ", pool->vals[loop++].dmax);

                BIO_printf(trc_out, "%02x ", pool->vals[loop++].dmax);

            pool = pool->next;

        }

        fprintf(stderr, "\n");

    }

#endif

        BIO_printf(trc_out, "\n");

    } OSSL_TRACE_END(BN_CTX);

    BN_STACK_finish(&ctx->stack);

    BN_POOL_finish(&ctx->pool);

    OPENSSL_free(ctx);
@@ -180,7 +170,7 @@ void BN_CTX_free(BN_CTX *ctx) 


void BN_CTX_start(BN_CTX *ctx)

{

    CTXDBG_ENTRY("BN_CTX_start", ctx);

    CTXDBG("ENTER BN_CTX_start()", ctx);

    /* If we're already overflowing ... */

    if (ctx->err_stack || ctx->too_many)

        ctx->err_stack++;
@@ -189,12 +179,12 @@ void BN_CTX_start(BN_CTX *ctx) 
        BNerr(BN_F_BN_CTX_START, BN_R_TOO_MANY_TEMPORARY_VARIABLES);

        ctx->err_stack++;

    }

    CTXDBG_EXIT(ctx);

    CTXDBG("LEAVE BN_CTX_start()", ctx);

}



void BN_CTX_end(BN_CTX *ctx)

{

    CTXDBG_ENTRY("BN_CTX_end", ctx);

    CTXDBG("ENTER BN_CTX_end()", ctx);

    if (ctx->err_stack)

        ctx->err_stack--;

    else {
@@ -206,14 +196,14 @@ void BN_CTX_end(BN_CTX *ctx) 
        /* Unjam "too_many" in case "get" had failed */

        ctx->too_many = 0;

    }

    CTXDBG_EXIT(ctx);

    CTXDBG("LEAVE BN_CTX_end()", ctx);

}



BIGNUM *BN_CTX_get(BN_CTX *ctx)

{

    BIGNUM *ret;



    CTXDBG_ENTRY("BN_CTX_get", ctx);

    CTXDBG("ENTER BN_CTX_get()", ctx);

    if (ctx->err_stack || ctx->too_many)

        return NULL;

    if ((ret = BN_POOL_get(&ctx->pool, ctx->flags)) == NULL) {
@@ -230,7 +220,7 @@ BIGNUM *BN_CTX_get(BN_CTX *ctx) 
    /* clear BN_FLG_CONSTTIME if leaked from previous frames */

    ret->flags &= (~BN_FLG_CONSTTIME);

    ctx->used++;

    CTXDBG_RET(ctx, ret);

    CTXDBG("LEAVE BN_CTX_get()", ctx);

    return ret;

}

crypto/trace.c

+1 −0
Original line number Diff line number Diff line
@@ -130,6 +130,7 @@ static const struct trace_category_st trace_categories[] = { 
    TRACE_CATEGORY_(PKCS12_KEYGEN),

    TRACE_CATEGORY_(PKCS12_DECRYPT),

    TRACE_CATEGORY_(X509V3_POLICY),

    TRACE_CATEGORY_(BN_CTX),

};



const char *OSSL_trace_get_category_name(int num)

include/openssl/trace.h

+2 −1
Original line number Diff line number Diff line
@@ -43,7 +43,8 @@ extern "C" { 
# define OSSL_TRACE_CATEGORY_PKCS12_KEYGEN       8

# define OSSL_TRACE_CATEGORY_PKCS12_DECRYPT      9

# define OSSL_TRACE_CATEGORY_X509V3_POLICY      10

# define OSSL_TRACE_CATEGORY_NUM                11

# define OSSL_TRACE_CATEGORY_BN_CTX             11

# define OSSL_TRACE_CATEGORY_NUM                12



/* Returns the trace category number for the given |name| */

int OSSL_trace_get_category_num(const char *name);