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