test/testutil/testutil_init.c

   1 /*
   2  * Copyright 2017-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 <string.h>
  11 #include <openssl/opensslconf.h>
  12 #include <openssl/trace.h>
  13 #include "apps.h"
  14 #include "../testutil.h"
  15
  16 #ifndef OPENSSL_NO_TRACE
  17 typedef struct tracedata_st {
  18     BIO *bio;
  19     unsigned int ingroup:1;
  20 } tracedata;
  21
  22 static size_t internal_trace_cb(const char *buf, size_t cnt,
  23                                 int category, int cmd, void *vdata)
  24 {
  25     int ret = 0;
  26     tracedata *trace_data = vdata;
  27     char buffer[256], *hex;
  28     CRYPTO_THREAD_ID tid;
  29
  30     switch (cmd) {
  31     case OSSL_TRACE_CTRL_BEGIN:
  32         trace_data->ingroup = 1;
  33
  34         tid = CRYPTO_THREAD_get_current_id();
  35         hex = OPENSSL_buf2hexstr((const unsigned char *)&tid, sizeof(tid));
  36         BIO_snprintf(buffer, sizeof(buffer), "TRACE[%s]:%s: ",
  37                      hex, OSSL_trace_get_category_name(category));
  38         OPENSSL_free(hex);
  39         BIO_set_prefix(trace_data->bio, buffer);
  40         break;
  41     case OSSL_TRACE_CTRL_WRITE:
  42         ret = BIO_write(trace_data->bio, buf, cnt);
  43         break;
  44     case OSSL_TRACE_CTRL_END:
  45         trace_data->ingroup = 0;
  46
  47         BIO_set_prefix(trace_data->bio, NULL);
  48         break;
  49     }
  50
  51     return ret < 0 ? 0 : ret;
  52 }
  53
  54 DEFINE_STACK_OF(tracedata)
  55 static STACK_OF(tracedata) *trace_data_stack;
  56
  57 static void tracedata_free(tracedata *data)
  58 {
  59     BIO_free_all(data->bio);
  60     OPENSSL_free(data);
  61 }
  62
  63 static STACK_OF(tracedata) *trace_data_stack;
  64
  65 static void cleanup_trace(void)
  66 {
  67     sk_tracedata_pop_free(trace_data_stack, tracedata_free);
  68 }
  69
  70 static void setup_trace_category(int category)
  71 {
  72     BIO *channel;
  73     tracedata *trace_data;
  74
  75     if (OSSL_trace_enabled(category))
  76         return;
  77
  78     channel = BIO_push(BIO_new(BIO_f_prefix()),
  79                        BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT));
  80     trace_data = OPENSSL_zalloc(sizeof(*trace_data));
  81
  82     if (trace_data == NULL
  83         || (trace_data->bio = channel) == NULL
  84         || OSSL_trace_set_callback(category, internal_trace_cb,
  85                                    trace_data) == 0
  86         || sk_tracedata_push(trace_data_stack, trace_data) == 0) {
  87
  88         fprintf(stderr,
  89                 "warning: unable to setup trace callback for category '%s'.\n",
  90                 OSSL_trace_get_category_name(category));
  91
  92         OSSL_trace_set_callback(category, NULL, NULL);
  93         BIO_free_all(channel);
  94     }
  95 }
  96
  97 static void setup_trace(const char *str)
  98 {
  99     char *val;
 100
 101     /*
 102      * We add this handler as early as possible to ensure it's executed
 103      * as late as possible, i.e. after the TRACE code has done its cleanup
 104      * (which happens last in OPENSSL_cleanup).
 105      */
 106     atexit(cleanup_trace);
 107
 108     trace_data_stack = sk_tracedata_new_null();
 109     val = OPENSSL_strdup(str);
 110
 111     if (val != NULL) {
 112         char *valp = val;
 113         char *item;
 114
 115         for (valp = val; (item = strtok(valp, ",")) != NULL; valp = NULL) {
 116             int category = OSSL_trace_get_category_num(item);
 117
 118             if (category == OSSL_TRACE_CATEGORY_ALL) {
 119                 while (++category < OSSL_TRACE_CATEGORY_NUM)
 120                     setup_trace_category(category);
 121                 break;
 122             } else if (category > 0) {
 123                 setup_trace_category(category);
 124             } else {
 125                 fprintf(stderr,
 126                         "warning: unknown trace category: '%s'.\n", item);
 127             }
 128         }
 129     }
 130
 131     OPENSSL_free(val);
 132 }
 133 #endif /* OPENSSL_NO_TRACE */
 134
 135 int global_init(void)
 136 {
 137 #ifndef OPENSSL_NO_TRACE
 138     setup_trace(getenv("OPENSSL_TRACE"));
 139 #endif
 140
 141     return 1;
 142 }