crypto/trace.c

   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 #include <stdio.h>
  11 #include <string.h>
  12
  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"
  21
  22 #include "e_os.h"                /* strcasecmp for Windows */
  23
  24 #ifndef OPENSSL_NO_TRACE
  25
  26 static CRYPTO_RWLOCK *trace_lock = NULL;
  27
  28 static const BIO  *current_channel = NULL;
  29
  30 /*-
  31  * INTERNAL TRACE CHANNEL IMPLEMENTATION
  32  *
  33  * For our own flexibility, all trace categories are associated with a
  34  * BIO sink object, also called the trace channel. Instead of a BIO object,
  35  * the application can also provide a callback function, in which case an
  36  * internal trace channel is attached, which simply calls the registered
  37  * callback function.
  38  */
  39 static int trace_write(BIO *b, const char *buf,
  40                                size_t num, size_t *written);
  41 static int trace_puts(BIO *b, const char *str);
  42 static long trace_ctrl(BIO *channel, int cmd, long argl, void *argp);
  43 static int trace_free(BIO *b);
  44
  45 static const BIO_METHOD trace_method = {
  46     BIO_TYPE_SOURCE_SINK,
  47     "trace",
  48     trace_write,
  49     NULL,                        /* old write */
  50     NULL,                        /* read_ex */
  51     NULL,                        /* read */
  52     trace_puts,
  53     NULL,                        /* gets */
  54     trace_ctrl,                  /* ctrl */
  55     NULL,                        /* create */
  56     trace_free,                  /* free */
  57     NULL,                        /* callback_ctrl */
  58 };
  59
  60 struct trace_data_st {
  61     OSSL_trace_cb callback;
  62     int category;
  63     void *data;
  64 };
  65
  66 static int trace_write(BIO *channel,
  67                        const char *buf, size_t num, size_t *written)
  68 {
  69     struct trace_data_st *ctx = BIO_get_data(channel);
  70     size_t cnt = ctx->callback(buf, num, ctx->category, OSSL_TRACE_CTRL_WRITE,
  71                                ctx->data);
  72
  73     *written = cnt;
  74     return cnt != 0;
  75 }
  76
  77 static int trace_puts(BIO *channel, const char *str)
  78 {
  79     size_t written;
  80
  81     if (trace_write(channel, str, strlen(str), &written))
  82         return (int)written;
  83
  84     return EOF;
  85 }
  86
  87 static long trace_ctrl(BIO *channel, int cmd, long argl, void *argp)
  88 {
  89     struct trace_data_st *ctx = BIO_get_data(channel);
  90
  91     switch (cmd) {
  92     case OSSL_TRACE_CTRL_BEGIN:
  93     case OSSL_TRACE_CTRL_END:
  94         /* We know that the callback is likely to return 0 here */
  95         ctx->callback("", 0, ctx->category, cmd, ctx->data);
  96         return 1;
  97     default:
  98         break;
  99     }
 100     return -2;                   /* Unsupported */
 101 }
 102
 103 static int trace_free(BIO *channel)
 104 {
 105     if (channel == NULL)
 106         return 0;
 107     OPENSSL_free(BIO_get_data(channel));
 108     return 1;
 109 }
 110 #endif
 111
 112 /*-
 113  * TRACE
 114  */
 115
 116 /* Helper struct and macro to get name string to number mapping */
 117 struct trace_category_st {
 118     const char * const name;
 119     const int num;
 120 };
 121 #define TRACE_CATEGORY_(name)       { #name, OSSL_TRACE_CATEGORY_##name }
 122
 123 static const struct trace_category_st trace_categories[] = {
 124     TRACE_CATEGORY_(ALL),
 125     TRACE_CATEGORY_(TRACE),
 126     TRACE_CATEGORY_(INIT),
 127     TRACE_CATEGORY_(TLS),
 128     TRACE_CATEGORY_(TLS_CIPHER),
 129     TRACE_CATEGORY_(CONF),
 130 #ifndef OPENSSL_NO_ENGINE
 131     TRACE_CATEGORY_(ENGINE_TABLE),
 132     TRACE_CATEGORY_(ENGINE_REF_COUNT),
 133 #endif
 134     TRACE_CATEGORY_(PKCS5V2),
 135     TRACE_CATEGORY_(PKCS12_KEYGEN),
 136     TRACE_CATEGORY_(PKCS12_DECRYPT),
 137     TRACE_CATEGORY_(X509V3_POLICY),
 138     TRACE_CATEGORY_(BN_CTX),
 139     TRACE_CATEGORY_(STORE),
 140     TRACE_CATEGORY_(DECODER),
 141     TRACE_CATEGORY_(ENCODER),
 142     TRACE_CATEGORY_(REF_COUNT)
 143 };
 144
 145 const char *OSSL_trace_get_category_name(int num)
 146 {
 147     size_t i;
 148
 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 */
 153 }
 154
 155 int OSSL_trace_get_category_num(const char *name)
 156 {
 157     size_t i;
 158
 159     for (i = 0; i < OSSL_NELEM(trace_categories); i++)
 160         if (strcasecmp(name, trace_categories[i].name) == 0)
 161             return trace_categories[i].num;
 162     return -1; /* not found */
 163 }
 164
 165 #ifndef OPENSSL_NO_TRACE
 166
 167 /* We use one trace channel for each trace category */
 168 static struct {
 169     enum { SIMPLE_CHANNEL, CALLBACK_CHANNEL } type;
 170     BIO *bio;
 171     char *prefix;
 172     char *suffix;
 173 } trace_channels[OSSL_TRACE_CATEGORY_NUM] = {
 174     { 0, NULL, NULL, NULL },
 175 };
 176
 177 #endif
 178
 179 #ifndef OPENSSL_NO_TRACE
 180
 181 enum {
 182     CHANNEL,
 183     PREFIX,
 184     SUFFIX
 185 };
 186
 187 static int trace_attach_cb(int category, int type, const void *data)
 188 {
 189     switch (type) {
 190     case CHANNEL:
 191         OSSL_TRACE2(TRACE, "Attach channel %p to category '%s'\n",
 192                     data, trace_categories[category].name);
 193         break;
 194     case PREFIX:
 195         OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
 196                     (const char *)data, trace_categories[category].name);
 197         break;
 198     case SUFFIX:
 199         OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
 200                     (const char *)data, trace_categories[category].name);
 201         break;
 202     default:                     /* No clue */
 203         break;
 204     }
 205     return 1;
 206 }
 207
 208 static int trace_detach_cb(int category, int type, const void *data)
 209 {
 210     switch (type) {
 211     case CHANNEL:
 212         OSSL_TRACE2(TRACE, "Detach channel %p from category '%s'\n",
 213                     data, trace_categories[category].name);
 214         break;
 215     case PREFIX:
 216         OSSL_TRACE2(TRACE, "Detach prefix \"%s\" from category '%s'\n",
 217                     (const char *)data, trace_categories[category].name);
 218         break;
 219     case SUFFIX:
 220         OSSL_TRACE2(TRACE, "Detach suffix \"%s\" from category '%s'\n",
 221                     (const char *)data, trace_categories[category].name);
 222         break;
 223     default:                     /* No clue */
 224         break;
 225     }
 226     return 1;
 227 }
 228
 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)
 232 {
 233     return do_ossl_trace_init();
 234 }
 235
 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 *))
 240 {
 241     BIO *curr_channel = NULL;
 242     char *curr_prefix = NULL;
 243     char *curr_suffix = NULL;
 244
 245     /* Ensure do_ossl_trace_init() is called once */
 246     if (!RUN_ONCE(&trace_inited, ossl_trace_init))
 247         return 0;
 248
 249     curr_channel = trace_channels[category].bio;
 250     curr_prefix = trace_channels[category].prefix;
 251     curr_suffix = trace_channels[category].suffix;
 252
 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);
 256     }
 257
 258     if (suffix != NULL && curr_suffix != NULL) {
 259         detach_cb(category, SUFFIX, curr_suffix);
 260     }
 261
 262     if (channel != NULL && curr_channel != NULL) {
 263         detach_cb(category, CHANNEL, curr_channel);
 264     }
 265
 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;
 270     }
 271
 272     if (suffix != NULL && curr_suffix != NULL) {
 273         OPENSSL_free(curr_suffix);
 274         trace_channels[category].suffix = NULL;
 275     }
 276
 277     if (channel != NULL && curr_channel != NULL) {
 278         BIO_free(curr_channel);
 279         trace_channels[category].type = 0;
 280         trace_channels[category].bio = NULL;
 281     }
 282
 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;
 287     }
 288
 289     if (prefix != NULL && *prefix != NULL) {
 290         if ((curr_prefix = OPENSSL_strdup(*prefix)) == NULL)
 291             return 0;
 292         trace_channels[category].prefix = curr_prefix;
 293     }
 294
 295     if (suffix != NULL && *suffix != NULL) {
 296         if ((curr_suffix = OPENSSL_strdup(*suffix)) == NULL)
 297             return 0;
 298         trace_channels[category].suffix = curr_suffix;
 299     }
 300
 301     /* Finally, run the attach callback on the new data */
 302     if (channel != NULL && *channel != NULL) {
 303         attach_cb(category, CHANNEL, *channel);
 304     }
 305
 306     if (prefix != NULL && *prefix != NULL) {
 307         attach_cb(category, PREFIX, *prefix);
 308     }
 309
 310     if (suffix != NULL && *suffix != NULL) {
 311         attach_cb(category, SUFFIX, *suffix);
 312     }
 313
 314     return 1;
 315 }
 316
 317 static int do_ossl_trace_init(void)
 318 {
 319     trace_lock = CRYPTO_THREAD_lock_new();
 320     return trace_lock != NULL;
 321 }
 322
 323 #endif
 324
 325 void ossl_trace_cleanup(void)
 326 {
 327 #ifndef OPENSSL_NO_TRACE
 328     int category;
 329     BIO *channel = NULL;
 330     const char *prefix = NULL;
 331     const char *suffix = NULL;
 332
 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)
 336             continue;
 337         set_trace_data(category, 0, &channel, &prefix, &suffix,
 338                        trace_attach_cb, trace_detach_cb);
 339     }
 340     set_trace_data(OSSL_TRACE_CATEGORY_TRACE, 0, &channel,
 341                    &prefix, &suffix,
 342                    trace_attach_cb, trace_detach_cb);
 343     CRYPTO_THREAD_lock_free(trace_lock);
 344 #endif
 345 }
 346
 347 int OSSL_trace_set_channel(int category, BIO *channel)
 348 {
 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);
 353 #endif
 354     return 0;
 355 }
 356
 357 #ifndef OPENSSL_NO_TRACE
 358 static int trace_attach_w_callback_cb(int category, int type, const void *data)
 359 {
 360     switch (type) {
 361     case CHANNEL:
 362         OSSL_TRACE2(TRACE,
 363                     "Attach channel %p to category '%s' (with callback)\n",
 364                     data, trace_categories[category].name);
 365         break;
 366     case PREFIX:
 367         OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
 368                     (const char *)data, trace_categories[category].name);
 369         break;
 370     case SUFFIX:
 371         OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
 372                     (const char *)data, trace_categories[category].name);
 373         break;
 374     default:                     /* No clue */
 375         break;
 376     }
 377     return 1;
 378 }
 379 #endif
 380
 381 int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
 382 {
 383 #ifndef OPENSSL_NO_TRACE
 384     BIO *channel = NULL;
 385     struct trace_data_st *trace_data = NULL;
 386
 387     if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
 388         return 0;
 389
 390     if (callback != NULL) {
 391         if ((channel = BIO_new(&trace_method)) == NULL
 392             || (trace_data =
 393                 OPENSSL_zalloc(sizeof(struct trace_data_st))) == NULL)
 394             goto err;
 395
 396         trace_data->callback = callback;
 397         trace_data->category = category;
 398         trace_data->data = data;
 399
 400         BIO_set_data(channel, trace_data);
 401     }
 402
 403     if (!set_trace_data(category, CALLBACK_CHANNEL, &channel, NULL, NULL,
 404                         trace_attach_w_callback_cb, trace_detach_cb))
 405         goto err;
 406
 407     return 1;
 408
 409  err:
 410     BIO_free(channel);
 411     OPENSSL_free(trace_data);
 412 #endif
 413
 414     return 0;
 415 }
 416
 417 int OSSL_trace_set_prefix(int category, const char *prefix)
 418 {
 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);
 423 #endif
 424     return 0;
 425 }
 426
 427 int OSSL_trace_set_suffix(int category, const char *suffix)
 428 {
 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);
 433 #endif
 434     return 0;
 435 }
 436
 437 #ifndef OPENSSL_NO_TRACE
 438 static int ossl_trace_get_category(int category)
 439 {
 440     if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
 441         return -1;
 442     if (trace_channels[category].bio != NULL)
 443         return category;
 444     return OSSL_TRACE_CATEGORY_ALL;
 445 }
 446 #endif
 447
 448 int OSSL_trace_enabled(int category)
 449 {
 450     int ret = 0;
 451 #ifndef OPENSSL_NO_TRACE
 452     category = ossl_trace_get_category(category);
 453     if (category >= 0)
 454         ret = trace_channels[category].bio != NULL;
 455 #endif
 456     return ret;
 457 }
 458
 459 BIO *OSSL_trace_begin(int category)
 460 {
 461     BIO *channel = NULL;
 462 #ifndef OPENSSL_NO_TRACE
 463     char *prefix = NULL;
 464
 465     category = ossl_trace_get_category(category);
 466     if (category < 0)
 467         return NULL;
 468
 469     channel = trace_channels[category].bio;
 470     prefix = trace_channels[category].prefix;
 471
 472     if (channel != NULL) {
 473         if (!CRYPTO_THREAD_write_lock(trace_lock))
 474             return NULL;
 475         current_channel = channel;
 476         switch (trace_channels[category].type) {
 477         case SIMPLE_CHANNEL:
 478             if (prefix != NULL) {
 479                 (void)BIO_puts(channel, prefix);
 480                 (void)BIO_puts(channel, "\n");
 481             }
 482             break;
 483         case CALLBACK_CHANNEL:
 484             (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
 485                            prefix == NULL ? 0 : strlen(prefix), prefix);
 486             break;
 487         }
 488     }
 489 #endif
 490     return channel;
 491 }
 492
 493 void OSSL_trace_end(int category, BIO * channel)
 494 {
 495 #ifndef OPENSSL_NO_TRACE
 496     char *suffix = NULL;
 497
 498     category = ossl_trace_get_category(category);
 499     if (category < 0)
 500         return;
 501     suffix = trace_channels[category].suffix;
 502     if (channel != NULL
 503         && ossl_assert(channel == current_channel)) {
 504         (void)BIO_flush(channel);
 505         switch (trace_channels[category].type) {
 506         case SIMPLE_CHANNEL:
 507             if (suffix != NULL) {
 508                 (void)BIO_puts(channel, suffix);
 509                 (void)BIO_puts(channel, "\n");
 510             }
 511             break;
 512         case CALLBACK_CHANNEL:
 513             (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
 514                            suffix == NULL ? 0 : strlen(suffix), suffix);
 515             break;
 516         }
 517         current_channel = NULL;
 518         CRYPTO_THREAD_unlock(trace_lock);
 519     }
 520 #endif
 521 }