diff options
author | Richard Levitte <levitte@openssl.org> | 2020-10-28 10:14:53 +0100 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2020-11-11 12:43:27 +0100 |
commit | 0b9f90f5043e4cb8559448fb6270b0e7dd74e4b9 (patch) | |
tree | de1b9c61005eea36202260232190624817368391 | |
parent | b9a2afdfe68a5212dc2352a574a6ca98d8cf5140 (diff) |
ENCODER: Add tracing
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/13167)
-rw-r--r-- | crypto/encode_decode/encoder_lib.c | 72 | ||||
-rw-r--r-- | crypto/encode_decode/encoder_pkey.c | 17 | ||||
-rw-r--r-- | crypto/trace.c | 1 | ||||
-rw-r--r-- | include/openssl/trace.h | 3 |
4 files changed, 86 insertions, 7 deletions
diff --git a/crypto/encode_decode/encoder_lib.c b/crypto/encode_decode/encoder_lib.c index ba68a0533e..d15fb27fde 100644 --- a/crypto/encode_decode/encoder_lib.c +++ b/crypto/encode_decode/encoder_lib.c @@ -14,6 +14,7 @@ #include <openssl/buffer.h> #include <openssl/params.h> #include <openssl/provider.h> +#include <openssl/trace.h> #include "encoder_local.h" struct encoder_process_data_st { @@ -234,6 +235,8 @@ void ossl_encoder_instance_free(OSSL_ENCODER_INSTANCE *encoder_inst) static int ossl_encoder_ctx_add_encoder_inst(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER_INSTANCE *ei) { + int ok; + if (ctx->encoder_insts == NULL && (ctx->encoder_insts = sk_OSSL_ENCODER_INSTANCE_new_null()) == NULL) { @@ -241,7 +244,18 @@ static int ossl_encoder_ctx_add_encoder_inst(OSSL_ENCODER_CTX *ctx, return 0; } - return (sk_OSSL_ENCODER_INSTANCE_push(ctx->encoder_insts, ei) > 0); + ok = (sk_OSSL_ENCODER_INSTANCE_push(ctx->encoder_insts, ei) > 0); + if (ok) { + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "(ctx %p) Added encoder instance %p (encoder %p) with:\n", + (void *)ctx, (void *)ei, (void *)ei->encoder); + BIO_printf(trc_out, + " output type: %s, output structure: %s, input type :%s\n", + ei->output_type, ei->output_structure, ei->input_type); + } OSSL_TRACE_END(ENCODER); + } + return ok; } int OSSL_ENCODER_CTX_add_encoder(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER *encoder) @@ -411,6 +425,13 @@ static int encoder_process(struct encoder_process_data_st *data) new_data.count_output_structure = data->count_output_structure; new_data.level = data->level + 1; + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "[%d] (ctx %p) Considering encoder instance %p (encoder %p)\n", + data->level, (void *)data->ctx, + (void *)current_encoder_inst, (void *)current_encoder); + } OSSL_TRACE_END(ENCODER); + /* * If this is the top call, we check if the output type of the current * encoder matches the desired output type. @@ -421,11 +442,25 @@ static int encoder_process(struct encoder_process_data_st *data) if (top) { if (data->ctx->output_type != NULL && strcasecmp(current_output_type, - data->ctx->output_type) != 0) + data->ctx->output_type) != 0) { + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "[%d] Skipping because current encoder output type (%s) != desired output type (%s)\n", + data->level, + current_output_type, data->ctx->output_type); + } OSSL_TRACE_END(ENCODER); continue; + } } else { - if (!OSSL_ENCODER_is_a(next_encoder, current_output_type)) + if (!OSSL_ENCODER_is_a(next_encoder, current_output_type)) { + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "[%d] Skipping because current encoder output type (%s) != name of encoder %p\n", + data->level, + current_output_type, (void *)next_encoder); + } OSSL_TRACE_END(ENCODER); continue; + } } /* @@ -436,8 +471,16 @@ static int encoder_process(struct encoder_process_data_st *data) if (data->ctx->output_structure != NULL && current_output_structure != NULL) { if (strcasecmp(data->ctx->output_structure, - current_output_structure) != 0) + current_output_structure) != 0) { + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "[%d] Skipping because current encoder output structure (%s) != ctx output structure (%s)\n", + data->level, + current_output_structure, + data->ctx->output_structure); + } OSSL_TRACE_END(ENCODER); continue; + } data->count_output_structure++; } @@ -465,6 +508,12 @@ static int encoder_process(struct encoder_process_data_st *data) */ if (ok != 0) break; + + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "[%d] Skipping because recusion level %d failed\n", + data->level, new_data.level); + } OSSL_TRACE_END(ENCODER); } /* @@ -473,6 +522,12 @@ static int encoder_process(struct encoder_process_data_st *data) */ if (i < 0) { ok = -1; + + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "[%d] (ctx %p) No suitable encoder found\n", + data->level, (void *)data->ctx); + } OSSL_TRACE_END(ENCODER); } else { /* Preparations */ @@ -561,13 +616,20 @@ static int encoder_process(struct encoder_process_data_st *data) == NULL) ok = 0; /* Assume BIO_new() recorded an error */ - if (ok) + if (ok) { ok = current_encoder->encode(current_encoder_ctx, (OSSL_CORE_BIO *)current_out, original_data, current_abstract, data->ctx->selection, ossl_pw_passphrase_callback_enc, &data->ctx->pwdata); + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "[%d] (ctx %p) Running encoder instance %p => %d\n", + data->level, (void *)data->ctx, + (void *)current_encoder_inst, ok); + } OSSL_TRACE_END(ENCODER); + } data->prev_encoder_inst = current_encoder_inst; } diff --git a/crypto/encode_decode/encoder_pkey.c b/crypto/encode_decode/encoder_pkey.c index 301651b62a..594543b19e 100644 --- a/crypto/encode_decode/encoder_pkey.c +++ b/crypto/encode_decode/encoder_pkey.c @@ -15,6 +15,7 @@ #include <openssl/core_names.h> #include <openssl/provider.h> #include <openssl/safestack.h> +#include <openssl/trace.h> #include "internal/provider.h" #include "internal/property.h" #include "crypto/evp.h" @@ -288,14 +289,28 @@ OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new_by_EVP_PKEY(const EVP_PKEY *pkey, ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_MALLOC_FAILURE); return NULL; } + + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, + "(ctx %p) Looking for %s encoders with selection %d\n", + (void *)ctx, EVP_PKEY_get0_first_alg_name(pkey), selection); + BIO_printf(trc_out, " output type: %s, output structure: %s\n", + output_type, output_struct); + } OSSL_TRACE_END(ENCODER); + if (OSSL_ENCODER_CTX_set_output_type(ctx, output_type) && (output_struct == NULL || OSSL_ENCODER_CTX_set_output_structure(ctx, output_struct)) && OSSL_ENCODER_CTX_set_selection(ctx, selection) && ossl_encoder_ctx_setup_for_EVP_PKEY(ctx, pkey, selection, libctx, propquery) - && OSSL_ENCODER_CTX_add_extra(ctx, libctx, propquery)) + && OSSL_ENCODER_CTX_add_extra(ctx, libctx, propquery)) { + OSSL_TRACE_BEGIN(ENCODER) { + BIO_printf(trc_out, "(ctx %p) Got %d encoders\n", + (void *)ctx, OSSL_ENCODER_CTX_get_num_encoders(ctx)); + } OSSL_TRACE_END(ENCODER); return ctx; + } OSSL_ENCODER_CTX_free(ctx); return NULL; diff --git a/crypto/trace.c b/crypto/trace.c index 46a1800753..ba9b8dd742 100644 --- a/crypto/trace.c +++ b/crypto/trace.c @@ -137,6 +137,7 @@ static const struct trace_category_st trace_categories[] = { TRACE_CATEGORY_(BN_CTX), TRACE_CATEGORY_(STORE), TRACE_CATEGORY_(DECODER), + TRACE_CATEGORY_(ENCODER), }; const char *OSSL_trace_get_category_name(int num) diff --git a/include/openssl/trace.h b/include/openssl/trace.h index d3e1e95df2..a0894ee2a4 100644 --- a/include/openssl/trace.h +++ b/include/openssl/trace.h @@ -54,7 +54,8 @@ extern "C" { # define OSSL_TRACE_CATEGORY_CMP 13 # define OSSL_TRACE_CATEGORY_STORE 14 # define OSSL_TRACE_CATEGORY_DECODER 15 -# define OSSL_TRACE_CATEGORY_NUM 16 +# define OSSL_TRACE_CATEGORY_ENCODER 16 +# define OSSL_TRACE_CATEGORY_NUM 17 /* Returns the trace category number for the given |name| */ int OSSL_trace_get_category_num(const char *name); |