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 <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"
  19
  20 #include "e_os.h"                /* strcasecmp for Windows */
  21
  22 #ifndef OPENSSL_NO_TRACE
  23
  24 static CRYPTO_RWLOCK *trace_lock = NULL;
  25
  26 static const BIO  *current_channel = NULL;
  27
  28 /*-
  29  * INTERNAL TRACE CHANNEL IMPLEMENTATION
  30  *
  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
  35  * callback function.
  36  */
  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);
  42
  43 static const BIO_METHOD trace_method = {
  44     BIO_TYPE_SOURCE_SINK,
  45     "trace",
  46     trace_write,
  47     NULL,                        /* old write */
  48     NULL,                        /* read_ex */
  49     NULL,                        /* read */
  50     trace_puts,
  51     NULL,                        /* gets */
  52     trace_ctrl,                  /* ctrl */
  53     NULL,                        /* create */
  54     trace_free,                  /* free */
  55     NULL,                        /* callback_ctrl */
  56 };
  57
  58 struct trace_data_st {
  59     OSSL_trace_cb callback;
  60     int category;
  61     void *data;
  62 };
  63
  64 static int trace_write(BIO *channel,
  65                        const char *buf, size_t num, size_t *written)
  66 {
  67     struct trace_data_st *ctx = BIO_get_data(channel);
  68     size_t cnt = ctx->callback(buf, num, ctx->category, OSSL_TRACE_CTRL_DURING,
  69                                ctx->data);
  70
  71     *written = cnt;
  72     return cnt != 0;
  73 }
  74
  75 static int trace_puts(BIO *channel, const char *str)
  76 {
  77     size_t written;
  78
  79     if (trace_write(channel, str, strlen(str), &written))
  80         return (int)written;
  81
  82     return EOF;
  83 }
  84
  85 static long trace_ctrl(BIO *channel, int cmd, long argl, void *argp)
  86 {
  87     struct trace_data_st *ctx = BIO_get_data(channel);
  88
  89     switch (cmd) {
  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);
  94         return 1;
  95     default:
  96         break;
  97     }
  98     return -2;                   /* Unsupported */
  99 }
 100
 101 static int trace_free(BIO *channel)
 102 {
 103     if (channel == NULL)
 104         return 0;
 105     OPENSSL_free(BIO_get_data(channel));
 106     return 1;
 107 }
 108 #endif
 109
 110 /*-
 111  * TRACE
 112  */
 113
 114 /* Helper struct and macro to get name string to number mapping */
 115 struct trace_category_st {
 116     const char * const name;
 117     const int num;
 118 };
 119 #define TRACE_CATEGORY_(name)       { #name, OSSL_TRACE_CATEGORY_##name }
 120
 121 static const struct trace_category_st trace_categories[] = {
 122     TRACE_CATEGORY_(ANY),
 123 };
 124
 125 const char *OSSL_trace_get_category_name(int num)
 126 {
 127     size_t i;
 128
 129     for (i = 0; i < OSSL_NELEM(trace_categories); i++)
 130         if (trace_categories[i].num == num)
 131             return trace_categories[i].name;
 132     return NULL; /* not found */
 133 }
 134
 135 int OSSL_trace_get_category_num(const char *name)
 136 {
 137     size_t i;
 138
 139     for (i = 0; i < OSSL_NELEM(trace_categories); i++)
 140         if (strcasecmp(name, trace_categories[i].name) == 0)
 141             return trace_categories[i].num;
 142     return -1; /* not found */
 143 }
 144
 145 #ifndef OPENSSL_NO_TRACE
 146
 147 /* We use one trace channel for each trace category */
 148 static struct {
 149     enum { t_channel, t_callback } type;
 150     BIO *bio;
 151     char *prefix;
 152     char *suffix;
 153 } trace_channels[OSSL_TRACE_CATEGORY_NUM] = {
 154     { 0, NULL, NULL, NULL },
 155 };
 156
 157 #endif
 158
 159 int ossl_trace_init(void)
 160 {
 161 #ifndef OPENSSL_NO_TRACE
 162     trace_lock = CRYPTO_THREAD_lock_new();
 163     if (trace_lock != NULL)
 164         return 1;
 165 #endif
 166
 167     return 0;
 168 }
 169
 170 void ossl_trace_cleanup(void)
 171 {
 172 #ifndef OPENSSL_NO_TRACE
 173     int category;
 174
 175     for (category = 0; category < OSSL_TRACE_CATEGORY_NUM; category++)
 176         OSSL_trace_set_channel(category, NULL);
 177     CRYPTO_THREAD_lock_free(trace_lock);
 178 #endif
 179 }
 180
 181 int OSSL_trace_set_channel(int category, BIO *channel)
 182 {
 183 #ifndef OPENSSL_NO_TRACE
 184     BIO *prev_channel;
 185
 186     if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
 187         goto err;
 188
 189     prev_channel = trace_channels[category].bio;
 190
 191     if (prev_channel != NULL) {
 192         BIO_free(prev_channel);
 193         trace_channels[category].bio = NULL;
 194     }
 195
 196     if (channel == NULL)
 197         return 1;                /* Done */
 198
 199     trace_channels[category].bio = channel;
 200     trace_channels[category].type = t_channel;
 201
 202     return 1;
 203
 204  err:
 205 #endif
 206
 207     return 0;
 208 }
 209
 210 int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
 211 {
 212 #ifndef OPENSSL_NO_TRACE
 213     BIO *channel = trace_channels[category].bio;
 214     struct trace_data_st *trace_data = NULL;
 215
 216     if (channel != NULL) {
 217         BIO_free(channel);
 218         trace_channels[category].bio = NULL;
 219     }
 220
 221     if (callback == NULL)
 222         return 1; /* done */
 223
 224     channel = BIO_new(&trace_method);
 225     if (channel == NULL)
 226         goto err;
 227
 228     trace_data = OPENSSL_zalloc(sizeof(struct trace_data_st));
 229     if (trace_data == NULL)
 230         goto err;
 231
 232     trace_data->callback = callback;
 233     trace_data->category = category;
 234     trace_data->data = data;
 235
 236     BIO_set_data(channel, trace_data);
 237
 238     trace_channels[category].bio = channel;
 239     trace_channels[category].type = t_callback;
 240
 241     return 1;
 242
 243  err:
 244     BIO_free(channel);
 245     OPENSSL_free(trace_data);
 246 #endif
 247
 248     return 0;
 249 }
 250
 251 int OSSL_trace_set_prefix(int category, const char *prefix)
 252 {
 253 #ifndef OPENSSL_NO_TRACE
 254     char *curr_prefix = trace_channels[category].prefix;
 255
 256     if (curr_prefix != NULL) {
 257         OPENSSL_free(curr_prefix);
 258         trace_channels[category].prefix = NULL;
 259     }
 260
 261     if (prefix == NULL)
 262         return 1;                /* Done */
 263
 264     curr_prefix = OPENSSL_strdup(prefix);
 265     if (curr_prefix == NULL)
 266         goto err;
 267
 268     trace_channels[category].prefix = curr_prefix;
 269
 270     return 1;
 271
 272  err:
 273 #endif
 274
 275     return 0;
 276 }
 277
 278 int OSSL_trace_set_suffix(int category, const char *suffix)
 279 {
 280 #ifndef OPENSSL_NO_TRACE
 281     char *curr_suffix = trace_channels[category].suffix;
 282
 283     if (curr_suffix != NULL) {
 284         OPENSSL_free(curr_suffix);
 285         trace_channels[category].suffix = NULL;
 286     }
 287
 288     if (suffix == NULL)
 289         return 1; /* done */
 290
 291     curr_suffix = OPENSSL_strdup(suffix);
 292     if (curr_suffix == NULL)
 293         goto err;
 294
 295     trace_channels[category].suffix = curr_suffix;
 296
 297     return 1;
 298
 299  err:
 300 #endif
 301
 302     return 0;
 303 }
 304
 305 #ifndef OPENSSL_NO_TRACE
 306 static int ossl_trace_get_category(int category)
 307 {
 308     if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
 309         return -1;
 310     if (trace_channels[category].bio != NULL)
 311         return category;
 312     return OSSL_TRACE_CATEGORY_ANY;
 313 }
 314 #endif
 315
 316 int OSSL_trace_enabled(int category)
 317 {
 318     int ret = 0;
 319 #ifndef OPENSSL_NO_TRACE
 320     category = ossl_trace_get_category(category);
 321     ret = trace_channels[category].bio != NULL;
 322 #endif
 323     return ret;
 324 }
 325
 326 BIO *OSSL_trace_begin(int category)
 327 {
 328     BIO *channel = NULL;
 329 #ifndef OPENSSL_NO_TRACE
 330     char *prefix = NULL;
 331
 332     category = ossl_trace_get_category(category);
 333     channel = trace_channels[category].bio;
 334     prefix = trace_channels[category].prefix;
 335
 336     if (channel != NULL) {
 337         CRYPTO_THREAD_write_lock(trace_lock);
 338         current_channel = channel;
 339         switch (trace_channels[category].type) {
 340         case t_channel:
 341             if (prefix != NULL) {
 342                 (void)BIO_puts(channel, prefix);
 343                 (void)BIO_puts(channel, "\n");
 344             }
 345             break;
 346         case t_callback:
 347             (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
 348                            prefix == NULL ? 0 : strlen(prefix), prefix);
 349             break;
 350         }
 351     }
 352 #endif
 353     return channel;
 354 }
 355
 356 void OSSL_trace_end(int category, BIO * channel)
 357 {
 358 #ifndef OPENSSL_NO_TRACE
 359     char *suffix = NULL;
 360
 361     category = ossl_trace_get_category(category);
 362     suffix = trace_channels[category].suffix;
 363     if (channel != NULL
 364         && ossl_assert(channel == current_channel)) {
 365         (void)BIO_flush(channel);
 366         switch (trace_channels[category].type) {
 367         case t_channel:
 368             if (suffix != NULL) {
 369                 (void)BIO_puts(channel, suffix);
 370                 (void)BIO_puts(channel, "\n");
 371             }
 372             break;
 373         case t_callback:
 374             (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
 375                            suffix == NULL ? 0 : strlen(suffix), suffix);
 376             break;
 377         }
 378         current_channel = NULL;
 379         CRYPTO_THREAD_unlock(trace_lock);
 380     }
 381 #endif
 382 }