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) ,"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"},
106 static ERR_STRING_DATA ERR_str_functs[]=
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"},
117 {ERR_PACK(0,SYS_F_WSASTARTUP,0), "WSAstartup"},
122 static ERR_STRING_DATA ERR_str_reasons[]=
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"},
157 #define err_clear_data(p,i) \
158 if (((p)->err_data[i] != NULL) && \
159 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
161 Free((p)->err_data[i]); \
162 (p)->err_data[i]=NULL; \
164 (p)->err_data_flags[i]=0;
166 static void ERR_STATE_free(ERR_STATE *s)
173 for (i=0; i<ERR_NUM_ERRORS; i++)
180 void ERR_load_ERR_strings(void)
186 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
189 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
193 CRYPTO_w_unlock(CRYPTO_LOCK_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);
203 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
205 if (error_hash == NULL)
207 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
208 error_hash=lh_new(err_hash,err_cmp);
209 if (error_hash == NULL)
211 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
214 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
216 ERR_load_ERR_strings();
219 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
222 str->error|=ERR_PACK(lib,0,0);
223 lh_insert(error_hash,(char *)str);
226 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
229 void ERR_free_strings(void)
231 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
233 if (error_hash != NULL)
239 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
242 /********************************************************/
244 void ERR_put_error(int lib, int func, int reason, const char *file,
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);
260 void ERR_clear_error(void)
267 /* hmm... is this needed */
268 for (i=0; i<ERR_NUM_ERRORS; i++)
271 es->err_file[i]=NULL;
273 err_clear_data(es,i);
276 es->top=es->bottom=0;
280 unsigned long ERR_get_error(void)
281 { return(get_error_values(1,NULL,NULL,NULL,NULL)); }
283 unsigned long ERR_get_error_line(const char **file,
285 { return(get_error_values(1,file,line,NULL,NULL)); }
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,
292 unsigned long ERR_peek_error(void)
293 { return(get_error_values(0,NULL,NULL,NULL,NULL)); }
295 unsigned long ERR_peek_error_line(const char **file,
297 { return(get_error_values(0,file,line,NULL,NULL)); }
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,
304 static unsigned long get_error_values(int inc, const char **file, int *line,
305 const char **data, int *flags)
313 if (es->bottom == es->top) return(0);
314 i=(es->bottom+1)%ERR_NUM_ERRORS;
316 ret=es->err_buffer[i];
323 if ((file != NULL) && (line != NULL))
325 if (es->err_file[i] == NULL)
328 if (line != NULL) *line=0;
332 *file=es->err_file[i];
333 if (line != NULL) *line=es->err_line[i];
339 if (es->err_data[i] == NULL)
342 if (flags != NULL) *flags=0;
346 *data=es->err_data[i];
347 if (flags != NULL) *flags=es->err_data_flags[i];
353 /* BAD for multi-threaded, uses a local buffer if ret == NULL */
354 char *ERR_error_string(unsigned long e, char *ret)
356 static char buf[256];
357 const char *ls,*fs,*rs;
365 ls=ERR_lib_error_string(e);
366 fs=ERR_func_error_string(e);
367 rs=ERR_reason_error_string(e);
369 if (ret == NULL) ret=buf;
371 sprintf(&(ret[0]),"error:%08lX:",e);
374 sprintf(&(ret[i]),":lib(%lu) ",l);
375 else sprintf(&(ret[i]),"%s",ls);
378 sprintf(&(ret[i]),":func(%lu) ",f);
379 else sprintf(&(ret[i]),":%s",fs);
382 sprintf(&(ret[i]),":reason(%lu)",r);
383 else sprintf(&(ret[i]),":%s",rs);
388 LHASH *ERR_get_string_table(void)
393 LHASH *ERR_get_err_state_table(void)
398 const char *ERR_lib_error_string(unsigned long e)
400 ERR_STRING_DATA d,*p=NULL;
405 CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
407 if (error_hash != NULL)
409 d.error=ERR_PACK(l,0,0);
410 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,(char *)&d);
413 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
415 return((p == NULL)?NULL:p->string);
418 const char *ERR_func_error_string(unsigned long e)
420 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,f,0);
431 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,(char *)&d);
434 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
436 return((p == NULL)?NULL:p->string);
439 const char *ERR_reason_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,0,r);
452 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,(char *)&d);
455 d.error=ERR_PACK(0,0,r);
456 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,
461 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
463 return((p == NULL)?NULL:p->string);
466 static unsigned long err_hash(ERR_STRING_DATA *a)
471 ret=l^ERR_GET_LIB(l)^ERR_GET_FUNC(l);
472 return(ret^ret%19*13);
475 static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b)
477 return((int)(a->error-b->error));
480 static unsigned long pid_hash(ERR_STATE *a)
485 static int pid_cmp(ERR_STATE *a, ERR_STATE *b)
487 return((int)((long)a->pid - (long)b->pid));
490 void ERR_remove_state(unsigned long pid)
494 if (thread_hash == NULL)
497 pid=(unsigned long)CRYPTO_thread_id();
499 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
500 p=(ERR_STATE *)lh_delete(thread_hash,(char *)&tmp);
501 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
503 if (p != NULL) ERR_STATE_free(p);
506 ERR_STATE *ERR_get_state(void)
508 static ERR_STATE fallback;
509 ERR_STATE *ret=NULL,tmp,*tmpp;
513 pid=(unsigned long)CRYPTO_thread_id();
515 CRYPTO_r_lock(CRYPTO_LOCK_ERR);
516 if (thread_hash == NULL)
518 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
519 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
520 if (thread_hash == NULL)
523 thread_hash=lh_new(pid_hash,pid_cmp);
525 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
526 if (thread_hash == NULL) return(&fallback);
529 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
534 ret=(ERR_STATE *)lh_retrieve(thread_hash,(char *)&tmp);
535 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
538 /* ret == the error state, if NULL, make a new one */
541 ret=(ERR_STATE *)Malloc(sizeof(ERR_STATE));
542 if (ret == NULL) return(&fallback);
546 for (i=0; i<ERR_NUM_ERRORS; i++)
548 ret->err_data[i]=NULL;
549 ret->err_data_flags[i]=0;
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 */
556 ERR_STATE_free(tmpp);
562 int ERR_get_next_error_library(void)
564 static int value=ERR_LIB_USER;
569 void ERR_set_error_data(char *data, int flags)
580 es->err_data[i]=data;
581 es->err_data_flags[es->top]=flags;
584 void ERR_add_error_data(int num, ...)
592 if (str == NULL) return;
597 for (i=0; i<num; i++)
599 a=va_arg(args, char*);
600 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
619 ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);