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
),
129 const char *OSSL_trace_get_category_name(int num
)
133 for (i
= 0; i
< OSSL_NELEM(trace_categories
); i
++)
134 if (trace_categories
[i
].num
== num
)
135 return trace_categories
[i
].name
;
136 return NULL
; /* not found */
139 int OSSL_trace_get_category_num(const char *name
)
143 for (i
= 0; i
< OSSL_NELEM(trace_categories
); i
++)
144 if (strcasecmp(name
, trace_categories
[i
].name
) == 0)
145 return trace_categories
[i
].num
;
146 return -1; /* not found */
149 #ifndef OPENSSL_NO_TRACE
151 /* We use one trace channel for each trace category */
153 enum { t_channel
, t_callback
} type
;
157 } trace_channels
[OSSL_TRACE_CATEGORY_NUM
] = {
158 { 0, NULL
, NULL
, NULL
},
163 int ossl_trace_init(void)
165 #ifndef OPENSSL_NO_TRACE
166 trace_lock
= CRYPTO_THREAD_lock_new();
167 if (trace_lock
!= NULL
)
174 void ossl_trace_cleanup(void)
176 #ifndef OPENSSL_NO_TRACE
179 for (category
= 0; category
< OSSL_TRACE_CATEGORY_NUM
; category
++)
180 OSSL_trace_set_channel(category
, NULL
);
181 CRYPTO_THREAD_lock_free(trace_lock
);
185 int OSSL_trace_set_channel(int category
, BIO
*channel
)
187 #ifndef OPENSSL_NO_TRACE
190 if (category
< 0 || category
>= OSSL_TRACE_CATEGORY_NUM
)
193 prev_channel
= trace_channels
[category
].bio
;
195 if (prev_channel
!= NULL
) {
196 BIO_free(prev_channel
);
197 trace_channels
[category
].bio
= NULL
;
203 trace_channels
[category
].bio
= channel
;
204 trace_channels
[category
].type
= t_channel
;
214 int OSSL_trace_set_callback(int category
, OSSL_trace_cb callback
, void *data
)
216 #ifndef OPENSSL_NO_TRACE
217 BIO
*channel
= trace_channels
[category
].bio
;
218 struct trace_data_st
*trace_data
= NULL
;
220 if (channel
!= NULL
) {
222 trace_channels
[category
].bio
= NULL
;
225 if (callback
== NULL
)
228 channel
= BIO_new(&trace_method
);
232 trace_data
= OPENSSL_zalloc(sizeof(struct trace_data_st
));
233 if (trace_data
== NULL
)
236 trace_data
->callback
= callback
;
237 trace_data
->category
= category
;
238 trace_data
->data
= data
;
240 BIO_set_data(channel
, trace_data
);
242 trace_channels
[category
].bio
= channel
;
243 trace_channels
[category
].type
= t_callback
;
249 OPENSSL_free(trace_data
);
255 int OSSL_trace_set_prefix(int category
, const char *prefix
)
257 #ifndef OPENSSL_NO_TRACE
258 char *curr_prefix
= trace_channels
[category
].prefix
;
260 if (curr_prefix
!= NULL
) {
261 OPENSSL_free(curr_prefix
);
262 trace_channels
[category
].prefix
= NULL
;
268 curr_prefix
= OPENSSL_strdup(prefix
);
269 if (curr_prefix
== NULL
)
272 trace_channels
[category
].prefix
= curr_prefix
;
282 int OSSL_trace_set_suffix(int category
, const char *suffix
)
284 #ifndef OPENSSL_NO_TRACE
285 char *curr_suffix
= trace_channels
[category
].suffix
;
287 if (curr_suffix
!= NULL
) {
288 OPENSSL_free(curr_suffix
);
289 trace_channels
[category
].suffix
= NULL
;
295 curr_suffix
= OPENSSL_strdup(suffix
);
296 if (curr_suffix
== NULL
)
299 trace_channels
[category
].suffix
= curr_suffix
;
309 #ifndef OPENSSL_NO_TRACE
310 static int ossl_trace_get_category(int category
)
312 if (category
< 0 || category
>= OSSL_TRACE_CATEGORY_NUM
)
314 if (trace_channels
[category
].bio
!= NULL
)
316 return OSSL_TRACE_CATEGORY_ANY
;
320 int OSSL_trace_enabled(int category
)
323 #ifndef OPENSSL_NO_TRACE
324 category
= ossl_trace_get_category(category
);
325 ret
= trace_channels
[category
].bio
!= NULL
;
330 BIO
*OSSL_trace_begin(int category
)
333 #ifndef OPENSSL_NO_TRACE
336 category
= ossl_trace_get_category(category
);
337 channel
= trace_channels
[category
].bio
;
338 prefix
= trace_channels
[category
].prefix
;
340 if (channel
!= NULL
) {
341 CRYPTO_THREAD_write_lock(trace_lock
);
342 current_channel
= channel
;
343 switch (trace_channels
[category
].type
) {
345 if (prefix
!= NULL
) {
346 (void)BIO_puts(channel
, prefix
);
347 (void)BIO_puts(channel
, "\n");
351 (void)BIO_ctrl(channel
, OSSL_TRACE_CTRL_BEGIN
,
352 prefix
== NULL
? 0 : strlen(prefix
), prefix
);
360 void OSSL_trace_end(int category
, BIO
* channel
)
362 #ifndef OPENSSL_NO_TRACE
365 category
= ossl_trace_get_category(category
);
366 suffix
= trace_channels
[category
].suffix
;
368 && ossl_assert(channel
== current_channel
)) {
369 (void)BIO_flush(channel
);
370 switch (trace_channels
[category
].type
) {
372 if (suffix
!= NULL
) {
373 (void)BIO_puts(channel
, suffix
);
374 (void)BIO_puts(channel
, "\n");
378 (void)BIO_ctrl(channel
, OSSL_TRACE_CTRL_END
,
379 suffix
== NULL
? 0 : strlen(suffix
), suffix
);
382 current_channel
= NULL
;
383 CRYPTO_THREAD_unlock(trace_lock
);