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