/*
- * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the Apache License 2.0 (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
#include <stdio.h>
#include <string.h>
+#include "internal/thread_once.h"
#include <openssl/bio.h>
#include <openssl/crypto.h>
#include <openssl/trace.h>
#include "internal/bio.h"
#include "internal/nelem.h"
-#include "internal/cryptlib_int.h"
+#include "crypto/cryptlib.h"
#include "e_os.h" /* strcasecmp for Windows */
const char *buf, size_t num, size_t *written)
{
struct trace_data_st *ctx = BIO_get_data(channel);
- size_t cnt = ctx->callback(buf, num, ctx->category, OSSL_TRACE_CTRL_DURING,
+ size_t cnt = ctx->callback(buf, num, ctx->category, OSSL_TRACE_CTRL_WRITE,
ctx->data);
*written = cnt;
#define TRACE_CATEGORY_(name) { #name, OSSL_TRACE_CATEGORY_##name }
static const struct trace_category_st trace_categories[] = {
- TRACE_CATEGORY_(ANY),
+ TRACE_CATEGORY_(ALL),
TRACE_CATEGORY_(TRACE),
TRACE_CATEGORY_(INIT),
TRACE_CATEGORY_(TLS),
TRACE_CATEGORY_(TLS_CIPHER),
- TRACE_CATEGORY_(ENGINE_CONF),
+ TRACE_CATEGORY_(CONF),
+#ifndef OPENSSL_NO_ENGINE
TRACE_CATEGORY_(ENGINE_TABLE),
TRACE_CATEGORY_(ENGINE_REF_COUNT),
+#endif
TRACE_CATEGORY_(PKCS5V2),
TRACE_CATEGORY_(PKCS12_KEYGEN),
TRACE_CATEGORY_(PKCS12_DECRYPT),
TRACE_CATEGORY_(X509V3_POLICY),
TRACE_CATEGORY_(BN_CTX),
+ TRACE_CATEGORY_(STORE),
+ TRACE_CATEGORY_(DECODER),
+ TRACE_CATEGORY_(ENCODER),
};
const char *OSSL_trace_get_category_name(int num)
/* We use one trace channel for each trace category */
static struct {
- enum { t_channel, t_callback } type;
+ enum { SIMPLE_CHANNEL, CALLBACK_CHANNEL } type;
BIO *bio;
char *prefix;
char *suffix;
#endif
#ifndef OPENSSL_NO_TRACE
+
+enum {
+ CHANNEL,
+ PREFIX,
+ SUFFIX
+};
+
static int trace_attach_cb(int category, int type, const void *data)
{
switch (type) {
- case 0: /* Channel */
+ case CHANNEL:
OSSL_TRACE2(TRACE, "Attach channel %p to category '%s'\n",
data, trace_categories[category].name);
break;
- case 1: /* Prefix */
+ case PREFIX:
OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
(const char *)data, trace_categories[category].name);
break;
- case 2: /* Suffix */
+ case SUFFIX:
OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
(const char *)data, trace_categories[category].name);
break;
static int trace_detach_cb(int category, int type, const void *data)
{
switch (type) {
- case 0: /* Channel */
+ case CHANNEL:
OSSL_TRACE2(TRACE, "Detach channel %p from category '%s'\n",
data, trace_categories[category].name);
break;
- case 1: /* Prefix */
+ case PREFIX:
OSSL_TRACE2(TRACE, "Detach prefix \"%s\" from category '%s'\n",
(const char *)data, trace_categories[category].name);
break;
- case 2: /* Suffix */
+ case SUFFIX:
OSSL_TRACE2(TRACE, "Detach suffix \"%s\" from category '%s'\n",
(const char *)data, trace_categories[category].name);
break;
return 1;
}
-static int set_trace_data(int category, BIO **channel,
+static int do_ossl_trace_init(void);
+static CRYPTO_ONCE trace_inited = CRYPTO_ONCE_STATIC_INIT;
+DEFINE_RUN_ONCE_STATIC(ossl_trace_init)
+{
+ return do_ossl_trace_init();
+}
+
+static int set_trace_data(int category, int type, BIO **channel,
const char **prefix, const char **suffix,
int (*attach_cb)(int, int, const void *),
int (*detach_cb)(int, int, const void *))
{
- BIO *curr_channel = trace_channels[category].bio;
- char *curr_prefix = trace_channels[category].prefix;
- char *curr_suffix = trace_channels[category].suffix;
+ BIO *curr_channel = NULL;
+ char *curr_prefix = NULL;
+ char *curr_suffix = NULL;
+
+ /* Ensure do_ossl_trace_init() is called once */
+ if (!RUN_ONCE(&trace_inited, ossl_trace_init))
+ return 0;
+
+ curr_channel = trace_channels[category].bio;
+ curr_prefix = trace_channels[category].prefix;
+ curr_suffix = trace_channels[category].suffix;
/* Make sure to run the detach callback first on all data */
if (prefix != NULL && curr_prefix != NULL) {
- detach_cb(category, 1, curr_prefix);
+ detach_cb(category, PREFIX, curr_prefix);
}
if (suffix != NULL && curr_suffix != NULL) {
- detach_cb(category, 2, curr_suffix);
+ detach_cb(category, SUFFIX, curr_suffix);
}
if (channel != NULL && curr_channel != NULL) {
- detach_cb(category, 0, curr_channel);
+ detach_cb(category, CHANNEL, curr_channel);
}
/* After detach callbacks are done, clear data where appropriate */
if (channel != NULL && curr_channel != NULL) {
BIO_free(curr_channel);
+ trace_channels[category].type = 0;
trace_channels[category].bio = NULL;
}
/* Before running callbacks are done, set new data where appropriate */
if (channel != NULL && *channel != NULL) {
+ trace_channels[category].type = type;
trace_channels[category].bio = *channel;
}
/* Finally, run the attach callback on the new data */
if (channel != NULL && *channel != NULL) {
- attach_cb(category, 0, *channel);
+ attach_cb(category, CHANNEL, *channel);
}
if (prefix != NULL && *prefix != NULL) {
- attach_cb(category, 1, *prefix);
+ attach_cb(category, PREFIX, *prefix);
}
if (suffix != NULL && *suffix != NULL) {
- attach_cb(category, 2, *suffix);
+ attach_cb(category, SUFFIX, *suffix);
}
return 1;
}
-#endif
-int ossl_trace_init(void)
+static int do_ossl_trace_init(void)
{
-#ifndef OPENSSL_NO_TRACE
trace_lock = CRYPTO_THREAD_lock_new();
- if (trace_lock == NULL)
- return 0;
-#endif
-
- return 1;
+ return trace_lock != NULL;
}
+#endif
+
void ossl_trace_cleanup(void)
{
#ifndef OPENSSL_NO_TRACE
/* We force the TRACE category to be treated last */
if (category == OSSL_TRACE_CATEGORY_TRACE)
continue;
- set_trace_data(category, &channel, &prefix, &suffix,
+ set_trace_data(category, 0, &channel, &prefix, &suffix,
trace_attach_cb, trace_detach_cb);
}
- set_trace_data(OSSL_TRACE_CATEGORY_TRACE, &channel, &prefix, &suffix,
+ set_trace_data(OSSL_TRACE_CATEGORY_TRACE, 0, &channel,
+ &prefix, &suffix,
trace_attach_cb, trace_detach_cb);
CRYPTO_THREAD_lock_free(trace_lock);
#endif
int OSSL_trace_set_channel(int category, BIO *channel)
{
#ifndef OPENSSL_NO_TRACE
- if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM
- || !set_trace_data(category, &channel, NULL, NULL,
- trace_attach_cb, trace_detach_cb))
- return 0;
-
- trace_channels[category].type = t_channel;
+ if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
+ return set_trace_data(category, SIMPLE_CHANNEL, &channel, NULL, NULL,
+ trace_attach_cb, trace_detach_cb);
#endif
- return 1;
+ return 0;
}
#ifndef OPENSSL_NO_TRACE
static int trace_attach_w_callback_cb(int category, int type, const void *data)
{
switch (type) {
- case 0: /* Channel */
+ case CHANNEL:
OSSL_TRACE2(TRACE,
"Attach channel %p to category '%s' (with callback)\n",
data, trace_categories[category].name);
break;
- case 1: /* Prefix */
+ case PREFIX:
OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
(const char *)data, trace_categories[category].name);
break;
- case 2: /* Suffix */
+ case SUFFIX:
OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
(const char *)data, trace_categories[category].name);
break;
struct trace_data_st *trace_data = NULL;
if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
- goto err;
+ return 0;
if (callback != NULL) {
if ((channel = BIO_new(&trace_method)) == NULL
BIO_set_data(channel, trace_data);
}
- if (!set_trace_data(category, &channel, NULL, NULL,
+ if (!set_trace_data(category, CALLBACK_CHANNEL, &channel, NULL, NULL,
trace_attach_w_callback_cb, trace_detach_cb))
goto err;
- trace_channels[category].type = t_callback;
- goto done;
+ return 1;
err:
BIO_free(channel);
OPENSSL_free(trace_data);
- return 0;
- done:
#endif
- return 1;
+
+ return 0;
}
int OSSL_trace_set_prefix(int category, const char *prefix)
{
- int rv = 1;
-
#ifndef OPENSSL_NO_TRACE
- if (category >= 0 || category < OSSL_TRACE_CATEGORY_NUM)
- return set_trace_data(category, NULL, &prefix, NULL,
+ if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
+ return set_trace_data(category, 0, NULL, &prefix, NULL,
trace_attach_cb, trace_detach_cb);
- rv = 0;
#endif
- return rv;
+ return 0;
}
int OSSL_trace_set_suffix(int category, const char *suffix)
{
- int rv = 1;
-
#ifndef OPENSSL_NO_TRACE
- if (category >= 0 || category < OSSL_TRACE_CATEGORY_NUM)
- return set_trace_data(category, NULL, NULL, &suffix,
+ if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
+ return set_trace_data(category, 0, NULL, NULL, &suffix,
trace_attach_cb, trace_detach_cb);
- rv = 0;
#endif
- return rv;
+ return 0;
}
#ifndef OPENSSL_NO_TRACE
return -1;
if (trace_channels[category].bio != NULL)
return category;
- return OSSL_TRACE_CATEGORY_ANY;
+ return OSSL_TRACE_CATEGORY_ALL;
}
#endif
int ret = 0;
#ifndef OPENSSL_NO_TRACE
category = ossl_trace_get_category(category);
- ret = trace_channels[category].bio != NULL;
+ if (category >= 0)
+ ret = trace_channels[category].bio != NULL;
#endif
return ret;
}
char *prefix = NULL;
category = ossl_trace_get_category(category);
+ if (category < 0)
+ return NULL;
+
channel = trace_channels[category].bio;
prefix = trace_channels[category].prefix;
CRYPTO_THREAD_write_lock(trace_lock);
current_channel = channel;
switch (trace_channels[category].type) {
- case t_channel:
+ case SIMPLE_CHANNEL:
if (prefix != NULL) {
(void)BIO_puts(channel, prefix);
(void)BIO_puts(channel, "\n");
}
break;
- case t_callback:
+ case CALLBACK_CHANNEL:
(void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
prefix == NULL ? 0 : strlen(prefix), prefix);
break;
&& ossl_assert(channel == current_channel)) {
(void)BIO_flush(channel);
switch (trace_channels[category].type) {
- case t_channel:
+ case SIMPLE_CHANNEL:
if (suffix != NULL) {
(void)BIO_puts(channel, suffix);
(void)BIO_puts(channel, "\n");
}
break;
- case t_callback:
+ case CALLBACK_CHANNEL:
(void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
suffix == NULL ? 0 : strlen(suffix), suffix);
break;
projects / openssl.git / blobdiff