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 <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"
20 #include "e_os.h" /* strcasecmp for Windows */
22 #ifndef OPENSSL_NO_TRACE
24 static CRYPTO_RWLOCK *trace_lock = NULL;
26 static const BIO *current_channel = NULL;
29 * INTERNAL TRACE CHANNEL IMPLEMENTATION
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
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);
43 static const BIO_METHOD trace_method = {
52 trace_ctrl, /* ctrl */
54 trace_free, /* free */
55 NULL, /* callback_ctrl */
58 struct trace_data_st {
59 OSSL_trace_cb callback;
64 static int trace_write(BIO *channel,
65 const char *buf, size_t num, size_t *written)
67 struct trace_data_st *ctx = BIO_get_data(channel);
68 size_t cnt = ctx->callback(buf, num, ctx->category, OSSL_TRACE_CTRL_DURING,
75 static int trace_puts(BIO *channel, const char *str)
79 if (trace_write(channel, str, strlen(str), &written))
85 static long trace_ctrl(BIO *channel, int cmd, long argl, void *argp)
87 struct trace_data_st *ctx = BIO_get_data(channel);
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);
98 return -2; /* Unsupported */
101 static int trace_free(BIO *channel)
105 OPENSSL_free(BIO_get_data(channel));
114 /* Helper struct and macro to get name string to number mapping */
115 struct trace_category_st {
116 const char * const name;
119 #define TRACE_CATEGORY_(name) { #name, OSSL_TRACE_CATEGORY_##name }
121 static const struct trace_category_st trace_categories[] = {
122 TRACE_CATEGORY_(ANY),
123 TRACE_CATEGORY_(INIT),
124 TRACE_CATEGORY_(TLS),
125 TRACE_CATEGORY_(TLS_CIPHER),
126 TRACE_CATEGORY_(ENGINE_CONF),
127 TRACE_CATEGORY_(ENGINE_TABLE),
128 TRACE_CATEGORY_(ENGINE_REF_COUNT),
129 TRACE_CATEGORY_(PKCS5V2),
130 TRACE_CATEGORY_(PKCS12_KEYGEN),
131 TRACE_CATEGORY_(X509V3_POLICY),
134 const char *OSSL_trace_get_category_name(int num)
138 for (i = 0; i < OSSL_NELEM(trace_categories); i++)
139 if (trace_categories[i].num == num)
140 return trace_categories[i].name;
141 return NULL; /* not found */
144 int OSSL_trace_get_category_num(const char *name)
148 for (i = 0; i < OSSL_NELEM(trace_categories); i++)
149 if (strcasecmp(name, trace_categories[i].name) == 0)
150 return trace_categories[i].num;
151 return -1; /* not found */
154 #ifndef OPENSSL_NO_TRACE
156 /* We use one trace channel for each trace category */
158 enum { t_channel, t_callback } type;
162 } trace_channels[OSSL_TRACE_CATEGORY_NUM] = {
163 { 0, NULL, NULL, NULL },
168 int ossl_trace_init(void)
170 #ifndef OPENSSL_NO_TRACE
171 trace_lock = CRYPTO_THREAD_lock_new();
172 if (trace_lock != NULL)
179 void ossl_trace_cleanup(void)
181 #ifndef OPENSSL_NO_TRACE
184 for (category = 0; category < OSSL_TRACE_CATEGORY_NUM; category++)
185 OSSL_trace_set_channel(category, NULL);
186 CRYPTO_THREAD_lock_free(trace_lock);
190 int OSSL_trace_set_channel(int category, BIO *channel)
192 #ifndef OPENSSL_NO_TRACE
195 if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
198 prev_channel = trace_channels[category].bio;
200 if (prev_channel != NULL) {
201 BIO_free(prev_channel);
202 trace_channels[category].bio = NULL;
208 trace_channels[category].bio = channel;
209 trace_channels[category].type = t_channel;
219 int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
221 #ifndef OPENSSL_NO_TRACE
222 BIO *channel = trace_channels[category].bio;
223 struct trace_data_st *trace_data = NULL;
225 if (channel != NULL) {
227 trace_channels[category].bio = NULL;
230 if (callback == NULL)
233 channel = BIO_new(&trace_method);
237 trace_data = OPENSSL_zalloc(sizeof(struct trace_data_st));
238 if (trace_data == NULL)
241 trace_data->callback = callback;
242 trace_data->category = category;
243 trace_data->data = data;
245 BIO_set_data(channel, trace_data);
247 trace_channels[category].bio = channel;
248 trace_channels[category].type = t_callback;
254 OPENSSL_free(trace_data);
260 int OSSL_trace_set_prefix(int category, const char *prefix)
262 #ifndef OPENSSL_NO_TRACE
263 char *curr_prefix = trace_channels[category].prefix;
265 if (curr_prefix != NULL) {
266 OPENSSL_free(curr_prefix);
267 trace_channels[category].prefix = NULL;
273 curr_prefix = OPENSSL_strdup(prefix);
274 if (curr_prefix == NULL)
277 trace_channels[category].prefix = curr_prefix;
287 int OSSL_trace_set_suffix(int category, const char *suffix)
289 #ifndef OPENSSL_NO_TRACE
290 char *curr_suffix = trace_channels[category].suffix;
292 if (curr_suffix != NULL) {
293 OPENSSL_free(curr_suffix);
294 trace_channels[category].suffix = NULL;
300 curr_suffix = OPENSSL_strdup(suffix);
301 if (curr_suffix == NULL)
304 trace_channels[category].suffix = curr_suffix;
314 #ifndef OPENSSL_NO_TRACE
315 static int ossl_trace_get_category(int category)
317 if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
319 if (trace_channels[category].bio != NULL)
321 return OSSL_TRACE_CATEGORY_ANY;
325 int OSSL_trace_enabled(int category)
328 #ifndef OPENSSL_NO_TRACE
329 category = ossl_trace_get_category(category);
330 ret = trace_channels[category].bio != NULL;
335 BIO *OSSL_trace_begin(int category)
338 #ifndef OPENSSL_NO_TRACE
341 category = ossl_trace_get_category(category);
342 channel = trace_channels[category].bio;
343 prefix = trace_channels[category].prefix;
345 if (channel != NULL) {
346 CRYPTO_THREAD_write_lock(trace_lock);
347 current_channel = channel;
348 switch (trace_channels[category].type) {
350 if (prefix != NULL) {
351 (void)BIO_puts(channel, prefix);
352 (void)BIO_puts(channel, "\n");
356 (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
357 prefix == NULL ? 0 : strlen(prefix), prefix);
365 void OSSL_trace_end(int category, BIO * channel)
367 #ifndef OPENSSL_NO_TRACE
370 category = ossl_trace_get_category(category);
371 suffix = trace_channels[category].suffix;
373 && ossl_assert(channel == current_channel)) {
374 (void)BIO_flush(channel);
375 switch (trace_channels[category].type) {
377 if (suffix != NULL) {
378 (void)BIO_puts(channel, suffix);
379 (void)BIO_puts(channel, "\n");
383 (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
384 suffix == NULL ? 0 : strlen(suffix), suffix);
387 current_channel = NULL;
388 CRYPTO_THREAD_unlock(trace_lock);