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