1 /* 2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved. 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 10 #ifndef OPENSSL_TRACE_H 11 # define OPENSSL_TRACE_H 12 # pragma once 13 14 # include <stdarg.h> 15 16 # include <openssl/bio.h> 17 18 # ifdef __cplusplus 19 extern "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 * 34 * The ALL category can be used as a fallback category to register a single 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.) 39 */ 40 # define OSSL_TRACE_CATEGORY_ALL 0 /* The fallback */ 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 45 # define OSSL_TRACE_CATEGORY_CONF 5 46 # ifndef OPENSSL_NO_ENGINE 47 # define OSSL_TRACE_CATEGORY_ENGINE_TABLE 6 48 # define OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT 7 49 # endif 50 # define OSSL_TRACE_CATEGORY_PKCS5V2 8 51 # define OSSL_TRACE_CATEGORY_PKCS12_KEYGEN 9 52 # define OSSL_TRACE_CATEGORY_PKCS12_DECRYPT 10 53 # define OSSL_TRACE_CATEGORY_X509V3_POLICY 11 54 # define OSSL_TRACE_CATEGORY_BN_CTX 12 55 # define OSSL_TRACE_CATEGORY_CMP 13 56 # define OSSL_TRACE_CATEGORY_STORE 14 57 # define OSSL_TRACE_CATEGORY_DECODER 15 58 # define OSSL_TRACE_CATEGORY_ENCODER 16 59 # define OSSL_TRACE_CATEGORY_REF_COUNT 17 60 /* Count of available categories. */ 61 # define OSSL_TRACE_CATEGORY_NUM 18 62 63 /* Returns the trace category number for the given |name| */ 64 int OSSL_trace_get_category_num(const char *name); 65 66 /* Returns the trace category name for the given |num| */ 67 const 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 */ 80 int 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 */ 91 int OSSL_trace_set_prefix(int category, const char *prefix); 92 int 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 */ 105 typedef 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 111 # define OSSL_TRACE_CTRL_WRITE 1 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 */ 125 int 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 */ 134 int 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 */ 153 BIO *OSSL_trace_begin(int category); 154 void 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 201 # if !defined OPENSSL_NO_TRACE && !defined FIPS_MODULE 202 203 # define OSSL_TRACE_BEGIN(category) \ 204 do { \ 205 BIO *trc_out = OSSL_trace_begin(OSSL_TRACE_CATEGORY_##category); \ 206 \ 207 if (trc_out != NULL) 208 209 # define OSSL_TRACE_END(category) \ 210 OSSL_trace_end(OSSL_TRACE_CATEGORY_##category, trc_out); \ 211 } while (0) 212 213 # define OSSL_TRACE_CANCEL(category) \ 214 OSSL_trace_end(OSSL_TRACE_CATEGORY_##category, trc_out) \ 215 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 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 */ 240 # if !defined OPENSSL_NO_TRACE && !defined FIPS_MODULE 241 242 # define OSSL_TRACE_ENABLED(category) \ 243 OSSL_trace_enabled(OSSL_TRACE_CATEGORY_##category) 244 245 # else 246 247 # define OSSL_TRACE_ENABLED(category) (0) 248 249 # endif 250 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 273 # if !defined OPENSSL_NO_TRACE && !defined FIPS_MODULE 274 275 # define OSSL_TRACEV(category, args) \ 276 OSSL_TRACE_BEGIN(category) \ 277 BIO_printf args; \ 278 OSSL_TRACE_END(category) 279 280 # else 281 282 # define OSSL_TRACEV(category, args) ((void)0) 283 284 # endif 285 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)) 305 # define OSSL_TRACE9(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) \ 306 OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9)) 307 308 # ifdef __cplusplus 309 } 310 # endif 311 312 #endif 313