VMS: fix collected error strings
[openssl.git] / crypto / err / err.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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
24 static int err_load_strings(const ERR_STRING_DATA *str);
25
26 static void ERR_STATE_free(ERR_STATE *s);
27 #ifndef OPENSSL_NO_ERR
28 static ERR_STRING_DATA ERR_str_libraries[] = {
29     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
30     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
31     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
32     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
33     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
34     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
35     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
36     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
37     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
38     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
39     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
40     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
41     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
42     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
43     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
44     {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
45     {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
46     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
47     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
48     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
49     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
50     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
51     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
52     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
53     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
54     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
55     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
56     {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
57     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
58     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
59     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
60     {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
61     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
62     {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
63     {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"},
64     {ERR_PACK(ERR_LIB_SM2, 0, 0), "SM2 routines"},
65     {0, NULL},
66 };
67
68 static ERR_STRING_DATA ERR_str_functs[] = {
69     {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
70     {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
71     {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
72     {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
73     {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
74     {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
75     {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
76     {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
77 # ifdef OPENSSL_SYS_WINDOWS
78     {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
79 # endif
80     {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
81     {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
82     {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
83     {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
84     {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
85     {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
86     {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
87     {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
88     {ERR_PACK(0, SYS_F_FFLUSH, 0), "fflush"},
89     {ERR_PACK(0, SYS_F_OPEN, 0), "open"},
90     {ERR_PACK(0, SYS_F_CLOSE, 0), "close"},
91     {ERR_PACK(0, SYS_F_IOCTL, 0), "ioctl"},
92     {ERR_PACK(0, SYS_F_STAT, 0), "stat"},
93     {ERR_PACK(0, SYS_F_FCNTL, 0), "fcntl"},
94     {ERR_PACK(0, SYS_F_FSTAT, 0), "fstat"},
95     {0, NULL},
96 };
97
98 static ERR_STRING_DATA ERR_str_reasons[] = {
99     {ERR_R_SYS_LIB, "system lib"},
100     {ERR_R_BN_LIB, "BN lib"},
101     {ERR_R_RSA_LIB, "RSA lib"},
102     {ERR_R_DH_LIB, "DH lib"},
103     {ERR_R_EVP_LIB, "EVP lib"},
104     {ERR_R_BUF_LIB, "BUF lib"},
105     {ERR_R_OBJ_LIB, "OBJ lib"},
106     {ERR_R_PEM_LIB, "PEM lib"},
107     {ERR_R_DSA_LIB, "DSA lib"},
108     {ERR_R_X509_LIB, "X509 lib"},
109     {ERR_R_ASN1_LIB, "ASN1 lib"},
110     {ERR_R_EC_LIB, "EC lib"},
111     {ERR_R_BIO_LIB, "BIO lib"},
112     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
113     {ERR_R_X509V3_LIB, "X509V3 lib"},
114     {ERR_R_ENGINE_LIB, "ENGINE lib"},
115     {ERR_R_UI_LIB, "UI lib"},
116     {ERR_R_OSSL_STORE_LIB, "STORE lib"},
117     {ERR_R_ECDSA_LIB, "ECDSA lib"},
118
119     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
120     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
121
122     {ERR_R_FATAL, "fatal"},
123     {ERR_R_MALLOC_FAILURE, "malloc failure"},
124     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
125      "called a function you should not call"},
126     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
127     {ERR_R_INTERNAL_ERROR, "internal error"},
128     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
129     {ERR_R_INIT_FAIL, "init fail"},
130     {ERR_R_OPERATION_FAIL, "operation fail"},
131
132     {0, NULL},
133 };
134 #endif
135
136 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
137 static int set_err_thread_local;
138 static CRYPTO_THREAD_LOCAL err_thread_local;
139
140 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
141 static CRYPTO_RWLOCK *err_string_lock;
142
143 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
144
145 /*
146  * The internal state
147  */
148
149 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
150 static int int_err_library_number = ERR_LIB_USER;
151
152 static unsigned long get_error_values(int inc, int top, const char **file,
153                                       int *line, const char **data,
154                                       int *flags);
155
156 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
157 {
158     unsigned long ret, l;
159
160     l = a->error;
161     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
162     return (ret ^ ret % 19 * 13);
163 }
164
165 static int err_string_data_cmp(const ERR_STRING_DATA *a,
166                                const ERR_STRING_DATA *b)
167 {
168     if (a->error == b->error)
169         return 0;
170     return a->error > b->error ? 1 : -1;
171 }
172
173 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
174 {
175     ERR_STRING_DATA *p = NULL;
176
177     CRYPTO_THREAD_read_lock(err_string_lock);
178     p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
179     CRYPTO_THREAD_unlock(err_string_lock);
180
181     return p;
182 }
183
184 #ifndef OPENSSL_NO_ERR
185 /* A measurement on Linux 2018-11-21 showed about 3.5kib */
186 # define SPACE_SYS_STR_REASONS 4 * 1024
187 # define NUM_SYS_STR_REASONS 127
188
189 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
190 /*
191  * SYS_str_reasons is filled with copies of strerror() results at
192  * initialization. 'errno' values up to 127 should cover all usual errors,
193  * others will be displayed numerically by ERR_error_string. It is crucial
194  * that we have something for each reason code that occurs in
195  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
196  * which always gets an errno value and never one of those 'standard' reason
197  * codes.
198  */
199
200 static void build_SYS_str_reasons(void)
201 {
202     /* OPENSSL_malloc cannot be used here, use static storage instead */
203     static char strerror_pool[SPACE_SYS_STR_REASONS];
204     char *cur = strerror_pool;
205     size_t cnt = 0;
206     static int init = 1;
207     int i;
208
209     CRYPTO_THREAD_write_lock(err_string_lock);
210     if (!init) {
211         CRYPTO_THREAD_unlock(err_string_lock);
212         return;
213     }
214
215     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
216         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
217
218         str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
219         if (str->string == NULL) {
220             if (openssl_strerror_r(i, cur, sizeof(strerror_pool) - cnt)) {
221                 size_t l = strlen(cur);
222
223                 str->string = cur;
224                 cnt += l;
225                 if (cnt > sizeof(strerror_pool))
226                     cnt = sizeof(strerror_pool);
227                 cur += l;
228
229                 /*
230                  * VMS has an unusual quirk of adding spaces at the end of
231                  * some (most? all?) messages.  Lets trim them off.
232                  */
233                 while (ossl_isspace(cur[-1])) {
234                     cur--;
235                     cnt--;
236                 }
237                 *cur++ = '\0';
238                 cnt++;
239             }
240         }
241         if (str->string == NULL)
242             str->string = "unknown";
243     }
244
245     /*
246      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
247      * required by ERR_load_strings.
248      */
249
250     init = 0;
251
252     CRYPTO_THREAD_unlock(err_string_lock);
253     err_load_strings(SYS_str_reasons);
254 }
255 #endif
256
257 #define err_clear_data(p, i) \
258         do { \
259             if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) {\
260                 OPENSSL_free((p)->err_data[i]); \
261                 (p)->err_data[i] = NULL; \
262             } \
263             (p)->err_data_flags[i] = 0; \
264         } while (0)
265
266 #define err_clear(p, i) \
267         do { \
268             err_clear_data(p, i); \
269             (p)->err_flags[i] = 0; \
270             (p)->err_buffer[i] = 0; \
271             (p)->err_file[i] = NULL; \
272             (p)->err_line[i] = -1; \
273         } while (0)
274
275 static void ERR_STATE_free(ERR_STATE *s)
276 {
277     int i;
278
279     if (s == NULL)
280         return;
281     for (i = 0; i < ERR_NUM_ERRORS; i++) {
282         err_clear_data(s, i);
283     }
284     OPENSSL_free(s);
285 }
286
287 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
288 {
289     if (!OPENSSL_init_crypto(0, NULL))
290         return 0;
291     err_string_lock = CRYPTO_THREAD_lock_new();
292     if (err_string_lock == NULL)
293         return 0;
294     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
295                                             err_string_data_cmp);
296     if (int_error_hash == NULL) {
297         CRYPTO_THREAD_lock_free(err_string_lock);
298         err_string_lock = NULL;
299         return 0;
300     }
301     return 1;
302 }
303
304 void err_cleanup(void)
305 {
306     if (set_err_thread_local != 0)
307         CRYPTO_THREAD_cleanup_local(&err_thread_local);
308     CRYPTO_THREAD_lock_free(err_string_lock);
309     err_string_lock = NULL;
310     lh_ERR_STRING_DATA_free(int_error_hash);
311     int_error_hash = NULL;
312 }
313
314 /*
315  * Legacy; pack in the library.
316  */
317 static void err_patch(int lib, ERR_STRING_DATA *str)
318 {
319     unsigned long plib = ERR_PACK(lib, 0, 0);
320
321     for (; str->error != 0; str++)
322         str->error |= plib;
323 }
324
325 /*
326  * Hash in |str| error strings. Assumes the URN_ONCE was done.
327  */
328 static int err_load_strings(const ERR_STRING_DATA *str)
329 {
330     CRYPTO_THREAD_write_lock(err_string_lock);
331     for (; str->error; str++)
332         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
333                                        (ERR_STRING_DATA *)str);
334     CRYPTO_THREAD_unlock(err_string_lock);
335     return 1;
336 }
337
338 int ERR_load_ERR_strings(void)
339 {
340 #ifndef OPENSSL_NO_ERR
341     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
342         return 0;
343
344     err_load_strings(ERR_str_libraries);
345     err_load_strings(ERR_str_reasons);
346     err_patch(ERR_LIB_SYS, ERR_str_functs);
347     err_load_strings(ERR_str_functs);
348     build_SYS_str_reasons();
349 #endif
350     return 1;
351 }
352
353 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
354 {
355     if (ERR_load_ERR_strings() == 0)
356         return 0;
357
358     err_patch(lib, str);
359     err_load_strings(str);
360     return 1;
361 }
362
363 int ERR_load_strings_const(const ERR_STRING_DATA *str)
364 {
365     if (ERR_load_ERR_strings() == 0)
366         return 0;
367     err_load_strings(str);
368     return 1;
369 }
370
371 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
372 {
373     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
374         return 0;
375
376     CRYPTO_THREAD_write_lock(err_string_lock);
377     /*
378      * We don't need to ERR_PACK the lib, since that was done (to
379      * the table) when it was loaded.
380      */
381     for (; str->error; str++)
382         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
383     CRYPTO_THREAD_unlock(err_string_lock);
384
385     return 1;
386 }
387
388 void err_free_strings_int(void)
389 {
390     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
391         return;
392 }
393
394 /********************************************************/
395
396 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
397 {
398     ERR_STATE *es;
399
400 #ifdef _OSD_POSIX
401     /*
402      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
403      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
404      * something sensible. @@@ We shouldn't modify a const string, though.
405      */
406     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
407         char *end;
408
409         /* Skip the "*POSIX(" prefix */
410         file += sizeof("*POSIX(") - 1;
411         end = &file[strlen(file) - 1];
412         if (*end == ')')
413             *end = '\0';
414         /* Optional: use the basename of the path only. */
415         if ((end = strrchr(file, '/')) != NULL)
416             file = &end[1];
417     }
418 #endif
419     es = ERR_get_state();
420     if (es == NULL)
421         return;
422
423     es->top = (es->top + 1) % ERR_NUM_ERRORS;
424     if (es->top == es->bottom)
425         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
426     es->err_flags[es->top] = 0;
427     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
428     es->err_file[es->top] = file;
429     es->err_line[es->top] = line;
430     err_clear_data(es, es->top);
431 }
432
433 void ERR_clear_error(void)
434 {
435     int i;
436     ERR_STATE *es;
437
438     es = ERR_get_state();
439     if (es == NULL)
440         return;
441
442     for (i = 0; i < ERR_NUM_ERRORS; i++) {
443         err_clear(es, i);
444     }
445     es->top = es->bottom = 0;
446 }
447
448 unsigned long ERR_get_error(void)
449 {
450     return get_error_values(1, 0, NULL, NULL, NULL, NULL);
451 }
452
453 unsigned long ERR_get_error_line(const char **file, int *line)
454 {
455     return get_error_values(1, 0, file, line, NULL, NULL);
456 }
457
458 unsigned long ERR_get_error_line_data(const char **file, int *line,
459                                       const char **data, int *flags)
460 {
461     return get_error_values(1, 0, file, line, data, flags);
462 }
463
464 unsigned long ERR_peek_error(void)
465 {
466     return get_error_values(0, 0, NULL, NULL, NULL, NULL);
467 }
468
469 unsigned long ERR_peek_error_line(const char **file, int *line)
470 {
471     return get_error_values(0, 0, file, line, NULL, NULL);
472 }
473
474 unsigned long ERR_peek_error_line_data(const char **file, int *line,
475                                        const char **data, int *flags)
476 {
477     return get_error_values(0, 0, file, line, data, flags);
478 }
479
480 unsigned long ERR_peek_last_error(void)
481 {
482     return get_error_values(0, 1, NULL, NULL, NULL, NULL);
483 }
484
485 unsigned long ERR_peek_last_error_line(const char **file, int *line)
486 {
487     return get_error_values(0, 1, file, line, NULL, NULL);
488 }
489
490 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
491                                             const char **data, int *flags)
492 {
493     return get_error_values(0, 1, file, line, data, flags);
494 }
495
496 static unsigned long get_error_values(int inc, int top, const char **file,
497                                       int *line, const char **data,
498                                       int *flags)
499 {
500     int i = 0;
501     ERR_STATE *es;
502     unsigned long ret;
503
504     es = ERR_get_state();
505     if (es == NULL)
506         return 0;
507
508     if (inc && top) {
509         if (file)
510             *file = "";
511         if (line)
512             *line = 0;
513         if (data)
514             *data = "";
515         if (flags)
516             *flags = 0;
517
518         return ERR_R_INTERNAL_ERROR;
519     }
520
521     if (es->bottom == es->top)
522         return 0;
523     if (top)
524         i = es->top;            /* last error */
525     else
526         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
527
528     ret = es->err_buffer[i];
529     if (inc) {
530         es->bottom = i;
531         es->err_buffer[i] = 0;
532     }
533
534     if (file != NULL && line != NULL) {
535         if (es->err_file[i] == NULL) {
536             *file = "NA";
537             *line = 0;
538         } else {
539             *file = es->err_file[i];
540             *line = es->err_line[i];
541         }
542     }
543
544     if (data == NULL) {
545         if (inc) {
546             err_clear_data(es, i);
547         }
548     } else {
549         if (es->err_data[i] == NULL) {
550             *data = "";
551             if (flags != NULL)
552                 *flags = 0;
553         } else {
554             *data = es->err_data[i];
555             if (flags != NULL)
556                 *flags = es->err_data_flags[i];
557         }
558     }
559     return ret;
560 }
561
562 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
563 {
564     char lsbuf[64], fsbuf[64], rsbuf[64];
565     const char *ls, *fs, *rs;
566     unsigned long l, f, r;
567
568     if (len == 0)
569         return;
570
571     l = ERR_GET_LIB(e);
572     ls = ERR_lib_error_string(e);
573     if (ls == NULL) {
574         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
575         ls = lsbuf;
576     }
577
578     fs = ERR_func_error_string(e);
579     f = ERR_GET_FUNC(e);
580     if (fs == NULL) {
581         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
582         fs = fsbuf;
583     }
584
585     rs = ERR_reason_error_string(e);
586     r = ERR_GET_REASON(e);
587     if (rs == NULL) {
588         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
589         rs = rsbuf;
590     }
591
592     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs);
593     if (strlen(buf) == len - 1) {
594         /* Didn't fit; use a minimal format. */
595         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
596     }
597 }
598
599 /*
600  * ERR_error_string_n should be used instead for ret != NULL as
601  * ERR_error_string cannot know how large the buffer is
602  */
603 char *ERR_error_string(unsigned long e, char *ret)
604 {
605     static char buf[256];
606
607     if (ret == NULL)
608         ret = buf;
609     ERR_error_string_n(e, ret, (int)sizeof(buf));
610     return ret;
611 }
612
613 const char *ERR_lib_error_string(unsigned long e)
614 {
615     ERR_STRING_DATA d, *p;
616     unsigned long l;
617
618     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
619         return NULL;
620     }
621
622     l = ERR_GET_LIB(e);
623     d.error = ERR_PACK(l, 0, 0);
624     p = int_err_get_item(&d);
625     return ((p == NULL) ? NULL : p->string);
626 }
627
628 const char *ERR_func_error_string(unsigned long e)
629 {
630     ERR_STRING_DATA d, *p;
631     unsigned long l, f;
632
633     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
634         return NULL;
635     }
636
637     l = ERR_GET_LIB(e);
638     f = ERR_GET_FUNC(e);
639     d.error = ERR_PACK(l, f, 0);
640     p = int_err_get_item(&d);
641     return ((p == NULL) ? NULL : p->string);
642 }
643
644 const char *ERR_reason_error_string(unsigned long e)
645 {
646     ERR_STRING_DATA d, *p = NULL;
647     unsigned long l, r;
648
649     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
650         return NULL;
651     }
652
653     l = ERR_GET_LIB(e);
654     r = ERR_GET_REASON(e);
655     d.error = ERR_PACK(l, 0, r);
656     p = int_err_get_item(&d);
657     if (!p) {
658         d.error = ERR_PACK(0, 0, r);
659         p = int_err_get_item(&d);
660     }
661     return ((p == NULL) ? NULL : p->string);
662 }
663
664 void err_delete_thread_state(void)
665 {
666     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
667     if (state == NULL)
668         return;
669
670     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
671     ERR_STATE_free(state);
672 }
673
674 #if OPENSSL_API_COMPAT < 0x10100000L
675 void ERR_remove_thread_state(void *dummy)
676 {
677 }
678 #endif
679
680 #if OPENSSL_API_COMPAT < 0x10000000L
681 void ERR_remove_state(unsigned long pid)
682 {
683 }
684 #endif
685
686 DEFINE_RUN_ONCE_STATIC(err_do_init)
687 {
688     set_err_thread_local = 1;
689     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
690 }
691
692 ERR_STATE *ERR_get_state(void)
693 {
694     ERR_STATE *state;
695
696     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
697         return NULL;
698
699     if (!RUN_ONCE(&err_init, err_do_init))
700         return NULL;
701
702     state = CRYPTO_THREAD_get_local(&err_thread_local);
703     if (state == (ERR_STATE*)-1)
704         return NULL;
705
706     if (state == NULL) {
707         if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
708             return NULL;
709
710         if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) {
711             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
712             return NULL;
713         }
714
715         if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
716                 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
717             ERR_STATE_free(state);
718             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
719             return NULL;
720         }
721
722         /* Ignore failures from these */
723         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
724     }
725
726     return state;
727 }
728
729 /*
730  * err_shelve_state returns the current thread local error state
731  * and freezes the error module until err_unshelve_state is called.
732  */
733 int err_shelve_state(void **state)
734 {
735     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
736         return 0;
737
738     if (!RUN_ONCE(&err_init, err_do_init))
739         return 0;
740
741     *state = CRYPTO_THREAD_get_local(&err_thread_local);
742     if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
743         return 0;
744
745     return 1;
746 }
747
748 /*
749  * err_unshelve_state restores the error state that was returned
750  * by err_shelve_state previously.
751  */
752 void err_unshelve_state(void* state)
753 {
754     if (state != (void*)-1)
755         CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state);
756 }
757
758 int ERR_get_next_error_library(void)
759 {
760     int ret;
761
762     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
763         return 0;
764
765     CRYPTO_THREAD_write_lock(err_string_lock);
766     ret = int_err_library_number++;
767     CRYPTO_THREAD_unlock(err_string_lock);
768     return ret;
769 }
770
771 void ERR_set_error_data(char *data, int flags)
772 {
773     ERR_STATE *es;
774     int i;
775
776     es = ERR_get_state();
777     if (es == NULL)
778         return;
779
780     i = es->top;
781
782     err_clear_data(es, i);
783     es->err_data[i] = data;
784     es->err_data_flags[i] = flags;
785 }
786
787 void ERR_add_error_data(int num, ...)
788 {
789     va_list args;
790     va_start(args, num);
791     ERR_add_error_vdata(num, args);
792     va_end(args);
793 }
794
795 void ERR_add_error_vdata(int num, va_list args)
796 {
797     int i, n, s;
798     char *str, *p, *a;
799
800     s = 80;
801     if ((str = OPENSSL_malloc(s + 1)) == NULL) {
802         /* ERRerr(ERR_F_ERR_ADD_ERROR_VDATA, ERR_R_MALLOC_FAILURE); */
803         return;
804     }
805     str[0] = '\0';
806
807     n = 0;
808     for (i = 0; i < num; i++) {
809         a = va_arg(args, char *);
810         if (a == NULL)
811             a = "<NULL>";
812         n += strlen(a);
813         if (n > s) {
814             s = n + 20;
815             p = OPENSSL_realloc(str, s + 1);
816             if (p == NULL) {
817                 OPENSSL_free(str);
818                 return;
819             }
820             str = p;
821         }
822         OPENSSL_strlcat(str, a, (size_t)s + 1);
823     }
824     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
825 }
826
827 int ERR_set_mark(void)
828 {
829     ERR_STATE *es;
830
831     es = ERR_get_state();
832     if (es == NULL)
833         return 0;
834
835     if (es->bottom == es->top)
836         return 0;
837     es->err_flags[es->top] |= ERR_FLAG_MARK;
838     return 1;
839 }
840
841 int ERR_pop_to_mark(void)
842 {
843     ERR_STATE *es;
844
845     es = ERR_get_state();
846     if (es == NULL)
847         return 0;
848
849     while (es->bottom != es->top
850            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
851         err_clear(es, es->top);
852         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
853     }
854
855     if (es->bottom == es->top)
856         return 0;
857     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
858     return 1;
859 }
860
861 int ERR_clear_last_mark(void)
862 {
863     ERR_STATE *es;
864     int top;
865
866     es = ERR_get_state();
867     if (es == NULL)
868         return 0;
869
870     top = es->top;
871     while (es->bottom != top
872            && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
873         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
874     }
875
876     if (es->bottom == top)
877         return 0;
878     es->err_flags[top] &= ~ERR_FLAG_MARK;
879     return 1;
880 }