crypto/err/err_prn.c

   1 /*
   2  * Copyright 1995-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 /* TODO: When ERR_STATE becomes opaque, this musts be removed */
  11 #define OSSL_FORCE_ERR_STATE
  12
  13 #include <stdio.h>
  14 #include "internal/cryptlib.h"
  15 #include <openssl/crypto.h>
  16 #include <openssl/buffer.h>
  17 #include <openssl/err.h>
  18 #include "err_local.h"
  19
  20 #define ERR_PRINT_BUF_SIZE 4096
  21 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
  22                          void *u)
  23 {
  24     CRYPTO_THREAD_ID tid = CRYPTO_THREAD_get_current_id();
  25     unsigned long l;
  26     const char *file, *data, *func;
  27     int line, flags;
  28
  29     while ((l = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
  30         char buf[ERR_PRINT_BUF_SIZE] = "";
  31         char *hex = NULL;
  32         int offset;
  33
  34         if ((flags & ERR_TXT_STRING) == 0)
  35             data = "";
  36
  37         hex = ossl_buf2hexstr_sep((const unsigned char *)&tid, sizeof(tid), '\0');
  38         BIO_snprintf(buf, sizeof(buf), "%s:", hex == NULL ? "<null>" : hex);
  39         offset = strlen(buf);
  40         ossl_err_string_int(l, func, buf + offset, sizeof(buf) - offset);
  41         offset += strlen(buf + offset);
  42         BIO_snprintf(buf + offset, sizeof(buf) - offset, ":%s:%d:%s\n",
  43                      file, line, data);
  44         OPENSSL_free(hex);
  45         if (cb(buf, strlen(buf), u) <= 0)
  46             break;              /* abort outputting the error report */
  47     }
  48 }
  49
  50 /* auxiliary function for incrementally reporting texts via the error queue */
  51 static void put_error(int lib, const char *func, int reason,
  52                       const char *file, int line)
  53 {
  54     ERR_new();
  55     ERR_set_debug(file, line, func);
  56     ERR_set_error(lib, reason, NULL /* no data here, so fmt is NULL */);
  57 }
  58
  59 #define TYPICAL_MAX_OUTPUT_BEFORE_DATA 100
  60 #define MAX_DATA_LEN (ERR_PRINT_BUF_SIZE - TYPICAL_MAX_OUTPUT_BEFORE_DATA)
  61 void ERR_add_error_txt(const char *separator, const char *txt)
  62 {
  63     const char *file = NULL;
  64     int line;
  65     const char *func = NULL;
  66     const char *data = NULL;
  67     int flags;
  68     unsigned long err = ERR_peek_last_error();
  69
  70     if (separator == NULL)
  71         separator = "";
  72     if (err == 0)
  73         put_error(ERR_LIB_NONE, NULL, 0, "", 0);
  74
  75     do {
  76         size_t available_len, data_len;
  77         const char *curr = txt, *next = txt;
  78         const char *leading_separator = separator;
  79         int trailing_separator = 0;
  80         char *tmp;
  81
  82         ERR_peek_last_error_all(&file, &line, &func, &data, &flags);
  83         if ((flags & ERR_TXT_STRING) == 0) {
  84             data = "";
  85             leading_separator = "";
  86         }
  87         data_len = strlen(data);
  88
  89         /* workaround for limit of ERR_print_errors_cb() */
  90         if (data_len >= MAX_DATA_LEN
  91                 || strlen(separator) >= (size_t)(MAX_DATA_LEN - data_len))
  92             available_len = 0;
  93         else
  94             available_len = MAX_DATA_LEN - data_len - strlen(separator) - 1;
  95         /* MAX_DATA_LEN > available_len >= 0 */
  96
  97         if (*separator == '\0') {
  98             const size_t len_next = strlen(next);
  99
 100             if (len_next <= available_len) {
 101                 next += len_next;
 102                 curr = NULL; /* no need to split */
 103             } else {
 104                 next += available_len;
 105                 curr = next; /* will split at this point */
 106             }
 107         } else {
 108             while (*next != '\0' && (size_t)(next - txt) <= available_len) {
 109                 curr = next;
 110                 next = strstr(curr, separator);
 111                 if (next != NULL) {
 112                     next += strlen(separator);
 113                     trailing_separator = *next == '\0';
 114                 } else {
 115                     next = curr + strlen(curr);
 116                 }
 117             }
 118             if ((size_t)(next - txt) <= available_len)
 119                 curr = NULL; /* the above loop implies *next == '\0' */
 120         }
 121         if (curr != NULL) {
 122             /* split error msg at curr since error data would get too long */
 123             if (curr != txt) {
 124                 tmp = OPENSSL_strndup(txt, curr - txt);
 125                 if (tmp == NULL)
 126                     return;
 127                 ERR_add_error_data(2, separator, tmp);
 128                 OPENSSL_free(tmp);
 129             }
 130             put_error(ERR_GET_LIB(err), func, err, file, line);
 131             txt = curr;
 132         } else {
 133             if (trailing_separator) {
 134                 tmp = OPENSSL_strndup(txt, next - strlen(separator) - txt);
 135                 if (tmp == NULL)
 136                     return;
 137                 /* output txt without the trailing separator */
 138                 ERR_add_error_data(2, leading_separator, tmp);
 139                 OPENSSL_free(tmp);
 140             } else {
 141                 ERR_add_error_data(2, leading_separator, txt);
 142             }
 143             txt = next; /* finished */
 144         }
 145     } while (*txt != '\0');
 146 }
 147
 148 void ERR_add_error_mem_bio(const char *separator, BIO *bio)
 149 {
 150     if (bio != NULL) {
 151         char *str;
 152         long len = BIO_get_mem_data(bio, &str);
 153
 154         if (len > 0) {
 155             if (str[len - 1] != '\0') {
 156                 if (BIO_write(bio, "", 1) <= 0)
 157                     return;
 158
 159                 len = BIO_get_mem_data(bio, &str);
 160             }
 161             if (len > 1)
 162                 ERR_add_error_txt(separator, str);
 163         }
 164     }
 165 }
 166
 167 static int print_bio(const char *str, size_t len, void *bp)
 168 {
 169     return BIO_write((BIO *)bp, str, len);
 170 }
 171
 172 void ERR_print_errors(BIO *bp)
 173 {
 174     ERR_print_errors_cb(print_bio, bp);
 175 }
 176
 177 #ifndef OPENSSL_NO_STDIO
 178 void ERR_print_errors_fp(FILE *fp)
 179 {
 180     BIO *bio = BIO_new_fp(fp, BIO_NOCLOSE);
 181     if (bio == NULL)
 182         return;
 183
 184     ERR_print_errors_cb(print_bio, bio);
 185     BIO_free(bio);
 186 }
 187 #endif