/src/openssl30/crypto/trace.c

Source
/*
 * Copyright 2019-2023 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"

#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[OSSL_TRACE_CATEGORY_NUM]
    = {
          TRACE_CATEGORY_(ALL),
          TRACE_CATEGORY_(TRACE),
          TRACE_CATEGORY_(INIT),
          TRACE_CATEGORY_(TLS),
          TRACE_CATEGORY_(TLS_CIPHER),
          TRACE_CATEGORY_(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),
          TRACE_CATEGORY_(CMP),
          TRACE_CATEGORY_(STORE),
          TRACE_CATEGORY_(DECODER),
          TRACE_CATEGORY_(ENCODER),
          TRACE_CATEGORY_(REF_COUNT)
      };

const char *OSSL_trace_get_category_name(int num)
{
    if (num < 0 || (size_t)num >= OSSL_NELEM(trace_categories))
        return NULL;
    /*
     * Partial check that OSSL_TRACE_CATEGORY_... macros
     * are synced with trace_categories array
     */
    if (!ossl_assert(trace_categories[num].name != NULL)
        || !ossl_assert(trace_categories[num].num == num))
        return NULL;
    return trace_categories[num].name;
}

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

    if (name == NULL)
        return -1;

    for (i = 0; i < OSSL_NELEM(trace_categories); i++)
        if (OPENSSL_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 (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;
    }

    if (channel != NULL && *channel != NULL) {
        trace_channels[category].type = type;
        trace_channels[category].bio = *channel;
        /*
         * This must not be done before setting prefix/suffix,
         * as those may fail, and then the caller is mislead to free *channel.
         */
    }

    /* 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 || !OSSL_trace_enabled(category))
        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);
    if (category < 0)
        return;
    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
}

Coverage Report

Created: 2025-12-31 06:58

Line	Count	Source
1		/*
2		* Copyright 2019-2023 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 "internal/thread_once.h"
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"
19		#include "internal/refcount.h"
20		#include "crypto/cryptlib.h"
21
22		#ifndef OPENSSL_NO_TRACE
23
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);
68		size_t cnt = ctx->callback(buf, num, ctx->category, OSSL_TRACE_CTRL_WRITE,
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		}
108		#endif
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
122		trace_categories[OSSL_TRACE_CATEGORY_NUM]
123		= {
124		TRACE_CATEGORY_(ALL),
125		TRACE_CATEGORY_(TRACE),
126		TRACE_CATEGORY_(INIT),
127		TRACE_CATEGORY_(TLS),
128		TRACE_CATEGORY_(TLS_CIPHER),
129		TRACE_CATEGORY_(CONF),
130		TRACE_CATEGORY_(ENGINE_TABLE),
131		TRACE_CATEGORY_(ENGINE_REF_COUNT),
132		TRACE_CATEGORY_(PKCS5V2),
133		TRACE_CATEGORY_(PKCS12_KEYGEN),
134		TRACE_CATEGORY_(PKCS12_DECRYPT),
135		TRACE_CATEGORY_(X509V3_POLICY),
136		TRACE_CATEGORY_(BN_CTX),
137		TRACE_CATEGORY_(CMP),
138		TRACE_CATEGORY_(STORE),
139		TRACE_CATEGORY_(DECODER),
140		TRACE_CATEGORY_(ENCODER),
141		TRACE_CATEGORY_(REF_COUNT)
142		};
143
144		const char *OSSL_trace_get_category_name(int num)
145	0	{
146	0	if (num < 0 \|\| (size_t)num >= OSSL_NELEM(trace_categories))
147	0	return NULL;
148		/*
149		* Partial check that OSSL_TRACE_CATEGORY_... macros
150		* are synced with trace_categories array
151		*/
152	0	if (!ossl_assert(trace_categories[num].name != NULL)
153	0	\|\| !ossl_assert(trace_categories[num].num == num))
154	0	return NULL;
155	0	return trace_categories[num].name;
156	0	}
157
158		int OSSL_trace_get_category_num(const char *name)
159	0	{
160	0	size_t i;
161
162	0	if (name == NULL)
163	0	return -1;
164
165	0	for (i = 0; i < OSSL_NELEM(trace_categories); i++)
166	0	if (OPENSSL_strcasecmp(name, trace_categories[i].name) == 0)
167	0	return trace_categories[i].num;
168
169	0	return -1; /* not found */
170	0	}
171
172		#ifndef OPENSSL_NO_TRACE
173
174		/* We use one trace channel for each trace category */
175		static struct {
176		enum { SIMPLE_CHANNEL,
177		CALLBACK_CHANNEL } type;
178		BIO *bio;
179		char *prefix;
180		char *suffix;
181		} trace_channels[OSSL_TRACE_CATEGORY_NUM] = {
182		{ 0, NULL, NULL, NULL },
183		};
184
185		#endif
186
187		#ifndef OPENSSL_NO_TRACE
188
189		enum {
190		CHANNEL,
191		PREFIX,
192		SUFFIX
193		};
194
195		static int trace_attach_cb(int category, int type, const void *data)
196		{
197		switch (type) {
198		case CHANNEL:
199		OSSL_TRACE2(TRACE, "Attach channel %p to category '%s'\n",
200		data, trace_categories[category].name);
201		break;
202		case PREFIX:
203		OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
204		(const char *)data, trace_categories[category].name);
205		break;
206		case SUFFIX:
207		OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
208		(const char *)data, trace_categories[category].name);
209		break;
210		default: /* No clue */
211		break;
212		}
213		return 1;
214		}
215
216		static int trace_detach_cb(int category, int type, const void *data)
217		{
218		switch (type) {
219		case CHANNEL:
220		OSSL_TRACE2(TRACE, "Detach channel %p from category '%s'\n",
221		data, trace_categories[category].name);
222		break;
223		case PREFIX:
224		OSSL_TRACE2(TRACE, "Detach prefix \"%s\" from category '%s'\n",
225		(const char *)data, trace_categories[category].name);
226		break;
227		case SUFFIX:
228		OSSL_TRACE2(TRACE, "Detach suffix \"%s\" from category '%s'\n",
229		(const char *)data, trace_categories[category].name);
230		break;
231		default: /* No clue */
232		break;
233		}
234		return 1;
235		}
236
237		static int do_ossl_trace_init(void);
238		static CRYPTO_ONCE trace_inited = CRYPTO_ONCE_STATIC_INIT;
239		DEFINE_RUN_ONCE_STATIC(ossl_trace_init)
240		{
241		return do_ossl_trace_init();
242		}
243
244		static int set_trace_data(int category, int type, BIO **channel,
245		const char prefix, const char suffix,
246		int (attach_cb)(int, int, const void ),
247		int (detach_cb)(int, int, const void ))
248		{
249		BIO *curr_channel = NULL;
250		char *curr_prefix = NULL;
251		char *curr_suffix = NULL;
252
253		/* Ensure do_ossl_trace_init() is called once */
254		if (!RUN_ONCE(&trace_inited, ossl_trace_init))
255		return 0;
256
257		curr_channel = trace_channels[category].bio;
258		curr_prefix = trace_channels[category].prefix;
259		curr_suffix = trace_channels[category].suffix;
260
261		/* Make sure to run the detach callback first on all data */
262		if (prefix != NULL && curr_prefix != NULL) {
263		detach_cb(category, PREFIX, curr_prefix);
264		}
265
266		if (suffix != NULL && curr_suffix != NULL) {
267		detach_cb(category, SUFFIX, curr_suffix);
268		}
269
270		if (channel != NULL && curr_channel != NULL) {
271		detach_cb(category, CHANNEL, curr_channel);
272		}
273
274		/* After detach callbacks are done, clear data where appropriate */
275		if (prefix != NULL && curr_prefix != NULL) {
276		OPENSSL_free(curr_prefix);
277		trace_channels[category].prefix = NULL;
278		}
279
280		if (suffix != NULL && curr_suffix != NULL) {
281		OPENSSL_free(curr_suffix);
282		trace_channels[category].suffix = NULL;
283		}
284
285		if (channel != NULL && curr_channel != NULL) {
286		BIO_free(curr_channel);
287		trace_channels[category].type = 0;
288		trace_channels[category].bio = NULL;
289		}
290
291		/* Before running callbacks are done, set new data where appropriate */
292		if (prefix != NULL && *prefix != NULL) {
293		if ((curr_prefix = OPENSSL_strdup(*prefix)) == NULL)
294		return 0;
295		trace_channels[category].prefix = curr_prefix;
296		}
297
298		if (suffix != NULL && *suffix != NULL) {
299		if ((curr_suffix = OPENSSL_strdup(*suffix)) == NULL)
300		return 0;
301		trace_channels[category].suffix = curr_suffix;
302		}
303
304		if (channel != NULL && *channel != NULL) {
305		trace_channels[category].type = type;
306		trace_channels[category].bio = *channel;
307		/*
308		* This must not be done before setting prefix/suffix,
309		* as those may fail, and then the caller is mislead to free *channel.
310		*/
311		}
312
313		/* Finally, run the attach callback on the new data */
314		if (channel != NULL && *channel != NULL) {
315		attach_cb(category, CHANNEL, *channel);
316		}
317
318		if (prefix != NULL && *prefix != NULL) {
319		attach_cb(category, PREFIX, *prefix);
320		}
321
322		if (suffix != NULL && *suffix != NULL) {
323		attach_cb(category, SUFFIX, *suffix);
324		}
325
326		return 1;
327		}
328
329		static int do_ossl_trace_init(void)
330		{
331		trace_lock = CRYPTO_THREAD_lock_new();
332		return trace_lock != NULL;
333		}
334
335		#endif
336
337		void ossl_trace_cleanup(void)
338	220	{
339		#ifndef OPENSSL_NO_TRACE
340		int category;
341		BIO *channel = NULL;
342		const char *prefix = NULL;
343		const char *suffix = NULL;
344
345		for (category = 0; category < OSSL_TRACE_CATEGORY_NUM; category++) {
346		/* We force the TRACE category to be treated last */
347		if (category == OSSL_TRACE_CATEGORY_TRACE)
348		continue;
349		set_trace_data(category, 0, &channel, &prefix, &suffix,
350		trace_attach_cb, trace_detach_cb);
351		}
352		set_trace_data(OSSL_TRACE_CATEGORY_TRACE, 0, &channel,
353		&prefix, &suffix,
354		trace_attach_cb, trace_detach_cb);
355		CRYPTO_THREAD_lock_free(trace_lock);
356		#endif
357	220	}
358
359		int OSSL_trace_set_channel(int category, BIO *channel)
360	220	{
361		#ifndef OPENSSL_NO_TRACE
362		if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
363		return set_trace_data(category, SIMPLE_CHANNEL, &channel, NULL, NULL,
364		trace_attach_cb, trace_detach_cb);
365		#endif
366	220	return 0;
367	220	}
368
369		#ifndef OPENSSL_NO_TRACE
370		static int trace_attach_w_callback_cb(int category, int type, const void *data)
371		{
372		switch (type) {
373		case CHANNEL:
374		OSSL_TRACE2(TRACE,
375		"Attach channel %p to category '%s' (with callback)\n",
376		data, trace_categories[category].name);
377		break;
378		case PREFIX:
379		OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
380		(const char *)data, trace_categories[category].name);
381		break;
382		case SUFFIX:
383		OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
384		(const char *)data, trace_categories[category].name);
385		break;
386		default: /* No clue */
387		break;
388		}
389		return 1;
390		}
391		#endif
392
393		int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
394	0	{
395		#ifndef OPENSSL_NO_TRACE
396		BIO *channel = NULL;
397		struct trace_data_st *trace_data = NULL;
398
399		if (category < 0 \|\| category >= OSSL_TRACE_CATEGORY_NUM)
400		return 0;
401
402		if (callback != NULL) {
403		if ((channel = BIO_new(&trace_method)) == NULL
404		\|\| (trace_data = OPENSSL_zalloc(sizeof(struct trace_data_st))) == NULL)
405		goto err;
406
407		trace_data->callback = callback;
408		trace_data->category = category;
409		trace_data->data = data;
410
411		BIO_set_data(channel, trace_data);
412		}
413
414		if (!set_trace_data(category, CALLBACK_CHANNEL, &channel, NULL, NULL,
415		trace_attach_w_callback_cb, trace_detach_cb))
416		goto err;
417
418		return 1;
419
420		err:
421		BIO_free(channel);
422		OPENSSL_free(trace_data);
423		#endif
424
425	0	return 0;
426	0	}
427
428		int OSSL_trace_set_prefix(int category, const char *prefix)
429	0	{
430		#ifndef OPENSSL_NO_TRACE
431		if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
432		return set_trace_data(category, 0, NULL, &prefix, NULL,
433		trace_attach_cb, trace_detach_cb);
434		#endif
435	0	return 0;
436	0	}
437
438		int OSSL_trace_set_suffix(int category, const char *suffix)
439	0	{
440		#ifndef OPENSSL_NO_TRACE
441		if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
442		return set_trace_data(category, 0, NULL, NULL, &suffix,
443		trace_attach_cb, trace_detach_cb);
444		#endif
445	0	return 0;
446	0	}
447
448		#ifndef OPENSSL_NO_TRACE
449		static int ossl_trace_get_category(int category)
450		{
451		if (category < 0 \|\| category >= OSSL_TRACE_CATEGORY_NUM)
452		return -1;
453		if (trace_channels[category].bio != NULL)
454		return category;
455		return OSSL_TRACE_CATEGORY_ALL;
456		}
457		#endif
458
459		int OSSL_trace_enabled(int category)
460	0	{
461	0	int ret = 0;
462		#ifndef OPENSSL_NO_TRACE
463		category = ossl_trace_get_category(category);
464		if (category >= 0)
465		ret = trace_channels[category].bio != NULL;
466		#endif
467	0	return ret;
468	0	}
469
470		BIO *OSSL_trace_begin(int category)
471	0	{
472	0	BIO *channel = NULL;
473		#ifndef OPENSSL_NO_TRACE
474		char *prefix = NULL;
475
476		category = ossl_trace_get_category(category);
477		if (category < 0 \|\| !OSSL_trace_enabled(category))
478		return NULL;
479
480		channel = trace_channels[category].bio;
481		prefix = trace_channels[category].prefix;
482
483		if (channel != NULL) {
484		if (!CRYPTO_THREAD_write_lock(trace_lock))
485		return NULL;
486		current_channel = channel;
487		switch (trace_channels[category].type) {
488		case SIMPLE_CHANNEL:
489		if (prefix != NULL) {
490		(void)BIO_puts(channel, prefix);
491		(void)BIO_puts(channel, "\n");
492		}
493		break;
494		case CALLBACK_CHANNEL:
495		(void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
496		prefix == NULL ? 0 : strlen(prefix), prefix);
497		break;
498		}
499		}
500		#endif
501	0	return channel;
502	0	}
503
504		void OSSL_trace_end(int category, BIO *channel)
505	0	{
506		#ifndef OPENSSL_NO_TRACE
507		char *suffix = NULL;
508
509		category = ossl_trace_get_category(category);
510		if (category < 0)
511		return;
512		suffix = trace_channels[category].suffix;
513		if (channel != NULL
514		&& ossl_assert(channel == current_channel)) {
515		(void)BIO_flush(channel);
516		switch (trace_channels[category].type) {
517		case SIMPLE_CHANNEL:
518		if (suffix != NULL) {
519		(void)BIO_puts(channel, suffix);
520		(void)BIO_puts(channel, "\n");
521		}
522		break;
523		case CALLBACK_CHANNEL:
524		(void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
525		suffix == NULL ? 0 : strlen(suffix), suffix);
526		break;
527		}
528		current_channel = NULL;
529		CRYPTO_THREAD_unlock(trace_lock);
530		}
531		#endif
532	0	}