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