Convert ERR_STATE to new multi-threading API
[openssl.git] / crypto / err / err.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57 /* ====================================================================
58  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  *    notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  *    notice, this list of conditions and the following disclaimer in
69  *    the documentation and/or other materials provided with the
70  *    distribution.
71  *
72  * 3. All advertising materials mentioning features or use of this
73  *    software must display the following acknowledgment:
74  *    "This product includes software developed by the OpenSSL Project
75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76  *
77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78  *    endorse or promote products derived from this software without
79  *    prior written permission. For written permission, please contact
80  *    openssl-core@openssl.org.
81  *
82  * 5. Products derived from this software may not be called "OpenSSL"
83  *    nor may "OpenSSL" appear in their names without prior written
84  *    permission of the OpenSSL Project.
85  *
86  * 6. Redistributions of any form whatsoever must retain the following
87  *    acknowledgment:
88  *    "This product includes software developed by the OpenSSL Project
89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90  *
91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102  * OF THE POSSIBILITY OF SUCH DAMAGE.
103  * ====================================================================
104  *
105  * This product includes cryptographic software written by Eric Young
106  * (eay@cryptsoft.com).  This product includes software written by Tim
107  * Hudson (tjh@cryptsoft.com).
108  *
109  */
110
111 #include <stdio.h>
112 #include <stdarg.h>
113 #include <string.h>
114 #include <internal/cryptlib_int.h>
115 #include <internal/threads.h>
116 #include <openssl/lhash.h>
117 #include <openssl/crypto.h>
118 #include <openssl/buffer.h>
119 #include <openssl/bio.h>
120 #include <openssl/err.h>
121 #include <openssl/opensslconf.h>
122
123 static void err_load_strings(int lib, ERR_STRING_DATA *str);
124
125 static void ERR_STATE_free(ERR_STATE *s);
126 #ifndef OPENSSL_NO_ERR
127 static ERR_STRING_DATA ERR_str_libraries[] = {
128     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
129     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
130     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
131     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
132     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
133     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
134     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
135     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
136     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
137     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
138     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
139     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
140     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
141     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
142     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
143     {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
144     {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
145     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
146     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
147     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
148     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
149     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
150     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
151     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
152     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
153     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
154     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
155     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
156     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
157     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
158     {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
159     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
160     {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
161     {0, NULL},
162 };
163
164 static ERR_STRING_DATA ERR_str_functs[] = {
165     {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
166     {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
167     {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
168     {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
169     {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
170     {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
171     {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
172     {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
173 # ifdef OPENSSL_SYS_WINDOWS
174     {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
175 # endif
176     {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
177     {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
178     {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
179     {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
180     {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
181     {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
182     {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
183     {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
184     {0, NULL},
185 };
186
187 static ERR_STRING_DATA ERR_str_reasons[] = {
188     {ERR_R_SYS_LIB, "system lib"},
189     {ERR_R_BN_LIB, "BN lib"},
190     {ERR_R_RSA_LIB, "RSA lib"},
191     {ERR_R_DH_LIB, "DH lib"},
192     {ERR_R_EVP_LIB, "EVP lib"},
193     {ERR_R_BUF_LIB, "BUF lib"},
194     {ERR_R_OBJ_LIB, "OBJ lib"},
195     {ERR_R_PEM_LIB, "PEM lib"},
196     {ERR_R_DSA_LIB, "DSA lib"},
197     {ERR_R_X509_LIB, "X509 lib"},
198     {ERR_R_ASN1_LIB, "ASN1 lib"},
199     {ERR_R_CONF_LIB, "CONF lib"},
200     {ERR_R_CRYPTO_LIB, "CRYPTO lib"},
201     {ERR_R_EC_LIB, "EC lib"},
202     {ERR_R_SSL_LIB, "SSL lib"},
203     {ERR_R_BIO_LIB, "BIO lib"},
204     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
205     {ERR_R_X509V3_LIB, "X509V3 lib"},
206     {ERR_R_PKCS12_LIB, "PKCS12 lib"},
207     {ERR_R_RAND_LIB, "RAND lib"},
208     {ERR_R_DSO_LIB, "DSO lib"},
209     {ERR_R_ENGINE_LIB, "ENGINE lib"},
210     {ERR_R_OCSP_LIB, "OCSP lib"},
211     {ERR_R_TS_LIB, "TS lib"},
212     {ERR_R_ECDSA_LIB, "ECDSA lib"},
213
214     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
215     {ERR_R_BAD_ASN1_OBJECT_HEADER, "bad asn1 object header"},
216     {ERR_R_BAD_GET_ASN1_OBJECT_CALL, "bad get asn1 object call"},
217     {ERR_R_EXPECTING_AN_ASN1_SEQUENCE, "expecting an asn1 sequence"},
218     {ERR_R_ASN1_LENGTH_MISMATCH, "asn1 length mismatch"},
219     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
220
221     {ERR_R_FATAL, "fatal"},
222     {ERR_R_MALLOC_FAILURE, "malloc failure"},
223     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
224      "called a function you should not call"},
225     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
226     {ERR_R_INTERNAL_ERROR, "internal error"},
227     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
228     {ERR_R_INIT_FAIL, "init fail"},
229
230     {0, NULL},
231 };
232 #endif
233
234 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
235 static CRYPTO_THREAD_LOCAL err_thread_local;
236
237 /* Predeclarations of the "err_defaults" functions */
238 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit);
239 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
240
241 /*
242  * The internal state
243  */
244
245 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
246 static int int_err_library_number = ERR_LIB_USER;
247
248 static unsigned long get_error_values(int inc, int top, const char **file,
249                                       int *line, const char **data,
250                                       int *flags);
251
252 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
253 {
254     unsigned long ret, l;
255
256     l = a->error;
257     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
258     return (ret ^ ret % 19 * 13);
259 }
260
261 static int err_string_data_cmp(const ERR_STRING_DATA *a,
262                                const ERR_STRING_DATA *b)
263 {
264     return (int)(a->error - b->error);
265 }
266
267 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit)
268 {
269     LHASH_OF(ERR_STRING_DATA) *ret = NULL;
270
271     if (lockit)
272         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
273     if (!int_error_hash && create) {
274         int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
275                                                 err_string_data_cmp);
276     }
277     if (int_error_hash != NULL)
278         ret = int_error_hash;
279     if (lockit)
280         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
281
282     return ret;
283 }
284
285 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
286 {
287     ERR_STRING_DATA *p = NULL;
288     LHASH_OF(ERR_STRING_DATA) *hash;
289
290     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
291     hash = get_hash(0, 0);
292     if (hash)
293         p = lh_ERR_STRING_DATA_retrieve(hash, d);
294     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
295
296     return p;
297 }
298
299 #ifndef OPENSSL_NO_ERR
300 # define NUM_SYS_STR_REASONS 127
301 # define LEN_SYS_STR_REASON 32
302
303 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
304 /*
305  * SYS_str_reasons is filled with copies of strerror() results at
306  * initialization. 'errno' values up to 127 should cover all usual errors,
307  * others will be displayed numerically by ERR_error_string. It is crucial
308  * that we have something for each reason code that occurs in
309  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
310  * which always gets an errno value and never one of those 'standard' reason
311  * codes.
312  */
313
314 static void build_SYS_str_reasons(void)
315 {
316     /* OPENSSL_malloc cannot be used here, use static storage instead */
317     static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
318     static int init = 1;
319     int i;
320
321     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
322     if (!init) {
323         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
324         return;
325     }
326
327     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
328     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
329     if (!init) {
330         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
331         return;
332     }
333
334     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
335         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
336
337         str->error = (unsigned long)i;
338         if (str->string == NULL) {
339             char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
340             char *src = strerror(i);
341             if (src != NULL) {
342                 strncpy(*dest, src, sizeof(*dest));
343                 (*dest)[sizeof(*dest) - 1] = '\0';
344                 str->string = *dest;
345             }
346         }
347         if (str->string == NULL)
348             str->string = "unknown";
349     }
350
351     /*
352      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
353      * required by ERR_load_strings.
354      */
355
356     init = 0;
357
358     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
359 }
360 #endif
361
362 #define err_clear_data(p,i) \
363         do { \
364         if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
365                 {  \
366                 OPENSSL_free((p)->err_data[i]); \
367                 (p)->err_data[i]=NULL; \
368                 } \
369         (p)->err_data_flags[i]=0; \
370         } while(0)
371
372 #define err_clear(p,i) \
373         do { \
374         (p)->err_flags[i]=0; \
375         (p)->err_buffer[i]=0; \
376         err_clear_data(p,i); \
377         (p)->err_file[i]=NULL; \
378         (p)->err_line[i]= -1; \
379         } while(0)
380
381 static void ERR_STATE_free(ERR_STATE *s)
382 {
383     int i;
384
385     if (s == NULL)
386         return;
387
388     for (i = 0; i < ERR_NUM_ERRORS; i++) {
389         err_clear_data(s, i);
390     }
391     OPENSSL_free(s);
392 }
393
394 void ERR_load_ERR_strings(void)
395 {
396 #ifndef OPENSSL_NO_ERR
397     err_load_strings(0, ERR_str_libraries);
398     err_load_strings(0, ERR_str_reasons);
399     err_load_strings(ERR_LIB_SYS, ERR_str_functs);
400     build_SYS_str_reasons();
401     err_load_strings(ERR_LIB_SYS, SYS_str_reasons);
402 #endif
403 }
404
405 static void err_load_strings(int lib, ERR_STRING_DATA *str)
406 {
407     LHASH_OF(ERR_STRING_DATA) *hash;
408
409     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
410     hash = get_hash(1, 0);
411     if (hash) {
412         for (; str->error; str++) {
413             if (lib)
414                 str->error |= ERR_PACK(lib, 0, 0);
415             (void)lh_ERR_STRING_DATA_insert(hash, str);
416         }
417     }
418     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
419 }
420
421 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
422 {
423     ERR_load_ERR_strings();
424     err_load_strings(lib, str);
425 }
426
427 void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
428 {
429     LHASH_OF(ERR_STRING_DATA) *hash;
430
431     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
432     hash = get_hash(0, 0);
433     if (hash) {
434         for (; str->error; str++) {
435             if (lib)
436                 str->error |= ERR_PACK(lib, 0, 0);
437             (void)lh_ERR_STRING_DATA_delete(hash, str);
438         }
439     }
440     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
441 }
442
443 void ERR_free_strings(void)
444 {
445     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
446     lh_ERR_STRING_DATA_free(int_error_hash);
447     int_error_hash = NULL;
448     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
449 }
450
451 /********************************************************/
452
453 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
454 {
455     ERR_STATE *es;
456
457 #ifdef _OSD_POSIX
458     /*
459      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
460      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
461      * something sensible. @@@ We shouldn't modify a const string, though.
462      */
463     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
464         char *end;
465
466         /* Skip the "*POSIX(" prefix */
467         file += sizeof("*POSIX(") - 1;
468         end = &file[strlen(file) - 1];
469         if (*end == ')')
470             *end = '\0';
471         /* Optional: use the basename of the path only. */
472         if ((end = strrchr(file, '/')) != NULL)
473             file = &end[1];
474     }
475 #endif
476     es = ERR_get_state();
477
478     es->top = (es->top + 1) % ERR_NUM_ERRORS;
479     if (es->top == es->bottom)
480         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
481     es->err_flags[es->top] = 0;
482     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
483     es->err_file[es->top] = file;
484     es->err_line[es->top] = line;
485     err_clear_data(es, es->top);
486 }
487
488 void ERR_clear_error(void)
489 {
490     int i;
491     ERR_STATE *es;
492
493     es = ERR_get_state();
494
495     for (i = 0; i < ERR_NUM_ERRORS; i++) {
496         err_clear(es, i);
497     }
498     es->top = es->bottom = 0;
499 }
500
501 unsigned long ERR_get_error(void)
502 {
503     return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
504 }
505
506 unsigned long ERR_get_error_line(const char **file, int *line)
507 {
508     return (get_error_values(1, 0, file, line, NULL, NULL));
509 }
510
511 unsigned long ERR_get_error_line_data(const char **file, int *line,
512                                       const char **data, int *flags)
513 {
514     return (get_error_values(1, 0, file, line, data, flags));
515 }
516
517 unsigned long ERR_peek_error(void)
518 {
519     return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
520 }
521
522 unsigned long ERR_peek_error_line(const char **file, int *line)
523 {
524     return (get_error_values(0, 0, file, line, NULL, NULL));
525 }
526
527 unsigned long ERR_peek_error_line_data(const char **file, int *line,
528                                        const char **data, int *flags)
529 {
530     return (get_error_values(0, 0, file, line, data, flags));
531 }
532
533 unsigned long ERR_peek_last_error(void)
534 {
535     return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
536 }
537
538 unsigned long ERR_peek_last_error_line(const char **file, int *line)
539 {
540     return (get_error_values(0, 1, file, line, NULL, NULL));
541 }
542
543 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
544                                             const char **data, int *flags)
545 {
546     return (get_error_values(0, 1, file, line, data, flags));
547 }
548
549 static unsigned long get_error_values(int inc, int top, const char **file,
550                                       int *line, const char **data,
551                                       int *flags)
552 {
553     int i = 0;
554     ERR_STATE *es;
555     unsigned long ret;
556
557     es = ERR_get_state();
558
559     if (inc && top) {
560         if (file)
561             *file = "";
562         if (line)
563             *line = 0;
564         if (data)
565             *data = "";
566         if (flags)
567             *flags = 0;
568
569         return ERR_R_INTERNAL_ERROR;
570     }
571
572     if (es->bottom == es->top)
573         return 0;
574     if (top)
575         i = es->top;            /* last error */
576     else
577         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
578
579     ret = es->err_buffer[i];
580     if (inc) {
581         es->bottom = i;
582         es->err_buffer[i] = 0;
583     }
584
585     if ((file != NULL) && (line != NULL)) {
586         if (es->err_file[i] == NULL) {
587             *file = "NA";
588             if (line != NULL)
589                 *line = 0;
590         } else {
591             *file = es->err_file[i];
592             if (line != NULL)
593                 *line = es->err_line[i];
594         }
595     }
596
597     if (data == NULL) {
598         if (inc) {
599             err_clear_data(es, i);
600         }
601     } else {
602         if (es->err_data[i] == NULL) {
603             *data = "";
604             if (flags != NULL)
605                 *flags = 0;
606         } else {
607             *data = es->err_data[i];
608             if (flags != NULL)
609                 *flags = es->err_data_flags[i];
610         }
611     }
612     return ret;
613 }
614
615 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
616 {
617     char lsbuf[64], fsbuf[64], rsbuf[64];
618     const char *ls, *fs, *rs;
619     unsigned long l, f, r;
620
621     l = ERR_GET_LIB(e);
622     f = ERR_GET_FUNC(e);
623     r = ERR_GET_REASON(e);
624
625     ls = ERR_lib_error_string(e);
626     fs = ERR_func_error_string(e);
627     rs = ERR_reason_error_string(e);
628
629     if (ls == NULL)
630         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
631     if (fs == NULL)
632         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
633     if (rs == NULL)
634         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
635
636     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
637                  fs ? fs : fsbuf, rs ? rs : rsbuf);
638     if (strlen(buf) == len - 1) {
639         /*
640          * output may be truncated; make sure we always have 5
641          * colon-separated fields, i.e. 4 colons ...
642          */
643 #define NUM_COLONS 4
644         if (len > NUM_COLONS) { /* ... if possible */
645             int i;
646             char *s = buf;
647
648             for (i = 0; i < NUM_COLONS; i++) {
649                 char *colon = strchr(s, ':');
650                 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
651                     /*
652                      * set colon no. i at last possible position (buf[len-1]
653                      * is the terminating 0)
654                      */
655                     colon = &buf[len - 1] - NUM_COLONS + i;
656                     *colon = ':';
657                 }
658                 s = colon + 1;
659             }
660         }
661     }
662 }
663
664 /*
665  * ERR_error_string_n should be used instead for ret != NULL as
666  * ERR_error_string cannot know how large the buffer is
667  */
668 char *ERR_error_string(unsigned long e, char *ret)
669 {
670     static char buf[256];
671
672     if (ret == NULL)
673         ret = buf;
674     ERR_error_string_n(e, ret, 256);
675
676     return ret;
677 }
678
679 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void)
680 {
681     return get_hash(0, 1);
682 }
683
684 const char *ERR_lib_error_string(unsigned long e)
685 {
686     ERR_STRING_DATA d, *p;
687     unsigned long l;
688
689     l = ERR_GET_LIB(e);
690     d.error = ERR_PACK(l, 0, 0);
691     p = int_err_get_item(&d);
692     return ((p == NULL) ? NULL : p->string);
693 }
694
695 const char *ERR_func_error_string(unsigned long e)
696 {
697     ERR_STRING_DATA d, *p;
698     unsigned long l, f;
699
700     l = ERR_GET_LIB(e);
701     f = ERR_GET_FUNC(e);
702     d.error = ERR_PACK(l, f, 0);
703     p = int_err_get_item(&d);
704     return ((p == NULL) ? NULL : p->string);
705 }
706
707 const char *ERR_reason_error_string(unsigned long e)
708 {
709     ERR_STRING_DATA d, *p = NULL;
710     unsigned long l, r;
711
712     l = ERR_GET_LIB(e);
713     r = ERR_GET_REASON(e);
714     d.error = ERR_PACK(l, 0, r);
715     p = int_err_get_item(&d);
716     if (!p) {
717         d.error = ERR_PACK(0, 0, r);
718         p = int_err_get_item(&d);
719     }
720     return ((p == NULL) ? NULL : p->string);
721 }
722
723 void ERR_remove_thread_state(void)
724 {
725     ERR_STATE *state = ERR_get_state();
726     if (state == NULL)
727         return;
728
729     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
730     ERR_STATE_free(state);
731 }
732
733 #if OPENSSL_API_COMPAT < 0x10000000L
734 void ERR_remove_state(unsigned long pid)
735 {
736     ERR_remove_thread_state();
737 }
738 #endif
739
740 static void err_do_init(void)
741 {
742     CRYPTO_THREAD_init_local(&err_thread_local, NULL);
743 }
744
745 ERR_STATE *ERR_get_state(void)
746 {
747     ERR_STATE *state = NULL;
748
749     CRYPTO_THREAD_run_once(&err_init, err_do_init);
750
751     state = CRYPTO_THREAD_get_local(&err_thread_local);
752
753     if (state == NULL) {
754         state = OPENSSL_zalloc(sizeof(*state));
755         if (state == NULL)
756             return NULL;
757
758         if (!CRYPTO_THREAD_set_local(&err_thread_local, state)) {
759             ERR_STATE_free(state);
760             return NULL;
761         }
762
763         /* Ignore failures from these */
764         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
765         ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE);
766     }
767
768     return state;
769 }
770
771 int ERR_get_next_error_library(void)
772 {
773     int ret;
774
775     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
776     ret = int_err_library_number++;
777     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
778     return ret;
779 }
780
781 void ERR_set_error_data(char *data, int flags)
782 {
783     ERR_STATE *es;
784     int i;
785
786     es = ERR_get_state();
787
788     i = es->top;
789     if (i == 0)
790         i = ERR_NUM_ERRORS - 1;
791
792     err_clear_data(es, i);
793     es->err_data[i] = data;
794     es->err_data_flags[i] = flags;
795 }
796
797 void ERR_add_error_data(int num, ...)
798 {
799     va_list args;
800     va_start(args, num);
801     ERR_add_error_vdata(num, args);
802     va_end(args);
803 }
804
805 void ERR_add_error_vdata(int num, va_list args)
806 {
807     int i, n, s;
808     char *str, *p, *a;
809
810     s = 80;
811     str = OPENSSL_malloc(s + 1);
812     if (str == NULL)
813         return;
814     str[0] = '\0';
815
816     n = 0;
817     for (i = 0; i < num; i++) {
818         a = va_arg(args, char *);
819         /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
820         if (a != NULL) {
821             n += strlen(a);
822             if (n > s) {
823                 s = n + 20;
824                 p = OPENSSL_realloc(str, s + 1);
825                 if (p == NULL) {
826                     OPENSSL_free(str);
827                     return;
828                 }
829                 str = p;
830             }
831             OPENSSL_strlcat(str, a, (size_t)s + 1);
832         }
833     }
834     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
835 }
836
837 int ERR_set_mark(void)
838 {
839     ERR_STATE *es;
840
841     es = ERR_get_state();
842
843     if (es->bottom == es->top)
844         return 0;
845     es->err_flags[es->top] |= ERR_FLAG_MARK;
846     return 1;
847 }
848
849 int ERR_pop_to_mark(void)
850 {
851     ERR_STATE *es;
852
853     es = ERR_get_state();
854
855     while (es->bottom != es->top
856            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
857         err_clear(es, es->top);
858         es->top -= 1;
859         if (es->top == -1)
860             es->top = ERR_NUM_ERRORS - 1;
861     }
862
863     if (es->bottom == es->top)
864         return 0;
865     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
866     return 1;
867 }