]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/trace.h
Implement a public BIO_ADDR_copy() function
[thirdparty/openssl.git] / include / openssl / trace.h
CommitLineData
2390c573 1/*
da1c088f 2 * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
2390c573
RL
3 *
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
8 */
9
ae4186b0
DMSP
10#ifndef OPENSSL_TRACE_H
11# define OPENSSL_TRACE_H
d59068bd 12# pragma once
2390c573
RL
13
14# include <stdarg.h>
15
16# include <openssl/bio.h>
17
18# ifdef __cplusplus
19extern "C" {
20# endif
21
22/*
23 * TRACE CATEGORIES
24 */
25
26/*
27 * The trace messages of the OpenSSL libraries are organized into different
28 * categories. For every trace category, the application can register a separate
29 * tracer callback. When a callback is registered, a so called trace channel is
30 * created for this category. This channel consists essentially of an internal
31 * BIO which sends all trace output it receives to the registered application
32 * callback.
33 *
3a8269b3 34 * The ALL category can be used as a fallback category to register a single
02bd2d7f
DMSP
35 * channel which receives the output from all categories. However, if the
36 * application intends to print the trace channel name in the line prefix,
37 * it is better to register channels for all categories separately.
38 * (This is how the openssl application does it.)
2390c573 39 */
3a8269b3 40# define OSSL_TRACE_CATEGORY_ALL 0 /* The fallback */
3b9e1a39
RL
41# define OSSL_TRACE_CATEGORY_TRACE 1
42# define OSSL_TRACE_CATEGORY_INIT 2
43# define OSSL_TRACE_CATEGORY_TLS 3
44# define OSSL_TRACE_CATEGORY_TLS_CIPHER 4
bc362b9b 45# define OSSL_TRACE_CATEGORY_CONF 5
78bd646b
TM
46# define OSSL_TRACE_CATEGORY_ENGINE_TABLE 6
47# define OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT 7
3b9e1a39
RL
48# define OSSL_TRACE_CATEGORY_PKCS5V2 8
49# define OSSL_TRACE_CATEGORY_PKCS12_KEYGEN 9
50# define OSSL_TRACE_CATEGORY_PKCS12_DECRYPT 10
51# define OSSL_TRACE_CATEGORY_X509V3_POLICY 11
52# define OSSL_TRACE_CATEGORY_BN_CTX 12
7960dbec 53# define OSSL_TRACE_CATEGORY_CMP 13
2897b009 54# define OSSL_TRACE_CATEGORY_STORE 14
de5008a4 55# define OSSL_TRACE_CATEGORY_DECODER 15
0b9f90f5 56# define OSSL_TRACE_CATEGORY_ENCODER 16
a935791d 57# define OSSL_TRACE_CATEGORY_REF_COUNT 17
e8fdb060 58# define OSSL_TRACE_CATEGORY_HTTP 18
a935791d 59/* Count of available categories. */
e8fdb060
DDO
60# define OSSL_TRACE_CATEGORY_NUM 19
61/* KEEP THIS LIST IN SYNC with trace_categories[] in crypto/trace.c */
2390c573
RL
62
63/* Returns the trace category number for the given |name| */
64int OSSL_trace_get_category_num(const char *name);
65
66/* Returns the trace category name for the given |num| */
67const char *OSSL_trace_get_category_name(int num);
68
69/*
70 * TRACE CONSUMERS
71 */
72
73/*
74 * Enables tracing for the given |category| by providing a BIO sink
75 * as |channel|. If a null pointer is passed as |channel|, an existing
76 * trace channel is removed and tracing for the category is disabled.
77 *
78 * Returns 1 on success and 0 on failure
79 */
80int OSSL_trace_set_channel(int category, BIO* channel);
81
82/*
83 * Attach a prefix and a suffix to the given |category|, to be printed at the
84 * beginning and at the end of each trace output group, i.e. when
85 * OSSL_trace_begin() and OSSL_trace_end() are called.
86 * If a null pointer is passed as argument, the existing prefix or suffix is
87 * removed.
88 *
89 * They return 1 on success and 0 on failure
90 */
91int OSSL_trace_set_prefix(int category, const char *prefix);
92int OSSL_trace_set_suffix(int category, const char *suffix);
93
94/*
95 * OSSL_trace_cb is the type tracing callback provided by the application.
96 * It MUST return the number of bytes written, or 0 on error (in other words,
97 * it can never write zero bytes).
98 *
99 * The |buffer| will always contain text, which may consist of several lines.
100 * The |data| argument points to whatever data was provided by the application
101 * when registering the tracer function.
102 *
103 * The |category| number is given, as well as a |cmd| number, described below.
104 */
105typedef size_t (*OSSL_trace_cb)(const char *buffer, size_t count,
106 int category, int cmd, void *data);
107/*
108 * Possible |cmd| numbers.
109 */
110# define OSSL_TRACE_CTRL_BEGIN 0
13d06925 111# define OSSL_TRACE_CTRL_WRITE 1
2390c573
RL
112# define OSSL_TRACE_CTRL_END 2
113
114/*
115 * Enables tracing for the given |category| by creating an internal
116 * trace channel which sends the output to the given |callback|.
117 * If a null pointer is passed as callback, an existing trace channel
118 * is removed and tracing for the category is disabled.
119 *
120 * NOTE: OSSL_trace_set_channel() and OSSL_trace_set_callback() are mutually
121 * exclusive.
122 *
123 * Returns 1 on success and 0 on failure
124 */
125int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data);
126
127/*
128 * TRACE PRODUCERS
129 */
130
131/*
132 * Returns 1 if tracing for the specified category is enabled, otherwise 0
133 */
134int OSSL_trace_enabled(int category);
135
136/*
137 * Wrap a group of tracing output calls. OSSL_trace_begin() locks tracing and
138 * returns the trace channel associated with the given category, or NULL if no
139 * channel is associated with the category. OSSL_trace_end() unlocks tracing.
140 *
141 * Usage:
142 *
143 * BIO *out;
144 * if ((out = OSSL_trace_begin(category)) != NULL) {
145 * ...
146 * BIO_fprintf(out, ...);
147 * ...
148 * OSSL_trace_end(category, out);
149 * }
150 *
151 * See also the convenience macros OSSL_TRACE_BEGIN and OSSL_TRACE_END below.
152 */
153BIO *OSSL_trace_begin(int category);
154void OSSL_trace_end(int category, BIO *channel);
155
156/*
157 * OSSL_TRACE* Convenience Macros
158 */
159
160/*
161 * When the tracing feature is disabled, these macros are defined to
162 * produce dead code, which a good compiler should eliminate.
163 */
164
165/*
166 * OSSL_TRACE_BEGIN, OSSL_TRACE_END - Define a Trace Group
167 *
168 * These two macros can be used to create a block which is executed only
169 * if the corresponding trace category is enabled. Inside this block, a
170 * local variable named |trc_out| is defined, which points to the channel
171 * associated with the given trace category.
172 *
173 * Usage: (using 'TLS' as an example category)
174 *
175 * OSSL_TRACE_BEGIN(TLS) {
176 *
177 * BIO_fprintf(trc_out, ... );
178 *
179 * } OSSL_TRACE_END(TLS);
180 *
181 *
182 * This expands to the following code
183 *
184 * do {
185 * BIO *trc_out = OSSL_trace_begin(OSSL_TRACE_CATEGORY_TLS);
186 * if (trc_out != NULL) {
187 * ...
188 * BIO_fprintf(trc_out, ...);
189 * }
190 * OSSL_trace_end(OSSL_TRACE_CATEGORY_TLS, trc_out);
191 * } while (0);
192 *
193 * The use of the inner '{...}' group and the trailing ';' is enforced
194 * by the definition of the macros in order to make the code look as much
195 * like C code as possible.
196 *
197 * Before returning from inside the trace block, it is necessary to
198 * call OSSL_TRACE_CANCEL(category).
199 */
200
c29b71c3 201# if !defined OPENSSL_NO_TRACE && !defined FIPS_MODULE
16a9d374
RL
202
203# define OSSL_TRACE_BEGIN(category) \
2390c573
RL
204 do { \
205 BIO *trc_out = OSSL_trace_begin(OSSL_TRACE_CATEGORY_##category); \
206 \
207 if (trc_out != NULL)
208
16a9d374 209# define OSSL_TRACE_END(category) \
2390c573
RL
210 OSSL_trace_end(OSSL_TRACE_CATEGORY_##category, trc_out); \
211 } while (0)
212
16a9d374 213# define OSSL_TRACE_CANCEL(category) \
2390c573
RL
214 OSSL_trace_end(OSSL_TRACE_CATEGORY_##category, trc_out) \
215
16a9d374
RL
216# else
217
218# define OSSL_TRACE_BEGIN(category) \
219 do { \
220 BIO *trc_out = NULL; \
221 if (0)
222
223# define OSSL_TRACE_END(category) \
224 } while(0)
225
226# define OSSL_TRACE_CANCEL(category) \
227 ((void)0)
228
229# endif
230
2390c573
RL
231/*
232 * OSSL_TRACE_ENABLED() - Check whether tracing is enabled for |category|
233 *
234 * Usage:
235 *
236 * if (OSSL_TRACE_ENABLED(TLS)) {
237 * ...
238 * }
239 */
c29b71c3 240# if !defined OPENSSL_NO_TRACE && !defined FIPS_MODULE
2390c573 241
16a9d374 242# define OSSL_TRACE_ENABLED(category) \
2390c573
RL
243 OSSL_trace_enabled(OSSL_TRACE_CATEGORY_##category)
244
16a9d374
RL
245# else
246
247# define OSSL_TRACE_ENABLED(category) (0)
248
249# endif
250
2390c573
RL
251/*
252 * OSSL_TRACE*() - OneShot Trace Macros
253 *
254 * These macros are intended to produce a simple printf-style trace output.
255 * Unfortunately, C90 macros don't support variable arguments, so the
256 * "vararg" OSSL_TRACEV() macro has a rather weird usage pattern:
257 *
258 * OSSL_TRACEV(category, (trc_out, "format string", ...args...));
259 *
260 * Where 'channel' is the literal symbol of this name, not a variable.
261 * For that reason, it is currently not intended to be used directly,
262 * but only as helper macro for the other oneshot trace macros
263 * OSSL_TRACE(), OSSL_TRACE1(), OSSL_TRACE2(), ...
264 *
265 * Usage:
266 *
267 * OSSL_TRACE(INIT, "Hello world!\n");
268 * OSSL_TRACE1(TLS, "The answer is %d\n", 42);
269 * OSSL_TRACE2(TLS, "The ultimate question to answer %d is '%s'\n",
270 * 42, "What do you get when you multiply six by nine?");
271 */
272
454d6927
TM
273# if !defined OPENSSL_NO_TRACE && !defined FIPS_MODULE
274
275# define OSSL_TRACEV(category, args) \
2390c573
RL
276 OSSL_TRACE_BEGIN(category) \
277 BIO_printf args; \
278 OSSL_TRACE_END(category)
279
454d6927
TM
280# else
281
282# define OSSL_TRACEV(category, args) ((void)0)
283
284# endif
285
2390c573
RL
286# define OSSL_TRACE(category, text) \
287 OSSL_TRACEV(category, (trc_out, "%s", text))
288
289# define OSSL_TRACE1(category, format, arg1) \
290 OSSL_TRACEV(category, (trc_out, format, arg1))
291# define OSSL_TRACE2(category, format, arg1, arg2) \
292 OSSL_TRACEV(category, (trc_out, format, arg1, arg2))
293# define OSSL_TRACE3(category, format, arg1, arg2, arg3) \
294 OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3))
295# define OSSL_TRACE4(category, format, arg1, arg2, arg3, arg4) \
296 OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4))
297# define OSSL_TRACE5(category, format, arg1, arg2, arg3, arg4, arg5) \
298 OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5))
299# define OSSL_TRACE6(category, format, arg1, arg2, arg3, arg4, arg5, arg6) \
300 OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6))
301# define OSSL_TRACE7(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7) \
302 OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7))
303# define OSSL_TRACE8(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) \
304 OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8))
4e0383d8 305# define OSSL_TRACE9(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) \
2390c573
RL
306 OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9))
307
0243e821
DDO
308#define OSSL_TRACE_STRING_MAX 80
309int OSSL_trace_string(BIO *out, int text, int full,
310 const unsigned char *data, size_t size);
311#define OSSL_TRACE_STRING(category, text, full, data, len) \
312 OSSL_TRACE_BEGIN(category) { \
313 OSSL_trace_string(trc_out, text, full, data, len); \
314 } OSSL_TRACE_END(category)
315
2390c573
RL
316# ifdef __cplusplus
317}
318# endif
319
320#endif