eca0f6d33e79a8830019f3ffdead3c4cc70a97a9
[openssl.git] / crypto / err / err.c
1 /*
2  * Copyright 1995-2018 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 <stdarg.h>
15 #include <string.h>
16 #include "crypto/cryptlib.h"
17 #include "internal/err.h"
18 #include "crypto/err.h"
19 #include <openssl/err.h>
20 #include <openssl/crypto.h>
21 #include <openssl/buffer.h>
22 #include <openssl/bio.h>
23 #include <openssl/opensslconf.h>
24 #include "internal/thread_once.h"
25 #include "crypto/ctype.h"
26 #include "internal/constant_time.h"
27 #include "e_os.h"
28 #include "err_local.h"
29
30 /* Forward declaration in case it's not published because of configuration */
31 ERR_STATE *ERR_get_state(void);
32
33 static int err_load_strings(const ERR_STRING_DATA *str);
34
35 static void ERR_STATE_free(ERR_STATE *s);
36 #ifndef OPENSSL_NO_ERR
37 static ERR_STRING_DATA ERR_str_libraries[] = {
38     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
39     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
40     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
41     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
42     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
43     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
44     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
45     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
46     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
47     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
48     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
49     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
50     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
51     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
52     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
53     {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
54     {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
55     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
56     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
57     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
58     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
59     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
60     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
61     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
62     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
63     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
64     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
65     {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
66     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
67     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
68     {ERR_PACK(ERR_LIB_CRMF, 0, 0), "CRMF routines"},
69     {ERR_PACK(ERR_LIB_CMP, 0, 0), "CMP routines"},
70     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
71     {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
72     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
73     {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"},
74     {ERR_PACK(ERR_LIB_SM2, 0, 0), "SM2 routines"},
75     {ERR_PACK(ERR_LIB_ESS, 0, 0), "ESS routines"},
76     {ERR_PACK(ERR_LIB_PROV, 0, 0), "Provider routines"},
77     {0, NULL},
78 };
79
80 static ERR_STRING_DATA ERR_str_reasons[] = {
81     {ERR_R_SYS_LIB, "system lib"},
82     {ERR_R_BN_LIB, "BN lib"},
83     {ERR_R_RSA_LIB, "RSA lib"},
84     {ERR_R_DH_LIB, "DH lib"},
85     {ERR_R_EVP_LIB, "EVP lib"},
86     {ERR_R_BUF_LIB, "BUF lib"},
87     {ERR_R_OBJ_LIB, "OBJ lib"},
88     {ERR_R_PEM_LIB, "PEM lib"},
89     {ERR_R_DSA_LIB, "DSA lib"},
90     {ERR_R_X509_LIB, "X509 lib"},
91     {ERR_R_ASN1_LIB, "ASN1 lib"},
92     {ERR_R_EC_LIB, "EC lib"},
93     {ERR_R_BIO_LIB, "BIO lib"},
94     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
95     {ERR_R_X509V3_LIB, "X509V3 lib"},
96     {ERR_R_ENGINE_LIB, "ENGINE lib"},
97     {ERR_R_UI_LIB, "UI lib"},
98     {ERR_R_OSSL_STORE_LIB, "STORE lib"},
99     {ERR_R_ECDSA_LIB, "ECDSA lib"},
100
101     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
102     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
103
104     {ERR_R_FATAL, "fatal"},
105     {ERR_R_MALLOC_FAILURE, "malloc failure"},
106     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
107      "called a function you should not call"},
108     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
109     {ERR_R_INTERNAL_ERROR, "internal error"},
110     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
111     {ERR_R_INIT_FAIL, "init fail"},
112     {ERR_R_OPERATION_FAIL, "operation fail"},
113
114     {0, NULL},
115 };
116 #endif
117
118 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
119 static int set_err_thread_local;
120 static CRYPTO_THREAD_LOCAL err_thread_local;
121
122 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
123 static CRYPTO_RWLOCK *err_string_lock;
124
125 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
126
127 /*
128  * The internal state
129  */
130
131 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
132 static int int_err_library_number = ERR_LIB_USER;
133
134 typedef enum ERR_GET_ACTION_e {
135     EV_POP, EV_PEEK, EV_PEEK_LAST
136 } ERR_GET_ACTION;
137
138 static unsigned long get_error_values(ERR_GET_ACTION g,
139                                       const char **file, int *line,
140                                       const char **func, const char **data,
141                                       int *flags);
142
143 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
144 {
145     unsigned long ret, l;
146
147     l = a->error;
148     ret = l ^ ERR_GET_LIB(l);
149     return (ret ^ ret % 19 * 13);
150 }
151
152 static int err_string_data_cmp(const ERR_STRING_DATA *a,
153                                const ERR_STRING_DATA *b)
154 {
155     if (a->error == b->error)
156         return 0;
157     return a->error > b->error ? 1 : -1;
158 }
159
160 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
161 {
162     ERR_STRING_DATA *p = NULL;
163
164     CRYPTO_THREAD_read_lock(err_string_lock);
165     p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
166     CRYPTO_THREAD_unlock(err_string_lock);
167
168     return p;
169 }
170
171 #ifndef OPENSSL_NO_ERR
172 /* 2019-05-21: Russian and Ukrainian locales on Linux require more than 6,5 kB */
173 # define SPACE_SYS_STR_REASONS 8 * 1024
174 # define NUM_SYS_STR_REASONS 127
175
176 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
177 /*
178  * SYS_str_reasons is filled with copies of strerror() results at
179  * initialization. 'errno' values up to 127 should cover all usual errors,
180  * others will be displayed numerically by ERR_error_string. It is crucial
181  * that we have something for each reason code that occurs in
182  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
183  * which always gets an errno value and never one of those 'standard' reason
184  * codes.
185  */
186
187 static void build_SYS_str_reasons(void)
188 {
189     /* OPENSSL_malloc cannot be used here, use static storage instead */
190     static char strerror_pool[SPACE_SYS_STR_REASONS];
191     char *cur = strerror_pool;
192     size_t cnt = 0;
193     static int init = 1;
194     int i;
195     int saveerrno = get_last_sys_error();
196
197     CRYPTO_THREAD_write_lock(err_string_lock);
198     if (!init) {
199         CRYPTO_THREAD_unlock(err_string_lock);
200         return;
201     }
202
203     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
204         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
205
206         str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
207         /*
208          * If we have used up all the space in strerror_pool,
209          * there's no point in calling openssl_strerror_r()
210          */
211         if (str->string == NULL && cnt < sizeof(strerror_pool)) {
212             if (openssl_strerror_r(i, cur, sizeof(strerror_pool) - cnt)) {
213                 size_t l = strlen(cur);
214
215                 str->string = cur;
216                 cnt += l;
217                 cur += l;
218
219                 /*
220                  * VMS has an unusual quirk of adding spaces at the end of
221                  * some (most? all?) messages. Lets trim them off.
222                  */
223                 while (cur > strerror_pool && ossl_isspace(cur[-1])) {
224                     cur--;
225                     cnt--;
226                 }
227                 *cur++ = '\0';
228                 cnt++;
229             }
230         }
231         if (str->string == NULL)
232             str->string = "unknown";
233     }
234
235     /*
236      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
237      * required by ERR_load_strings.
238      */
239
240     init = 0;
241
242     CRYPTO_THREAD_unlock(err_string_lock);
243     /* openssl_strerror_r could change errno, but we want to preserve it */
244     set_sys_error(saveerrno);
245     err_load_strings(SYS_str_reasons);
246 }
247 #endif
248
249 static void ERR_STATE_free(ERR_STATE *s)
250 {
251     int i;
252
253     if (s == NULL)
254         return;
255     for (i = 0; i < ERR_NUM_ERRORS; i++) {
256         err_clear_data(s, i, 1);
257     }
258     OPENSSL_free(s);
259 }
260
261 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
262 {
263     if (!OPENSSL_init_crypto(0, NULL))
264         return 0;
265     err_string_lock = CRYPTO_THREAD_lock_new();
266     if (err_string_lock == NULL)
267         return 0;
268     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
269                                             err_string_data_cmp);
270     if (int_error_hash == NULL) {
271         CRYPTO_THREAD_lock_free(err_string_lock);
272         err_string_lock = NULL;
273         return 0;
274     }
275     return 1;
276 }
277
278 void err_cleanup(void)
279 {
280     if (set_err_thread_local != 0)
281         CRYPTO_THREAD_cleanup_local(&err_thread_local);
282     CRYPTO_THREAD_lock_free(err_string_lock);
283     err_string_lock = NULL;
284     lh_ERR_STRING_DATA_free(int_error_hash);
285     int_error_hash = NULL;
286 }
287
288 /*
289  * Legacy; pack in the library.
290  */
291 static void err_patch(int lib, ERR_STRING_DATA *str)
292 {
293     unsigned long plib = ERR_PACK(lib, 0, 0);
294
295     for (; str->error != 0; str++)
296         str->error |= plib;
297 }
298
299 /*
300  * Hash in |str| error strings. Assumes the URN_ONCE was done.
301  */
302 static int err_load_strings(const ERR_STRING_DATA *str)
303 {
304     CRYPTO_THREAD_write_lock(err_string_lock);
305     for (; str->error; str++)
306         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
307                                        (ERR_STRING_DATA *)str);
308     CRYPTO_THREAD_unlock(err_string_lock);
309     return 1;
310 }
311
312 int ERR_load_ERR_strings(void)
313 {
314 #ifndef OPENSSL_NO_ERR
315     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
316         return 0;
317
318     err_load_strings(ERR_str_libraries);
319     err_load_strings(ERR_str_reasons);
320     build_SYS_str_reasons();
321 #endif
322     return 1;
323 }
324
325 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
326 {
327     if (ERR_load_ERR_strings() == 0)
328         return 0;
329
330     err_patch(lib, str);
331     err_load_strings(str);
332     return 1;
333 }
334
335 int ERR_load_strings_const(const ERR_STRING_DATA *str)
336 {
337     if (ERR_load_ERR_strings() == 0)
338         return 0;
339     err_load_strings(str);
340     return 1;
341 }
342
343 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
344 {
345     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
346         return 0;
347
348     CRYPTO_THREAD_write_lock(err_string_lock);
349     /*
350      * We don't need to ERR_PACK the lib, since that was done (to
351      * the table) when it was loaded.
352      */
353     for (; str->error; str++)
354         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
355     CRYPTO_THREAD_unlock(err_string_lock);
356
357     return 1;
358 }
359
360 void err_free_strings_int(void)
361 {
362     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
363         return;
364 }
365
366 /********************************************************/
367
368 void ERR_clear_error(void)
369 {
370     int i;
371     ERR_STATE *es;
372
373     es = err_get_state_int();
374     if (es == NULL)
375         return;
376
377     for (i = 0; i < ERR_NUM_ERRORS; i++) {
378         err_clear(es, i, 0);
379     }
380     es->top = es->bottom = 0;
381 }
382
383 unsigned long ERR_get_error(void)
384 {
385     return get_error_values(EV_POP, NULL, NULL, NULL, NULL, NULL);
386 }
387
388 unsigned long ERR_get_error_line(const char **file, int *line)
389 {
390     return get_error_values(EV_POP, file, line, NULL, NULL, NULL);
391 }
392
393 unsigned long ERR_get_error_func(const char **func)
394 {
395     return get_error_values(EV_POP, NULL, NULL, func, NULL, NULL);
396 }
397
398 unsigned long ERR_get_error_data(const char **data, int *flags)
399 {
400     return get_error_values(EV_POP, NULL, NULL, NULL, data, flags);
401 }
402
403 unsigned long ERR_get_error_all(const char **file, int *line,
404                                 const char **func,
405                                 const char **data, int *flags)
406 {
407     return get_error_values(EV_POP, file, line, func, data, flags);
408 }
409
410 #if !OPENSSL_API_3
411 unsigned long ERR_get_error_line_data(const char **file, int *line,
412                                       const char **data, int *flags)
413 {
414     return get_error_values(EV_POP, file, line, NULL, data, flags);
415 }
416 #endif
417
418 unsigned long ERR_peek_error(void)
419 {
420     return get_error_values(EV_PEEK, NULL, NULL, NULL, NULL, NULL);
421 }
422
423 unsigned long ERR_peek_error_line(const char **file, int *line)
424 {
425     return get_error_values(EV_PEEK, file, line, NULL, NULL, NULL);
426 }
427
428 unsigned long ERR_peek_error_func(const char **func)
429 {
430     return get_error_values(EV_PEEK, NULL, NULL, func, NULL, NULL);
431 }
432
433 unsigned long ERR_peek_error_data(const char **data, int *flags)
434 {
435     return get_error_values(EV_PEEK, NULL, NULL, NULL, data, flags);
436 }
437
438 unsigned long ERR_peek_error_all(const char **file, int *line,
439                                  const char **func,
440                                  const char **data, int *flags)
441 {
442     return get_error_values(EV_PEEK, file, line, func, data, flags);
443 }
444
445 #if !OPENSSL_API_3
446 unsigned long ERR_peek_error_line_data(const char **file, int *line,
447                                        const char **data, int *flags)
448 {
449     return get_error_values(EV_PEEK, file, line, NULL, data, flags);
450 }
451 #endif
452
453 unsigned long ERR_peek_last_error(void)
454 {
455     return get_error_values(EV_PEEK_LAST, NULL, NULL, NULL, NULL, NULL);
456 }
457
458 unsigned long ERR_peek_last_error_line(const char **file, int *line)
459 {
460     return get_error_values(EV_PEEK_LAST, file, line, NULL, NULL, NULL);
461 }
462
463 unsigned long ERR_peek_last_error_func(const char **func)
464 {
465     return get_error_values(EV_PEEK_LAST, NULL, NULL, func, NULL, NULL);
466 }
467
468 unsigned long ERR_peek_last_error_data(const char **data, int *flags)
469 {
470     return get_error_values(EV_PEEK_LAST, NULL, NULL, NULL, data, flags);
471 }
472
473 unsigned long ERR_peek_last_error_all(const char **file, int *line,
474                                       const char **func,
475                                       const char **data, int *flags)
476 {
477     return get_error_values(EV_PEEK_LAST, file, line, func, data, flags);
478 }
479
480 #if !OPENSSL_API_3
481 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
482                                             const char **data, int *flags)
483 {
484     return get_error_values(EV_PEEK_LAST, file, line, NULL, data, flags);
485 }
486 #endif
487
488 static unsigned long get_error_values(ERR_GET_ACTION g,
489                                       const char **file, int *line,
490                                       const char **func,
491                                       const char **data, int *flags)
492 {
493     int i = 0;
494     ERR_STATE *es;
495     unsigned long ret;
496
497     es = err_get_state_int();
498     if (es == NULL)
499         return 0;
500
501     /*
502      * Clear anything that should have been cleared earlier. We do this
503      * here because this doesn't have constant-time issues.
504      */
505     while (es->bottom != es->top) {
506         if (es->err_flags[es->top] & ERR_FLAG_CLEAR) {
507             err_clear(es, es->top, 0);
508             es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
509             continue;
510         }
511         i = (es->bottom + 1) % ERR_NUM_ERRORS;
512         if (es->err_flags[i] & ERR_FLAG_CLEAR) {
513             es->bottom = i;
514             err_clear(es, es->bottom, 0);
515             continue;
516         }
517         break;
518     }
519
520     /* If everything has been cleared, the stack is empty. */
521     if (es->bottom == es->top)
522         return 0;
523
524     /* Which error, the top of stack (latest one) or the first one? */
525     if (g == EV_PEEK_LAST)
526         i = es->top;
527     else
528         i = (es->bottom + 1) % ERR_NUM_ERRORS;
529
530     ret = es->err_buffer[i];
531     if (g == EV_POP) {
532         es->bottom = i;
533         es->err_buffer[i] = 0;
534     }
535
536     if (file != NULL && line != NULL) {
537         if (es->err_file[i] == NULL) {
538             *file = "NA";
539             *line = 0;
540         } else {
541             *file = es->err_file[i];
542             *line = es->err_line[i];
543         }
544     }
545
546     if (func != NULL) {
547         *func = es->err_func[i];
548         if (*func == NULL)
549             *func = "N/A";
550     }
551
552     if (data == NULL) {
553         if (g == EV_POP) {
554             err_clear_data(es, i, 0);
555         }
556     } else {
557         if (es->err_data[i] == NULL) {
558             *data = "";
559             if (flags != NULL)
560                 *flags = 0;
561         } else {
562             *data = es->err_data[i];
563             if (flags != NULL)
564                 *flags = es->err_data_flags[i];
565         }
566     }
567     return ret;
568 }
569
570 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
571 {
572     char lsbuf[64], rsbuf[64];
573     const char *ls, *rs;
574     unsigned long f = 0, l, r;
575
576     if (len == 0)
577         return;
578
579     l = ERR_GET_LIB(e);
580     ls = ERR_lib_error_string(e);
581     if (ls == NULL) {
582         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
583         ls = lsbuf;
584     }
585
586     rs = ERR_reason_error_string(e);
587     r = ERR_GET_REASON(e);
588     if (rs == NULL) {
589         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
590         rs = rsbuf;
591     }
592
593     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, "", rs);
594     if (strlen(buf) == len - 1) {
595         /* Didn't fit; use a minimal format. */
596         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
597     }
598 }
599
600 /*
601  * ERR_error_string_n should be used instead for ret != NULL as
602  * ERR_error_string cannot know how large the buffer is
603  */
604 char *ERR_error_string(unsigned long e, char *ret)
605 {
606     static char buf[256];
607
608     if (ret == NULL)
609         ret = buf;
610     ERR_error_string_n(e, ret, (int)sizeof(buf));
611     return ret;
612 }
613
614 const char *ERR_lib_error_string(unsigned long e)
615 {
616     ERR_STRING_DATA d, *p;
617     unsigned long l;
618
619     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
620         return NULL;
621     }
622
623     l = ERR_GET_LIB(e);
624     d.error = ERR_PACK(l, 0, 0);
625     p = int_err_get_item(&d);
626     return ((p == NULL) ? NULL : p->string);
627 }
628
629 #if !OPENSSL_API_3
630 const char *ERR_func_error_string(unsigned long e)
631 {
632     return NULL;
633 }
634 #endif
635
636 const char *ERR_reason_error_string(unsigned long e)
637 {
638     ERR_STRING_DATA d, *p = NULL;
639     unsigned long l, r;
640
641     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
642         return NULL;
643     }
644
645     l = ERR_GET_LIB(e);
646     r = ERR_GET_REASON(e);
647     d.error = ERR_PACK(l, 0, r);
648     p = int_err_get_item(&d);
649     if (!p) {
650         d.error = ERR_PACK(0, 0, r);
651         p = int_err_get_item(&d);
652     }
653     return ((p == NULL) ? NULL : p->string);
654 }
655
656 /* TODO(3.0): arg ignored for now */
657 static void err_delete_thread_state(void *arg)
658 {
659     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
660     if (state == NULL)
661         return;
662
663     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
664     ERR_STATE_free(state);
665 }
666
667 #if !OPENSSL_API_1_1_0
668 void ERR_remove_thread_state(void *dummy)
669 {
670 }
671 #endif
672
673 #if !OPENSSL_API_1_0_0
674 void ERR_remove_state(unsigned long pid)
675 {
676 }
677 #endif
678
679 DEFINE_RUN_ONCE_STATIC(err_do_init)
680 {
681     set_err_thread_local = 1;
682     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
683 }
684
685 ERR_STATE *err_get_state_int(void)
686 {
687     ERR_STATE *state;
688     int saveerrno = get_last_sys_error();
689
690     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
691         return NULL;
692
693     if (!RUN_ONCE(&err_init, err_do_init))
694         return NULL;
695
696     state = CRYPTO_THREAD_get_local(&err_thread_local);
697     if (state == (ERR_STATE*)-1)
698         return NULL;
699
700     if (state == NULL) {
701         if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
702             return NULL;
703
704         if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) {
705             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
706             return NULL;
707         }
708
709         if (!ossl_init_thread_start(NULL, NULL, err_delete_thread_state)
710                 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
711             ERR_STATE_free(state);
712             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
713             return NULL;
714         }
715
716         /* Ignore failures from these */
717         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
718     }
719
720     set_sys_error(saveerrno);
721     return state;
722 }
723
724 #if !OPENSSL_API_3
725 ERR_STATE *ERR_get_state(void)
726 {
727     return err_get_state_int();
728 }
729 #endif
730
731
732 /*
733  * err_shelve_state returns the current thread local error state
734  * and freezes the error module until err_unshelve_state is called.
735  */
736 int err_shelve_state(void **state)
737 {
738     int saveerrno = get_last_sys_error();
739
740     /*
741      * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
742      * via ossl_init_load_crypto_nodelete(), by which point the requested
743      * "base" initialization has already been performed, so the below call is a
744      * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
745      *
746      * If are no other valid callers of this function, the call below can be
747      * removed, avoiding the re-entry into OPENSSL_init_crypto().  If there are
748      * potential uses that are not from inside OPENSSL_init_crypto(), then this
749      * call is needed, but some care is required to make sure that the re-entry
750      * remains a NOOP.
751      */
752     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
753         return 0;
754
755     if (!RUN_ONCE(&err_init, err_do_init))
756         return 0;
757
758     *state = CRYPTO_THREAD_get_local(&err_thread_local);
759     if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
760         return 0;
761
762     set_sys_error(saveerrno);
763     return 1;
764 }
765
766 /*
767  * err_unshelve_state restores the error state that was returned
768  * by err_shelve_state previously.
769  */
770 void err_unshelve_state(void* state)
771 {
772     if (state != (void*)-1)
773         CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state);
774 }
775
776 int ERR_get_next_error_library(void)
777 {
778     int ret;
779
780     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
781         return 0;
782
783     CRYPTO_THREAD_write_lock(err_string_lock);
784     ret = int_err_library_number++;
785     CRYPTO_THREAD_unlock(err_string_lock);
786     return ret;
787 }
788
789 static int err_set_error_data_int(char *data, size_t size, int flags,
790                                   int deallocate)
791 {
792     ERR_STATE *es;
793
794     es = err_get_state_int();
795     if (es == NULL)
796         return 0;
797
798     err_clear_data(es, es->top, deallocate);
799     err_set_data(es, es->top, data, size, flags);
800
801     return 1;
802 }
803
804 void ERR_set_error_data(char *data, int flags)
805 {
806     /*
807      * This function is void so we cannot propagate the error return. Since it
808      * is also in the public API we can't change the return type.
809      *
810      * We estimate the size of the data.  If it's not flagged as allocated,
811      * then this is safe, and if it is flagged as allocated, then our size
812      * may be smaller than the actual allocation, but that doesn't matter
813      * too much, the buffer will remain untouched or will eventually be
814      * reallocated to a new size.
815      *
816      * callers should be advised that this function takes over ownership of
817      * the allocated memory, i.e. they can't count on the pointer to remain
818      * valid.
819      */
820     err_set_error_data_int(data, strlen(data) + 1, flags, 1);
821 }
822
823 void ERR_add_error_data(int num, ...)
824 {
825     va_list args;
826     va_start(args, num);
827     ERR_add_error_vdata(num, args);
828     va_end(args);
829 }
830
831 void ERR_add_error_vdata(int num, va_list args)
832 {
833     int i, len, size;
834     int flags = ERR_TXT_MALLOCED | ERR_TXT_STRING;
835     char *str, *arg;
836     ERR_STATE *es;
837
838     /* Get the current error data; if an allocated string get it. */
839     es = err_get_state_int();
840     if (es == NULL)
841         return;
842     i = es->top;
843
844     /*
845      * If err_data is allocated already, re-use the space.
846      * Otherwise, allocate a small new buffer.
847      */
848     if ((es->err_data_flags[i] & flags) == flags) {
849         str = es->err_data[i];
850         size = es->err_data_size[i];
851
852         /*
853          * To protect the string we just grabbed from tampering by other
854          * functions we may call, or to protect them from freeing a pointer
855          * that may no longer be valid at that point, we clear away the
856          * data pointer and the flags.  We will set them again at the end
857          * of this function.
858          */
859         es->err_data[i] = NULL;
860         es->err_data_flags[i] = 0;
861     } else if ((str = OPENSSL_malloc(size = 81)) == NULL) {
862         return;
863     } else {
864         str[0] = '\0';
865     }
866     len = strlen(str);
867
868     while (--num >= 0) {
869         arg = va_arg(args, char *);
870         if (arg == NULL)
871             arg = "<NULL>";
872         len += strlen(arg);
873         if (len >= size) {
874             char *p;
875
876             size = len + 20;
877             p = OPENSSL_realloc(str, size);
878             if (p == NULL) {
879                 OPENSSL_free(str);
880                 return;
881             }
882             str = p;
883         }
884         OPENSSL_strlcat(str, arg, (size_t)size);
885     }
886     if (!err_set_error_data_int(str, size, flags, 0))
887         OPENSSL_free(str);
888 }
889
890 int ERR_set_mark(void)
891 {
892     ERR_STATE *es;
893
894     es = err_get_state_int();
895     if (es == NULL)
896         return 0;
897
898     if (es->bottom == es->top)
899         return 0;
900     es->err_flags[es->top] |= ERR_FLAG_MARK;
901     return 1;
902 }
903
904 int ERR_pop_to_mark(void)
905 {
906     ERR_STATE *es;
907
908     es = err_get_state_int();
909     if (es == NULL)
910         return 0;
911
912     while (es->bottom != es->top
913            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
914         err_clear(es, es->top, 0);
915         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
916     }
917
918     if (es->bottom == es->top)
919         return 0;
920     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
921     return 1;
922 }
923
924 int ERR_clear_last_mark(void)
925 {
926     ERR_STATE *es;
927     int top;
928
929     es = err_get_state_int();
930     if (es == NULL)
931         return 0;
932
933     top = es->top;
934     while (es->bottom != top
935            && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
936         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
937     }
938
939     if (es->bottom == top)
940         return 0;
941     es->err_flags[top] &= ~ERR_FLAG_MARK;
942     return 1;
943 }
944
945 void err_clear_last_constant_time(int clear)
946 {
947     ERR_STATE *es;
948     int top;
949
950     es = err_get_state_int();
951     if (es == NULL)
952         return;
953
954     top = es->top;
955
956     /*
957      * Flag error as cleared but remove it elsewhere to avoid two errors
958      * accessing the same error stack location, revealing timing information.
959      */
960     clear = constant_time_select_int(constant_time_eq_int(clear, 0),
961                                      0, ERR_FLAG_CLEAR);
962     es->err_flags[top] |= clear;
963 }