LHASH revamp. make depend.
[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 "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         {
131 {ERR_PACK(ERR_LIB_NONE,0,0)             ,"unknown library"},
132 {ERR_PACK(ERR_LIB_SYS,0,0)              ,"system library"},
133 {ERR_PACK(ERR_LIB_BN,0,0)               ,"bignum routines"},
134 {ERR_PACK(ERR_LIB_RSA,0,0)              ,"rsa routines"},
135 {ERR_PACK(ERR_LIB_DH,0,0)               ,"Diffie-Hellman routines"},
136 {ERR_PACK(ERR_LIB_EVP,0,0)              ,"digital envelope routines"},
137 {ERR_PACK(ERR_LIB_BUF,0,0)              ,"memory buffer routines"},
138 {ERR_PACK(ERR_LIB_OBJ,0,0)              ,"object identifier routines"},
139 {ERR_PACK(ERR_LIB_PEM,0,0)              ,"PEM routines"},
140 {ERR_PACK(ERR_LIB_DSA,0,0)              ,"dsa routines"},
141 {ERR_PACK(ERR_LIB_X509,0,0)             ,"x509 certificate routines"},
142 {ERR_PACK(ERR_LIB_ASN1,0,0)             ,"asn1 encoding routines"},
143 {ERR_PACK(ERR_LIB_CONF,0,0)             ,"configuration file routines"},
144 {ERR_PACK(ERR_LIB_CRYPTO,0,0)           ,"common libcrypto routines"},
145 {ERR_PACK(ERR_LIB_EC,0,0)               ,"elliptic curve 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_HMAC,0,0)             ,"HMAC routines"},
157 {ERR_PACK(ERR_LIB_CMS,0,0)              ,"CMS routines"},
158 {0,NULL},
159         };
160
161 static ERR_STRING_DATA ERR_str_functs[]=
162         {
163         {ERR_PACK(0,SYS_F_FOPEN,0),             "fopen"},
164         {ERR_PACK(0,SYS_F_CONNECT,0),           "connect"},
165         {ERR_PACK(0,SYS_F_GETSERVBYNAME,0),     "getservbyname"},
166         {ERR_PACK(0,SYS_F_SOCKET,0),            "socket"}, 
167         {ERR_PACK(0,SYS_F_IOCTLSOCKET,0),       "ioctlsocket"},
168         {ERR_PACK(0,SYS_F_BIND,0),              "bind"},
169         {ERR_PACK(0,SYS_F_LISTEN,0),            "listen"},
170         {ERR_PACK(0,SYS_F_ACCEPT,0),            "accept"},
171 #ifdef OPENSSL_SYS_WINDOWS
172         {ERR_PACK(0,SYS_F_WSASTARTUP,0),        "WSAstartup"},
173 #endif
174         {ERR_PACK(0,SYS_F_OPENDIR,0),           "opendir"},
175         {ERR_PACK(0,SYS_F_FREAD,0),             "fread"},
176         {0,NULL},
177         };
178
179 static ERR_STRING_DATA ERR_str_reasons[]=
180         {
181 {ERR_R_SYS_LIB                          ,"system lib"},
182 {ERR_R_BN_LIB                           ,"BN lib"},
183 {ERR_R_RSA_LIB                          ,"RSA lib"},
184 {ERR_R_DH_LIB                           ,"DH lib"},
185 {ERR_R_EVP_LIB                          ,"EVP lib"},
186 {ERR_R_BUF_LIB                          ,"BUF lib"},
187 {ERR_R_OBJ_LIB                          ,"OBJ lib"},
188 {ERR_R_PEM_LIB                          ,"PEM lib"},
189 {ERR_R_DSA_LIB                          ,"DSA lib"},
190 {ERR_R_X509_LIB                         ,"X509 lib"},
191 {ERR_R_ASN1_LIB                         ,"ASN1 lib"},
192 {ERR_R_CONF_LIB                         ,"CONF lib"},
193 {ERR_R_CRYPTO_LIB                       ,"CRYPTO lib"},
194 {ERR_R_EC_LIB                           ,"EC lib"},
195 {ERR_R_SSL_LIB                          ,"SSL lib"},
196 {ERR_R_BIO_LIB                          ,"BIO lib"},
197 {ERR_R_PKCS7_LIB                        ,"PKCS7 lib"},
198 {ERR_R_X509V3_LIB                       ,"X509V3 lib"},
199 {ERR_R_PKCS12_LIB                       ,"PKCS12 lib"},
200 {ERR_R_RAND_LIB                         ,"RAND lib"},
201 {ERR_R_DSO_LIB                          ,"DSO lib"},
202 {ERR_R_ENGINE_LIB                       ,"ENGINE lib"},
203 {ERR_R_OCSP_LIB                         ,"OCSP lib"},
204 {ERR_R_TS_LIB                           ,"TS lib"},
205
206 {ERR_R_NESTED_ASN1_ERROR                ,"nested asn1 error"},
207 {ERR_R_BAD_ASN1_OBJECT_HEADER           ,"bad asn1 object header"},
208 {ERR_R_BAD_GET_ASN1_OBJECT_CALL         ,"bad get asn1 object call"},
209 {ERR_R_EXPECTING_AN_ASN1_SEQUENCE       ,"expecting an asn1 sequence"},
210 {ERR_R_ASN1_LENGTH_MISMATCH             ,"asn1 length mismatch"},
211 {ERR_R_MISSING_ASN1_EOS                 ,"missing asn1 eos"},
212
213 {ERR_R_FATAL                            ,"fatal"},
214 {ERR_R_MALLOC_FAILURE                   ,"malloc failure"},
215 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED      ,"called a function you should not call"},
216 {ERR_R_PASSED_NULL_PARAMETER            ,"passed a null parameter"},
217 {ERR_R_INTERNAL_ERROR                   ,"internal error"},
218 {ERR_R_DISABLED                         ,"called a function that was disabled at compile-time"},
219
220 {0,NULL},
221         };
222 #endif
223
224
225 /* Define the predeclared (but externally opaque) "ERR_FNS" type */
226 struct st_ERR_FNS
227         {
228         /* Works on the "error_hash" string table */
229         LHASH_OF(ERR_STRING_DATA) *(*cb_err_get)(int create);
230         void (*cb_err_del)(void);
231         ERR_STRING_DATA *(*cb_err_get_item)(const ERR_STRING_DATA *);
232         ERR_STRING_DATA *(*cb_err_set_item)(ERR_STRING_DATA *);
233         ERR_STRING_DATA *(*cb_err_del_item)(ERR_STRING_DATA *);
234         /* Works on the "thread_hash" error-state table */
235         LHASH_OF(ERR_STATE) *(*cb_thread_get)(int create);
236         void (*cb_thread_release)(LHASH_OF(ERR_STATE) **hash);
237         ERR_STATE *(*cb_thread_get_item)(const ERR_STATE *);
238         ERR_STATE *(*cb_thread_set_item)(ERR_STATE *);
239         void (*cb_thread_del_item)(const ERR_STATE *);
240         /* Returns the next available error "library" numbers */
241         int (*cb_get_next_lib)(void);
242         };
243
244 /* Predeclarations of the "err_defaults" functions */
245 static LHASH_OF(ERR_STRING_DATA) *int_err_get(int create);
246 static void int_err_del(void);
247 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
248 static ERR_STRING_DATA *int_err_set_item(ERR_STRING_DATA *);
249 static ERR_STRING_DATA *int_err_del_item(ERR_STRING_DATA *);
250 static LHASH_OF(ERR_STATE) *int_thread_get(int create);
251 static void int_thread_release(LHASH_OF(ERR_STATE) **hash);
252 static ERR_STATE *int_thread_get_item(const ERR_STATE *);
253 static ERR_STATE *int_thread_set_item(ERR_STATE *);
254 static void int_thread_del_item(const ERR_STATE *);
255 static int int_err_get_next_lib(void);
256 /* The static ERR_FNS table using these defaults functions */
257 static const ERR_FNS err_defaults =
258         {
259         int_err_get,
260         int_err_del,
261         int_err_get_item,
262         int_err_set_item,
263         int_err_del_item,
264         int_thread_get,
265         int_thread_release,
266         int_thread_get_item,
267         int_thread_set_item,
268         int_thread_del_item,
269         int_err_get_next_lib
270         };
271
272 /* The replacable table of ERR_FNS functions we use at run-time */
273 static const ERR_FNS *err_fns = NULL;
274
275 /* Eg. rather than using "err_get()", use "ERRFN(err_get)()". */
276 #define ERRFN(a) err_fns->cb_##a
277
278 /* The internal state used by "err_defaults" - as such, the setting, reading,
279  * creating, and deleting of this data should only be permitted via the
280  * "err_defaults" functions. This way, a linked module can completely defer all
281  * ERR state operation (together with requisite locking) to the implementations
282  * and state in the loading application. */
283 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
284 static LHASH_OF(ERR_STATE) *int_thread_hash = NULL;
285 static int int_thread_hash_references = 0;
286 static int int_err_library_number= ERR_LIB_USER;
287
288 /* Internal function that checks whether "err_fns" is set and if not, sets it to
289  * the defaults. */
290 static void err_fns_check(void)
291         {
292         if (err_fns) return;
293         
294         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
295         if (!err_fns)
296                 err_fns = &err_defaults;
297         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
298         }
299
300 /* API functions to get or set the underlying ERR functions. */
301
302 const ERR_FNS *ERR_get_implementation(void)
303         {
304         err_fns_check();
305         return err_fns;
306         }
307
308 int ERR_set_implementation(const ERR_FNS *fns)
309         {
310         int ret = 0;
311
312         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
313         /* It's too late if 'err_fns' is non-NULL. BTW: not much point setting
314          * an error is there?! */
315         if (!err_fns)
316                 {
317                 err_fns = fns;
318                 ret = 1;
319                 }
320         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
321         return ret;
322         }
323
324 /* These are the callbacks provided to "lh_new()" when creating the LHASH tables
325  * internal to the "err_defaults" implementation. */
326
327 static unsigned long get_error_values(int inc,int top,const char **file,int *line,
328                                       const char **data,int *flags);
329
330 /* The internal functions used in the "err_defaults" implementation */
331
332 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
333         {
334         unsigned long ret,l;
335
336         l=a->error;
337         ret=l^ERR_GET_LIB(l)^ERR_GET_FUNC(l);
338         return(ret^ret%19*13);
339         }
340 static IMPLEMENT_LHASH_HASH_FN(err_string_data, ERR_STRING_DATA);
341
342 static int err_string_data_cmp(const ERR_STRING_DATA *a,
343                                const ERR_STRING_DATA *b)
344         {
345         return (int)(a->error - b->error);
346         }
347 static IMPLEMENT_LHASH_COMP_FN(err_string_data, ERR_STRING_DATA);
348
349 static LHASH_OF(ERR_STRING_DATA) *int_err_get(int create)
350         {
351         LHASH_OF(ERR_STRING_DATA) *ret = NULL;
352
353         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
354         if (!int_error_hash && create)
355                 {
356                 CRYPTO_push_info("int_err_get (err.c)");
357                 int_error_hash = lh_ERR_STRING_DATA_new();
358                 CRYPTO_pop_info();
359                 }
360         if (int_error_hash)
361                 ret = int_error_hash;
362         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
363
364         return ret;
365         }
366
367 static void int_err_del(void)
368         {
369         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
370         if (int_error_hash)
371                 {
372                 lh_ERR_STRING_DATA_free(int_error_hash);
373                 int_error_hash = NULL;
374                 }
375         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
376         }
377
378 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
379         {
380         ERR_STRING_DATA *p;
381         LHASH_OF(ERR_STRING_DATA) *hash;
382
383         err_fns_check();
384         hash = ERRFN(err_get)(0);
385         if (!hash)
386                 return NULL;
387
388         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
389         p = lh_ERR_STRING_DATA_retrieve(hash, d);
390         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
391
392         return p;
393         }
394
395 static ERR_STRING_DATA *int_err_set_item(ERR_STRING_DATA *d)
396         {
397         ERR_STRING_DATA *p;
398         LHASH_OF(ERR_STRING_DATA) *hash;
399
400         err_fns_check();
401         hash = ERRFN(err_get)(1);
402         if (!hash)
403                 return NULL;
404
405         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
406         p = lh_ERR_STRING_DATA_insert(hash, d);
407         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
408
409         return p;
410         }
411
412 static ERR_STRING_DATA *int_err_del_item(ERR_STRING_DATA *d)
413         {
414         ERR_STRING_DATA *p;
415         LHASH_OF(ERR_STRING_DATA) *hash;
416
417         err_fns_check();
418         hash = ERRFN(err_get)(0);
419         if (!hash)
420                 return NULL;
421
422         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
423         p = lh_ERR_STRING_DATA_delete(hash, d);
424         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
425
426         return p;
427         }
428
429 static unsigned long err_state_hash(const ERR_STATE *a)
430         {
431         return CRYPTO_THREADID_hash(&a->tid);
432         }
433 static IMPLEMENT_LHASH_HASH_FN(err_state, ERR_STATE);
434
435 static int err_state_cmp(const ERR_STATE *a, const ERR_STATE *b)
436         {
437         return CRYPTO_THREADID_cmp(&a->tid, &b->tid);
438         }
439 static IMPLEMENT_LHASH_COMP_FN(err_state, ERR_STATE);
440
441 static LHASH_OF(ERR_STATE) *int_thread_get(int create)
442         {
443         LHASH_OF(ERR_STATE) *ret = NULL;
444
445         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
446         if (!int_thread_hash && create)
447                 {
448                 CRYPTO_push_info("int_thread_get (err.c)");
449                 int_thread_hash = lh_ERR_STATE_new();
450                 CRYPTO_pop_info();
451                 }
452         if (int_thread_hash)
453                 {
454                 int_thread_hash_references++;
455                 ret = int_thread_hash;
456                 }
457         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
458         return ret;
459         }
460
461 static void int_thread_release(LHASH_OF(ERR_STATE) **hash)
462         {
463         int i;
464
465         if (hash == NULL || *hash == NULL)
466                 return;
467
468         i = CRYPTO_add(&int_thread_hash_references, -1, CRYPTO_LOCK_ERR);
469
470 #ifdef REF_PRINT
471         fprintf(stderr,"%4d:%s\n",int_thread_hash_references,"ERR");
472 #endif
473         if (i > 0) return;
474 #ifdef REF_CHECK
475         if (i < 0)
476                 {
477                 fprintf(stderr,"int_thread_release, bad reference count\n");
478                 abort(); /* ok */
479                 }
480 #endif
481         *hash = NULL;
482         }
483
484 static ERR_STATE *int_thread_get_item(const ERR_STATE *d)
485         {
486         ERR_STATE *p;
487         LHASH_OF(ERR_STATE) *hash;
488
489         err_fns_check();
490         hash = ERRFN(thread_get)(0);
491         if (!hash)
492                 return NULL;
493
494         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
495         p = lh_ERR_STATE_retrieve(hash, d);
496         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
497
498         ERRFN(thread_release)(&hash);
499         return p;
500         }
501
502 static ERR_STATE *int_thread_set_item(ERR_STATE *d)
503         {
504         ERR_STATE *p;
505         LHASH_OF(ERR_STATE) *hash;
506
507         err_fns_check();
508         hash = ERRFN(thread_get)(1);
509         if (!hash)
510                 return NULL;
511
512         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
513         p = lh_ERR_STATE_insert(hash, d);
514         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
515
516         ERRFN(thread_release)(&hash);
517         return p;
518         }
519
520 static void int_thread_del_item(const ERR_STATE *d)
521         {
522         ERR_STATE *p;
523         LHASH_OF(ERR_STATE) *hash;
524
525         err_fns_check();
526         hash = ERRFN(thread_get)(0);
527         if (!hash)
528                 return;
529
530         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
531         p = lh_ERR_STATE_delete(hash, d);
532         /* make sure we don't leak memory */
533         if (int_thread_hash_references == 1
534             && int_thread_hash && lh_ERR_STATE_num_items(int_thread_hash) == 0)
535                 {
536                 lh_ERR_STATE_free(int_thread_hash);
537                 int_thread_hash = NULL;
538                 }
539         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
540
541         ERRFN(thread_release)(&hash);
542         if (p)
543                 ERR_STATE_free(p);
544         }
545
546 static int int_err_get_next_lib(void)
547         {
548         int ret;
549
550         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
551         ret = int_err_library_number++;
552         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
553
554         return ret;
555         }
556
557
558 #ifndef OPENSSL_NO_ERR
559 #define NUM_SYS_STR_REASONS 127
560 #define LEN_SYS_STR_REASON 32
561
562 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
563 /* SYS_str_reasons is filled with copies of strerror() results at
564  * initialization.
565  * 'errno' values up to 127 should cover all usual errors,
566  * others will be displayed numerically by ERR_error_string.
567  * It is crucial that we have something for each reason code
568  * that occurs in ERR_str_reasons, or bogus reason strings
569  * will be returned for SYSerr(), which always gets an errno
570  * value and never one of those 'standard' reason codes. */
571
572 static void build_SYS_str_reasons(void)
573         {
574         /* OPENSSL_malloc cannot be used here, use static storage instead */
575         static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
576         int i;
577         static int init = 1;
578
579         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
580         if (!init)
581                 {
582                 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
583                 return;
584                 }
585         
586         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
587         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
588         if (!init)
589                 {
590                 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
591                 return;
592                 }
593
594         for (i = 1; i <= NUM_SYS_STR_REASONS; i++)
595                 {
596                 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
597
598                 str->error = (unsigned long)i;
599                 if (str->string == NULL)
600                         {
601                         char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
602                         char *src = strerror(i);
603                         if (src != NULL)
604                                 {
605                                 strncpy(*dest, src, sizeof *dest);
606                                 (*dest)[sizeof *dest - 1] = '\0';
607                                 str->string = *dest;
608                                 }
609                         }
610                 if (str->string == NULL)
611                         str->string = "unknown";
612                 }
613
614         /* Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL},
615          * as required by ERR_load_strings. */
616
617         init = 0;
618         
619         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
620         }
621 #endif
622
623 #define err_clear_data(p,i) \
624         do { \
625         if (((p)->err_data[i] != NULL) && \
626                 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
627                 {  \
628                 OPENSSL_free((p)->err_data[i]); \
629                 (p)->err_data[i]=NULL; \
630                 } \
631         (p)->err_data_flags[i]=0; \
632         } while(0)
633
634 #define err_clear(p,i) \
635         do { \
636         (p)->err_flags[i]=0; \
637         (p)->err_buffer[i]=0; \
638         err_clear_data(p,i); \
639         (p)->err_file[i]=NULL; \
640         (p)->err_line[i]= -1; \
641         } while(0)
642
643 static void ERR_STATE_free(ERR_STATE *s)
644         {
645         int i;
646
647         if (s == NULL)
648             return;
649
650         for (i=0; i<ERR_NUM_ERRORS; i++)
651                 {
652                 err_clear_data(s,i);
653                 }
654         OPENSSL_free(s);
655         }
656
657 void ERR_load_ERR_strings(void)
658         {
659         err_fns_check();
660 #ifndef OPENSSL_NO_ERR
661         err_load_strings(0,ERR_str_libraries);
662         err_load_strings(0,ERR_str_reasons);
663         err_load_strings(ERR_LIB_SYS,ERR_str_functs);
664         build_SYS_str_reasons();
665         err_load_strings(ERR_LIB_SYS,SYS_str_reasons);
666 #endif
667         }
668
669 static void err_load_strings(int lib, ERR_STRING_DATA *str)
670         {
671         while (str->error)
672                 {
673                 if (lib)
674                         str->error|=ERR_PACK(lib,0,0);
675                 ERRFN(err_set_item)(str);
676                 str++;
677                 }
678         }
679
680 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
681         {
682         ERR_load_ERR_strings();
683         err_load_strings(lib, str);
684         }
685
686 void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
687         {
688         while (str->error)
689                 {
690                 if (lib)
691                         str->error|=ERR_PACK(lib,0,0);
692                 ERRFN(err_del_item)(str);
693                 str++;
694                 }
695         }
696
697 void ERR_free_strings(void)
698         {
699         err_fns_check();
700         ERRFN(err_del)();
701         }
702
703 /********************************************************/
704
705 void ERR_put_error(int lib, int func, int reason, const char *file,
706              int line)
707         {
708         ERR_STATE *es;
709
710 #ifdef _OSD_POSIX
711         /* In the BS2000-OSD POSIX subsystem, the compiler generates
712          * path names in the form "*POSIX(/etc/passwd)".
713          * This dirty hack strips them to something sensible.
714          * @@@ We shouldn't modify a const string, though.
715          */
716         if (strncmp(file,"*POSIX(", sizeof("*POSIX(")-1) == 0) {
717                 char *end;
718
719                 /* Skip the "*POSIX(" prefix */
720                 file += sizeof("*POSIX(")-1;
721                 end = &file[strlen(file)-1];
722                 if (*end == ')')
723                         *end = '\0';
724                 /* Optional: use the basename of the path only. */
725                 if ((end = strrchr(file, '/')) != NULL)
726                         file = &end[1];
727         }
728 #endif
729         es=ERR_get_state();
730
731         es->top=(es->top+1)%ERR_NUM_ERRORS;
732         if (es->top == es->bottom)
733                 es->bottom=(es->bottom+1)%ERR_NUM_ERRORS;
734         es->err_flags[es->top]=0;
735         es->err_buffer[es->top]=ERR_PACK(lib,func,reason);
736         es->err_file[es->top]=file;
737         es->err_line[es->top]=line;
738         err_clear_data(es,es->top);
739         }
740
741 void ERR_clear_error(void)
742         {
743         int i;
744         ERR_STATE *es;
745
746         es=ERR_get_state();
747
748         for (i=0; i<ERR_NUM_ERRORS; i++)
749                 {
750                 err_clear(es,i);
751                 }
752         es->top=es->bottom=0;
753         }
754
755
756 unsigned long ERR_get_error(void)
757         { return(get_error_values(1,0,NULL,NULL,NULL,NULL)); }
758
759 unsigned long ERR_get_error_line(const char **file,
760              int *line)
761         { return(get_error_values(1,0,file,line,NULL,NULL)); }
762
763 unsigned long ERR_get_error_line_data(const char **file, int *line,
764              const char **data, int *flags)
765         { return(get_error_values(1,0,file,line,data,flags)); }
766
767
768 unsigned long ERR_peek_error(void)
769         { return(get_error_values(0,0,NULL,NULL,NULL,NULL)); }
770
771 unsigned long ERR_peek_error_line(const char **file, int *line)
772         { return(get_error_values(0,0,file,line,NULL,NULL)); }
773
774 unsigned long ERR_peek_error_line_data(const char **file, int *line,
775              const char **data, int *flags)
776         { return(get_error_values(0,0,file,line,data,flags)); }
777
778
779 unsigned long ERR_peek_last_error(void)
780         { return(get_error_values(0,1,NULL,NULL,NULL,NULL)); }
781
782 unsigned long ERR_peek_last_error_line(const char **file, int *line)
783         { return(get_error_values(0,1,file,line,NULL,NULL)); }
784
785 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
786              const char **data, int *flags)
787         { return(get_error_values(0,1,file,line,data,flags)); }
788
789
790 static unsigned long get_error_values(int inc, int top, const char **file, int *line,
791              const char **data, int *flags)
792         {       
793         int i=0;
794         ERR_STATE *es;
795         unsigned long ret;
796
797         es=ERR_get_state();
798
799         if (inc && top)
800                 {
801                 if (file) *file = "";
802                 if (line) *line = 0;
803                 if (data) *data = "";
804                 if (flags) *flags = 0;
805                         
806                 return ERR_R_INTERNAL_ERROR;
807                 }
808
809         if (es->bottom == es->top) return 0;
810         if (top)
811                 i=es->top;                       /* last error */
812         else
813                 i=(es->bottom+1)%ERR_NUM_ERRORS; /* first error */
814
815         ret=es->err_buffer[i];
816         if (inc)
817                 {
818                 es->bottom=i;
819                 es->err_buffer[i]=0;
820                 }
821
822         if ((file != NULL) && (line != NULL))
823                 {
824                 if (es->err_file[i] == NULL)
825                         {
826                         *file="NA";
827                         if (line != NULL) *line=0;
828                         }
829                 else
830                         {
831                         *file=es->err_file[i];
832                         if (line != NULL) *line=es->err_line[i];
833                         }
834                 }
835
836         if (data == NULL)
837                 {
838                 if (inc)
839                         {
840                         err_clear_data(es, i);
841                         }
842                 }
843         else
844                 {
845                 if (es->err_data[i] == NULL)
846                         {
847                         *data="";
848                         if (flags != NULL) *flags=0;
849                         }
850                 else
851                         {
852                         *data=es->err_data[i];
853                         if (flags != NULL) *flags=es->err_data_flags[i];
854                         }
855                 }
856         return ret;
857         }
858
859 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
860         {
861         char lsbuf[64], fsbuf[64], rsbuf[64];
862         const char *ls,*fs,*rs;
863         unsigned long l,f,r;
864
865         l=ERR_GET_LIB(e);
866         f=ERR_GET_FUNC(e);
867         r=ERR_GET_REASON(e);
868
869         ls=ERR_lib_error_string(e);
870         fs=ERR_func_error_string(e);
871         rs=ERR_reason_error_string(e);
872
873         if (ls == NULL) 
874                 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
875         if (fs == NULL)
876                 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
877         if (rs == NULL)
878                 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
879
880         BIO_snprintf(buf, len,"error:%08lX:%s:%s:%s", e, ls?ls:lsbuf, 
881                 fs?fs:fsbuf, rs?rs:rsbuf);
882         if (strlen(buf) == len-1)
883                 {
884                 /* output may be truncated; make sure we always have 5 
885                  * colon-separated fields, i.e. 4 colons ... */
886 #define NUM_COLONS 4
887                 if (len > NUM_COLONS) /* ... if possible */
888                         {
889                         int i;
890                         char *s = buf;
891                         
892                         for (i = 0; i < NUM_COLONS; i++)
893                                 {
894                                 char *colon = strchr(s, ':');
895                                 if (colon == NULL || colon > &buf[len-1] - NUM_COLONS + i)
896                                         {
897                                         /* set colon no. i at last possible position
898                                          * (buf[len-1] is the terminating 0)*/
899                                         colon = &buf[len-1] - NUM_COLONS + i;
900                                         *colon = ':';
901                                         }
902                                 s = colon + 1;
903                                 }
904                         }
905                 }
906         }
907
908 /* BAD for multi-threading: uses a local buffer if ret == NULL */
909 /* ERR_error_string_n should be used instead for ret != NULL
910  * as ERR_error_string cannot know how large the buffer is */
911 char *ERR_error_string(unsigned long e, char *ret)
912         {
913         static char buf[256];
914
915         if (ret == NULL) ret=buf;
916         ERR_error_string_n(e, ret, 256);
917
918         return ret;
919         }
920
921 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void)
922         {
923         err_fns_check();
924         return ERRFN(err_get)(0);
925         }
926
927 LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void)
928         {
929         err_fns_check();
930         return ERRFN(thread_get)(0);
931         }
932
933 void ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash)
934         {
935         err_fns_check();
936         ERRFN(thread_release)(hash);
937         }
938
939 const char *ERR_lib_error_string(unsigned long e)
940         {
941         ERR_STRING_DATA d,*p;
942         unsigned long l;
943
944         err_fns_check();
945         l=ERR_GET_LIB(e);
946         d.error=ERR_PACK(l,0,0);
947         p=ERRFN(err_get_item)(&d);
948         return((p == NULL)?NULL:p->string);
949         }
950
951 const char *ERR_func_error_string(unsigned long e)
952         {
953         ERR_STRING_DATA d,*p;
954         unsigned long l,f;
955
956         err_fns_check();
957         l=ERR_GET_LIB(e);
958         f=ERR_GET_FUNC(e);
959         d.error=ERR_PACK(l,f,0);
960         p=ERRFN(err_get_item)(&d);
961         return((p == NULL)?NULL:p->string);
962         }
963
964 const char *ERR_reason_error_string(unsigned long e)
965         {
966         ERR_STRING_DATA d,*p=NULL;
967         unsigned long l,r;
968
969         err_fns_check();
970         l=ERR_GET_LIB(e);
971         r=ERR_GET_REASON(e);
972         d.error=ERR_PACK(l,0,r);
973         p=ERRFN(err_get_item)(&d);
974         if (!p)
975                 {
976                 d.error=ERR_PACK(0,0,r);
977                 p=ERRFN(err_get_item)(&d);
978                 }
979         return((p == NULL)?NULL:p->string);
980         }
981
982 void ERR_remove_thread_state(CRYPTO_THREADID *tid)
983         {
984         ERR_STATE tmp;
985
986         if (tid)
987                 CRYPTO_THREADID_cpy(&tmp.tid, tid);
988         else
989                 CRYPTO_THREADID_set(&tmp.tid);
990         err_fns_check();
991         /* thread_del_item automatically destroys the LHASH if the number of
992          * items reaches zero. */
993         ERRFN(thread_del_item)(&tmp);
994         }
995
996 #ifndef OPENSSL_NO_DEPRECATED
997 void ERR_remove_state(unsigned long pid)
998         {
999         ERR_remove_thread_state(NULL);
1000         }
1001 #endif
1002
1003 ERR_STATE *ERR_get_state(void)
1004         {
1005         static ERR_STATE fallback;
1006         CRYPTO_THREADID tid;
1007         ERR_STATE *ret,tmp,*tmpp=NULL;
1008         int i;
1009
1010         err_fns_check();
1011         CRYPTO_THREADID_set(&tid);
1012         CRYPTO_THREADID_cpy(&tmp.tid, &tid);
1013         ret=ERRFN(thread_get_item)(&tmp);
1014
1015         /* ret == the error state, if NULL, make a new one */
1016         if (ret == NULL)
1017                 {
1018                 ret=(ERR_STATE *)OPENSSL_malloc(sizeof(ERR_STATE));
1019                 if (ret == NULL) return(&fallback);
1020                 CRYPTO_THREADID_cpy(&ret->tid, &tid);
1021                 ret->top=0;
1022                 ret->bottom=0;
1023                 for (i=0; i<ERR_NUM_ERRORS; i++)
1024                         {
1025                         ret->err_data[i]=NULL;
1026                         ret->err_data_flags[i]=0;
1027                         }
1028                 tmpp = ERRFN(thread_set_item)(ret);
1029                 /* To check if insertion failed, do a get. */
1030                 if (ERRFN(thread_get_item)(ret) != ret)
1031                         {
1032                         ERR_STATE_free(ret); /* could not insert it */
1033                         return(&fallback);
1034                         }
1035                 /* If a race occured in this function and we came second, tmpp
1036                  * is the first one that we just replaced. */
1037                 if (tmpp)
1038                         ERR_STATE_free(tmpp);
1039                 }
1040         return ret;
1041         }
1042
1043 int ERR_get_next_error_library(void)
1044         {
1045         err_fns_check();
1046         return ERRFN(get_next_lib)();
1047         }
1048
1049 void ERR_set_error_data(char *data, int flags)
1050         {
1051         ERR_STATE *es;
1052         int i;
1053
1054         es=ERR_get_state();
1055
1056         i=es->top;
1057         if (i == 0)
1058                 i=ERR_NUM_ERRORS-1;
1059
1060         err_clear_data(es,i);
1061         es->err_data[i]=data;
1062         es->err_data_flags[i]=flags;
1063         }
1064
1065 void ERR_add_error_data(int num, ...)
1066         {
1067         va_list args;
1068         int i,n,s;
1069         char *str,*p,*a;
1070
1071         s=80;
1072         str=OPENSSL_malloc(s+1);
1073         if (str == NULL) return;
1074         str[0]='\0';
1075
1076         va_start(args, num);
1077         n=0;
1078         for (i=0; i<num; i++)
1079                 {
1080                 a=va_arg(args, char*);
1081                 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
1082                 if (a != NULL)
1083                         {
1084                         n+=strlen(a);
1085                         if (n > s)
1086                                 {
1087                                 s=n+20;
1088                                 p=OPENSSL_realloc(str,s+1);
1089                                 if (p == NULL)
1090                                         {
1091                                         OPENSSL_free(str);
1092                                         goto err;
1093                                         }
1094                                 else
1095                                         str=p;
1096                                 }
1097                         BUF_strlcat(str,a,(size_t)s+1);
1098                         }
1099                 }
1100         ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);
1101
1102 err:
1103         va_end(args);
1104         }
1105
1106 int ERR_set_mark(void)
1107         {
1108         ERR_STATE *es;
1109
1110         es=ERR_get_state();
1111
1112         if (es->bottom == es->top) return 0;
1113         es->err_flags[es->top]|=ERR_FLAG_MARK;
1114         return 1;
1115         }
1116
1117 int ERR_pop_to_mark(void)
1118         {
1119         ERR_STATE *es;
1120
1121         es=ERR_get_state();
1122
1123         while(es->bottom != es->top
1124                 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0)
1125                 {
1126                 err_clear(es,es->top);
1127                 es->top-=1;
1128                 if (es->top == -1) es->top=ERR_NUM_ERRORS-1;
1129                 }
1130                 
1131         if (es->bottom == es->top) return 0;
1132         es->err_flags[es->top]&=~ERR_FLAG_MARK;
1133         return 1;
1134         }