Skip to content

Commit

Permalink
ENCODER: Add tracing
Browse files Browse the repository at this point in the history 
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from #13167)
  • Loading branch information
@levitte
levitte committed Nov 11, 2020
1 parent b9a2afd commit 0b9f90f
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 7 deletions.
72 changes: 67 additions & 5 deletions crypto/encode_decode/encoder_lib.c
View file
Expand Up @@ -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 {
Expand Down Expand Up @@ -234,14 +235,27 @@ 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) {
ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_MALLOC_FAILURE);
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)
Expand Down Expand Up @@ -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.
Expand All @@ -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;
}
}

/*
Expand All @@ -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++;
}
Expand Down Expand Up @@ -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);
}

/*
Expand All @@ -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 */

Expand Down Expand Up @@ -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;
}
Expand Down
17 changes: 16 additions & 1 deletion crypto/encode_decode/encoder_pkey.c
View file
Expand Up @@ -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"
Expand Down Expand Up @@ -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;
Expand Down
1 change: 1 addition & 0 deletions crypto/trace.c
View file
Expand Up @@ -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)
Expand Down
3 changes: 2 additions & 1 deletion include/openssl/trace.h
View file
Expand Up @@ -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);
Expand Down

0 comments on commit 0b9f90f

Please sign in to comment.