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     TRACE_CATEGORY_(TLS),
 124 };
 125
 126 const char *OSSL_trace_get_category_name(int num)
 127 {
 128     size_t i;
 129
 130     for (i = 0; i < OSSL_NELEM(trace_categories); i++)
 131         if (trace_categories[i].num == num)
 132             return trace_categories[i].name;
 133     return NULL; /* not found */
 134 }
 135
 136 int OSSL_trace_get_category_num(const char *name)
 137 {
 138     size_t i;
 139
 140     for (i = 0; i < OSSL_NELEM(trace_categories); i++)
 141         if (strcasecmp(name, trace_categories[i].name) == 0)
 142             return trace_categories[i].num;
 143     return -1; /* not found */
 144 }
 145
 146 #ifndef OPENSSL_NO_TRACE
 147
 148 /* We use one trace channel for each trace category */
 149 static struct {
 150     enum { t_channel, t_callback } type;
 151     BIO *bio;
 152     char *prefix;
 153     char *suffix;
 154 } trace_channels[OSSL_TRACE_CATEGORY_NUM] = {
 155     { 0, NULL, NULL, NULL },
 156 };
 157
 158 #endif
 159
 160 int ossl_trace_init(void)
 161 {
 162 #ifndef OPENSSL_NO_TRACE
 163     trace_lock = CRYPTO_THREAD_lock_new();
 164     if (trace_lock != NULL)
 165         return 1;
 166 #endif
 167
 168     return 0;
 169 }
 170
 171 void ossl_trace_cleanup(void)
 172 {
 173 #ifndef OPENSSL_NO_TRACE
 174     int category;
 175
 176     for (category = 0; category < OSSL_TRACE_CATEGORY_NUM; category++)
 177         OSSL_trace_set_channel(category, NULL);
 178     CRYPTO_THREAD_lock_free(trace_lock);
 179 #endif
 180 }
 181
 182 int OSSL_trace_set_channel(int category, BIO *channel)
 183 {
 184 #ifndef OPENSSL_NO_TRACE
 185     BIO *prev_channel;
 186
 187     if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
 188         goto err;
 189
 190     prev_channel = trace_channels[category].bio;
 191
 192     if (prev_channel != NULL) {
 193         BIO_free(prev_channel);
 194         trace_channels[category].bio = NULL;
 195     }
 196
 197     if (channel == NULL)
 198         return 1;                /* Done */
 199
 200     trace_channels[category].bio = channel;
 201     trace_channels[category].type = t_channel;
 202
 203     return 1;
 204
 205  err:
 206 #endif
 207
 208     return 0;
 209 }
 210
 211 int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
 212 {
 213 #ifndef OPENSSL_NO_TRACE
 214     BIO *channel = trace_channels[category].bio;
 215     struct trace_data_st *trace_data = NULL;
 216
 217     if (channel != NULL) {
 218         BIO_free(channel);
 219         trace_channels[category].bio = NULL;
 220     }
 221
 222     if (callback == NULL)
 223         return 1; /* done */
 224
 225     channel = BIO_new(&trace_method);
 226     if (channel == NULL)
 227         goto err;
 228
 229     trace_data = OPENSSL_zalloc(sizeof(struct trace_data_st));
 230     if (trace_data == NULL)
 231         goto err;
 232
 233     trace_data->callback = callback;
 234     trace_data->category = category;
 235     trace_data->data = data;
 236
 237     BIO_set_data(channel, trace_data);
 238
 239     trace_channels[category].bio = channel;
 240     trace_channels[category].type = t_callback;
 241
 242     return 1;
 243
 244  err:
 245     BIO_free(channel);
 246     OPENSSL_free(trace_data);
 247 #endif
 248
 249     return 0;
 250 }
 251
 252 int OSSL_trace_set_prefix(int category, const char *prefix)
 253 {
 254 #ifndef OPENSSL_NO_TRACE
 255     char *curr_prefix = trace_channels[category].prefix;
 256
 257     if (curr_prefix != NULL) {
 258         OPENSSL_free(curr_prefix);
 259         trace_channels[category].prefix = NULL;
 260     }
 261
 262     if (prefix == NULL)
 263         return 1;                /* Done */
 264
 265     curr_prefix = OPENSSL_strdup(prefix);
 266     if (curr_prefix == NULL)
 267         goto err;
 268
 269     trace_channels[category].prefix = curr_prefix;
 270
 271     return 1;
 272
 273  err:
 274 #endif
 275
 276     return 0;
 277 }
 278
 279 int OSSL_trace_set_suffix(int category, const char *suffix)
 280 {
 281 #ifndef OPENSSL_NO_TRACE
 282     char *curr_suffix = trace_channels[category].suffix;
 283
 284     if (curr_suffix != NULL) {
 285         OPENSSL_free(curr_suffix);
 286         trace_channels[category].suffix = NULL;
 287     }
 288
 289     if (suffix == NULL)
 290         return 1; /* done */
 291
 292     curr_suffix = OPENSSL_strdup(suffix);
 293     if (curr_suffix == NULL)
 294         goto err;
 295
 296     trace_channels[category].suffix = curr_suffix;
 297
 298     return 1;
 299
 300  err:
 301 #endif
 302
 303     return 0;
 304 }
 305
 306 #ifndef OPENSSL_NO_TRACE
 307 static int ossl_trace_get_category(int category)
 308 {
 309     if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM)
 310         return -1;
 311     if (trace_channels[category].bio != NULL)
 312         return category;
 313     return OSSL_TRACE_CATEGORY_ANY;
 314 }
 315 #endif
 316
 317 int OSSL_trace_enabled(int category)
 318 {
 319     int ret = 0;
 320 #ifndef OPENSSL_NO_TRACE
 321     category = ossl_trace_get_category(category);
 322     ret = trace_channels[category].bio != NULL;
 323 #endif
 324     return ret;
 325 }
 326
 327 BIO *OSSL_trace_begin(int category)
 328 {
 329     BIO *channel = NULL;
 330 #ifndef OPENSSL_NO_TRACE
 331     char *prefix = NULL;
 332
 333     category = ossl_trace_get_category(category);
 334     channel = trace_channels[category].bio;
 335     prefix = trace_channels[category].prefix;
 336
 337     if (channel != NULL) {
 338         CRYPTO_THREAD_write_lock(trace_lock);
 339         current_channel = channel;
 340         switch (trace_channels[category].type) {
 341         case t_channel:
 342             if (prefix != NULL) {
 343                 (void)BIO_puts(channel, prefix);
 344                 (void)BIO_puts(channel, "\n");
 345             }
 346             break;
 347         case t_callback:
 348             (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
 349                            prefix == NULL ? 0 : strlen(prefix), prefix);
 350             break;
 351         }
 352     }
 353 #endif
 354     return channel;
 355 }
 356
 357 void OSSL_trace_end(int category, BIO * channel)
 358 {
 359 #ifndef OPENSSL_NO_TRACE
 360     char *suffix = NULL;
 361
 362     category = ossl_trace_get_category(category);
 363     suffix = trace_channels[category].suffix;
 364     if (channel != NULL
 365         && ossl_assert(channel == current_channel)) {
 366         (void)BIO_flush(channel);
 367         switch (trace_channels[category].type) {
 368         case t_channel:
 369             if (suffix != NULL) {
 370                 (void)BIO_puts(channel, suffix);
 371                 (void)BIO_puts(channel, "\n");
 372             }
 373             break;
 374         case t_callback:
 375             (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
 376                            suffix == NULL ? 0 : strlen(suffix), suffix);
 377             break;
 378         }
 379         current_channel = NULL;
 380         CRYPTO_THREAD_unlock(trace_lock);
 381     }
 382 #endif
 383 }