Deprecate ERR_free_strings() and make it a no-op
[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 "internal/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 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
238 static CRYPTO_RWLOCK *err_string_lock;
239
240 /* Predeclarations of the "err_defaults" functions */
241 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit);
242 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
243
244 /*
245  * The internal state
246  */
247
248 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
249 static int int_err_library_number = ERR_LIB_USER;
250
251 static unsigned long get_error_values(int inc, int top, const char **file,
252                                       int *line, const char **data,
253                                       int *flags);
254
255 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
256 {
257     unsigned long ret, l;
258
259     l = a->error;
260     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
261     return (ret ^ ret % 19 * 13);
262 }
263
264 static int err_string_data_cmp(const ERR_STRING_DATA *a,
265                                const ERR_STRING_DATA *b)
266 {
267     return (int)(a->error - b->error);
268 }
269
270 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit)
271 {
272     LHASH_OF(ERR_STRING_DATA) *ret = NULL;
273
274     if (lockit)
275         CRYPTO_THREAD_write_lock(err_string_lock);
276     if (!int_error_hash && create) {
277         int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
278                                                 err_string_data_cmp);
279     }
280     if (int_error_hash != NULL)
281         ret = int_error_hash;
282     if (lockit)
283         CRYPTO_THREAD_unlock(err_string_lock);
284
285     return ret;
286 }
287
288 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
289 {
290     ERR_STRING_DATA *p = NULL;
291     LHASH_OF(ERR_STRING_DATA) *hash;
292
293     CRYPTO_THREAD_read_lock(err_string_lock);
294     hash = get_hash(0, 0);
295     if (hash)
296         p = lh_ERR_STRING_DATA_retrieve(hash, d);
297     CRYPTO_THREAD_unlock(err_string_lock);
298
299     return p;
300 }
301
302 #ifndef OPENSSL_NO_ERR
303 # define NUM_SYS_STR_REASONS 127
304 # define LEN_SYS_STR_REASON 32
305
306 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
307 /*
308  * SYS_str_reasons is filled with copies of strerror() results at
309  * initialization. 'errno' values up to 127 should cover all usual errors,
310  * others will be displayed numerically by ERR_error_string. It is crucial
311  * that we have something for each reason code that occurs in
312  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
313  * which always gets an errno value and never one of those 'standard' reason
314  * codes.
315  */
316
317 static void build_SYS_str_reasons(void)
318 {
319     /* OPENSSL_malloc cannot be used here, use static storage instead */
320     static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
321     static int init = 1;
322     int i;
323
324     CRYPTO_THREAD_write_lock(err_string_lock);
325     if (!init) {
326         CRYPTO_THREAD_unlock(err_string_lock);
327         return;
328     }
329
330     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
331         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
332
333         str->error = (unsigned long)i;
334         if (str->string == NULL) {
335             char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
336             char *src = strerror(i);
337             if (src != NULL) {
338                 strncpy(*dest, src, sizeof(*dest));
339                 (*dest)[sizeof(*dest) - 1] = '\0';
340                 str->string = *dest;
341             }
342         }
343         if (str->string == NULL)
344             str->string = "unknown";
345     }
346
347     /*
348      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
349      * required by ERR_load_strings.
350      */
351
352     init = 0;
353
354     CRYPTO_THREAD_unlock(err_string_lock);
355 }
356 #endif
357
358 #define err_clear_data(p,i) \
359         do { \
360         if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
361                 {  \
362                 OPENSSL_free((p)->err_data[i]); \
363                 (p)->err_data[i]=NULL; \
364                 } \
365         (p)->err_data_flags[i]=0; \
366         } while(0)
367
368 #define err_clear(p,i) \
369         do { \
370         (p)->err_flags[i]=0; \
371         (p)->err_buffer[i]=0; \
372         err_clear_data(p,i); \
373         (p)->err_file[i]=NULL; \
374         (p)->err_line[i]= -1; \
375         } while(0)
376
377 static void ERR_STATE_free(ERR_STATE *s)
378 {
379     int i;
380
381     if (s == NULL)
382         return;
383
384     for (i = 0; i < ERR_NUM_ERRORS; i++) {
385         err_clear_data(s, i);
386     }
387     OPENSSL_free(s);
388 }
389
390 static void do_err_strings_init(void)
391 {
392     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
393     err_string_lock = CRYPTO_THREAD_lock_new();
394     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
395 }
396
397 void ERR_load_ERR_strings(void)
398 {
399 #ifndef OPENSSL_NO_ERR
400     CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
401
402     err_load_strings(0, ERR_str_libraries);
403     err_load_strings(0, ERR_str_reasons);
404     err_load_strings(ERR_LIB_SYS, ERR_str_functs);
405     build_SYS_str_reasons();
406     err_load_strings(ERR_LIB_SYS, SYS_str_reasons);
407 #endif
408 }
409
410 static void err_load_strings(int lib, ERR_STRING_DATA *str)
411 {
412     LHASH_OF(ERR_STRING_DATA) *hash;
413
414     CRYPTO_THREAD_write_lock(err_string_lock);
415     hash = get_hash(1, 0);
416     if (hash) {
417         for (; str->error; str++) {
418             if (lib)
419                 str->error |= ERR_PACK(lib, 0, 0);
420             (void)lh_ERR_STRING_DATA_insert(hash, str);
421         }
422     }
423     CRYPTO_THREAD_unlock(err_string_lock);
424 }
425
426 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
427 {
428     ERR_load_ERR_strings();
429     err_load_strings(lib, str);
430 }
431
432 void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
433 {
434     LHASH_OF(ERR_STRING_DATA) *hash;
435
436     CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
437
438     CRYPTO_THREAD_write_lock(err_string_lock);
439     hash = get_hash(0, 0);
440     if (hash) {
441         for (; str->error; str++) {
442             if (lib)
443                 str->error |= ERR_PACK(lib, 0, 0);
444             (void)lh_ERR_STRING_DATA_delete(hash, str);
445         }
446     }
447     CRYPTO_THREAD_unlock(err_string_lock);
448 }
449
450 void err_free_strings_intern(void)
451 {
452     CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
453
454     CRYPTO_THREAD_write_lock(err_string_lock);
455     lh_ERR_STRING_DATA_free(int_error_hash);
456     int_error_hash = NULL;
457     CRYPTO_THREAD_unlock(err_string_lock);
458 }
459
460 /********************************************************/
461
462 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
463 {
464     ERR_STATE *es;
465
466 #ifdef _OSD_POSIX
467     /*
468      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
469      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
470      * something sensible. @@@ We shouldn't modify a const string, though.
471      */
472     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
473         char *end;
474
475         /* Skip the "*POSIX(" prefix */
476         file += sizeof("*POSIX(") - 1;
477         end = &file[strlen(file) - 1];
478         if (*end == ')')
479             *end = '\0';
480         /* Optional: use the basename of the path only. */
481         if ((end = strrchr(file, '/')) != NULL)
482             file = &end[1];
483     }
484 #endif
485     es = ERR_get_state();
486
487     es->top = (es->top + 1) % ERR_NUM_ERRORS;
488     if (es->top == es->bottom)
489         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
490     es->err_flags[es->top] = 0;
491     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
492     es->err_file[es->top] = file;
493     es->err_line[es->top] = line;
494     err_clear_data(es, es->top);
495 }
496
497 void ERR_clear_error(void)
498 {
499     int i;
500     ERR_STATE *es;
501
502     es = ERR_get_state();
503
504     for (i = 0; i < ERR_NUM_ERRORS; i++) {
505         err_clear(es, i);
506     }
507     es->top = es->bottom = 0;
508 }
509
510 unsigned long ERR_get_error(void)
511 {
512     return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
513 }
514
515 unsigned long ERR_get_error_line(const char **file, int *line)
516 {
517     return (get_error_values(1, 0, file, line, NULL, NULL));
518 }
519
520 unsigned long ERR_get_error_line_data(const char **file, int *line,
521                                       const char **data, int *flags)
522 {
523     return (get_error_values(1, 0, file, line, data, flags));
524 }
525
526 unsigned long ERR_peek_error(void)
527 {
528     return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
529 }
530
531 unsigned long ERR_peek_error_line(const char **file, int *line)
532 {
533     return (get_error_values(0, 0, file, line, NULL, NULL));
534 }
535
536 unsigned long ERR_peek_error_line_data(const char **file, int *line,
537                                        const char **data, int *flags)
538 {
539     return (get_error_values(0, 0, file, line, data, flags));
540 }
541
542 unsigned long ERR_peek_last_error(void)
543 {
544     return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
545 }
546
547 unsigned long ERR_peek_last_error_line(const char **file, int *line)
548 {
549     return (get_error_values(0, 1, file, line, NULL, NULL));
550 }
551
552 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
553                                             const char **data, int *flags)
554 {
555     return (get_error_values(0, 1, file, line, data, flags));
556 }
557
558 static unsigned long get_error_values(int inc, int top, const char **file,
559                                       int *line, const char **data,
560                                       int *flags)
561 {
562     int i = 0;
563     ERR_STATE *es;
564     unsigned long ret;
565
566     es = ERR_get_state();
567
568     if (inc && top) {
569         if (file)
570             *file = "";
571         if (line)
572             *line = 0;
573         if (data)
574             *data = "";
575         if (flags)
576             *flags = 0;
577
578         return ERR_R_INTERNAL_ERROR;
579     }
580
581     if (es->bottom == es->top)
582         return 0;
583     if (top)
584         i = es->top;            /* last error */
585     else
586         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
587
588     ret = es->err_buffer[i];
589     if (inc) {
590         es->bottom = i;
591         es->err_buffer[i] = 0;
592     }
593
594     if ((file != NULL) && (line != NULL)) {
595         if (es->err_file[i] == NULL) {
596             *file = "NA";
597             if (line != NULL)
598                 *line = 0;
599         } else {
600             *file = es->err_file[i];
601             if (line != NULL)
602                 *line = es->err_line[i];
603         }
604     }
605
606     if (data == NULL) {
607         if (inc) {
608             err_clear_data(es, i);
609         }
610     } else {
611         if (es->err_data[i] == NULL) {
612             *data = "";
613             if (flags != NULL)
614                 *flags = 0;
615         } else {
616             *data = es->err_data[i];
617             if (flags != NULL)
618                 *flags = es->err_data_flags[i];
619         }
620     }
621     return ret;
622 }
623
624 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
625 {
626     char lsbuf[64], fsbuf[64], rsbuf[64];
627     const char *ls, *fs, *rs;
628     unsigned long l, f, r;
629
630     l = ERR_GET_LIB(e);
631     f = ERR_GET_FUNC(e);
632     r = ERR_GET_REASON(e);
633
634     ls = ERR_lib_error_string(e);
635     fs = ERR_func_error_string(e);
636     rs = ERR_reason_error_string(e);
637
638     if (ls == NULL)
639         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
640     if (fs == NULL)
641         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
642     if (rs == NULL)
643         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
644
645     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
646                  fs ? fs : fsbuf, rs ? rs : rsbuf);
647     if (strlen(buf) == len - 1) {
648         /*
649          * output may be truncated; make sure we always have 5
650          * colon-separated fields, i.e. 4 colons ...
651          */
652 #define NUM_COLONS 4
653         if (len > NUM_COLONS) { /* ... if possible */
654             int i;
655             char *s = buf;
656
657             for (i = 0; i < NUM_COLONS; i++) {
658                 char *colon = strchr(s, ':');
659                 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
660                     /*
661                      * set colon no. i at last possible position (buf[len-1]
662                      * is the terminating 0)
663                      */
664                     colon = &buf[len - 1] - NUM_COLONS + i;
665                     *colon = ':';
666                 }
667                 s = colon + 1;
668             }
669         }
670     }
671 }
672
673 /*
674  * ERR_error_string_n should be used instead for ret != NULL as
675  * ERR_error_string cannot know how large the buffer is
676  */
677 char *ERR_error_string(unsigned long e, char *ret)
678 {
679     static char buf[256];
680
681     if (ret == NULL)
682         ret = buf;
683     ERR_error_string_n(e, ret, 256);
684
685     return ret;
686 }
687
688 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void)
689 {
690     return get_hash(0, 1);
691 }
692
693 const char *ERR_lib_error_string(unsigned long e)
694 {
695     ERR_STRING_DATA d, *p;
696     unsigned long l;
697
698     CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
699
700     l = ERR_GET_LIB(e);
701     d.error = ERR_PACK(l, 0, 0);
702     p = int_err_get_item(&d);
703     return ((p == NULL) ? NULL : p->string);
704 }
705
706 const char *ERR_func_error_string(unsigned long e)
707 {
708     ERR_STRING_DATA d, *p;
709     unsigned long l, f;
710
711     CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
712
713     l = ERR_GET_LIB(e);
714     f = ERR_GET_FUNC(e);
715     d.error = ERR_PACK(l, f, 0);
716     p = int_err_get_item(&d);
717     return ((p == NULL) ? NULL : p->string);
718 }
719
720 const char *ERR_reason_error_string(unsigned long e)
721 {
722     ERR_STRING_DATA d, *p = NULL;
723     unsigned long l, r;
724
725     CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
726
727     l = ERR_GET_LIB(e);
728     r = ERR_GET_REASON(e);
729     d.error = ERR_PACK(l, 0, r);
730     p = int_err_get_item(&d);
731     if (!p) {
732         d.error = ERR_PACK(0, 0, r);
733         p = int_err_get_item(&d);
734     }
735     return ((p == NULL) ? NULL : p->string);
736 }
737
738 void ERR_remove_thread_state(void)
739 {
740     ERR_STATE *state = ERR_get_state();
741     if (state == NULL)
742         return;
743
744     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
745     ERR_STATE_free(state);
746 }
747
748 #if OPENSSL_API_COMPAT < 0x10000000L
749 void ERR_remove_state(unsigned long pid)
750 {
751     ERR_remove_thread_state();
752 }
753 #endif
754
755 static void err_do_init(void)
756 {
757     CRYPTO_THREAD_init_local(&err_thread_local, NULL);
758 }
759
760 ERR_STATE *ERR_get_state(void)
761 {
762     ERR_STATE *state = NULL;
763
764     CRYPTO_THREAD_run_once(&err_init, err_do_init);
765
766     state = CRYPTO_THREAD_get_local(&err_thread_local);
767
768     if (state == NULL) {
769         state = OPENSSL_zalloc(sizeof(*state));
770         if (state == NULL)
771             return NULL;
772
773         if (!CRYPTO_THREAD_set_local(&err_thread_local, state)) {
774             ERR_STATE_free(state);
775             return NULL;
776         }
777
778         /* Ignore failures from these */
779         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
780         ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE);
781     }
782
783     return state;
784 }
785
786 int ERR_get_next_error_library(void)
787 {
788     int ret;
789
790     CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
791
792     CRYPTO_THREAD_write_lock(err_string_lock);
793     ret = int_err_library_number++;
794     CRYPTO_THREAD_unlock(err_string_lock);
795     return ret;
796 }
797
798 void ERR_set_error_data(char *data, int flags)
799 {
800     ERR_STATE *es;
801     int i;
802
803     es = ERR_get_state();
804
805     i = es->top;
806     if (i == 0)
807         i = ERR_NUM_ERRORS - 1;
808
809     err_clear_data(es, i);
810     es->err_data[i] = data;
811     es->err_data_flags[i] = flags;
812 }
813
814 void ERR_add_error_data(int num, ...)
815 {
816     va_list args;
817     va_start(args, num);
818     ERR_add_error_vdata(num, args);
819     va_end(args);
820 }
821
822 void ERR_add_error_vdata(int num, va_list args)
823 {
824     int i, n, s;
825     char *str, *p, *a;
826
827     s = 80;
828     str = OPENSSL_malloc(s + 1);
829     if (str == NULL)
830         return;
831     str[0] = '\0';
832
833     n = 0;
834     for (i = 0; i < num; i++) {
835         a = va_arg(args, char *);
836         /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
837         if (a != NULL) {
838             n += strlen(a);
839             if (n > s) {
840                 s = n + 20;
841                 p = OPENSSL_realloc(str, s + 1);
842                 if (p == NULL) {
843                     OPENSSL_free(str);
844                     return;
845                 }
846                 str = p;
847             }
848             OPENSSL_strlcat(str, a, (size_t)s + 1);
849         }
850     }
851     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
852 }
853
854 int ERR_set_mark(void)
855 {
856     ERR_STATE *es;
857
858     es = ERR_get_state();
859
860     if (es->bottom == es->top)
861         return 0;
862     es->err_flags[es->top] |= ERR_FLAG_MARK;
863     return 1;
864 }
865
866 int ERR_pop_to_mark(void)
867 {
868     ERR_STATE *es;
869
870     es = ERR_get_state();
871
872     while (es->bottom != es->top
873            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
874         err_clear(es, es->top);
875         es->top -= 1;
876         if (es->top == -1)
877             es->top = ERR_NUM_ERRORS - 1;
878     }
879
880     if (es->bottom == es->top)
881         return 0;
882     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
883     return 1;
884 }