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_(PKCS12_DECRYPT
),
132 TRACE_CATEGORY_(X509V3_POLICY
),
133 TRACE_CATEGORY_(BN_CTX
),
136 const char *OSSL_trace_get_category_name(int num
)
140 for (i
= 0; i
< OSSL_NELEM(trace_categories
); i
++)
141 if (trace_categories
[i
].num
== num
)
142 return trace_categories
[i
].name
;
143 return NULL
; /* not found */
146 int OSSL_trace_get_category_num(const char *name
)
150 for (i
= 0; i
< OSSL_NELEM(trace_categories
); i
++)
151 if (strcasecmp(name
, trace_categories
[i
].name
) == 0)
152 return trace_categories
[i
].num
;
153 return -1; /* not found */
156 #ifndef OPENSSL_NO_TRACE
158 /* We use one trace channel for each trace category */
160 enum { t_channel
, t_callback
} type
;
164 } trace_channels
[OSSL_TRACE_CATEGORY_NUM
] = {
165 { 0, NULL
, NULL
, NULL
},
170 int ossl_trace_init(void)
172 #ifndef OPENSSL_NO_TRACE
173 trace_lock
= CRYPTO_THREAD_lock_new();
174 if (trace_lock
!= NULL
)
181 void ossl_trace_cleanup(void)
183 #ifndef OPENSSL_NO_TRACE
186 for (category
= 0; category
< OSSL_TRACE_CATEGORY_NUM
; category
++)
187 OSSL_trace_set_channel(category
, NULL
);
188 CRYPTO_THREAD_lock_free(trace_lock
);
192 int OSSL_trace_set_channel(int category
, BIO
*channel
)
194 #ifndef OPENSSL_NO_TRACE
197 if (category
< 0 || category
>= OSSL_TRACE_CATEGORY_NUM
)
200 prev_channel
= trace_channels
[category
].bio
;
202 if (prev_channel
!= NULL
) {
203 BIO_free(prev_channel
);
204 trace_channels
[category
].bio
= NULL
;
210 trace_channels
[category
].bio
= channel
;
211 trace_channels
[category
].type
= t_channel
;
221 int OSSL_trace_set_callback(int category
, OSSL_trace_cb callback
, void *data
)
223 #ifndef OPENSSL_NO_TRACE
224 BIO
*channel
= trace_channels
[category
].bio
;
225 struct trace_data_st
*trace_data
= NULL
;
227 if (channel
!= NULL
) {
229 trace_channels
[category
].bio
= NULL
;
232 if (callback
== NULL
)
235 channel
= BIO_new(&trace_method
);
239 trace_data
= OPENSSL_zalloc(sizeof(struct trace_data_st
));
240 if (trace_data
== NULL
)
243 trace_data
->callback
= callback
;
244 trace_data
->category
= category
;
245 trace_data
->data
= data
;
247 BIO_set_data(channel
, trace_data
);
249 trace_channels
[category
].bio
= channel
;
250 trace_channels
[category
].type
= t_callback
;
256 OPENSSL_free(trace_data
);
262 int OSSL_trace_set_prefix(int category
, const char *prefix
)
264 #ifndef OPENSSL_NO_TRACE
265 char *curr_prefix
= trace_channels
[category
].prefix
;
267 if (curr_prefix
!= NULL
) {
268 OPENSSL_free(curr_prefix
);
269 trace_channels
[category
].prefix
= NULL
;
275 curr_prefix
= OPENSSL_strdup(prefix
);
276 if (curr_prefix
== NULL
)
279 trace_channels
[category
].prefix
= curr_prefix
;
289 int OSSL_trace_set_suffix(int category
, const char *suffix
)
291 #ifndef OPENSSL_NO_TRACE
292 char *curr_suffix
= trace_channels
[category
].suffix
;
294 if (curr_suffix
!= NULL
) {
295 OPENSSL_free(curr_suffix
);
296 trace_channels
[category
].suffix
= NULL
;
302 curr_suffix
= OPENSSL_strdup(suffix
);
303 if (curr_suffix
== NULL
)
306 trace_channels
[category
].suffix
= curr_suffix
;
316 #ifndef OPENSSL_NO_TRACE
317 static int ossl_trace_get_category(int category
)
319 if (category
< 0 || category
>= OSSL_TRACE_CATEGORY_NUM
)
321 if (trace_channels
[category
].bio
!= NULL
)
323 return OSSL_TRACE_CATEGORY_ANY
;
327 int OSSL_trace_enabled(int category
)
330 #ifndef OPENSSL_NO_TRACE
331 category
= ossl_trace_get_category(category
);
332 ret
= trace_channels
[category
].bio
!= NULL
;
337 BIO
*OSSL_trace_begin(int category
)
340 #ifndef OPENSSL_NO_TRACE
343 category
= ossl_trace_get_category(category
);
344 channel
= trace_channels
[category
].bio
;
345 prefix
= trace_channels
[category
].prefix
;
347 if (channel
!= NULL
) {
348 CRYPTO_THREAD_write_lock(trace_lock
);
349 current_channel
= channel
;
350 switch (trace_channels
[category
].type
) {
352 if (prefix
!= NULL
) {
353 (void)BIO_puts(channel
, prefix
);
354 (void)BIO_puts(channel
, "\n");
358 (void)BIO_ctrl(channel
, OSSL_TRACE_CTRL_BEGIN
,
359 prefix
== NULL
? 0 : strlen(prefix
), prefix
);
367 void OSSL_trace_end(int category
, BIO
* channel
)
369 #ifndef OPENSSL_NO_TRACE
372 category
= ossl_trace_get_category(category
);
373 suffix
= trace_channels
[category
].suffix
;
375 && ossl_assert(channel
== current_channel
)) {
376 (void)BIO_flush(channel
);
377 switch (trace_channels
[category
].type
) {
379 if (suffix
!= NULL
) {
380 (void)BIO_puts(channel
, suffix
);
381 (void)BIO_puts(channel
, "\n");
385 (void)BIO_ctrl(channel
, OSSL_TRACE_CTRL_END
,
386 suffix
== NULL
? 0 : strlen(suffix
), suffix
);
389 current_channel
= NULL
;
390 CRYPTO_THREAD_unlock(trace_lock
);