[thirdparty/openssl.git] / crypto / trace.c

/*
 * Copyright 2019-2021 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
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#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/refcount.h"
#include "crypto/cryptlib.h"

#include "e_os.h"                /* strcasecmp for Windows */

#ifndef OPENSSL_NO_TRACE

static CRYPTO_RWLOCK *trace_lock = NULL;

static const BIO  *current_channel = NULL;

/*-
 * INTERNAL TRACE CHANNEL IMPLEMENTATION
 *
 * For our own flexibility, all trace categories are associated with a
 * BIO sink object, also called the trace channel. Instead of a BIO object,
 * the application can also provide a callback function, in which case an
 * internal trace channel is attached, which simply calls the registered
 * callback function.
 */
static int trace_write(BIO *b, const char *buf,
                               size_t num, size_t *written);
static int trace_puts(BIO *b, const char *str);
static long trace_ctrl(BIO *channel, int cmd, long argl, void *argp);
static int trace_free(BIO *b);

static const BIO_METHOD trace_method = {
    BIO_TYPE_SOURCE_SINK,
    "trace",
    trace_write,
    NULL,                        /* old write */
    NULL,                        /* read_ex */
    NULL,                        /* read */
    trace_puts,
    NULL,                        /* gets */
    trace_ctrl,                  /* ctrl */
    NULL,                        /* create */
    trace_free,                  /* free */
    NULL,                        /* callback_ctrl */
};

struct trace_data_st {
    OSSL_trace_cb callback;
    int category;
    void *data;
};

static int trace_write(BIO *channel,
                       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_WRITE,
                               ctx->data);

    *written = cnt;
    return cnt != 0;
}

static int trace_puts(BIO *channel, const char *str)
{
    size_t written;

    if (trace_write(channel, str, strlen(str), &written))
        return (int)written;

    return EOF;
}

static long trace_ctrl(BIO *channel, int cmd, long argl, void *argp)
{
    struct trace_data_st *ctx = BIO_get_data(channel);

    switch (cmd) {
    case OSSL_TRACE_CTRL_BEGIN:
    case OSSL_TRACE_CTRL_END:
        /* We know that the callback is likely to return 0 here */
        ctx->callback("", 0, ctx->category, cmd, ctx->data);
        return 1;
    default:
        break;
    }
    return -2;                   /* Unsupported */
}

static int trace_free(BIO *channel)
{
    if (channel == NULL)
        return 0;
    OPENSSL_free(BIO_get_data(channel));
    return 1;
}
#endif

/*-
 * TRACE
 */

/* Helper struct and macro to get name string to number mapping */
struct trace_category_st {
    const char * const name;
    const int num;
};
#define TRACE_CATEGORY_(name)       { #name, OSSL_TRACE_CATEGORY_##name }

static const struct trace_category_st trace_categories[] = {
    TRACE_CATEGORY_(ALL),
    TRACE_CATEGORY_(TRACE),
    TRACE_CATEGORY_(INIT),
    TRACE_CATEGORY_(TLS),
    TRACE_CATEGORY_(TLS_CIPHER),
    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),
    TRACE_CATEGORY_(REF_COUNT)
};

const char *OSSL_trace_get_category_name(int num)
{
    size_t i;

    for (i = 0; i < OSSL_NELEM(trace_categories); i++)
        if (trace_categories[i].num == num)
            return trace_categories[i].name;
    return NULL; /* not found */
}

int OSSL_trace_get_category_num(const char *name)
{
    size_t i;

    for (i = 0; i < OSSL_NELEM(trace_categories); i++)
        if (strcasecmp(name, trace_categories[i].name) == 0)
            return trace_categories[i].num;
    return -1; /* not found */
}

#ifndef OPENSSL_NO_TRACE

/* We use one trace channel for each trace category */
static struct {
    enum { SIMPLE_CHANNEL, CALLBACK_CHANNEL } type;
    BIO *bio;
    char *prefix;
    char *suffix;
} trace_channels[OSSL_TRACE_CATEGORY_NUM] = {
    { 0, NULL, NULL, NULL },
};

#endif

#ifndef OPENSSL_NO_TRACE

enum {
    CHANNEL,
    PREFIX,
    SUFFIX
};

static int trace_attach_cb(int category, int type, const void *data)
{
    switch (type) {
    case CHANNEL:
        OSSL_TRACE2(TRACE, "Attach channel %p to category '%s'\n",
                    data, trace_categories[category].name);
        break;
    case PREFIX:
        OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
                    (const char *)data, trace_categories[category].name);
        break;
    case SUFFIX:
        OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
                    (const char *)data, trace_categories[category].name);
        break;
    default:                     /* No clue */
        break;
    }
    return 1;
}

static int trace_detach_cb(int category, int type, const void *data)
{
    switch (type) {
    case CHANNEL:
        OSSL_TRACE2(TRACE, "Detach channel %p from category '%s'\n",
                    data, trace_categories[category].name);
        break;
    case PREFIX:
        OSSL_TRACE2(TRACE, "Detach prefix \"%s\" from category '%s'\n",
                    (const char *)data, trace_categories[category].name);
        break;
    case SUFFIX:
        OSSL_TRACE2(TRACE, "Detach suffix \"%s\" from category '%s'\n",
                    (const char *)data, trace_categories[category].name);
        break;
    default:                     /* No clue */
        break;
    }
    return 1;
}

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 = 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, PREFIX, curr_prefix);
    }

    if (suffix != NULL && curr_suffix != NULL) {
        detach_cb(category, SUFFIX, curr_suffix);
    }

    if (channel != NULL && curr_channel != NULL) {
        detach_cb(category, CHANNEL, curr_channel);
    }

    /* After detach callbacks are done, clear data where appropriate */
    if (prefix != NULL && curr_prefix != NULL) {
        OPENSSL_free(curr_prefix);
        trace_channels[category].prefix = NULL;
    }

    if (suffix != NULL && curr_suffix != NULL) {
        OPENSSL_free(curr_suffix);
        trace_channels[category].suffix = NULL;
    }

    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;
    }

    if (prefix != NULL && *prefix != NULL) {
        if ((curr_prefix = OPENSSL_strdup(*prefix)) == NULL)
            return 0;
        trace_channels[category].prefix = curr_prefix;
    }

    if (suffix != NULL && *suffix != NULL) {
        if ((curr_suffix = OPENSSL_strdup(*suffix)) == NULL)
            return 0;
        trace_channels[category].suffix = curr_suffix;
    }

    /* Finally, run the attach callback on the new data */
    if (channel != NULL && *channel != NULL) {
        attach_cb(category, CHANNEL, *channel);
    }

    if (prefix != NULL && *prefix != NULL) {
        attach_cb(category, PREFIX, *prefix);
    }

    if (suffix != NULL && *suffix != NULL) {
        attach_cb(category, SUFFIX, *suffix);
    }

    return 1;
}

static int do_ossl_trace_init(void)
{
    trace_lock = CRYPTO_THREAD_lock_new();
    return trace_lock != NULL;
}

#endif

void ossl_trace_cleanup(void)
{
#ifndef OPENSSL_NO_TRACE
    int category;
    BIO *channel = NULL;
    const char *prefix = NULL;
    const char *suffix = NULL;

    for (category = 0; category < OSSL_TRACE_CATEGORY_NUM; category++) {
        /* We force the TRACE category to be treated last */
        if (category == OSSL_TRACE_CATEGORY_TRACE)
            continue;
        set_trace_data(category, 0, &channel, &prefix, &suffix,
                       trace_attach_cb, trace_detach_cb);
    }
    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)
        return set_trace_data(category, SIMPLE_CHANNEL, &channel, NULL, NULL,
                              trace_attach_cb, trace_detach_cb);
#endif
    return 0;
}

#ifndef OPENSSL_NO_TRACE
static int trace_attach_w_callback_cb(int category, int type, const void *data)
{
    switch (type) {
    case CHANNEL:
        OSSL_TRACE2(TRACE,
                    "Attach channel %p to category '%s' (with callback)\n",
                    data, trace_categories[category].name);
        break;
    case PREFIX:
        OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
                    (const char *)data, trace_categories[category].name);
        break;
    case SUFFIX:
        OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
                    (const char *)data, trace_categories[category].name);
        break;
    default:                     /* No clue */
        break;
    }
    return 1;
}
#endif

int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
{
#ifndef OPENSSL_NO_TRACE
    BIO *channel = NULL;
    struct trace_data_st *trace_data = NULL;

    if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
        return 0;

    if (callback != NULL) {
        if ((channel = BIO_new(&trace_method)) == NULL
            || (trace_data =
                OPENSSL_zalloc(sizeof(struct trace_data_st))) == NULL)
            goto err;

        trace_data->callback = callback;
        trace_data->category = category;
        trace_data->data = data;

        BIO_set_data(channel, trace_data);
    }

    if (!set_trace_data(category, CALLBACK_CHANNEL, &channel, NULL, NULL,
                        trace_attach_w_callback_cb, trace_detach_cb))
        goto err;

    return 1;

 err:
    BIO_free(channel);
    OPENSSL_free(trace_data);
#endif

    return 0;
}

int OSSL_trace_set_prefix(int category, const char *prefix)
{
#ifndef OPENSSL_NO_TRACE
    if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
        return set_trace_data(category, 0, NULL, &prefix, NULL,
                              trace_attach_cb, trace_detach_cb);
#endif
    return 0;
}

int OSSL_trace_set_suffix(int category, const char *suffix)
{
#ifndef OPENSSL_NO_TRACE
    if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
        return set_trace_data(category, 0, NULL, NULL, &suffix,
                              trace_attach_cb, trace_detach_cb);
#endif
    return 0;
}

#ifndef OPENSSL_NO_TRACE
static int ossl_trace_get_category(int category)
{
    if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
        return -1;
    if (trace_channels[category].bio != NULL)
        return category;
    return OSSL_TRACE_CATEGORY_ALL;
}
#endif

int OSSL_trace_enabled(int category)
{
    int ret = 0;
#ifndef OPENSSL_NO_TRACE
    category = ossl_trace_get_category(category);
    if (category >= 0)
        ret = trace_channels[category].bio != NULL;
#endif
    return ret;
}

BIO *OSSL_trace_begin(int category)
{
    BIO *channel = NULL;
#ifndef OPENSSL_NO_TRACE
    char *prefix = NULL;

    category = ossl_trace_get_category(category);
    if (category < 0)
        return NULL;

    channel = trace_channels[category].bio;
    prefix = trace_channels[category].prefix;

    if (channel != NULL) {
        if (!CRYPTO_THREAD_write_lock(trace_lock))
            return NULL;
        current_channel = channel;
        switch (trace_channels[category].type) {
        case SIMPLE_CHANNEL:
            if (prefix != NULL) {
                (void)BIO_puts(channel, prefix);
                (void)BIO_puts(channel, "\n");
            }
            break;
        case CALLBACK_CHANNEL:
            (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
                           prefix == NULL ? 0 : strlen(prefix), prefix);
            break;
        }
    }
#endif
    return channel;
}

void OSSL_trace_end(int category, BIO * channel)
{
#ifndef OPENSSL_NO_TRACE
    char *suffix = NULL;

    category = ossl_trace_get_category(category);
    suffix = trace_channels[category].suffix;
    if (channel != NULL
        && ossl_assert(channel == current_channel)) {
        (void)BIO_flush(channel);
        switch (trace_channels[category].type) {
        case SIMPLE_CHANNEL:
            if (suffix != NULL) {
                (void)BIO_puts(channel, suffix);
                (void)BIO_puts(channel, "\n");
            }
            break;
        case CALLBACK_CHANNEL:
            (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
                           suffix == NULL ? 0 : strlen(suffix), suffix);
            break;
        }
        current_channel = NULL;
        CRYPTO_THREAD_unlock(trace_lock);
    }
#endif
}
Commit	Line	Data
2390c573	1	/*
3c2bdd7d	2	* Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
2390c573 RL	3	*
	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
	5	* this file except in compliance with the License. You can obtain a copy
	6	* in the file LICENSE in the source distribution or at
	7	* https://www.openssl.org/source/license.html
	8	*/
	9
	10	#include <stdio.h>
	11	#include <string.h>
	12
cf0932cd	13	#include "internal/thread_once.h"
2390c573 RL	14	#include <openssl/bio.h>
	15	#include <openssl/crypto.h>
	16	#include <openssl/trace.h>
	17	#include "internal/bio.h"
	18	#include "internal/nelem.h"
a935791d	19	#include "internal/refcount.h"
25f2138b	20	#include "crypto/cryptlib.h"
2390c573 RL	21
	22	#include "e_os.h" /* strcasecmp for Windows */
	23
16a9d374 RL	24	#ifndef OPENSSL_NO_TRACE
16a9d374 RL	25
2390c573 RL	26	static CRYPTO_RWLOCK *trace_lock = NULL;
	27
	28	static const BIO *current_channel = NULL;
	29
	30	/*-
	31	* INTERNAL TRACE CHANNEL IMPLEMENTATION
	32	*
	33	* For our own flexibility, all trace categories are associated with a
	34	* BIO sink object, also called the trace channel. Instead of a BIO object,
	35	* the application can also provide a callback function, in which case an
	36	* internal trace channel is attached, which simply calls the registered
	37	* callback function.
	38	*/
	39	static int trace_write(BIO b, const char buf,
	40	size_t num, size_t *written);
	41	static int trace_puts(BIO b, const char str);
	42	static long trace_ctrl(BIO channel, int cmd, long argl, void argp);
	43	static int trace_free(BIO *b);
	44
	45	static const BIO_METHOD trace_method = {
	46	BIO_TYPE_SOURCE_SINK,
	47	"trace",
	48	trace_write,
	49	NULL, /* old write */
	50	NULL, /* read_ex */
	51	NULL, /* read */
	52	trace_puts,
	53	NULL, /* gets */
	54	trace_ctrl, /* ctrl */
	55	NULL, /* create */
	56	trace_free, /* free */
	57	NULL, /* callback_ctrl */
	58	};
	59
	60	struct trace_data_st {
	61	OSSL_trace_cb callback;
	62	int category;
	63	void *data;
	64	};
	65
	66	static int trace_write(BIO *channel,
	67	const char buf, size_t num, size_t written)
	68	{
	69	struct trace_data_st *ctx = BIO_get_data(channel);
13d06925	70	size_t cnt = ctx->callback(buf, num, ctx->category, OSSL_TRACE_CTRL_WRITE,
2390c573 RL	71	ctx->data);
	72
	73	*written = cnt;
	74	return cnt != 0;
	75	}
	76
	77	static int trace_puts(BIO channel, const char str)
	78	{
	79	size_t written;
	80
	81	if (trace_write(channel, str, strlen(str), &written))
	82	return (int)written;
	83
	84	return EOF;
	85	}
	86
	87	static long trace_ctrl(BIO channel, int cmd, long argl, void argp)
	88	{
	89	struct trace_data_st *ctx = BIO_get_data(channel);
	90
	91	switch (cmd) {
	92	case OSSL_TRACE_CTRL_BEGIN:
	93	case OSSL_TRACE_CTRL_END:
	94	/* We know that the callback is likely to return 0 here */
	95	ctx->callback("", 0, ctx->category, cmd, ctx->data);
	96	return 1;
	97	default:
	98	break;
	99	}
	100	return -2; /* Unsupported */
	101	}
	102
	103	static int trace_free(BIO *channel)
	104	{
	105	if (channel == NULL)
	106	return 0;
	107	OPENSSL_free(BIO_get_data(channel));
	108	return 1;
	109	}
16a9d374	110	#endif
2390c573 RL	111
	112	/*-
	113	* TRACE
	114	*/
	115
	116	/* Helper struct and macro to get name string to number mapping */
	117	struct trace_category_st {
	118	const char * const name;
	119	const int num;
	120	};
	121	#define TRACE_CATEGORY_(name) { #name, OSSL_TRACE_CATEGORY_##name }
	122
	123	static const struct trace_category_st trace_categories[] = {
3a8269b3	124	TRACE_CATEGORY_(ALL),
3b9e1a39	125	TRACE_CATEGORY_(TRACE),
5c641735	126	TRACE_CATEGORY_(INIT),
49b26f54	127	TRACE_CATEGORY_(TLS),
77359d22	128	TRACE_CATEGORY_(TLS_CIPHER),
bc362b9b	129	TRACE_CATEGORY_(CONF),
184fb690	130	#ifndef OPENSSL_NO_ENGINE
f272be67	131	TRACE_CATEGORY_(ENGINE_TABLE),
f518e3e8	132	TRACE_CATEGORY_(ENGINE_REF_COUNT),
184fb690	133	#endif
3a9b3d2d	134	TRACE_CATEGORY_(PKCS5V2),
a902e43d	135	TRACE_CATEGORY_(PKCS12_KEYGEN),
5f8a5f46	136	TRACE_CATEGORY_(PKCS12_DECRYPT),
b9ce85f6	137	TRACE_CATEGORY_(X509V3_POLICY),
6e810f2d	138	TRACE_CATEGORY_(BN_CTX),
2897b009	139	TRACE_CATEGORY_(STORE),
de5008a4	140	TRACE_CATEGORY_(DECODER),
0b9f90f5	141	TRACE_CATEGORY_(ENCODER),
a935791d	142	TRACE_CATEGORY_(REF_COUNT)
2390c573 RL	143	};
	144
	145	const char *OSSL_trace_get_category_name(int num)
	146	{
	147	size_t i;
	148
	149	for (i = 0; i < OSSL_NELEM(trace_categories); i++)
	150	if (trace_categories[i].num == num)
	151	return trace_categories[i].name;
	152	return NULL; /* not found */
	153	}
	154
	155	int OSSL_trace_get_category_num(const char *name)
	156	{
	157	size_t i;
	158
	159	for (i = 0; i < OSSL_NELEM(trace_categories); i++)
	160	if (strcasecmp(name, trace_categories[i].name) == 0)
	161	return trace_categories[i].num;
	162	return -1; /* not found */
	163	}
	164
16a9d374 RL	165	#ifndef OPENSSL_NO_TRACE
16a9d374 RL	166
2390c573 RL	167	/* We use one trace channel for each trace category */
2390c573 RL	168	static struct {
5afb177c	169	enum { SIMPLE_CHANNEL, CALLBACK_CHANNEL } type;
2390c573 RL	170	BIO *bio;
	171	char *prefix;
	172	char *suffix;
	173	} trace_channels[OSSL_TRACE_CATEGORY_NUM] = {
	174	{ 0, NULL, NULL, NULL },
	175	};
	176
16a9d374 RL	177	#endif
16a9d374 RL	178
3b9e1a39	179	#ifndef OPENSSL_NO_TRACE
e474a286 DMSP	180
	181	enum {
	182	CHANNEL,
	183	PREFIX,
	184	SUFFIX
	185	};
	186
3b9e1a39 RL	187	static int trace_attach_cb(int category, int type, const void *data)
	188	{
	189	switch (type) {
e474a286	190	case CHANNEL:
3b9e1a39 RL	191	OSSL_TRACE2(TRACE, "Attach channel %p to category '%s'\n",
	192	data, trace_categories[category].name);
	193	break;
e474a286	194	case PREFIX:
3b9e1a39 RL	195	OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
	196	(const char *)data, trace_categories[category].name);
	197	break;
e474a286	198	case SUFFIX:
3b9e1a39 RL	199	OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
	200	(const char *)data, trace_categories[category].name);
	201	break;
	202	default: /* No clue */
	203	break;
	204	}
	205	return 1;
	206	}
	207
	208	static int trace_detach_cb(int category, int type, const void *data)
	209	{
	210	switch (type) {
e474a286	211	case CHANNEL:
3b9e1a39 RL	212	OSSL_TRACE2(TRACE, "Detach channel %p from category '%s'\n",
	213	data, trace_categories[category].name);
	214	break;
e474a286	215	case PREFIX:
3b9e1a39 RL	216	OSSL_TRACE2(TRACE, "Detach prefix \"%s\" from category '%s'\n",
	217	(const char *)data, trace_categories[category].name);
	218	break;
e474a286	219	case SUFFIX:
3b9e1a39 RL	220	OSSL_TRACE2(TRACE, "Detach suffix \"%s\" from category '%s'\n",
	221	(const char *)data, trace_categories[category].name);
	222	break;
	223	default: /* No clue */
	224	break;
	225	}
	226	return 1;
	227	}
	228
cf0932cd DDO	229	static int do_ossl_trace_init(void);
	230	static CRYPTO_ONCE trace_inited = CRYPTO_ONCE_STATIC_INIT;
	231	DEFINE_RUN_ONCE_STATIC(ossl_trace_init)
	232	{
	233	return do_ossl_trace_init();
	234	}
	235
fe50e115	236	static int set_trace_data(int category, int type, BIO **channel,
3b9e1a39 RL	237	const char prefix, const char suffix,
	238	int (attach_cb)(int, int, const void ),
	239	int (detach_cb)(int, int, const void ))
	240	{
fe26f798 RL	241	BIO *curr_channel = NULL;
	242	char *curr_prefix = NULL;
	243	char *curr_suffix = NULL;
	244
cf0932cd DDO	245	/* Ensure do_ossl_trace_init() is called once */
	246	if (!RUN_ONCE(&trace_inited, ossl_trace_init))
	247	return 0;
fe26f798 RL	248
	249	curr_channel = trace_channels[category].bio;
	250	curr_prefix = trace_channels[category].prefix;
	251	curr_suffix = trace_channels[category].suffix;
3b9e1a39 RL	252
	253	/* Make sure to run the detach callback first on all data */
	254	if (prefix != NULL && curr_prefix != NULL) {
e474a286	255	detach_cb(category, PREFIX, curr_prefix);
3b9e1a39 RL	256	}
	257
	258	if (suffix != NULL && curr_suffix != NULL) {
e474a286	259	detach_cb(category, SUFFIX, curr_suffix);
3b9e1a39 RL	260	}
	261
	262	if (channel != NULL && curr_channel != NULL) {
e474a286	263	detach_cb(category, CHANNEL, curr_channel);
3b9e1a39 RL	264	}
	265
	266	/* After detach callbacks are done, clear data where appropriate */
	267	if (prefix != NULL && curr_prefix != NULL) {
	268	OPENSSL_free(curr_prefix);
	269	trace_channels[category].prefix = NULL;
	270	}
	271
	272	if (suffix != NULL && curr_suffix != NULL) {
	273	OPENSSL_free(curr_suffix);
	274	trace_channels[category].suffix = NULL;
	275	}
	276
	277	if (channel != NULL && curr_channel != NULL) {
	278	BIO_free(curr_channel);
fe50e115	279	trace_channels[category].type = 0;
3b9e1a39 RL	280	trace_channels[category].bio = NULL;
	281	}
	282
	283	/* Before running callbacks are done, set new data where appropriate */
	284	if (channel != NULL && *channel != NULL) {
fe50e115	285	trace_channels[category].type = type;
3b9e1a39 RL	286	trace_channels[category].bio = *channel;
	287	}
	288
	289	if (prefix != NULL && *prefix != NULL) {
	290	if ((curr_prefix = OPENSSL_strdup(*prefix)) == NULL)
	291	return 0;
	292	trace_channels[category].prefix = curr_prefix;
	293	}
	294
	295	if (suffix != NULL && *suffix != NULL) {
	296	if ((curr_suffix = OPENSSL_strdup(*suffix)) == NULL)
	297	return 0;
	298	trace_channels[category].suffix = curr_suffix;
	299	}
	300
	301	/* Finally, run the attach callback on the new data */
	302	if (channel != NULL && *channel != NULL) {
e474a286	303	attach_cb(category, CHANNEL, *channel);
3b9e1a39 RL	304	}
	305
	306	if (prefix != NULL && *prefix != NULL) {
e474a286	307	attach_cb(category, PREFIX, *prefix);
3b9e1a39 RL	308	}
	309
	310	if (suffix != NULL && *suffix != NULL) {
e474a286	311	attach_cb(category, SUFFIX, *suffix);
3b9e1a39 RL	312	}
	313
	314	return 1;
	315	}
3b9e1a39	316
cf0932cd	317	static int do_ossl_trace_init(void)
2390c573 RL	318	{
2390c573 RL	319	trace_lock = CRYPTO_THREAD_lock_new();
cf0932cd	320	return trace_lock != NULL;
2390c573 RL	321	}
2390c573 RL	322
cf0932cd DDO	323	#endif
cf0932cd DDO	324
2390c573 RL	325	void ossl_trace_cleanup(void)
2390c573 RL	326	{
16a9d374	327	#ifndef OPENSSL_NO_TRACE
2390c573	328	int category;
3b9e1a39 RL	329	BIO *channel = NULL;
	330	const char *prefix = NULL;
	331	const char *suffix = NULL;
	332
	333	for (category = 0; category < OSSL_TRACE_CATEGORY_NUM; category++) {
	334	/* We force the TRACE category to be treated last */
	335	if (category == OSSL_TRACE_CATEGORY_TRACE)
	336	continue;
fe50e115	337	set_trace_data(category, 0, &channel, &prefix, &suffix,
3b9e1a39 RL	338	trace_attach_cb, trace_detach_cb);
3b9e1a39 RL	339	}
fe50e115 DMSP	340	set_trace_data(OSSL_TRACE_CATEGORY_TRACE, 0, &channel,
fe50e115 DMSP	341	&prefix, &suffix,
3b9e1a39	342	trace_attach_cb, trace_detach_cb);
2390c573	343	CRYPTO_THREAD_lock_free(trace_lock);
16a9d374	344	#endif
2390c573 RL	345	}
	346
	347	int OSSL_trace_set_channel(int category, BIO *channel)
	348	{
16a9d374	349	#ifndef OPENSSL_NO_TRACE
0fda9f7c DMSP	350	if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
0fda9f7c DMSP	351	return set_trace_data(category, SIMPLE_CHANNEL, &channel, NULL, NULL,
02bd2d7f	352	trace_attach_cb, trace_detach_cb);
16a9d374	353	#endif
0fda9f7c	354	return 0;
2390c573 RL	355	}
2390c573 RL	356
3b9e1a39 RL	357	#ifndef OPENSSL_NO_TRACE
	358	static int trace_attach_w_callback_cb(int category, int type, const void *data)
	359	{
	360	switch (type) {
e474a286	361	case CHANNEL:
3b9e1a39 RL	362	OSSL_TRACE2(TRACE,
	363	"Attach channel %p to category '%s' (with callback)\n",
	364	data, trace_categories[category].name);
	365	break;
e474a286	366	case PREFIX:
3b9e1a39 RL	367	OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
	368	(const char *)data, trace_categories[category].name);
	369	break;
e474a286	370	case SUFFIX:
3b9e1a39 RL	371	OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
	372	(const char *)data, trace_categories[category].name);
	373	break;
	374	default: /* No clue */
	375	break;
	376	}
	377	return 1;
	378	}
	379	#endif
	380
2390c573 RL	381	int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
2390c573 RL	382	{
16a9d374	383	#ifndef OPENSSL_NO_TRACE
3b9e1a39	384	BIO *channel = NULL;
2390c573 RL	385	struct trace_data_st *trace_data = NULL;
2390c573 RL	386
3b9e1a39	387	if (category < 0 \|\| category >= OSSL_TRACE_CATEGORY_NUM)
0fda9f7c	388	return 0;
2390c573	389
3b9e1a39 RL	390	if (callback != NULL) {
	391	if ((channel = BIO_new(&trace_method)) == NULL
	392	\|\| (trace_data =
	393	OPENSSL_zalloc(sizeof(struct trace_data_st))) == NULL)
	394	goto err;
2390c573	395
3b9e1a39 RL	396	trace_data->callback = callback;
	397	trace_data->category = category;
	398	trace_data->data = data;
2390c573	399
3b9e1a39 RL	400	BIO_set_data(channel, trace_data);
3b9e1a39 RL	401	}
2390c573	402
fe50e115	403	if (!set_trace_data(category, CALLBACK_CHANNEL, &channel, NULL, NULL,
3b9e1a39 RL	404	trace_attach_w_callback_cb, trace_detach_cb))
3b9e1a39 RL	405	goto err;
2390c573	406
0fda9f7c	407	return 1;
2390c573 RL	408
	409	err:
	410	BIO_free(channel);
	411	OPENSSL_free(trace_data);
d33d7616	412	#endif
0fda9f7c DMSP	413
0fda9f7c DMSP	414	return 0;
2390c573 RL	415	}
	416
	417	int OSSL_trace_set_prefix(int category, const char *prefix)
	418	{
16a9d374	419	#ifndef OPENSSL_NO_TRACE
0fda9f7c	420	if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
fe50e115	421	return set_trace_data(category, 0, NULL, &prefix, NULL,
3b9e1a39	422	trace_attach_cb, trace_detach_cb);
16a9d374	423	#endif
0fda9f7c	424	return 0;
2390c573 RL	425	}
	426
	427	int OSSL_trace_set_suffix(int category, const char *suffix)
	428	{
16a9d374	429	#ifndef OPENSSL_NO_TRACE
0fda9f7c	430	if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
fe50e115	431	return set_trace_data(category, 0, NULL, NULL, &suffix,
3b9e1a39	432	trace_attach_cb, trace_detach_cb);
16a9d374	433	#endif
0fda9f7c	434	return 0;
2390c573 RL	435	}
2390c573 RL	436
16a9d374	437	#ifndef OPENSSL_NO_TRACE
2390c573 RL	438	static int ossl_trace_get_category(int category)
	439	{
	440	if (category < 0 \|\| category >= OSSL_TRACE_CATEGORY_NUM)
	441	return -1;
	442	if (trace_channels[category].bio != NULL)
	443	return category;
3a8269b3	444	return OSSL_TRACE_CATEGORY_ALL;
2390c573	445	}
16a9d374	446	#endif
2390c573 RL	447
	448	int OSSL_trace_enabled(int category)
	449	{
	450	int ret = 0;
16a9d374	451	#ifndef OPENSSL_NO_TRACE
2390c573	452	category = ossl_trace_get_category(category);
6a411436 DMSP	453	if (category >= 0)
6a411436 DMSP	454	ret = trace_channels[category].bio != NULL;
16a9d374	455	#endif
2390c573 RL	456	return ret;
	457	}
	458
	459	BIO *OSSL_trace_begin(int category)
	460	{
	461	BIO *channel = NULL;
16a9d374	462	#ifndef OPENSSL_NO_TRACE
2390c573 RL	463	char *prefix = NULL;
	464
	465	category = ossl_trace_get_category(category);
6a411436 DMSP	466	if (category < 0)
	467	return NULL;
	468
2390c573 RL	469	channel = trace_channels[category].bio;
	470	prefix = trace_channels[category].prefix;
	471
	472	if (channel != NULL) {
cd3f8c1b RS	473	if (!CRYPTO_THREAD_write_lock(trace_lock))
cd3f8c1b RS	474	return NULL;
2390c573 RL	475	current_channel = channel;
2390c573 RL	476	switch (trace_channels[category].type) {
5afb177c	477	case SIMPLE_CHANNEL:
2390c573 RL	478	if (prefix != NULL) {
	479	(void)BIO_puts(channel, prefix);
	480	(void)BIO_puts(channel, "\n");
	481	}
	482	break;
5afb177c	483	case CALLBACK_CHANNEL:
2390c573 RL	484	(void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
	485	prefix == NULL ? 0 : strlen(prefix), prefix);
	486	break;
	487	}
	488	}
16a9d374	489	#endif
2390c573 RL	490	return channel;
	491	}
	492
	493	void OSSL_trace_end(int category, BIO * channel)
	494	{
16a9d374	495	#ifndef OPENSSL_NO_TRACE
2390c573 RL	496	char *suffix = NULL;
	497
	498	category = ossl_trace_get_category(category);
	499	suffix = trace_channels[category].suffix;
	500	if (channel != NULL
	501	&& ossl_assert(channel == current_channel)) {
	502	(void)BIO_flush(channel);
	503	switch (trace_channels[category].type) {
5afb177c	504	case SIMPLE_CHANNEL:
2390c573 RL	505	if (suffix != NULL) {
	506	(void)BIO_puts(channel, suffix);
	507	(void)BIO_puts(channel, "\n");
	508	}
	509	break;
5afb177c	510	case CALLBACK_CHANNEL:
2390c573 RL	511	(void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
	512	suffix == NULL ? 0 : strlen(suffix), suffix);
	513	break;
	514	}
	515	current_channel = NULL;
	516	CRYPTO_THREAD_unlock(trace_lock);
	517	}
16a9d374	518	#endif
2390c573	519	}