2 * Copyright 2019-2022 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 "internal/refcount.h"
20 #include "crypto/cryptlib.h"
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 #ifndef OPENSSL_NO_ENGINE
129 TRACE_CATEGORY_(ENGINE_TABLE
),
130 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 TRACE_CATEGORY_(HTTP
),
143 }; /* KEEP THIS LIST IN SYNC with #define OSSL_TRACE_CATEGORY_... in trace.h */
145 const char *OSSL_trace_get_category_name(int num
)
149 for (i
= 0; i
< OSSL_NELEM(trace_categories
); i
++)
150 if (trace_categories
[i
].num
== num
)
151 return trace_categories
[i
].name
;
152 return NULL
; /* not found */
155 int OSSL_trace_get_category_num(const char *name
)
159 for (i
= 0; i
< OSSL_NELEM(trace_categories
); i
++)
160 if (OPENSSL_strcasecmp(name
, trace_categories
[i
].name
) == 0)
161 return trace_categories
[i
].num
;
162 return -1; /* not found */
165 #ifndef OPENSSL_NO_TRACE
167 /* We use one trace channel for each trace category */
169 enum { SIMPLE_CHANNEL
, CALLBACK_CHANNEL
} type
;
173 } trace_channels
[OSSL_TRACE_CATEGORY_NUM
] = {
174 { 0, NULL
, NULL
, NULL
},
179 #ifndef OPENSSL_NO_TRACE
187 static int trace_attach_cb(int category
, int type
, const void *data
)
191 OSSL_TRACE2(TRACE
, "Attach channel %p to category '%s'\n",
192 data
, trace_categories
[category
].name
);
195 OSSL_TRACE2(TRACE
, "Attach prefix \"%s\" to category '%s'\n",
196 (const char *)data
, trace_categories
[category
].name
);
199 OSSL_TRACE2(TRACE
, "Attach suffix \"%s\" to category '%s'\n",
200 (const char *)data
, trace_categories
[category
].name
);
202 default: /* No clue */
208 static int trace_detach_cb(int category
, int type
, const void *data
)
212 OSSL_TRACE2(TRACE
, "Detach channel %p from category '%s'\n",
213 data
, trace_categories
[category
].name
);
216 OSSL_TRACE2(TRACE
, "Detach prefix \"%s\" from category '%s'\n",
217 (const char *)data
, trace_categories
[category
].name
);
220 OSSL_TRACE2(TRACE
, "Detach suffix \"%s\" from category '%s'\n",
221 (const char *)data
, trace_categories
[category
].name
);
223 default: /* No clue */
229 static int do_ossl_trace_init(void);
230 static CRYPTO_ONCE trace_inited
= CRYPTO_ONCE_STATIC_INIT
;
231 DEFINE_RUN_ONCE_STATIC(ossl_trace_init
)
233 return do_ossl_trace_init();
236 static int set_trace_data(int category
, int type
, BIO
**channel
,
237 const char **prefix
, const char **suffix
,
238 int (*attach_cb
)(int, int, const void *),
239 int (*detach_cb
)(int, int, const void *))
241 BIO
*curr_channel
= NULL
;
242 char *curr_prefix
= NULL
;
243 char *curr_suffix
= NULL
;
245 /* Ensure do_ossl_trace_init() is called once */
246 if (!RUN_ONCE(&trace_inited
, ossl_trace_init
))
249 curr_channel
= trace_channels
[category
].bio
;
250 curr_prefix
= trace_channels
[category
].prefix
;
251 curr_suffix
= trace_channels
[category
].suffix
;
253 /* Make sure to run the detach callback first on all data */
254 if (prefix
!= NULL
&& curr_prefix
!= NULL
) {
255 detach_cb(category
, PREFIX
, curr_prefix
);
258 if (suffix
!= NULL
&& curr_suffix
!= NULL
) {
259 detach_cb(category
, SUFFIX
, curr_suffix
);
262 if (channel
!= NULL
&& curr_channel
!= NULL
) {
263 detach_cb(category
, CHANNEL
, curr_channel
);
266 /* After detach callbacks are done, clear data where appropriate */
267 if (prefix
!= NULL
&& curr_prefix
!= NULL
) {
268 OPENSSL_free(curr_prefix
);
269 trace_channels
[category
].prefix
= NULL
;
272 if (suffix
!= NULL
&& curr_suffix
!= NULL
) {
273 OPENSSL_free(curr_suffix
);
274 trace_channels
[category
].suffix
= NULL
;
277 if (channel
!= NULL
&& curr_channel
!= NULL
) {
278 BIO_free(curr_channel
);
279 trace_channels
[category
].type
= 0;
280 trace_channels
[category
].bio
= NULL
;
283 /* Before running callbacks are done, set new data where appropriate */
284 if (channel
!= NULL
&& *channel
!= NULL
) {
285 trace_channels
[category
].type
= type
;
286 trace_channels
[category
].bio
= *channel
;
289 if (prefix
!= NULL
&& *prefix
!= NULL
) {
290 if ((curr_prefix
= OPENSSL_strdup(*prefix
)) == NULL
)
292 trace_channels
[category
].prefix
= curr_prefix
;
295 if (suffix
!= NULL
&& *suffix
!= NULL
) {
296 if ((curr_suffix
= OPENSSL_strdup(*suffix
)) == NULL
)
298 trace_channels
[category
].suffix
= curr_suffix
;
301 /* Finally, run the attach callback on the new data */
302 if (channel
!= NULL
&& *channel
!= NULL
) {
303 attach_cb(category
, CHANNEL
, *channel
);
306 if (prefix
!= NULL
&& *prefix
!= NULL
) {
307 attach_cb(category
, PREFIX
, *prefix
);
310 if (suffix
!= NULL
&& *suffix
!= NULL
) {
311 attach_cb(category
, SUFFIX
, *suffix
);
317 static int do_ossl_trace_init(void)
319 trace_lock
= CRYPTO_THREAD_lock_new();
320 return trace_lock
!= NULL
;
325 void ossl_trace_cleanup(void)
327 #ifndef OPENSSL_NO_TRACE
330 const char *prefix
= NULL
;
331 const char *suffix
= NULL
;
333 for (category
= 0; category
< OSSL_TRACE_CATEGORY_NUM
; category
++) {
334 /* We force the TRACE category to be treated last */
335 if (category
== OSSL_TRACE_CATEGORY_TRACE
)
337 set_trace_data(category
, 0, &channel
, &prefix
, &suffix
,
338 trace_attach_cb
, trace_detach_cb
);
340 set_trace_data(OSSL_TRACE_CATEGORY_TRACE
, 0, &channel
,
342 trace_attach_cb
, trace_detach_cb
);
343 CRYPTO_THREAD_lock_free(trace_lock
);
347 int OSSL_trace_set_channel(int category
, BIO
*channel
)
349 #ifndef OPENSSL_NO_TRACE
350 if (category
>= 0 && category
< OSSL_TRACE_CATEGORY_NUM
)
351 return set_trace_data(category
, SIMPLE_CHANNEL
, &channel
, NULL
, NULL
,
352 trace_attach_cb
, trace_detach_cb
);
357 #ifndef OPENSSL_NO_TRACE
358 static int trace_attach_w_callback_cb(int category
, int type
, const void *data
)
363 "Attach channel %p to category '%s' (with callback)\n",
364 data
, trace_categories
[category
].name
);
367 OSSL_TRACE2(TRACE
, "Attach prefix \"%s\" to category '%s'\n",
368 (const char *)data
, trace_categories
[category
].name
);
371 OSSL_TRACE2(TRACE
, "Attach suffix \"%s\" to category '%s'\n",
372 (const char *)data
, trace_categories
[category
].name
);
374 default: /* No clue */
381 int OSSL_trace_set_callback(int category
, OSSL_trace_cb callback
, void *data
)
383 #ifndef OPENSSL_NO_TRACE
385 struct trace_data_st
*trace_data
= NULL
;
387 if (category
< 0 || category
>= OSSL_TRACE_CATEGORY_NUM
)
390 if (callback
!= NULL
) {
391 if ((channel
= BIO_new(&trace_method
)) == NULL
393 OPENSSL_zalloc(sizeof(struct trace_data_st
))) == NULL
)
396 trace_data
->callback
= callback
;
397 trace_data
->category
= category
;
398 trace_data
->data
= data
;
400 BIO_set_data(channel
, trace_data
);
403 if (!set_trace_data(category
, CALLBACK_CHANNEL
, &channel
, NULL
, NULL
,
404 trace_attach_w_callback_cb
, trace_detach_cb
))
411 OPENSSL_free(trace_data
);
417 int OSSL_trace_set_prefix(int category
, const char *prefix
)
419 #ifndef OPENSSL_NO_TRACE
420 if (category
>= 0 && category
< OSSL_TRACE_CATEGORY_NUM
)
421 return set_trace_data(category
, 0, NULL
, &prefix
, NULL
,
422 trace_attach_cb
, trace_detach_cb
);
427 int OSSL_trace_set_suffix(int category
, const char *suffix
)
429 #ifndef OPENSSL_NO_TRACE
430 if (category
>= 0 && category
< OSSL_TRACE_CATEGORY_NUM
)
431 return set_trace_data(category
, 0, NULL
, NULL
, &suffix
,
432 trace_attach_cb
, trace_detach_cb
);
437 #ifndef OPENSSL_NO_TRACE
438 static int ossl_trace_get_category(int category
)
440 if (category
< 0 || category
>= OSSL_TRACE_CATEGORY_NUM
)
442 if (trace_channels
[category
].bio
!= NULL
)
444 return OSSL_TRACE_CATEGORY_ALL
;
448 int OSSL_trace_enabled(int category
)
451 #ifndef OPENSSL_NO_TRACE
452 category
= ossl_trace_get_category(category
);
454 ret
= trace_channels
[category
].bio
!= NULL
;
459 BIO
*OSSL_trace_begin(int category
)
462 #ifndef OPENSSL_NO_TRACE
465 category
= ossl_trace_get_category(category
);
469 channel
= trace_channels
[category
].bio
;
470 prefix
= trace_channels
[category
].prefix
;
472 if (channel
!= NULL
) {
473 if (!CRYPTO_THREAD_write_lock(trace_lock
))
475 current_channel
= channel
;
476 switch (trace_channels
[category
].type
) {
478 if (prefix
!= NULL
) {
479 (void)BIO_puts(channel
, prefix
);
480 (void)BIO_puts(channel
, "\n");
483 case CALLBACK_CHANNEL
:
484 (void)BIO_ctrl(channel
, OSSL_TRACE_CTRL_BEGIN
,
485 prefix
== NULL
? 0 : strlen(prefix
), prefix
);
493 void OSSL_trace_end(int category
, BIO
* channel
)
495 #ifndef OPENSSL_NO_TRACE
498 category
= ossl_trace_get_category(category
);
501 suffix
= trace_channels
[category
].suffix
;
503 && ossl_assert(channel
== current_channel
)) {
504 (void)BIO_flush(channel
);
505 switch (trace_channels
[category
].type
) {
507 if (suffix
!= NULL
) {
508 (void)BIO_puts(channel
, suffix
);
509 (void)BIO_puts(channel
, "\n");
512 case CALLBACK_CHANNEL
:
513 (void)BIO_ctrl(channel
, OSSL_TRACE_CTRL_END
,
514 suffix
== NULL
? 0 : strlen(suffix
), suffix
);
517 current_channel
= NULL
;
518 CRYPTO_THREAD_unlock(trace_lock
);