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