Remove redundant ifdef.
[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 #include <stdio.h>
60 #include <stdarg.h>
61 #include <openssl/lhash.h>
62 #include <openssl/crypto.h>
63 #include "cryptlib.h"
64 #include <openssl/buffer.h>
65 #include <openssl/err.h>
66 #include <openssl/crypto.h>
67
68
69 static LHASH *error_hash=NULL;
70 static LHASH *thread_hash=NULL;
71
72 static unsigned long err_hash(ERR_STRING_DATA *a);
73 static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b);
74 static unsigned long pid_hash(ERR_STATE *pid);
75 static int pid_cmp(ERR_STATE *a,ERR_STATE *pid);
76 static unsigned long get_error_values(int inc,const char **file,int *line,
77                                       const char **data,int *flags);
78 static void ERR_STATE_free(ERR_STATE *s);
79 #ifndef NO_ERR
80 static ERR_STRING_DATA ERR_str_libraries[]=
81         {
82 {ERR_PACK(ERR_LIB_NONE,0,0)             ,"unknown library"},
83 {ERR_PACK(ERR_LIB_SYS,0,0)              ,"system library"},
84 {ERR_PACK(ERR_LIB_BN,0,0)               ,"bignum routines"},
85 {ERR_PACK(ERR_LIB_RSA,0,0)              ,"rsa routines"},
86 {ERR_PACK(ERR_LIB_DH,0,0)               ,"Diffie-Hellman routines"},
87 {ERR_PACK(ERR_LIB_EVP,0,0)              ,"digital envelope routines"},
88 {ERR_PACK(ERR_LIB_BUF,0,0)              ,"memory buffer routines"},
89 {ERR_PACK(ERR_LIB_BIO,0,0)              ,"BIO routines"},
90 {ERR_PACK(ERR_LIB_OBJ,0,0)              ,"object identifier routines"},
91 {ERR_PACK(ERR_LIB_PEM,0,0)              ,"PEM routines"},
92 {ERR_PACK(ERR_LIB_ASN1,0,0)             ,"asn1 encoding routines"},
93 {ERR_PACK(ERR_LIB_X509,0,0)             ,"x509 certificate routines"},
94 {ERR_PACK(ERR_LIB_CONF,0,0)             ,"configuation file routines"},
95 {ERR_PACK(ERR_LIB_METH,0,0)             ,"X509 lookup 'method' routines"},
96 {ERR_PACK(ERR_LIB_SSL,0,0)              ,"SSL routines"},
97 {ERR_PACK(ERR_LIB_RSAREF,0,0)           ,"RSAref routines"},
98 {ERR_PACK(ERR_LIB_PROXY,0,0)            ,"Proxy routines"},
99 {ERR_PACK(ERR_LIB_BIO,0,0)              ,"BIO routines"},
100 {ERR_PACK(ERR_LIB_PKCS7,0,0)            ,"PKCS7 routines"},
101 {ERR_PACK(ERR_LIB_X509V3,0,0)           ,"X509 V3 routines"},
102 {ERR_PACK(ERR_LIB_PKCS12,0,0)           ,"PKCS12 routines"},
103 {0,NULL},
104         };
105
106 static ERR_STRING_DATA ERR_str_functs[]=
107         {
108         {ERR_PACK(0,SYS_F_FOPEN,0),             "fopen"},
109         {ERR_PACK(0,SYS_F_CONNECT,0),           "connect"},
110         {ERR_PACK(0,SYS_F_GETSERVBYNAME,0),     "getservbyname"},
111         {ERR_PACK(0,SYS_F_SOCKET,0),            "socket"}, 
112         {ERR_PACK(0,SYS_F_IOCTLSOCKET,0),       "ioctlsocket"},
113         {ERR_PACK(0,SYS_F_BIND,0),              "bind"},
114         {ERR_PACK(0,SYS_F_LISTEN,0),            "listen"},
115         {ERR_PACK(0,SYS_F_ACCEPT,0),            "accept"},
116 #ifdef WINDOWS
117         {ERR_PACK(0,SYS_F_WSASTARTUP,0),        "WSAstartup"},
118 #endif
119         {0,NULL},
120         };
121
122 static ERR_STRING_DATA ERR_str_reasons[]=
123         {
124 {ERR_R_FATAL                             ,"fatal"},
125 {ERR_R_SYS_LIB                          ,"system lib"},
126 {ERR_R_BN_LIB                           ,"BN lib"},
127 {ERR_R_RSA_LIB                          ,"RSA lib"},
128 {ERR_R_DH_LIB                           ,"DH lib"},
129 {ERR_R_EVP_LIB                          ,"EVP lib"},
130 {ERR_R_BUF_LIB                          ,"BUF lib"},
131 {ERR_R_BIO_LIB                          ,"BIO lib"},
132 {ERR_R_OBJ_LIB                          ,"OBJ lib"},
133 {ERR_R_PEM_LIB                          ,"PEM lib"},
134 {ERR_R_X509_LIB                         ,"X509 lib"},
135 {ERR_R_METH_LIB                         ,"METH lib"},
136 {ERR_R_ASN1_LIB                         ,"ASN1 lib"},
137 {ERR_R_CONF_LIB                         ,"CONF lib"},
138 {ERR_R_SSL_LIB                          ,"SSL lib"},
139 {ERR_R_PROXY_LIB                        ,"PROXY lib"},
140 {ERR_R_BIO_LIB                          ,"BIO lib"},
141 {ERR_R_PKCS7_LIB                        ,"PKCS7 lib"},
142 {ERR_R_PKCS12_LIB                       ,"PKCS12 lib"},
143 {ERR_R_MALLOC_FAILURE                   ,"Malloc failure"},
144 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED      ,"called a fuction you should not call"},
145 {ERR_R_PASSED_NULL_PARAMETER            ,"passed a null parameter"},
146 {ERR_R_NESTED_ASN1_ERROR                ,"nested asn1 error"},
147 {ERR_R_BAD_ASN1_OBJECT_HEADER           ,"bad asn1 object header"},
148 {ERR_R_BAD_GET_ASN1_OBJECT_CALL         ,"bad get asn1 object call"},
149 {ERR_R_EXPECTING_AN_ASN1_SEQUENCE       ,"expecting an asn1 sequence"},
150 {ERR_R_ASN1_LENGTH_MISMATCH             ,"asn1 length mismatch"},
151 {ERR_R_MISSING_ASN1_EOS                 ,"missing asn1 eos"},
152
153 {0,NULL},
154         };
155 #endif
156
157 #define err_clear_data(p,i) \
158         if (((p)->err_data[i] != NULL) && \
159                 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
160                 {  \
161                 Free((p)->err_data[i]); \
162                 (p)->err_data[i]=NULL; \
163                 } \
164         (p)->err_data_flags[i]=0;
165
166 static void ERR_STATE_free(ERR_STATE *s)
167         {
168         int i;
169
170         if(s == NULL)
171             return;
172
173         for (i=0; i<ERR_NUM_ERRORS; i++)
174                 {
175                 err_clear_data(s,i);
176                 }
177         Free(s);
178         }
179
180 void ERR_load_ERR_strings(void)
181         {
182         static int init=1;
183
184         if (init)
185                 {
186                 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
187                 if (init == 0)
188                         {
189                         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
190                         return;
191                         }
192                 init=0;
193                 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
194
195 #ifndef NO_ERR
196                 ERR_load_strings(0,ERR_str_libraries);
197                 ERR_load_strings(0,ERR_str_reasons);
198                 ERR_load_strings(ERR_LIB_SYS,ERR_str_functs);
199 #endif
200                 }
201         }
202
203 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
204         {
205         if (error_hash == NULL)
206                 {
207                 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
208                 error_hash=lh_new(err_hash,err_cmp);
209                 if (error_hash == NULL)
210                         {
211                         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
212                         return;
213                         }
214                 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
215
216                 ERR_load_ERR_strings();
217                 }
218
219         CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
220         while (str->error)
221                 {
222                 str->error|=ERR_PACK(lib,0,0);
223                 lh_insert(error_hash,(char *)str);
224                 str++;
225                 }
226         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
227         }
228
229 void ERR_free_strings(void)
230         {
231         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
232
233         if (error_hash != NULL)
234                 {
235                 lh_free(error_hash);
236                 error_hash=NULL;
237                 }
238
239         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
240         }
241
242 /********************************************************/
243
244 void ERR_put_error(int lib, int func, int reason, const char *file,
245              int line)
246         {
247         ERR_STATE *es;
248
249         es=ERR_get_state();
250
251         es->top=(es->top+1)%ERR_NUM_ERRORS;
252         if (es->top == es->bottom)
253                 es->bottom=(es->bottom+1)%ERR_NUM_ERRORS;
254         es->err_buffer[es->top]=ERR_PACK(lib,func,reason);
255         es->err_file[es->top]=file;
256         es->err_line[es->top]=line;
257         err_clear_data(es,es->top);
258         }
259
260 void ERR_clear_error(void)
261         {
262         ERR_STATE *es;
263
264         es=ERR_get_state();
265
266 #if 0
267         /* hmm... is this needed */
268         for (i=0; i<ERR_NUM_ERRORS; i++)
269                 {
270                 es->err_buffer[i]=0;
271                 es->err_file[i]=NULL;
272                 es->err_line[i]= -1;
273                 err_clear_data(es,i);
274                 }
275 #endif
276         es->top=es->bottom=0;
277         }
278
279
280 unsigned long ERR_get_error(void)
281         { return(get_error_values(1,NULL,NULL,NULL,NULL)); }
282
283 unsigned long ERR_get_error_line(const char **file,
284              int *line)
285         { return(get_error_values(1,file,line,NULL,NULL)); }
286
287 unsigned long ERR_get_error_line_data(const char **file, int *line,
288              const char **data, int *flags)
289         { return(get_error_values(1,file,line,
290              data,flags)); }
291
292 unsigned long ERR_peek_error(void)
293         { return(get_error_values(0,NULL,NULL,NULL,NULL)); }
294
295 unsigned long ERR_peek_error_line(const char **file,
296              int *line)
297         { return(get_error_values(0,file,line,NULL,NULL)); }
298
299 unsigned long ERR_peek_error_line_data(const char **file, int *line,
300              const char **data, int *flags)
301         { return(get_error_values(0,file,line,
302              data,flags)); }
303
304 static unsigned long get_error_values(int inc, const char **file, int *line,
305              const char **data, int *flags)
306         {       
307         int i=0;
308         ERR_STATE *es;
309         unsigned long ret;
310
311         es=ERR_get_state();
312
313         if (es->bottom == es->top) return(0);
314         i=(es->bottom+1)%ERR_NUM_ERRORS;
315
316         ret=es->err_buffer[i];
317         if (inc)
318                 {
319                 es->bottom=i;
320                 es->err_buffer[i]=0;
321                 }
322
323         if ((file != NULL) && (line != NULL))
324                 {
325                 if (es->err_file[i] == NULL)
326                         {
327                         *file="NA";
328                         if (line != NULL) *line=0;
329                         }
330                 else
331                         {
332                         *file=es->err_file[i];
333                         if (line != NULL) *line=es->err_line[i];
334                         }
335                 }
336
337         if (data != NULL)
338                 {
339                 if (es->err_data[i] == NULL)
340                         {
341                         *data="";
342                         if (flags != NULL) *flags=0;
343                         }
344                 else
345                         {
346                         *data=es->err_data[i];
347                         if (flags != NULL) *flags=es->err_data_flags[i];
348                         }
349                 }
350         return(ret);
351         }
352
353 /* BAD for multi-threaded, uses a local buffer if ret == NULL */
354 char *ERR_error_string(unsigned long e, char *ret)
355         {
356         static char buf[256];
357         const char *ls,*fs,*rs;
358         unsigned long l,f,r;
359         int i;
360
361         l=ERR_GET_LIB(e);
362         f=ERR_GET_FUNC(e);
363         r=ERR_GET_REASON(e);
364
365         ls=ERR_lib_error_string(e);
366         fs=ERR_func_error_string(e);
367         rs=ERR_reason_error_string(e);
368
369         if (ret == NULL) ret=buf;
370
371         sprintf(&(ret[0]),"error:%08lX:",e);
372         i=strlen(ret);
373         if (ls == NULL)
374                 sprintf(&(ret[i]),":lib(%lu) ",l);
375         else    sprintf(&(ret[i]),"%s",ls);
376         i=strlen(ret);
377         if (fs == NULL)
378                 sprintf(&(ret[i]),":func(%lu) ",f);
379         else    sprintf(&(ret[i]),":%s",fs);
380         i=strlen(ret);
381         if (rs == NULL)
382                 sprintf(&(ret[i]),":reason(%lu)",r);
383         else    sprintf(&(ret[i]),":%s",rs);
384
385         return(ret);
386         }
387
388 LHASH *ERR_get_string_table(void)
389         {
390         return(error_hash);
391         }
392
393 LHASH *ERR_get_err_state_table(void)
394         {
395         return(thread_hash);
396         }
397
398 const char *ERR_lib_error_string(unsigned long e)
399         {
400         ERR_STRING_DATA d,*p=NULL;
401         unsigned long l;
402
403         l=ERR_GET_LIB(e);
404
405         CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
406
407         if (error_hash != NULL)
408                 {
409                 d.error=ERR_PACK(l,0,0);
410                 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,(char *)&d);
411                 }
412
413         CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
414
415         return((p == NULL)?NULL:p->string);
416         }
417
418 const char *ERR_func_error_string(unsigned long e)
419         {
420         ERR_STRING_DATA d,*p=NULL;
421         unsigned long l,f;
422
423         l=ERR_GET_LIB(e);
424         f=ERR_GET_FUNC(e);
425
426         CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
427
428         if (error_hash != NULL)
429                 {
430                 d.error=ERR_PACK(l,f,0);
431                 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,(char *)&d);
432                 }
433
434         CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
435
436         return((p == NULL)?NULL:p->string);
437         }
438
439 const char *ERR_reason_error_string(unsigned long e)
440         {
441         ERR_STRING_DATA d,*p=NULL;
442         unsigned long l,r;
443
444         l=ERR_GET_LIB(e);
445         r=ERR_GET_REASON(e);
446
447         CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
448
449         if (error_hash != NULL)
450                 {
451                 d.error=ERR_PACK(l,0,r);
452                 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,(char *)&d);
453                 if (p == NULL)
454                         {
455                         d.error=ERR_PACK(0,0,r);
456                         p=(ERR_STRING_DATA *)lh_retrieve(error_hash,
457                                 (char *)&d);
458                         }
459                 }
460
461         CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
462
463         return((p == NULL)?NULL:p->string);
464         }
465
466 static unsigned long err_hash(ERR_STRING_DATA *a)
467         {
468         unsigned long ret,l;
469
470         l=a->error;
471         ret=l^ERR_GET_LIB(l)^ERR_GET_FUNC(l);
472         return(ret^ret%19*13);
473         }
474
475 static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b)
476         {
477         return((int)(a->error-b->error));
478         }
479
480 static unsigned long pid_hash(ERR_STATE *a)
481         {
482         return(a->pid*13);
483         }
484
485 static int pid_cmp(ERR_STATE *a, ERR_STATE *b)
486         {
487         return((int)((long)a->pid - (long)b->pid));
488         }
489
490 void ERR_remove_state(unsigned long pid)
491         {
492         ERR_STATE *p,tmp;
493
494         if (thread_hash == NULL)
495                 return;
496         if (pid == 0)
497                 pid=(unsigned long)CRYPTO_thread_id();
498         tmp.pid=pid;
499         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
500         p=(ERR_STATE *)lh_delete(thread_hash,(char *)&tmp);
501         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
502
503         if (p != NULL) ERR_STATE_free(p);
504         }
505
506 ERR_STATE *ERR_get_state(void)
507         {
508         static ERR_STATE fallback;
509         ERR_STATE *ret=NULL,tmp,*tmpp;
510         int i;
511         unsigned long pid;
512
513         pid=(unsigned long)CRYPTO_thread_id();
514
515         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
516         if (thread_hash == NULL)
517                 {
518                 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
519                 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
520                 if (thread_hash == NULL)
521                         {
522                         MemCheck_off();
523                         thread_hash=lh_new(pid_hash,pid_cmp);
524                         MemCheck_on();
525                         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
526                         if (thread_hash == NULL) return(&fallback);
527                         }
528                 else
529                         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
530                 }
531         else
532                 {
533                 tmp.pid=pid;
534                 ret=(ERR_STATE *)lh_retrieve(thread_hash,(char *)&tmp);
535                 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
536                 }
537
538         /* ret == the error state, if NULL, make a new one */
539         if (ret == NULL)
540                 {
541                 ret=(ERR_STATE *)Malloc(sizeof(ERR_STATE));
542                 if (ret == NULL) return(&fallback);
543                 ret->pid=pid;
544                 ret->top=0;
545                 ret->bottom=0;
546                 for (i=0; i<ERR_NUM_ERRORS; i++)
547                         {
548                         ret->err_data[i]=NULL;
549                         ret->err_data_flags[i]=0;
550                         }
551                 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
552                 tmpp=(ERR_STATE *)lh_insert(thread_hash,(char *)ret);
553                 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
554                 if (tmpp != NULL) /* old entry - should not happen */
555                         {
556                         ERR_STATE_free(tmpp);
557                         }
558                 }
559         return(ret);
560         }
561
562 int ERR_get_next_error_library(void)
563         {
564         static int value=ERR_LIB_USER;
565
566         return(value++);
567         }
568
569 void ERR_set_error_data(char *data, int flags)
570         {
571         ERR_STATE *es;
572         int i;
573
574         es=ERR_get_state();
575
576         i=es->top;
577         if (i == 0)
578                 i=ERR_NUM_ERRORS-1;
579
580         es->err_data[i]=data;
581         es->err_data_flags[es->top]=flags;
582         }
583
584 void ERR_add_error_data(int num, ...)
585         {
586         va_list args;
587         int i,n,s;
588         char *str,*p,*a;
589
590         s=64;
591         str=Malloc(s+1);
592         if (str == NULL) return;
593         str[0]='\0';
594
595         va_start(args, num);
596         n=0;
597         for (i=0; i<num; i++)
598                 {
599                 a=va_arg(args, char*);
600                 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
601                 if (a != NULL)
602                         {
603                         n+=strlen(a);
604                         if (n > s)
605                                 {
606                                 s=n+20;
607                                 p=Realloc(str,s+1);
608                                 if (p == NULL)
609                                         {
610                                         Free(str);
611                                         return;
612                                         }
613                                 else
614                                         str=p;
615                                 }
616                         strcat(str,a);
617                         }
618                 }
619         ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);
620
621         va_end(args);
622         }
623