2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
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
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 "crypto/cryptlib.h"
21 #include "e_os.h" /* strcasecmp for Windows */
23 #ifndef OPENSSL_NO_TRACE
25 static CRYPTO_RWLOCK *trace_lock = NULL;
27 static const BIO *current_channel = NULL;
30 * INTERNAL TRACE CHANNEL IMPLEMENTATION
32 * For our own flexibility, all trace categories are associated with a
33 * BIO sink object, also called the trace channel. Instead of a BIO object,
34 * the application can also provide a callback function, in which case an
35 * internal trace channel is attached, which simply calls the registered
38 static int trace_write(BIO *b, const char *buf,
39 size_t num, size_t *written);
40 static int trace_puts(BIO *b, const char *str);
41 static long trace_ctrl(BIO *channel, int cmd, long argl, void *argp);
42 static int trace_free(BIO *b);
44 static const BIO_METHOD trace_method = {
53 trace_ctrl, /* ctrl */
55 trace_free, /* free */
56 NULL, /* callback_ctrl */
59 struct trace_data_st {
60 OSSL_trace_cb callback;
65 static int trace_write(BIO *channel,
66 const char *buf, size_t num, size_t *written)
68 struct trace_data_st *ctx = BIO_get_data(channel);
69 size_t cnt = ctx->callback(buf, num, ctx->category, OSSL_TRACE_CTRL_WRITE,
76 static int trace_puts(BIO *channel, const char *str)
80 if (trace_write(channel, str, strlen(str), &written))
86 static long trace_ctrl(BIO *channel, int cmd, long argl, void *argp)
88 struct trace_data_st *ctx = BIO_get_data(channel);
91 case OSSL_TRACE_CTRL_BEGIN:
92 case OSSL_TRACE_CTRL_END:
93 /* We know that the callback is likely to return 0 here */
94 ctx->callback("", 0, ctx->category, cmd, ctx->data);
99 return -2; /* Unsupported */
102 static int trace_free(BIO *channel)
106 OPENSSL_free(BIO_get_data(channel));
115 /* Helper struct and macro to get name string to number mapping */
116 struct trace_category_st {
117 const char * const name;
120 #define TRACE_CATEGORY_(name) { #name, OSSL_TRACE_CATEGORY_##name }
122 static const struct trace_category_st trace_categories[] = {
123 TRACE_CATEGORY_(ALL),
124 TRACE_CATEGORY_(TRACE),
125 TRACE_CATEGORY_(INIT),
126 TRACE_CATEGORY_(TLS),
127 TRACE_CATEGORY_(TLS_CIPHER),
128 TRACE_CATEGORY_(CONF),
129 TRACE_CATEGORY_(ENGINE_TABLE),
130 TRACE_CATEGORY_(ENGINE_REF_COUNT),
131 TRACE_CATEGORY_(PKCS5V2),
132 TRACE_CATEGORY_(PKCS12_KEYGEN),
133 TRACE_CATEGORY_(PKCS12_DECRYPT),
134 TRACE_CATEGORY_(X509V3_POLICY),
135 TRACE_CATEGORY_(BN_CTX),
136 TRACE_CATEGORY_(STORE),
139 const char *OSSL_trace_get_category_name(int num)
143 for (i = 0; i < OSSL_NELEM(trace_categories); i++)
144 if (trace_categories[i].num == num)
145 return trace_categories[i].name;
146 return NULL; /* not found */
149 int OSSL_trace_get_category_num(const char *name)
153 for (i = 0; i < OSSL_NELEM(trace_categories); i++)
154 if (strcasecmp(name, trace_categories[i].name) == 0)
155 return trace_categories[i].num;
156 return -1; /* not found */
159 #ifndef OPENSSL_NO_TRACE
161 /* We use one trace channel for each trace category */
163 enum { SIMPLE_CHANNEL, CALLBACK_CHANNEL } type;
167 } trace_channels[OSSL_TRACE_CATEGORY_NUM] = {
168 { 0, NULL, NULL, NULL },
173 #ifndef OPENSSL_NO_TRACE
181 static int trace_attach_cb(int category, int type, const void *data)
185 OSSL_TRACE2(TRACE, "Attach channel %p to category '%s'\n",
186 data, trace_categories[category].name);
189 OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
190 (const char *)data, trace_categories[category].name);
193 OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
194 (const char *)data, trace_categories[category].name);
196 default: /* No clue */
202 static int trace_detach_cb(int category, int type, const void *data)
206 OSSL_TRACE2(TRACE, "Detach channel %p from category '%s'\n",
207 data, trace_categories[category].name);
210 OSSL_TRACE2(TRACE, "Detach prefix \"%s\" from category '%s'\n",
211 (const char *)data, trace_categories[category].name);
214 OSSL_TRACE2(TRACE, "Detach suffix \"%s\" from category '%s'\n",
215 (const char *)data, trace_categories[category].name);
217 default: /* No clue */
223 static int do_ossl_trace_init(void);
224 static CRYPTO_ONCE trace_inited = CRYPTO_ONCE_STATIC_INIT;
225 DEFINE_RUN_ONCE_STATIC(ossl_trace_init)
227 return do_ossl_trace_init();
230 static int set_trace_data(int category, int type, BIO **channel,
231 const char **prefix, const char **suffix,
232 int (*attach_cb)(int, int, const void *),
233 int (*detach_cb)(int, int, const void *))
235 BIO *curr_channel = NULL;
236 char *curr_prefix = NULL;
237 char *curr_suffix = NULL;
239 /* Ensure do_ossl_trace_init() is called once */
240 if (!RUN_ONCE(&trace_inited, ossl_trace_init))
243 curr_channel = trace_channels[category].bio;
244 curr_prefix = trace_channels[category].prefix;
245 curr_suffix = trace_channels[category].suffix;
247 /* Make sure to run the detach callback first on all data */
248 if (prefix != NULL && curr_prefix != NULL) {
249 detach_cb(category, PREFIX, curr_prefix);
252 if (suffix != NULL && curr_suffix != NULL) {
253 detach_cb(category, SUFFIX, curr_suffix);
256 if (channel != NULL && curr_channel != NULL) {
257 detach_cb(category, CHANNEL, curr_channel);
260 /* After detach callbacks are done, clear data where appropriate */
261 if (prefix != NULL && curr_prefix != NULL) {
262 OPENSSL_free(curr_prefix);
263 trace_channels[category].prefix = NULL;
266 if (suffix != NULL && curr_suffix != NULL) {
267 OPENSSL_free(curr_suffix);
268 trace_channels[category].suffix = NULL;
271 if (channel != NULL && curr_channel != NULL) {
272 BIO_free(curr_channel);
273 trace_channels[category].type = 0;
274 trace_channels[category].bio = NULL;
277 /* Before running callbacks are done, set new data where appropriate */
278 if (channel != NULL && *channel != NULL) {
279 trace_channels[category].type = type;
280 trace_channels[category].bio = *channel;
283 if (prefix != NULL && *prefix != NULL) {
284 if ((curr_prefix = OPENSSL_strdup(*prefix)) == NULL)
286 trace_channels[category].prefix = curr_prefix;
289 if (suffix != NULL && *suffix != NULL) {
290 if ((curr_suffix = OPENSSL_strdup(*suffix)) == NULL)
292 trace_channels[category].suffix = curr_suffix;
295 /* Finally, run the attach callback on the new data */
296 if (channel != NULL && *channel != NULL) {
297 attach_cb(category, CHANNEL, *channel);
300 if (prefix != NULL && *prefix != NULL) {
301 attach_cb(category, PREFIX, *prefix);
304 if (suffix != NULL && *suffix != NULL) {
305 attach_cb(category, SUFFIX, *suffix);
311 static int do_ossl_trace_init(void)
313 trace_lock = CRYPTO_THREAD_lock_new();
314 return trace_lock != NULL;
319 void ossl_trace_cleanup(void)
321 #ifndef OPENSSL_NO_TRACE
324 const char *prefix = NULL;
325 const char *suffix = NULL;
327 for (category = 0; category < OSSL_TRACE_CATEGORY_NUM; category++) {
328 /* We force the TRACE category to be treated last */
329 if (category == OSSL_TRACE_CATEGORY_TRACE)
331 set_trace_data(category, 0, &channel, &prefix, &suffix,
332 trace_attach_cb, trace_detach_cb);
334 set_trace_data(OSSL_TRACE_CATEGORY_TRACE, 0, &channel,
336 trace_attach_cb, trace_detach_cb);
337 CRYPTO_THREAD_lock_free(trace_lock);
341 int OSSL_trace_set_channel(int category, BIO *channel)
343 #ifndef OPENSSL_NO_TRACE
344 if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
345 return set_trace_data(category, SIMPLE_CHANNEL, &channel, NULL, NULL,
346 trace_attach_cb, trace_detach_cb);
351 #ifndef OPENSSL_NO_TRACE
352 static int trace_attach_w_callback_cb(int category, int type, const void *data)
357 "Attach channel %p to category '%s' (with callback)\n",
358 data, trace_categories[category].name);
361 OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
362 (const char *)data, trace_categories[category].name);
365 OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
366 (const char *)data, trace_categories[category].name);
368 default: /* No clue */
375 int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
377 #ifndef OPENSSL_NO_TRACE
379 struct trace_data_st *trace_data = NULL;
381 if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
384 if (callback != NULL) {
385 if ((channel = BIO_new(&trace_method)) == NULL
387 OPENSSL_zalloc(sizeof(struct trace_data_st))) == NULL)
390 trace_data->callback = callback;
391 trace_data->category = category;
392 trace_data->data = data;
394 BIO_set_data(channel, trace_data);
397 if (!set_trace_data(category, CALLBACK_CHANNEL, &channel, NULL, NULL,
398 trace_attach_w_callback_cb, trace_detach_cb))
405 OPENSSL_free(trace_data);
411 int OSSL_trace_set_prefix(int category, const char *prefix)
413 #ifndef OPENSSL_NO_TRACE
414 if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
415 return set_trace_data(category, 0, NULL, &prefix, NULL,
416 trace_attach_cb, trace_detach_cb);
421 int OSSL_trace_set_suffix(int category, const char *suffix)
423 #ifndef OPENSSL_NO_TRACE
424 if (category >= 0 && category < OSSL_TRACE_CATEGORY_NUM)
425 return set_trace_data(category, 0, NULL, NULL, &suffix,
426 trace_attach_cb, trace_detach_cb);
431 #ifndef OPENSSL_NO_TRACE
432 static int ossl_trace_get_category(int category)
434 if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
436 if (trace_channels[category].bio != NULL)
438 return OSSL_TRACE_CATEGORY_ALL;
442 int OSSL_trace_enabled(int category)
445 #ifndef OPENSSL_NO_TRACE
446 category = ossl_trace_get_category(category);
448 ret = trace_channels[category].bio != NULL;
453 BIO *OSSL_trace_begin(int category)
456 #ifndef OPENSSL_NO_TRACE
459 category = ossl_trace_get_category(category);
463 channel = trace_channels[category].bio;
464 prefix = trace_channels[category].prefix;
466 if (channel != NULL) {
467 CRYPTO_THREAD_write_lock(trace_lock);
468 current_channel = channel;
469 switch (trace_channels[category].type) {
471 if (prefix != NULL) {
472 (void)BIO_puts(channel, prefix);
473 (void)BIO_puts(channel, "\n");
476 case CALLBACK_CHANNEL:
477 (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
478 prefix == NULL ? 0 : strlen(prefix), prefix);
486 void OSSL_trace_end(int category, BIO * channel)
488 #ifndef OPENSSL_NO_TRACE
491 category = ossl_trace_get_category(category);
492 suffix = trace_channels[category].suffix;
494 && ossl_assert(channel == current_channel)) {
495 (void)BIO_flush(channel);
496 switch (trace_channels[category].type) {
498 if (suffix != NULL) {
499 (void)BIO_puts(channel, suffix);
500 (void)BIO_puts(channel, "\n");
503 case CALLBACK_CHANNEL:
504 (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
505 suffix == NULL ? 0 : strlen(suffix), suffix);
508 current_channel = NULL;
509 CRYPTO_THREAD_unlock(trace_lock);