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