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_WRITE
,
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_(ALL
),
123 TRACE_CATEGORY_(TRACE
),
124 TRACE_CATEGORY_(INIT
),
125 TRACE_CATEGORY_(TLS
),
126 TRACE_CATEGORY_(TLS_CIPHER
),
127 TRACE_CATEGORY_(CONF
),
128 TRACE_CATEGORY_(ENGINE_TABLE
),
129 TRACE_CATEGORY_(ENGINE_REF_COUNT
),
130 TRACE_CATEGORY_(PKCS5V2
),
131 TRACE_CATEGORY_(PKCS12_KEYGEN
),
132 TRACE_CATEGORY_(PKCS12_DECRYPT
),
133 TRACE_CATEGORY_(X509V3_POLICY
),
134 TRACE_CATEGORY_(BN_CTX
),
135 TRACE_CATEGORY_(PROV
),
136 TRACE_CATEGORY_(FETCH
),
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 set_trace_data(int category
, int type
, BIO
**channel
,
224 const char **prefix
, const char **suffix
,
225 int (*attach_cb
)(int, int, const void *),
226 int (*detach_cb
)(int, int, const void *))
228 BIO
*curr_channel
= NULL
;
229 char *curr_prefix
= NULL
;
230 char *curr_suffix
= NULL
;
232 /* Ensure ossl_trace_init() is called */
233 OPENSSL_init_crypto(0, NULL
);
235 curr_channel
= trace_channels
[category
].bio
;
236 curr_prefix
= trace_channels
[category
].prefix
;
237 curr_suffix
= trace_channels
[category
].suffix
;
239 /* Make sure to run the detach callback first on all data */
240 if (prefix
!= NULL
&& curr_prefix
!= NULL
) {
241 detach_cb(category
, PREFIX
, curr_prefix
);
244 if (suffix
!= NULL
&& curr_suffix
!= NULL
) {
245 detach_cb(category
, SUFFIX
, curr_suffix
);
248 if (channel
!= NULL
&& curr_channel
!= NULL
) {
249 detach_cb(category
, CHANNEL
, curr_channel
);
252 /* After detach callbacks are done, clear data where appropriate */
253 if (prefix
!= NULL
&& curr_prefix
!= NULL
) {
254 OPENSSL_free(curr_prefix
);
255 trace_channels
[category
].prefix
= NULL
;
258 if (suffix
!= NULL
&& curr_suffix
!= NULL
) {
259 OPENSSL_free(curr_suffix
);
260 trace_channels
[category
].suffix
= NULL
;
263 if (channel
!= NULL
&& curr_channel
!= NULL
) {
264 BIO_free(curr_channel
);
265 trace_channels
[category
].type
= 0;
266 trace_channels
[category
].bio
= NULL
;
269 /* Before running callbacks are done, set new data where appropriate */
270 if (channel
!= NULL
&& *channel
!= NULL
) {
271 trace_channels
[category
].type
= type
;
272 trace_channels
[category
].bio
= *channel
;
275 if (prefix
!= NULL
&& *prefix
!= NULL
) {
276 if ((curr_prefix
= OPENSSL_strdup(*prefix
)) == NULL
)
278 trace_channels
[category
].prefix
= curr_prefix
;
281 if (suffix
!= NULL
&& *suffix
!= NULL
) {
282 if ((curr_suffix
= OPENSSL_strdup(*suffix
)) == NULL
)
284 trace_channels
[category
].suffix
= curr_suffix
;
287 /* Finally, run the attach callback on the new data */
288 if (channel
!= NULL
&& *channel
!= NULL
) {
289 attach_cb(category
, CHANNEL
, *channel
);
292 if (prefix
!= NULL
&& *prefix
!= NULL
) {
293 attach_cb(category
, PREFIX
, *prefix
);
296 if (suffix
!= NULL
&& *suffix
!= NULL
) {
297 attach_cb(category
, SUFFIX
, *suffix
);
304 int ossl_trace_init(void)
306 #ifndef OPENSSL_NO_TRACE
307 trace_lock
= CRYPTO_THREAD_lock_new();
308 if (trace_lock
== NULL
)
315 void ossl_trace_cleanup(void)
317 #ifndef OPENSSL_NO_TRACE
320 const char *prefix
= NULL
;
321 const char *suffix
= NULL
;
323 for (category
= 0; category
< OSSL_TRACE_CATEGORY_NUM
; category
++) {
324 /* We force the TRACE category to be treated last */
325 if (category
== OSSL_TRACE_CATEGORY_TRACE
)
327 set_trace_data(category
, 0, &channel
, &prefix
, &suffix
,
328 trace_attach_cb
, trace_detach_cb
);
330 set_trace_data(OSSL_TRACE_CATEGORY_TRACE
, 0, &channel
,
332 trace_attach_cb
, trace_detach_cb
);
333 CRYPTO_THREAD_lock_free(trace_lock
);
337 int OSSL_trace_set_channel(int category
, BIO
*channel
)
339 #ifndef OPENSSL_NO_TRACE
340 if (category
>= 0 && category
< OSSL_TRACE_CATEGORY_NUM
)
341 return set_trace_data(category
, SIMPLE_CHANNEL
, &channel
, NULL
, NULL
,
342 trace_attach_cb
, trace_detach_cb
);
347 #ifndef OPENSSL_NO_TRACE
348 static int trace_attach_w_callback_cb(int category
, int type
, const void *data
)
353 "Attach channel %p to category '%s' (with callback)\n",
354 data
, trace_categories
[category
].name
);
357 OSSL_TRACE2(TRACE
, "Attach prefix \"%s\" to category '%s'\n",
358 (const char *)data
, trace_categories
[category
].name
);
361 OSSL_TRACE2(TRACE
, "Attach suffix \"%s\" to category '%s'\n",
362 (const char *)data
, trace_categories
[category
].name
);
364 default: /* No clue */
371 int OSSL_trace_set_callback(int category
, OSSL_trace_cb callback
, void *data
)
373 #ifndef OPENSSL_NO_TRACE
375 struct trace_data_st
*trace_data
= NULL
;
377 if (category
< 0 || category
>= OSSL_TRACE_CATEGORY_NUM
)
380 if (callback
!= NULL
) {
381 if ((channel
= BIO_new(&trace_method
)) == NULL
383 OPENSSL_zalloc(sizeof(struct trace_data_st
))) == NULL
)
386 trace_data
->callback
= callback
;
387 trace_data
->category
= category
;
388 trace_data
->data
= data
;
390 BIO_set_data(channel
, trace_data
);
393 if (!set_trace_data(category
, CALLBACK_CHANNEL
, &channel
, NULL
, NULL
,
394 trace_attach_w_callback_cb
, trace_detach_cb
))
401 OPENSSL_free(trace_data
);
407 int OSSL_trace_set_prefix(int category
, const char *prefix
)
409 #ifndef OPENSSL_NO_TRACE
410 if (category
>= 0 && category
< OSSL_TRACE_CATEGORY_NUM
)
411 return set_trace_data(category
, 0, NULL
, &prefix
, NULL
,
412 trace_attach_cb
, trace_detach_cb
);
417 int OSSL_trace_set_suffix(int category
, const char *suffix
)
419 #ifndef OPENSSL_NO_TRACE
420 if (category
>= 0 && category
< OSSL_TRACE_CATEGORY_NUM
)
421 return set_trace_data(category
, 0, NULL
, NULL
, &suffix
,
422 trace_attach_cb
, trace_detach_cb
);
427 #ifndef OPENSSL_NO_TRACE
428 static int ossl_trace_get_category(int category
)
430 if (category
< 0 || category
>= OSSL_TRACE_CATEGORY_NUM
)
432 if (trace_channels
[category
].bio
!= NULL
)
434 return OSSL_TRACE_CATEGORY_ALL
;
438 int OSSL_trace_enabled(int category
)
441 #ifndef OPENSSL_NO_TRACE
442 category
= ossl_trace_get_category(category
);
444 ret
= trace_channels
[category
].bio
!= NULL
;
449 BIO
*OSSL_trace_begin(int category
)
452 #ifndef OPENSSL_NO_TRACE
455 category
= ossl_trace_get_category(category
);
459 channel
= trace_channels
[category
].bio
;
460 prefix
= trace_channels
[category
].prefix
;
462 if (channel
!= NULL
) {
463 CRYPTO_THREAD_write_lock(trace_lock
);
464 current_channel
= channel
;
465 switch (trace_channels
[category
].type
) {
467 if (prefix
!= NULL
) {
468 (void)BIO_puts(channel
, prefix
);
469 (void)BIO_puts(channel
, "\n");
472 case CALLBACK_CHANNEL
:
473 (void)BIO_ctrl(channel
, OSSL_TRACE_CTRL_BEGIN
,
474 prefix
== NULL
? 0 : strlen(prefix
), prefix
);
482 void OSSL_trace_end(int category
, BIO
* channel
)
484 #ifndef OPENSSL_NO_TRACE
487 category
= ossl_trace_get_category(category
);
488 suffix
= trace_channels
[category
].suffix
;
490 && ossl_assert(channel
== current_channel
)) {
491 (void)BIO_flush(channel
);
492 switch (trace_channels
[category
].type
) {
494 if (suffix
!= NULL
) {
495 (void)BIO_puts(channel
, suffix
);
496 (void)BIO_puts(channel
, "\n");
499 case CALLBACK_CHANNEL
:
500 (void)BIO_ctrl(channel
, OSSL_TRACE_CTRL_END
,
501 suffix
== NULL
? 0 : strlen(suffix
), suffix
);
504 current_channel
= NULL
;
505 CRYPTO_THREAD_unlock(trace_lock
);