2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
61 #include <openssl/lhash.h>
62 #include <openssl/crypto.h>
64 #include <openssl/buffer.h>
65 #include <openssl/err.h>
66 #include <openssl/crypto.h>
69 static LHASH *error_hash=NULL;
70 static LHASH *thread_hash=NULL;
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);
80 static ERR_STRING_DATA ERR_str_libraries[]=
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) ,"configuration 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 {ERR_PACK(ERR_LIB_RAND,0,0) ,"random number generator"},
107 static ERR_STRING_DATA ERR_str_functs[]=
109 {ERR_PACK(0,SYS_F_FOPEN,0), "fopen"},
110 {ERR_PACK(0,SYS_F_CONNECT,0), "connect"},
111 {ERR_PACK(0,SYS_F_GETSERVBYNAME,0), "getservbyname"},
112 {ERR_PACK(0,SYS_F_SOCKET,0), "socket"},
113 {ERR_PACK(0,SYS_F_IOCTLSOCKET,0), "ioctlsocket"},
114 {ERR_PACK(0,SYS_F_BIND,0), "bind"},
115 {ERR_PACK(0,SYS_F_LISTEN,0), "listen"},
116 {ERR_PACK(0,SYS_F_ACCEPT,0), "accept"},
118 {ERR_PACK(0,SYS_F_WSASTARTUP,0), "WSAstartup"},
120 {ERR_PACK(0,SYS_F_OPENDIR,0), "opendir"},
124 static ERR_STRING_DATA ERR_str_reasons[]=
126 {ERR_R_FATAL ,"fatal"},
127 {ERR_R_SYS_LIB ,"system lib"},
128 {ERR_R_BN_LIB ,"BN lib"},
129 {ERR_R_RSA_LIB ,"RSA lib"},
130 {ERR_R_DH_LIB ,"DH lib"},
131 {ERR_R_EVP_LIB ,"EVP lib"},
132 {ERR_R_BUF_LIB ,"BUF lib"},
133 {ERR_R_BIO_LIB ,"BIO lib"},
134 {ERR_R_OBJ_LIB ,"OBJ lib"},
135 {ERR_R_PEM_LIB ,"PEM lib"},
136 {ERR_R_X509_LIB ,"X509 lib"},
137 {ERR_R_METH_LIB ,"METH lib"},
138 {ERR_R_ASN1_LIB ,"ASN1 lib"},
139 {ERR_R_CONF_LIB ,"CONF lib"},
140 {ERR_R_SSL_LIB ,"SSL lib"},
141 {ERR_R_PROXY_LIB ,"PROXY lib"},
142 {ERR_R_BIO_LIB ,"BIO lib"},
143 {ERR_R_PKCS7_LIB ,"PKCS7 lib"},
144 {ERR_R_PKCS12_LIB ,"PKCS12 lib"},
145 {ERR_R_MALLOC_FAILURE ,"Malloc failure"},
146 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED ,"called a function you should not call"},
147 {ERR_R_PASSED_NULL_PARAMETER ,"passed a null parameter"},
148 {ERR_R_NESTED_ASN1_ERROR ,"nested asn1 error"},
149 {ERR_R_BAD_ASN1_OBJECT_HEADER ,"bad asn1 object header"},
150 {ERR_R_BAD_GET_ASN1_OBJECT_CALL ,"bad get asn1 object call"},
151 {ERR_R_EXPECTING_AN_ASN1_SEQUENCE ,"expecting an asn1 sequence"},
152 {ERR_R_ASN1_LENGTH_MISMATCH ,"asn1 length mismatch"},
153 {ERR_R_MISSING_ASN1_EOS ,"missing asn1 eos"},
159 #define err_clear_data(p,i) \
160 if (((p)->err_data[i] != NULL) && \
161 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
163 Free((p)->err_data[i]); \
164 (p)->err_data[i]=NULL; \
166 (p)->err_data_flags[i]=0;
168 static void ERR_STATE_free(ERR_STATE *s)
175 for (i=0; i<ERR_NUM_ERRORS; i++)
182 void ERR_load_ERR_strings(void)
188 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
191 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
195 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
198 ERR_load_strings(0,ERR_str_libraries);
199 ERR_load_strings(0,ERR_str_reasons);
200 ERR_load_strings(ERR_LIB_SYS,ERR_str_functs);
205 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
207 if (error_hash == NULL)
209 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
210 error_hash=lh_new(err_hash,err_cmp);
211 if (error_hash == NULL)
213 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
216 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
218 ERR_load_ERR_strings();
221 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
224 str->error|=ERR_PACK(lib,0,0);
225 lh_insert(error_hash,str);
228 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
231 void ERR_free_strings(void)
233 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
235 if (error_hash != NULL)
241 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
244 /********************************************************/
246 void ERR_put_error(int lib, int func, int reason, const char *file,
252 /* In the BS2000-OSD POSIX subsystem, the compiler generates
253 * path names in the form "*POSIX(/etc/passwd)".
254 * This dirty hack strips them to something sensible.
255 * @@@ We shouldn't modify a const string, though.
257 if (strncmp(file,"*POSIX(", sizeof("*POSIX(")-1) == 0) {
260 /* Skip the "*POSIX(" prefix */
261 file += sizeof("*POSIX(")-1;
262 end = &file[strlen(file)-1];
265 /* Optional: use the basename of the path only. */
266 if ((end = strrchr(file, '/')) != NULL)
272 es->top=(es->top+1)%ERR_NUM_ERRORS;
273 if (es->top == es->bottom)
274 es->bottom=(es->bottom+1)%ERR_NUM_ERRORS;
275 es->err_buffer[es->top]=ERR_PACK(lib,func,reason);
276 es->err_file[es->top]=file;
277 es->err_line[es->top]=line;
278 err_clear_data(es,es->top);
281 void ERR_clear_error(void)
288 /* hmm... is this needed */
289 for (i=0; i<ERR_NUM_ERRORS; i++)
292 es->err_file[i]=NULL;
294 err_clear_data(es,i);
297 es->top=es->bottom=0;
301 unsigned long ERR_get_error(void)
302 { return(get_error_values(1,NULL,NULL,NULL,NULL)); }
304 unsigned long ERR_get_error_line(const char **file,
306 { return(get_error_values(1,file,line,NULL,NULL)); }
308 unsigned long ERR_get_error_line_data(const char **file, int *line,
309 const char **data, int *flags)
310 { return(get_error_values(1,file,line,
313 unsigned long ERR_peek_error(void)
314 { return(get_error_values(0,NULL,NULL,NULL,NULL)); }
316 unsigned long ERR_peek_error_line(const char **file,
318 { return(get_error_values(0,file,line,NULL,NULL)); }
320 unsigned long ERR_peek_error_line_data(const char **file, int *line,
321 const char **data, int *flags)
322 { return(get_error_values(0,file,line,
325 static unsigned long get_error_values(int inc, const char **file, int *line,
326 const char **data, int *flags)
334 if (es->bottom == es->top) return(0);
335 i=(es->bottom+1)%ERR_NUM_ERRORS;
337 ret=es->err_buffer[i];
344 if ((file != NULL) && (line != NULL))
346 if (es->err_file[i] == NULL)
349 if (line != NULL) *line=0;
353 *file=es->err_file[i];
354 if (line != NULL) *line=es->err_line[i];
360 if (es->err_data[i] == NULL)
363 if (flags != NULL) *flags=0;
367 *data=es->err_data[i];
368 if (flags != NULL) *flags=es->err_data_flags[i];
374 /* BAD for multi-threaded, uses a local buffer if ret == NULL */
375 char *ERR_error_string(unsigned long e, char *ret)
377 static char buf[256];
378 const char *ls,*fs,*rs;
386 ls=ERR_lib_error_string(e);
387 fs=ERR_func_error_string(e);
388 rs=ERR_reason_error_string(e);
390 if (ret == NULL) ret=buf;
392 sprintf(&(ret[0]),"error:%08lX:",e);
395 sprintf(&(ret[i]),":lib(%lu) ",l);
396 else sprintf(&(ret[i]),"%s",ls);
399 sprintf(&(ret[i]),":func(%lu) ",f);
400 else sprintf(&(ret[i]),":%s",fs);
403 sprintf(&(ret[i]),":reason(%lu)",r);
404 else sprintf(&(ret[i]),":%s",rs);
409 LHASH *ERR_get_string_table(void)
414 LHASH *ERR_get_err_state_table(void)
419 const char *ERR_lib_error_string(unsigned long e)
421 ERR_STRING_DATA d,*p=NULL;
426 CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
428 if (error_hash != NULL)
430 d.error=ERR_PACK(l,0,0);
431 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
434 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
436 return((p == NULL)?NULL:p->string);
439 const char *ERR_func_error_string(unsigned long e)
441 ERR_STRING_DATA d,*p=NULL;
447 CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
449 if (error_hash != NULL)
451 d.error=ERR_PACK(l,f,0);
452 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
455 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
457 return((p == NULL)?NULL:p->string);
460 const char *ERR_reason_error_string(unsigned long e)
462 ERR_STRING_DATA d,*p=NULL;
468 CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
470 if (error_hash != NULL)
472 d.error=ERR_PACK(l,0,r);
473 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
476 d.error=ERR_PACK(0,0,r);
477 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
481 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
483 return((p == NULL)?NULL:p->string);
486 static unsigned long err_hash(ERR_STRING_DATA *a)
491 ret=l^ERR_GET_LIB(l)^ERR_GET_FUNC(l);
492 return(ret^ret%19*13);
495 static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b)
497 return((int)(a->error-b->error));
500 static unsigned long pid_hash(ERR_STATE *a)
505 static int pid_cmp(ERR_STATE *a, ERR_STATE *b)
507 return((int)((long)a->pid - (long)b->pid));
510 void ERR_remove_state(unsigned long pid)
514 if (thread_hash == NULL)
517 pid=(unsigned long)CRYPTO_thread_id();
519 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
520 p=(ERR_STATE *)lh_delete(thread_hash,&tmp);
521 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
523 if (p != NULL) ERR_STATE_free(p);
526 ERR_STATE *ERR_get_state(void)
528 static ERR_STATE fallback;
529 ERR_STATE *ret=NULL,tmp,*tmpp;
533 pid=(unsigned long)CRYPTO_thread_id();
535 CRYPTO_r_lock(CRYPTO_LOCK_ERR);
536 if (thread_hash == NULL)
538 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
539 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
540 if (thread_hash == NULL)
543 thread_hash=lh_new(pid_hash,pid_cmp);
545 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
546 if (thread_hash == NULL) return(&fallback);
549 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
554 ret=(ERR_STATE *)lh_retrieve(thread_hash,&tmp);
555 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
558 /* ret == the error state, if NULL, make a new one */
561 ret=(ERR_STATE *)Malloc(sizeof(ERR_STATE));
562 if (ret == NULL) return(&fallback);
566 for (i=0; i<ERR_NUM_ERRORS; i++)
568 ret->err_data[i]=NULL;
569 ret->err_data_flags[i]=0;
571 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
572 tmpp=(ERR_STATE *)lh_insert(thread_hash,ret);
573 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
574 if (tmpp != NULL) /* old entry - should not happen */
576 ERR_STATE_free(tmpp);
582 int ERR_get_next_error_library(void)
584 static int value=ERR_LIB_USER;
589 void ERR_set_error_data(char *data, int flags)
600 es->err_data[i]=data;
601 es->err_data_flags[es->top]=flags;
604 void ERR_add_error_data(int num, ...)
612 if (str == NULL) return;
617 for (i=0; i<num; i++)
619 a=va_arg(args, char*);
620 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
639 ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);