crypto/trace.c

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