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.]
58 /* ====================================================================
59 * Copyright (c) 1998-2000 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
115 #include <openssl/lhash.h>
116 #include <openssl/crypto.h>
117 #include "cryptlib.h"
118 #include <openssl/buffer.h>
119 #include <openssl/err.h>
120 #include <openssl/crypto.h>
123 static LHASH *error_hash=NULL;
124 static LHASH *thread_hash=NULL;
126 static unsigned long err_hash(ERR_STRING_DATA *a);
127 static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b);
128 static unsigned long pid_hash(ERR_STATE *pid);
129 static int pid_cmp(ERR_STATE *a,ERR_STATE *pid);
130 static unsigned long get_error_values(int inc,const char **file,int *line,
131 const char **data,int *flags);
132 static void ERR_STATE_free(ERR_STATE *s);
134 static ERR_STRING_DATA ERR_str_libraries[]=
136 {ERR_PACK(ERR_LIB_NONE,0,0) ,"unknown library"},
137 {ERR_PACK(ERR_LIB_SYS,0,0) ,"system library"},
138 {ERR_PACK(ERR_LIB_BN,0,0) ,"bignum routines"},
139 {ERR_PACK(ERR_LIB_RSA,0,0) ,"rsa routines"},
140 {ERR_PACK(ERR_LIB_DH,0,0) ,"Diffie-Hellman routines"},
141 {ERR_PACK(ERR_LIB_EVP,0,0) ,"digital envelope routines"},
142 {ERR_PACK(ERR_LIB_BUF,0,0) ,"memory buffer routines"},
143 {ERR_PACK(ERR_LIB_BIO,0,0) ,"BIO routines"},
144 {ERR_PACK(ERR_LIB_OBJ,0,0) ,"object identifier routines"},
145 {ERR_PACK(ERR_LIB_PEM,0,0) ,"PEM routines"},
146 {ERR_PACK(ERR_LIB_ASN1,0,0) ,"asn1 encoding routines"},
147 {ERR_PACK(ERR_LIB_X509,0,0) ,"x509 certificate routines"},
148 {ERR_PACK(ERR_LIB_CONF,0,0) ,"configuration file routines"},
149 {ERR_PACK(ERR_LIB_METH,0,0) ,"X509 lookup 'method' routines"},
150 {ERR_PACK(ERR_LIB_SSL,0,0) ,"SSL routines"},
151 {ERR_PACK(ERR_LIB_RSAREF,0,0) ,"RSAref routines"},
152 {ERR_PACK(ERR_LIB_PROXY,0,0) ,"Proxy routines"},
153 {ERR_PACK(ERR_LIB_BIO,0,0) ,"BIO routines"},
154 {ERR_PACK(ERR_LIB_PKCS7,0,0) ,"PKCS7 routines"},
155 {ERR_PACK(ERR_LIB_X509V3,0,0) ,"X509 V3 routines"},
156 {ERR_PACK(ERR_LIB_PKCS12,0,0) ,"PKCS12 routines"},
157 {ERR_PACK(ERR_LIB_RAND,0,0) ,"random number generator"},
161 static ERR_STRING_DATA ERR_str_functs[]=
163 {ERR_PACK(0,SYS_F_FOPEN,0), "fopen"},
164 {ERR_PACK(0,SYS_F_CONNECT,0), "connect"},
165 {ERR_PACK(0,SYS_F_GETSERVBYNAME,0), "getservbyname"},
166 {ERR_PACK(0,SYS_F_SOCKET,0), "socket"},
167 {ERR_PACK(0,SYS_F_IOCTLSOCKET,0), "ioctlsocket"},
168 {ERR_PACK(0,SYS_F_BIND,0), "bind"},
169 {ERR_PACK(0,SYS_F_LISTEN,0), "listen"},
170 {ERR_PACK(0,SYS_F_ACCEPT,0), "accept"},
172 {ERR_PACK(0,SYS_F_WSASTARTUP,0), "WSAstartup"},
174 {ERR_PACK(0,SYS_F_OPENDIR,0), "opendir"},
178 static ERR_STRING_DATA ERR_str_reasons[]=
180 {ERR_R_FATAL ,"fatal"},
181 {ERR_R_SYS_LIB ,"system lib"},
182 {ERR_R_BN_LIB ,"BN lib"},
183 {ERR_R_RSA_LIB ,"RSA lib"},
184 {ERR_R_DH_LIB ,"DH lib"},
185 {ERR_R_EVP_LIB ,"EVP lib"},
186 {ERR_R_BUF_LIB ,"BUF lib"},
187 {ERR_R_BIO_LIB ,"BIO lib"},
188 {ERR_R_OBJ_LIB ,"OBJ lib"},
189 {ERR_R_PEM_LIB ,"PEM lib"},
190 {ERR_R_X509_LIB ,"X509 lib"},
191 {ERR_R_METH_LIB ,"METH lib"},
192 {ERR_R_ASN1_LIB ,"ASN1 lib"},
193 {ERR_R_CONF_LIB ,"CONF lib"},
194 {ERR_R_SSL_LIB ,"SSL lib"},
195 {ERR_R_PROXY_LIB ,"PROXY lib"},
196 {ERR_R_BIO_LIB ,"BIO lib"},
197 {ERR_R_PKCS7_LIB ,"PKCS7 lib"},
198 {ERR_R_PKCS12_LIB ,"PKCS12 lib"},
199 {ERR_R_MALLOC_FAILURE ,"Malloc failure"},
200 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED ,"called a function you should not call"},
201 {ERR_R_PASSED_NULL_PARAMETER ,"passed a null parameter"},
202 {ERR_R_NESTED_ASN1_ERROR ,"nested asn1 error"},
203 {ERR_R_BAD_ASN1_OBJECT_HEADER ,"bad asn1 object header"},
204 {ERR_R_BAD_GET_ASN1_OBJECT_CALL ,"bad get asn1 object call"},
205 {ERR_R_EXPECTING_AN_ASN1_SEQUENCE ,"expecting an asn1 sequence"},
206 {ERR_R_ASN1_LENGTH_MISMATCH ,"asn1 length mismatch"},
207 {ERR_R_MISSING_ASN1_EOS ,"missing asn1 eos"},
213 #define NUM_SYS_STR_REASONS 127
214 #define LEN_SYS_STR_REASON 32
216 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
217 /* SYS_str_reasons is filled with copies of strerror() results at
219 * 'errno' values up to 127 should cover all usual errors,
220 * others will be displayed numerically by ERR_error_string.
221 * It is crucial that we have something for each reason code
222 * that occurs in ERR_str_reasons, or bogus reason strings
223 * will be returned for SYSerr(), which always gets an errno
224 * value and never one of those 'standard' reason codes. */
226 static void build_SYS_str_reasons()
228 /* Malloc cannot be used here, use static storage instead */
229 static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
232 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
234 for (i = 1; i <= NUM_SYS_STR_REASONS; i++)
236 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
238 str->error = (unsigned long)i;
239 if (str->string == NULL)
241 char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
242 char *src = strerror(i);
245 strncpy(*dest, src, sizeof *dest);
246 (*dest)[sizeof *dest - 1] = '\0';
250 if (str->string == NULL)
251 str->string = "unknown";
254 /* Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL},
255 * as required by ERR_load_strings. */
257 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
261 #define err_clear_data(p,i) \
262 if (((p)->err_data[i] != NULL) && \
263 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
265 Free((p)->err_data[i]); \
266 (p)->err_data[i]=NULL; \
268 (p)->err_data_flags[i]=0;
270 static void ERR_STATE_free(ERR_STATE *s)
277 for (i=0; i<ERR_NUM_ERRORS; i++)
284 void ERR_load_ERR_strings(void)
290 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
293 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
296 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
299 ERR_load_strings(0,ERR_str_libraries);
300 ERR_load_strings(0,ERR_str_reasons);
301 ERR_load_strings(ERR_LIB_SYS,ERR_str_functs);
302 build_SYS_str_reasons();
303 ERR_load_strings(ERR_LIB_SYS,SYS_str_reasons);
309 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
311 if (error_hash == NULL)
313 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
314 error_hash=lh_new(err_hash,err_cmp);
315 if (error_hash == NULL)
317 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
320 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
322 ERR_load_ERR_strings();
325 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
328 str->error|=ERR_PACK(lib,0,0);
329 lh_insert(error_hash,str);
332 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
335 void ERR_free_strings(void)
337 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
339 if (error_hash != NULL)
345 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
348 /********************************************************/
350 void ERR_put_error(int lib, int func, int reason, const char *file,
356 /* In the BS2000-OSD POSIX subsystem, the compiler generates
357 * path names in the form "*POSIX(/etc/passwd)".
358 * This dirty hack strips them to something sensible.
359 * @@@ We shouldn't modify a const string, though.
361 if (strncmp(file,"*POSIX(", sizeof("*POSIX(")-1) == 0) {
364 /* Skip the "*POSIX(" prefix */
365 file += sizeof("*POSIX(")-1;
366 end = &file[strlen(file)-1];
369 /* Optional: use the basename of the path only. */
370 if ((end = strrchr(file, '/')) != NULL)
376 es->top=(es->top+1)%ERR_NUM_ERRORS;
377 if (es->top == es->bottom)
378 es->bottom=(es->bottom+1)%ERR_NUM_ERRORS;
379 es->err_buffer[es->top]=ERR_PACK(lib,func,reason);
380 es->err_file[es->top]=file;
381 es->err_line[es->top]=line;
382 err_clear_data(es,es->top);
385 void ERR_clear_error(void)
392 /* hmm... is this needed */
393 for (i=0; i<ERR_NUM_ERRORS; i++)
396 es->err_file[i]=NULL;
398 err_clear_data(es,i);
401 es->top=es->bottom=0;
405 unsigned long ERR_get_error(void)
406 { return(get_error_values(1,NULL,NULL,NULL,NULL)); }
408 unsigned long ERR_get_error_line(const char **file,
410 { return(get_error_values(1,file,line,NULL,NULL)); }
412 unsigned long ERR_get_error_line_data(const char **file, int *line,
413 const char **data, int *flags)
414 { return(get_error_values(1,file,line,
417 unsigned long ERR_peek_error(void)
418 { return(get_error_values(0,NULL,NULL,NULL,NULL)); }
420 unsigned long ERR_peek_error_line(const char **file,
422 { return(get_error_values(0,file,line,NULL,NULL)); }
424 unsigned long ERR_peek_error_line_data(const char **file, int *line,
425 const char **data, int *flags)
426 { return(get_error_values(0,file,line,
429 static unsigned long get_error_values(int inc, const char **file, int *line,
430 const char **data, int *flags)
438 if (es->bottom == es->top) return(0);
439 i=(es->bottom+1)%ERR_NUM_ERRORS;
441 ret=es->err_buffer[i];
448 if ((file != NULL) && (line != NULL))
450 if (es->err_file[i] == NULL)
453 if (line != NULL) *line=0;
457 *file=es->err_file[i];
458 if (line != NULL) *line=es->err_line[i];
464 if (es->err_data[i] == NULL)
467 if (flags != NULL) *flags=0;
471 *data=es->err_data[i];
472 if (flags != NULL) *flags=es->err_data_flags[i];
478 /* BAD for multi-threaded, uses a local buffer if ret == NULL */
479 char *ERR_error_string(unsigned long e, char *ret)
481 static char buf[256];
482 const char *ls,*fs,*rs;
490 ls=ERR_lib_error_string(e);
491 fs=ERR_func_error_string(e);
492 rs=ERR_reason_error_string(e);
494 if (ret == NULL) ret=buf;
496 sprintf(&(ret[0]),"error:%08lX:",e);
499 sprintf(&(ret[i]),":lib(%lu) ",l);
500 else sprintf(&(ret[i]),"%s",ls);
503 sprintf(&(ret[i]),":func(%lu) ",f);
504 else sprintf(&(ret[i]),":%s",fs);
507 sprintf(&(ret[i]),":reason(%lu)",r);
508 else sprintf(&(ret[i]),":%s",rs);
513 LHASH *ERR_get_string_table(void)
518 LHASH *ERR_get_err_state_table(void)
523 const char *ERR_lib_error_string(unsigned long e)
525 ERR_STRING_DATA d,*p=NULL;
530 CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
532 if (error_hash != NULL)
534 d.error=ERR_PACK(l,0,0);
535 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
538 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
540 return((p == NULL)?NULL:p->string);
543 const char *ERR_func_error_string(unsigned long e)
545 ERR_STRING_DATA d,*p=NULL;
551 CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
553 if (error_hash != NULL)
555 d.error=ERR_PACK(l,f,0);
556 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
559 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
561 return((p == NULL)?NULL:p->string);
564 const char *ERR_reason_error_string(unsigned long e)
566 ERR_STRING_DATA d,*p=NULL;
572 CRYPTO_r_lock(CRYPTO_LOCK_ERR_HASH);
574 if (error_hash != NULL)
576 d.error=ERR_PACK(l,0,r);
577 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
580 d.error=ERR_PACK(0,0,r);
581 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
585 CRYPTO_r_unlock(CRYPTO_LOCK_ERR_HASH);
587 return((p == NULL)?NULL:p->string);
590 static unsigned long err_hash(ERR_STRING_DATA *a)
595 ret=l^ERR_GET_LIB(l)^ERR_GET_FUNC(l);
596 return(ret^ret%19*13);
599 static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b)
601 return((int)(a->error-b->error));
604 static unsigned long pid_hash(ERR_STATE *a)
609 static int pid_cmp(ERR_STATE *a, ERR_STATE *b)
611 return((int)((long)a->pid - (long)b->pid));
614 void ERR_remove_state(unsigned long pid)
618 if (thread_hash == NULL)
621 pid=(unsigned long)CRYPTO_thread_id();
623 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
624 p=(ERR_STATE *)lh_delete(thread_hash,&tmp);
625 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
627 if (p != NULL) ERR_STATE_free(p);
630 ERR_STATE *ERR_get_state(void)
632 static ERR_STATE fallback;
633 ERR_STATE *ret=NULL,tmp,*tmpp;
637 pid=(unsigned long)CRYPTO_thread_id();
639 CRYPTO_r_lock(CRYPTO_LOCK_ERR);
640 if (thread_hash == NULL)
642 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
643 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
644 if (thread_hash == NULL)
647 thread_hash=lh_new(pid_hash,pid_cmp);
649 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
650 if (thread_hash == NULL) return(&fallback);
653 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
658 ret=(ERR_STATE *)lh_retrieve(thread_hash,&tmp);
659 CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
662 /* ret == the error state, if NULL, make a new one */
665 ret=(ERR_STATE *)Malloc(sizeof(ERR_STATE));
666 if (ret == NULL) return(&fallback);
670 for (i=0; i<ERR_NUM_ERRORS; i++)
672 ret->err_data[i]=NULL;
673 ret->err_data_flags[i]=0;
675 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
676 tmpp=(ERR_STATE *)lh_insert(thread_hash,ret);
677 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
678 if (tmpp != NULL) /* old entry - should not happen */
680 ERR_STATE_free(tmpp);
686 int ERR_get_next_error_library(void)
688 static int value=ERR_LIB_USER;
693 void ERR_set_error_data(char *data, int flags)
704 es->err_data[i]=data;
705 es->err_data_flags[es->top]=flags;
708 void ERR_add_error_data(int num, ...)
716 if (str == NULL) return;
721 for (i=0; i<num; i++)
723 a=va_arg(args, char*);
724 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
743 ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);