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

/*
 * Copyright 2019 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 <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 "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_(ANY),
    TRACE_CATEGORY_(TRACE),
    TRACE_CATEGORY_(INIT),
    TRACE_CATEGORY_(TLS),
    TRACE_CATEGORY_(TLS_CIPHER),
    TRACE_CATEGORY_(ENGINE_CONF),
    TRACE_CATEGORY_(ENGINE_TABLE),
    TRACE_CATEGORY_(ENGINE_REF_COUNT),
    TRACE_CATEGORY_(PKCS5V2),
    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)
{
    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 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;

    /* 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;
}
#endif

int ossl_trace_init(void)
{
#ifndef OPENSSL_NO_TRACE
    trace_lock = CRYPTO_THREAD_lock_new();
    if (trace_lock == NULL)
        return 0;
#endif

    return 1;
}

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
        || !set_trace_data(category, SIMPLE_CHANNEL, &channel, NULL, NULL,
                           trace_attach_cb, trace_detach_cb))
        return 0;
#endif
    return 1;
}

#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)
        goto err;

    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;

    goto done;

 err:
    BIO_free(channel);
    OPENSSL_free(trace_data);
    return 0;
 done:
#endif
    return 1;
}

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, 0, NULL, &prefix, NULL,
                              trace_attach_cb, trace_detach_cb);
    rv = 0;
#endif
    return rv;
}

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, 0, NULL, NULL, &suffix,
                              trace_attach_cb, trace_detach_cb);
    rv = 0;
#endif
    return rv;
}

#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_ANY;
}
#endif

int OSSL_trace_enabled(int category)
{
    int ret = 0;
#ifndef OPENSSL_NO_TRACE
    category = ossl_trace_get_category(category);
    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);
    channel = trace_channels[category].bio;
    prefix = trace_channels[category].prefix;

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