err.c 21.2 KB
Newer Older
R
Rich Salz 已提交
1
/*
2
 * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
3
 *
R
Rich Salz 已提交
4 5 6 7
 * Licensed under the OpenSSL license (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
8
 */
9 10

#include <stdio.h>
U
Ulf Möller 已提交
11
#include <stdarg.h>
12
#include <string.h>
R
Rich Salz 已提交
13 14 15
#include "internal/cryptlib_int.h"
#include "internal/err.h"
#include "internal/err_int.h"
16
#include <openssl/err.h>
17 18
#include <openssl/crypto.h>
#include <openssl/buffer.h>
B
Bodo Möller 已提交
19
#include <openssl/bio.h>
20
#include <openssl/opensslconf.h>
R
Rich Salz 已提交
21
#include "internal/thread_once.h"
B
Ben Laurie 已提交
22

23
static int err_load_strings(const ERR_STRING_DATA *str);
24

25
static void ERR_STATE_free(ERR_STATE *s);
26
#ifndef OPENSSL_NO_ERR
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
static ERR_STRING_DATA ERR_str_libraries[] = {
    {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
    {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
    {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
    {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
    {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
    {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
    {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
    {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
    {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
    {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
    {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
    {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
    {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
    {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
    {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
    {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
    {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
    {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
    {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
    {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
    {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
    {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
    {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
    {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
    {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
    {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
    {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
55
    {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
56 57 58
    {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
    {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
    {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
59
    {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
M
Matt Caswell 已提交
60
    {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
D
Dr. Stephen Henson 已提交
61
    {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
R
Richard Levitte 已提交
62
    {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"},
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
    {0, NULL},
};

static ERR_STRING_DATA ERR_str_functs[] = {
    {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
    {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
    {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
    {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
    {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
    {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
    {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
    {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
# ifdef OPENSSL_SYS_WINDOWS
    {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
# endif
    {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
    {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
80 81
    {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
    {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
82 83 84
    {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
    {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
    {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
K
Kurt Roeckx 已提交
85
    {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
R
Rich Salz 已提交
86
    {ERR_PACK(0, SYS_F_FFLUSH, 0), "fflush"},
R
Richard Levitte 已提交
87 88 89
    {ERR_PACK(0, SYS_F_OPEN, 0), "open"},
    {ERR_PACK(0, SYS_F_CLOSE, 0), "close"},
    {ERR_PACK(0, SYS_F_IOCTL, 0), "ioctl"},
90
    {ERR_PACK(0, SYS_F_STAT, 0), "stat"},
B
Benjamin Kaduk 已提交
91
    {ERR_PACK(0, SYS_F_FCNTL, 0), "fcntl"},
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
    {0, NULL},
};

static ERR_STRING_DATA ERR_str_reasons[] = {
    {ERR_R_SYS_LIB, "system lib"},
    {ERR_R_BN_LIB, "BN lib"},
    {ERR_R_RSA_LIB, "RSA lib"},
    {ERR_R_DH_LIB, "DH lib"},
    {ERR_R_EVP_LIB, "EVP lib"},
    {ERR_R_BUF_LIB, "BUF lib"},
    {ERR_R_OBJ_LIB, "OBJ lib"},
    {ERR_R_PEM_LIB, "PEM lib"},
    {ERR_R_DSA_LIB, "DSA lib"},
    {ERR_R_X509_LIB, "X509 lib"},
    {ERR_R_ASN1_LIB, "ASN1 lib"},
    {ERR_R_EC_LIB, "EC lib"},
    {ERR_R_BIO_LIB, "BIO lib"},
    {ERR_R_PKCS7_LIB, "PKCS7 lib"},
    {ERR_R_X509V3_LIB, "X509V3 lib"},
    {ERR_R_ENGINE_LIB, "ENGINE lib"},
112
    {ERR_R_UI_LIB, "UI lib"},
R
Richard Levitte 已提交
113
    {ERR_R_OSSL_STORE_LIB, "STORE lib"},
114 115 116 117 118 119 120 121 122 123 124 125
    {ERR_R_ECDSA_LIB, "ECDSA lib"},

    {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
    {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},

    {ERR_R_FATAL, "fatal"},
    {ERR_R_MALLOC_FAILURE, "malloc failure"},
    {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
     "called a function you should not call"},
    {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
    {ERR_R_INTERNAL_ERROR, "internal error"},
    {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
126
    {ERR_R_INIT_FAIL, "init fail"},
127
    {ERR_R_OPERATION_FAIL, "operation fail"},
128 129 130

    {0, NULL},
};
131
#endif
132

133
static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
134
static int set_err_thread_local;
135 136
static CRYPTO_THREAD_LOCAL err_thread_local;

137 138 139
static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
static CRYPTO_RWLOCK *err_string_lock;

140 141
static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);

142
/*
R
Rich Salz 已提交
143
 * The internal state
144
 */
R
Rich Salz 已提交
145

B
Ben Laurie 已提交
146
static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
147
static int int_err_library_number = ERR_LIB_USER;
148

149 150 151
static unsigned long get_error_values(int inc, int top, const char **file,
                                      int *line, const char **data,
                                      int *flags);
152

B
Ben Laurie 已提交
153
static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
154 155 156 157 158 159 160
{
    unsigned long ret, l;

    l = a->error;
    ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
    return (ret ^ ret % 19 * 13);
}
B
Ben Laurie 已提交
161 162

static int err_string_data_cmp(const ERR_STRING_DATA *a,
163 164
                               const ERR_STRING_DATA *b)
{
R
Rich Salz 已提交
165 166 167
    if (a->error == b->error)
        return 0;
    return a->error > b->error ? 1 : -1;
168 169
}

170
static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
171
{
R
Rich Salz 已提交
172
    ERR_STRING_DATA *p = NULL;
173

174
    CRYPTO_THREAD_read_lock(err_string_lock);
175
    p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
176
    CRYPTO_THREAD_unlock(err_string_lock);
177

178 179
    return p;
}
180

181
#ifndef OPENSSL_NO_ERR
182 183
# define NUM_SYS_STR_REASONS 127
# define LEN_SYS_STR_REASON 32
184 185

static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
186 187 188 189 190 191 192 193 194
/*
 * SYS_str_reasons is filled with copies of strerror() results at
 * initialization. 'errno' values up to 127 should cover all usual errors,
 * others will be displayed numerically by ERR_error_string. It is crucial
 * that we have something for each reason code that occurs in
 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
 * which always gets an errno value and never one of those 'standard' reason
 * codes.
 */
195

196
static void build_SYS_str_reasons(void)
197 198 199 200
{
    /* OPENSSL_malloc cannot be used here, use static storage instead */
    static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
    static int init = 1;
R
Rich Salz 已提交
201
    int i;
202

203
    CRYPTO_THREAD_write_lock(err_string_lock);
204
    if (!init) {
205
        CRYPTO_THREAD_unlock(err_string_lock);
206 207 208 209 210 211
        return;
    }

    for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
        ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];

212
        str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
213 214
        if (str->string == NULL) {
            char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
215
            if (openssl_strerror_r(i, *dest, sizeof(*dest)))
216 217 218 219 220 221 222 223 224 225 226 227 228
                str->string = *dest;
        }
        if (str->string == NULL)
            str->string = "unknown";
    }

    /*
     * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
     * required by ERR_load_strings.
     */

    init = 0;

229
    CRYPTO_THREAD_unlock(err_string_lock);
230
    err_load_strings(SYS_str_reasons);
231
}
232 233
#endif

234
#define err_clear_data(p,i) \
235
        do { \
R
Rich Salz 已提交
236
        if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
237 238 239 240 241 242
                {  \
                OPENSSL_free((p)->err_data[i]); \
                (p)->err_data[i]=NULL; \
                } \
        (p)->err_data_flags[i]=0; \
        } while(0)
243 244

#define err_clear(p,i) \
245 246 247 248 249 250 251
        do { \
        (p)->err_flags[i]=0; \
        (p)->err_buffer[i]=0; \
        err_clear_data(p,i); \
        (p)->err_file[i]=NULL; \
        (p)->err_line[i]= -1; \
        } while(0)
252

U
Ulf Möller 已提交
253
static void ERR_STATE_free(ERR_STATE *s)
254 255
{
    int i;
256

257 258
    if (s == NULL)
        return;
B
Ben Laurie 已提交
259

260 261 262 263 264
    for (i = 0; i < ERR_NUM_ERRORS; i++) {
        err_clear_data(s, i);
    }
    OPENSSL_free(s);
}
265

266
DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
267
{
M
Matt Caswell 已提交
268
    OPENSSL_init_crypto(0, NULL);
R
Rich Salz 已提交
269
    err_string_lock = CRYPTO_THREAD_glock_new("err_string");
270 271 272
    int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
                                            err_string_data_cmp);
    return err_string_lock != NULL && int_error_hash != NULL;
273 274 275 276
}

void err_cleanup(void)
{
277 278
    if (set_err_thread_local != 0)
        CRYPTO_THREAD_cleanup_local(&err_thread_local);
279 280
    CRYPTO_THREAD_lock_free(err_string_lock);
    err_string_lock = NULL;
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    lh_ERR_STRING_DATA_free(int_error_hash);
    int_error_hash = NULL;
}

/*
 * Legacy; pack in the library.
 */
static void err_patch(int lib, ERR_STRING_DATA *str)
{
    unsigned long plib = ERR_PACK(lib, 0, 0);

    for (; str->error != 0; str++)
        str->error |= plib;
}

/*
 * Hash in |str| error strings. Assumes the URN_ONCE was done.
 */
static int err_load_strings(const ERR_STRING_DATA *str)
{
    CRYPTO_THREAD_write_lock(err_string_lock);
    for (; str->error; str++)
        (void)lh_ERR_STRING_DATA_insert(int_error_hash,
                                       (ERR_STRING_DATA *)str);
    CRYPTO_THREAD_unlock(err_string_lock);
    return 1;
307 308
}

309
int ERR_load_ERR_strings(void)
310
{
311
#ifndef OPENSSL_NO_ERR
312 313
    if (!RUN_ONCE(&err_string_init, do_err_strings_init))
        return 0;
314

315 316 317 318
    err_load_strings(ERR_str_libraries);
    err_load_strings(ERR_str_reasons);
    err_patch(ERR_LIB_SYS, ERR_str_functs);
    err_load_strings(ERR_str_functs);
319
    build_SYS_str_reasons();
320
#endif
321
    return 1;
322
}
323

324
int ERR_load_strings(int lib, ERR_STRING_DATA *str)
325
{
326 327 328 329 330 331
    if (ERR_load_ERR_strings() == 0)
        return 0;

    err_patch(lib, str);
    err_load_strings(str);
    return 1;
332
}
333

334
int ERR_load_strings_const(const ERR_STRING_DATA *str)
335
{
336 337
    if (ERR_load_ERR_strings() == 0)
        return 0;
338
    err_load_strings(str);
339
    return 1;
340
}
341

342
int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
343
{
344 345
    if (!RUN_ONCE(&err_string_init, do_err_strings_init))
        return 0;
346 347

    CRYPTO_THREAD_write_lock(err_string_lock);
348 349 350 351 352 353
    /*
     * We don't need to ERR_PACK the lib, since that was done (to
     * the table) when it was loaded.
     */
    for (; str->error; str++)
        (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
354
    CRYPTO_THREAD_unlock(err_string_lock);
355 356

    return 1;
357
}
358

359
void err_free_strings_int(void)
360
{
361 362
    if (!RUN_ONCE(&err_string_init, do_err_strings_init))
        return;
363
}
364

365 366
/********************************************************/

367 368 369
void ERR_put_error(int lib, int func, int reason, const char *file, int line)
{
    ERR_STATE *es;
370

371
#ifdef _OSD_POSIX
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    /*
     * In the BS2000-OSD POSIX subsystem, the compiler generates path names
     * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
     * something sensible. @@@ We shouldn't modify a const string, though.
     */
    if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
        char *end;

        /* Skip the "*POSIX(" prefix */
        file += sizeof("*POSIX(") - 1;
        end = &file[strlen(file) - 1];
        if (*end == ')')
            *end = '\0';
        /* Optional: use the basename of the path only. */
        if ((end = strrchr(file, '/')) != NULL)
            file = &end[1];
    }
389
#endif
390
    es = ERR_get_state();
391 392
    if (es == NULL)
        return;
393 394 395 396 397 398 399 400 401 402

    es->top = (es->top + 1) % ERR_NUM_ERRORS;
    if (es->top == es->bottom)
        es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
    es->err_flags[es->top] = 0;
    es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
    es->err_file[es->top] = file;
    es->err_line[es->top] = line;
    err_clear_data(es, es->top);
}
403

U
Ulf Möller 已提交
404
void ERR_clear_error(void)
405 406 407
{
    int i;
    ERR_STATE *es;
408

409
    es = ERR_get_state();
410 411
    if (es == NULL)
        return;
412

413 414 415 416 417
    for (i = 0; i < ERR_NUM_ERRORS; i++) {
        err_clear(es, i);
    }
    es->top = es->bottom = 0;
}
418

U
Ulf Möller 已提交
419
unsigned long ERR_get_error(void)
420 421 422
{
    return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
}
423

424 425 426 427
unsigned long ERR_get_error_line(const char **file, int *line)
{
    return (get_error_values(1, 0, file, line, NULL, NULL));
}
428

U
Ulf Möller 已提交
429
unsigned long ERR_get_error_line_data(const char **file, int *line,
430 431 432 433
                                      const char **data, int *flags)
{
    return (get_error_values(1, 0, file, line, data, flags));
}
B
Bodo Möller 已提交
434

U
Ulf Möller 已提交
435
unsigned long ERR_peek_error(void)
436 437 438
{
    return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
}
439

B
Bodo Möller 已提交
440
unsigned long ERR_peek_error_line(const char **file, int *line)
441 442 443
{
    return (get_error_values(0, 0, file, line, NULL, NULL));
}
444

U
Ulf Möller 已提交
445
unsigned long ERR_peek_error_line_data(const char **file, int *line,
446 447 448 449
                                       const char **data, int *flags)
{
    return (get_error_values(0, 0, file, line, data, flags));
}
B
Bodo Möller 已提交
450 451

unsigned long ERR_peek_last_error(void)
452 453 454
{
    return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
}
B
Bodo Möller 已提交
455 456

unsigned long ERR_peek_last_error_line(const char **file, int *line)
457 458 459
{
    return (get_error_values(0, 1, file, line, NULL, NULL));
}
B
Bodo Möller 已提交
460

B
Bodo Möller 已提交
461
unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
462 463 464 465 466 467 468 469 470 471 472 473 474 475
                                            const char **data, int *flags)
{
    return (get_error_values(0, 1, file, line, data, flags));
}

static unsigned long get_error_values(int inc, int top, const char **file,
                                      int *line, const char **data,
                                      int *flags)
{
    int i = 0;
    ERR_STATE *es;
    unsigned long ret;

    es = ERR_get_state();
476 477
    if (es == NULL)
        return 0;
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

    if (inc && top) {
        if (file)
            *file = "";
        if (line)
            *line = 0;
        if (data)
            *data = "";
        if (flags)
            *flags = 0;

        return ERR_R_INTERNAL_ERROR;
    }

    if (es->bottom == es->top)
        return 0;
    if (top)
        i = es->top;            /* last error */
    else
        i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */

    ret = es->err_buffer[i];
    if (inc) {
        es->bottom = i;
        es->err_buffer[i] = 0;
    }

    if ((file != NULL) && (line != NULL)) {
        if (es->err_file[i] == NULL) {
            *file = "NA";
            if (line != NULL)
                *line = 0;
        } else {
            *file = es->err_file[i];
            if (line != NULL)
                *line = es->err_line[i];
        }
    }

    if (data == NULL) {
        if (inc) {
            err_clear_data(es, i);
        }
    } else {
        if (es->err_data[i] == NULL) {
            *data = "";
            if (flags != NULL)
                *flags = 0;
        } else {
            *data = es->err_data[i];
            if (flags != NULL)
                *flags = es->err_data_flags[i];
        }
    }
    return ret;
}
534

B
Bodo Möller 已提交
535
void ERR_error_string_n(unsigned long e, char *buf, size_t len)
536 537 538 539 540
{
    char lsbuf[64], fsbuf[64], rsbuf[64];
    const char *ls, *fs, *rs;
    unsigned long l, f, r;

541 542 543
    if (len == 0)
        return;

544 545
    l = ERR_GET_LIB(e);
    ls = ERR_lib_error_string(e);
R
Rich Salz 已提交
546
    if (ls == NULL) {
547
        BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
R
Rich Salz 已提交
548 549 550 551 552 553
        ls = lsbuf;
    }

    fs = ERR_func_error_string(e);
    f = ERR_GET_FUNC(e);
    if (fs == NULL) {
554
        BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
R
Rich Salz 已提交
555 556 557 558 559 560
        fs = fsbuf;
    }

    rs = ERR_reason_error_string(e);
    r = ERR_GET_REASON(e);
    if (rs == NULL) {
561
        BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
R
Rich Salz 已提交
562 563
        rs = rsbuf;
    }
564

R
Rich Salz 已提交
565
    BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs);
566
    if (strlen(buf) == len - 1) {
R
Rich Salz 已提交
567 568
        /* Didn't fit; use a minimal format. */
        BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
569 570
    }
}
B
Bodo Möller 已提交
571

572 573 574 575
/*
 * ERR_error_string_n should be used instead for ret != NULL as
 * ERR_error_string cannot know how large the buffer is
 */
B
Bodo Möller 已提交
576
char *ERR_error_string(unsigned long e, char *ret)
577 578
{
    static char buf[256];
B
Bodo Möller 已提交
579

580 581
    if (ret == NULL)
        ret = buf;
R
Rich Salz 已提交
582
    ERR_error_string_n(e, ret, (int)sizeof(buf));
583 584
    return ret;
}
585

U
Ulf Möller 已提交
586
const char *ERR_lib_error_string(unsigned long e)
587 588 589
{
    ERR_STRING_DATA d, *p;
    unsigned long l;
590

591 592 593
    if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
        return NULL;
    }
594

595 596
    l = ERR_GET_LIB(e);
    d.error = ERR_PACK(l, 0, 0);
R
Rich Salz 已提交
597
    p = int_err_get_item(&d);
598 599
    return ((p == NULL) ? NULL : p->string);
}
600

U
Ulf Möller 已提交
601
const char *ERR_func_error_string(unsigned long e)
602 603 604 605
{
    ERR_STRING_DATA d, *p;
    unsigned long l, f;

606 607 608
    if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
        return NULL;
    }
609

610 611 612
    l = ERR_GET_LIB(e);
    f = ERR_GET_FUNC(e);
    d.error = ERR_PACK(l, f, 0);
R
Rich Salz 已提交
613
    p = int_err_get_item(&d);
614 615
    return ((p == NULL) ? NULL : p->string);
}
616

U
Ulf Möller 已提交
617
const char *ERR_reason_error_string(unsigned long e)
618 619 620 621
{
    ERR_STRING_DATA d, *p = NULL;
    unsigned long l, r;

622 623 624
    if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
        return NULL;
    }
625

626 627 628
    l = ERR_GET_LIB(e);
    r = ERR_GET_REASON(e);
    d.error = ERR_PACK(l, 0, r);
R
Rich Salz 已提交
629
    p = int_err_get_item(&d);
630 631
    if (!p) {
        d.error = ERR_PACK(0, 0, r);
R
Rich Salz 已提交
632
        p = int_err_get_item(&d);
633 634 635
    }
    return ((p == NULL) ? NULL : p->string);
}
636

637
void err_delete_thread_state(void)
638
{
639
    ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
640 641
    if (state == NULL)
        return;
642

643 644
    CRYPTO_THREAD_set_local(&err_thread_local, NULL);
    ERR_STATE_free(state);
645
}
646

647
#if OPENSSL_API_COMPAT < 0x10100000L
648 649 650 651 652
void ERR_remove_thread_state(void *dummy)
{
}
#endif

653
#if OPENSSL_API_COMPAT < 0x10000000L
654
void ERR_remove_state(unsigned long pid)
655 656
{
}
657 658
#endif

659
DEFINE_RUN_ONCE_STATIC(err_do_init)
660
{
661
    set_err_thread_local = 1;
662
    return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
663 664
}

U
Ulf Möller 已提交
665
ERR_STATE *ERR_get_state(void)
666
{
667 668
    ERR_STATE *state = NULL;

669 670
    if (!RUN_ONCE(&err_init, err_do_init))
        return NULL;
671 672 673 674 675 676 677 678

    state = CRYPTO_THREAD_get_local(&err_thread_local);

    if (state == NULL) {
        state = OPENSSL_zalloc(sizeof(*state));
        if (state == NULL)
            return NULL;

679 680
        if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
            || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
681 682
            ERR_STATE_free(state);
            return NULL;
683
        }
684 685

        /* Ignore failures from these */
686
        OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
687
    }
688 689

    return state;
690
}
691

U
Ulf Möller 已提交
692
int ERR_get_next_error_library(void)
693
{
R
Rich Salz 已提交
694 695
    int ret;

696 697 698
    if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
        return 0;
    }
699 700

    CRYPTO_THREAD_write_lock(err_string_lock);
R
Rich Salz 已提交
701
    ret = int_err_library_number++;
702
    CRYPTO_THREAD_unlock(err_string_lock);
R
Rich Salz 已提交
703
    return ret;
704
}
705

U
Ulf Möller 已提交
706
void ERR_set_error_data(char *data, int flags)
707 708 709
{
    ERR_STATE *es;
    int i;
710

711
    es = ERR_get_state();
712 713
    if (es == NULL)
        return;
714

715
    i = es->top;
716

717 718 719 720
    err_clear_data(es, i);
    es->err_data[i] = data;
    es->err_data_flags[i] = flags;
}
721

U
Ulf Möller 已提交
722
void ERR_add_error_data(int num, ...)
723 724 725 726 727 728
{
    va_list args;
    va_start(args, num);
    ERR_add_error_vdata(num, args);
    va_end(args);
}
729 730

void ERR_add_error_vdata(int num, va_list args)
731 732 733 734 735 736 737 738 739 740 741 742 743
{
    int i, n, s;
    char *str, *p, *a;

    s = 80;
    str = OPENSSL_malloc(s + 1);
    if (str == NULL)
        return;
    str[0] = '\0';

    n = 0;
    for (i = 0; i < num; i++) {
        a = va_arg(args, char *);
R
Rich Salz 已提交
744 745
        if (a == NULL)
            a = "<NULL>";
R
Rich Salz 已提交
746 747 748 749 750 751 752
        n += strlen(a);
        if (n > s) {
            s = n + 20;
            p = OPENSSL_realloc(str, s + 1);
            if (p == NULL) {
                OPENSSL_free(str);
                return;
753
            }
R
Rich Salz 已提交
754
            str = p;
755
        }
R
Rich Salz 已提交
756
        OPENSSL_strlcat(str, a, (size_t)s + 1);
757 758 759
    }
    ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
}
760 761

int ERR_set_mark(void)
762 763
{
    ERR_STATE *es;
764

765
    es = ERR_get_state();
766 767
    if (es == NULL)
        return 0;
768

769 770 771 772 773
    if (es->bottom == es->top)
        return 0;
    es->err_flags[es->top] |= ERR_FLAG_MARK;
    return 1;
}
774 775

int ERR_pop_to_mark(void)
776 777 778 779
{
    ERR_STATE *es;

    es = ERR_get_state();
780 781
    if (es == NULL)
        return 0;
782 783 784 785

    while (es->bottom != es->top
           && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
        err_clear(es, es->top);
A
Andy Polyakov 已提交
786
        es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
787 788 789 790 791 792 793
    }

    if (es->bottom == es->top)
        return 0;
    es->err_flags[es->top] &= ~ERR_FLAG_MARK;
    return 1;
}
R
Richard Levitte 已提交
794 795 796 797 798 799 800 801 802 803 804 805 806

int ERR_clear_last_mark(void)
{
    ERR_STATE *es;
    int top;

    es = ERR_get_state();
    if (es == NULL)
        return 0;

    top = es->top;
    while (es->bottom != top
           && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
A
Andy Polyakov 已提交
807
        top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
R
Richard Levitte 已提交
808 809 810 811 812 813 814
    }

    if (es->bottom == top)
        return 0;
    es->err_flags[top] &= ~ERR_FLAG_MARK;
    return 1;
}