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