Use the passed buffer in ERR_error_string!
[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  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
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
71  *    distribution.
72  *
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/)"
77  *
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.
82  *
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.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
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  * ====================================================================
105  *
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).
109  *
110  */
111
112 #include <stdio.h>
113 #include <stdarg.h>
114 #include <string.h>
115 #include <openssl/lhash.h>
116 #include <openssl/crypto.h>
117 #include "cryptlib.h"
118 #include <openssl/buffer.h>
119 #include <openssl/bio.h>
120 #include <openssl/err.h>
121
122
123 static LHASH *error_hash=NULL;
124 static LHASH *thread_hash=NULL;
125
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);
133 #ifndef NO_ERR
134 static ERR_STRING_DATA ERR_str_libraries[]=
135         {
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_DSA,0,0)              ,"dsa routines"},
141 {ERR_PACK(ERR_LIB_DH,0,0)               ,"Diffie-Hellman routines"},
142 {ERR_PACK(ERR_LIB_EVP,0,0)              ,"digital envelope routines"},
143 {ERR_PACK(ERR_LIB_BUF,0,0)              ,"memory buffer routines"},
144 {ERR_PACK(ERR_LIB_BIO,0,0)              ,"BIO routines"},
145 {ERR_PACK(ERR_LIB_OBJ,0,0)              ,"object identifier routines"},
146 {ERR_PACK(ERR_LIB_PEM,0,0)              ,"PEM routines"},
147 {ERR_PACK(ERR_LIB_ASN1,0,0)             ,"asn1 encoding routines"},
148 {ERR_PACK(ERR_LIB_X509,0,0)             ,"x509 certificate routines"},
149 {ERR_PACK(ERR_LIB_CONF,0,0)             ,"configuration file routines"},
150 {ERR_PACK(ERR_LIB_METH,0,0)             ,"X509 lookup 'method' routines"},
151 {ERR_PACK(ERR_LIB_SSL,0,0)              ,"SSL routines"},
152 {ERR_PACK(ERR_LIB_RSAREF,0,0)           ,"RSAref routines"},
153 {ERR_PACK(ERR_LIB_PROXY,0,0)            ,"Proxy routines"},
154 {ERR_PACK(ERR_LIB_BIO,0,0)              ,"BIO routines"},
155 {ERR_PACK(ERR_LIB_PKCS7,0,0)            ,"PKCS7 routines"},
156 {ERR_PACK(ERR_LIB_X509V3,0,0)           ,"X509 V3 routines"},
157 {ERR_PACK(ERR_LIB_PKCS12,0,0)           ,"PKCS12 routines"},
158 {ERR_PACK(ERR_LIB_RAND,0,0)             ,"random number generator"},
159 {ERR_PACK(ERR_LIB_DSO,0,0)              ,"DSO support routines"},
160 {0,NULL},
161         };
162
163 static ERR_STRING_DATA ERR_str_functs[]=
164         {
165         {ERR_PACK(0,SYS_F_FOPEN,0),             "fopen"},
166         {ERR_PACK(0,SYS_F_CONNECT,0),           "connect"},
167         {ERR_PACK(0,SYS_F_GETSERVBYNAME,0),     "getservbyname"},
168         {ERR_PACK(0,SYS_F_SOCKET,0),            "socket"}, 
169         {ERR_PACK(0,SYS_F_IOCTLSOCKET,0),       "ioctlsocket"},
170         {ERR_PACK(0,SYS_F_BIND,0),              "bind"},
171         {ERR_PACK(0,SYS_F_LISTEN,0),            "listen"},
172         {ERR_PACK(0,SYS_F_ACCEPT,0),            "accept"},
173 #ifdef WINDOWS
174         {ERR_PACK(0,SYS_F_WSASTARTUP,0),        "WSAstartup"},
175 #endif
176         {ERR_PACK(0,SYS_F_OPENDIR,0),           "opendir"},
177         {0,NULL},
178         };
179
180 static ERR_STRING_DATA ERR_str_reasons[]=
181         {
182 {ERR_R_FATAL                             ,"fatal"},
183 {ERR_R_SYS_LIB                          ,"system lib"},
184 {ERR_R_BN_LIB                           ,"BN lib"},
185 {ERR_R_RSA_LIB                          ,"RSA lib"},
186 {ERR_R_DH_LIB                           ,"DH lib"},
187 {ERR_R_EVP_LIB                          ,"EVP lib"},
188 {ERR_R_BUF_LIB                          ,"BUF lib"},
189 {ERR_R_BIO_LIB                          ,"BIO lib"},
190 {ERR_R_OBJ_LIB                          ,"OBJ lib"},
191 {ERR_R_PEM_LIB                          ,"PEM lib"},
192 {ERR_R_X509_LIB                         ,"X509 lib"},
193 {ERR_R_METH_LIB                         ,"METH lib"},
194 {ERR_R_ASN1_LIB                         ,"ASN1 lib"},
195 {ERR_R_CONF_LIB                         ,"CONF lib"},
196 {ERR_R_SSL_LIB                          ,"SSL lib"},
197 {ERR_R_PROXY_LIB                        ,"PROXY lib"},
198 {ERR_R_BIO_LIB                          ,"BIO lib"},
199 {ERR_R_PKCS7_LIB                        ,"PKCS7 lib"},
200 {ERR_R_PKCS12_LIB                       ,"PKCS12 lib"},
201 {ERR_R_MALLOC_FAILURE                   ,"Malloc failure"},
202 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED      ,"called a function you should not call"},
203 {ERR_R_PASSED_NULL_PARAMETER            ,"passed a null parameter"},
204 {ERR_R_NESTED_ASN1_ERROR                ,"nested asn1 error"},
205 {ERR_R_BAD_ASN1_OBJECT_HEADER           ,"bad asn1 object header"},
206 {ERR_R_BAD_GET_ASN1_OBJECT_CALL         ,"bad get asn1 object call"},
207 {ERR_R_EXPECTING_AN_ASN1_SEQUENCE       ,"expecting an asn1 sequence"},
208 {ERR_R_ASN1_LENGTH_MISMATCH             ,"asn1 length mismatch"},
209 {ERR_R_MISSING_ASN1_EOS                 ,"missing asn1 eos"},
210 {ERR_R_DSO_LIB                          ,"DSO lib"},
211
212 {0,NULL},
213         };
214
215
216 #define NUM_SYS_STR_REASONS 127
217 #define LEN_SYS_STR_REASON 32
218
219 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
220 /* SYS_str_reasons is filled with copies of strerror() results at
221  * initialization.
222  * 'errno' values up to 127 should cover all usual errors,
223  * others will be displayed numerically by ERR_error_string.
224  * It is crucial that we have something for each reason code
225  * that occurs in ERR_str_reasons, or bogus reason strings
226  * will be returned for SYSerr(), which always gets an errno
227  * value and never one of those 'standard' reason codes. */
228
229 static void build_SYS_str_reasons()
230         {
231         /* OPENSSL_malloc cannot be used here, use static storage instead */
232         static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
233         int i;
234
235         CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
236
237         for (i = 1; i <= NUM_SYS_STR_REASONS; i++)
238                 {
239                 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
240
241                 str->error = (unsigned long)i;
242                 if (str->string == NULL)
243                         {
244                         char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
245                         char *src = strerror(i);
246                         if (src != NULL)
247                                 {
248                                 strncpy(*dest, src, sizeof *dest);
249                                 (*dest)[sizeof *dest - 1] = '\0';
250                                 str->string = *dest;
251                                 }
252                         }
253                 if (str->string == NULL)
254                         str->string = "unknown";
255                 }
256
257         /* Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL},
258          * as required by ERR_load_strings. */
259
260         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
261         }
262 #endif
263
264 #define err_clear_data(p,i) \
265         if (((p)->err_data[i] != NULL) && \
266                 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
267                 {  \
268                 OPENSSL_free((p)->err_data[i]); \
269                 (p)->err_data[i]=NULL; \
270                 } \
271         (p)->err_data_flags[i]=0;
272
273 static void ERR_STATE_free(ERR_STATE *s)
274         {
275         int i;
276
277         if(s == NULL)
278             return;
279
280         for (i=0; i<ERR_NUM_ERRORS; i++)
281                 {
282                 err_clear_data(s,i);
283                 }
284         OPENSSL_free(s);
285         }
286
287 void ERR_load_ERR_strings(void)
288         {
289         static int init=1;
290
291         if (init)
292                 {
293                 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
294                 if (init == 0)
295                         {
296                         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
297                         return;
298                         }
299                 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
300
301 #ifndef NO_ERR
302                 ERR_load_strings(0,ERR_str_libraries);
303                 ERR_load_strings(0,ERR_str_reasons);
304                 ERR_load_strings(ERR_LIB_SYS,ERR_str_functs);
305                 build_SYS_str_reasons();
306                 ERR_load_strings(ERR_LIB_SYS,SYS_str_reasons);
307 #endif
308                 init=0;
309                 }
310         }
311
312 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
313         {
314         if (error_hash == NULL)
315                 {
316                 CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
317                 error_hash=lh_new(err_hash,err_cmp);
318                 if (error_hash == NULL)
319                         {
320                         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
321                         return;
322                         }
323                 CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
324
325                 ERR_load_ERR_strings();
326                 }
327
328         CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
329         while (str->error)
330                 {
331                 str->error|=ERR_PACK(lib,0,0);
332                 lh_insert(error_hash,str);
333                 str++;
334                 }
335         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
336         }
337
338 void ERR_free_strings(void)
339         {
340         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
341
342         if (error_hash != NULL)
343                 {
344                 lh_free(error_hash);
345                 error_hash=NULL;
346                 }
347
348         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
349         }
350
351 /********************************************************/
352
353 void ERR_put_error(int lib, int func, int reason, const char *file,
354              int line)
355         {
356         ERR_STATE *es;
357
358 #ifdef _OSD_POSIX
359         /* In the BS2000-OSD POSIX subsystem, the compiler generates
360          * path names in the form "*POSIX(/etc/passwd)".
361          * This dirty hack strips them to something sensible.
362          * @@@ We shouldn't modify a const string, though.
363          */
364         if (strncmp(file,"*POSIX(", sizeof("*POSIX(")-1) == 0) {
365                 char *end;
366
367                 /* Skip the "*POSIX(" prefix */
368                 file += sizeof("*POSIX(")-1;
369                 end = &file[strlen(file)-1];
370                 if (*end == ')')
371                         *end = '\0';
372                 /* Optional: use the basename of the path only. */
373                 if ((end = strrchr(file, '/')) != NULL)
374                         file = &end[1];
375         }
376 #endif
377         es=ERR_get_state();
378
379         es->top=(es->top+1)%ERR_NUM_ERRORS;
380         if (es->top == es->bottom)
381                 es->bottom=(es->bottom+1)%ERR_NUM_ERRORS;
382         es->err_buffer[es->top]=ERR_PACK(lib,func,reason);
383         es->err_file[es->top]=file;
384         es->err_line[es->top]=line;
385         err_clear_data(es,es->top);
386         }
387
388 void ERR_clear_error(void)
389         {
390         ERR_STATE *es;
391
392         es=ERR_get_state();
393
394 #if 0
395         /* hmm... is this needed */
396         for (i=0; i<ERR_NUM_ERRORS; i++)
397                 {
398                 es->err_buffer[i]=0;
399                 es->err_file[i]=NULL;
400                 es->err_line[i]= -1;
401                 err_clear_data(es,i);
402                 }
403 #endif
404         es->top=es->bottom=0;
405         }
406
407
408 unsigned long ERR_get_error(void)
409         { return(get_error_values(1,NULL,NULL,NULL,NULL)); }
410
411 unsigned long ERR_get_error_line(const char **file,
412              int *line)
413         { return(get_error_values(1,file,line,NULL,NULL)); }
414
415 unsigned long ERR_get_error_line_data(const char **file, int *line,
416              const char **data, int *flags)
417         { return(get_error_values(1,file,line,
418              data,flags)); }
419
420 unsigned long ERR_peek_error(void)
421         { return(get_error_values(0,NULL,NULL,NULL,NULL)); }
422
423 unsigned long ERR_peek_error_line(const char **file,
424              int *line)
425         { return(get_error_values(0,file,line,NULL,NULL)); }
426
427 unsigned long ERR_peek_error_line_data(const char **file, int *line,
428              const char **data, int *flags)
429         { return(get_error_values(0,file,line,
430              data,flags)); }
431
432 static unsigned long get_error_values(int inc, const char **file, int *line,
433              const char **data, int *flags)
434         {       
435         int i=0;
436         ERR_STATE *es;
437         unsigned long ret;
438
439         es=ERR_get_state();
440
441         if (es->bottom == es->top) return(0);
442         i=(es->bottom+1)%ERR_NUM_ERRORS;
443
444         ret=es->err_buffer[i];
445         if (inc)
446                 {
447                 es->bottom=i;
448                 es->err_buffer[i]=0;
449                 }
450
451         if ((file != NULL) && (line != NULL))
452                 {
453                 if (es->err_file[i] == NULL)
454                         {
455                         *file="NA";
456                         if (line != NULL) *line=0;
457                         }
458                 else
459                         {
460                         *file=es->err_file[i];
461                         if (line != NULL) *line=es->err_line[i];
462                         }
463                 }
464
465         if (data != NULL)
466                 {
467                 if (es->err_data[i] == NULL)
468                         {
469                         *data="";
470                         if (flags != NULL) *flags=0;
471                         }
472                 else
473                         {
474                         *data=es->err_data[i];
475                         if (flags != NULL) *flags=es->err_data_flags[i];
476                         }
477                 }
478         return(ret);
479         }
480
481 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
482         {
483         char lsbuf[64], fsbuf[64], rsbuf[64];
484         const char *ls,*fs,*rs;
485         unsigned long l,f,r;
486
487         l=ERR_GET_LIB(e);
488         f=ERR_GET_FUNC(e);
489         r=ERR_GET_REASON(e);
490
491         ls=ERR_lib_error_string(e);
492         fs=ERR_func_error_string(e);
493         rs=ERR_reason_error_string(e);
494
495         if (ls == NULL) 
496                 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
497         if (fs == NULL)
498                 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
499         if (rs == NULL)
500                 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
501
502         BIO_snprintf(buf, len,"error:%08lX:%s:%s:%s", e, ls?ls:lsbuf, 
503                 fs?fs:fsbuf, rs?rs:rsbuf);
504         if (strlen(buf) == len-1)
505                 {
506                 /* output may be truncated; make sure we always have 5 
507                  * colon-separated fields, i.e. 4 colons ... */
508 #define NUM_COLONS 4
509                 if (len > NUM_COLONS) /* ... if possible */
510                         {
511                         int i;
512                         char *s = buf;
513                         
514                         for (i = 0; i < NUM_COLONS; i++)
515                                 {
516                                 char *colon = strchr(s, ':');
517                                 if (colon == NULL || colon > &buf[len-1] - NUM_COLONS + i)
518                                         {
519                                         /* set colon no. i at last possible position
520                                          * (buf[len-1] is the terminating 0)*/
521                                         colon = &buf[len-1] - NUM_COLONS + i;
522                                         *colon = ':';
523                                         }
524                                 s = colon + 1;
525                                 }
526                         }
527                 }
528         }
529
530 /* BAD for multi-threading: uses a local buffer if ret == NULL */
531 /* ERR_error_string_n should be used instead for ret != NULL
532  * as ERR_error_string cannot know how large the buffer is */
533 char *ERR_error_string(unsigned long e, char *ret)
534         {
535         static char buf[256];
536
537         if (ret == NULL) ret=buf;
538         ERR_error_string_n(e, ret, 256);
539
540         return(ret);
541         }
542
543 LHASH *ERR_get_string_table(void)
544         {
545         return(error_hash);
546         }
547
548 /* not thread-safe */
549 LHASH *ERR_get_err_state_table(void)
550         {
551         return(thread_hash);
552         }
553
554 const char *ERR_lib_error_string(unsigned long e)
555         {
556         ERR_STRING_DATA d,*p=NULL;
557         unsigned long l;
558
559         l=ERR_GET_LIB(e);
560
561         CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
562
563         if (error_hash != NULL)
564                 {
565                 d.error=ERR_PACK(l,0,0);
566                 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
567                 }
568
569         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
570
571         return((p == NULL)?NULL:p->string);
572         }
573
574 const char *ERR_func_error_string(unsigned long e)
575         {
576         ERR_STRING_DATA d,*p=NULL;
577         unsigned long l,f;
578
579         l=ERR_GET_LIB(e);
580         f=ERR_GET_FUNC(e);
581
582         CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
583
584         if (error_hash != NULL)
585                 {
586                 d.error=ERR_PACK(l,f,0);
587                 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
588                 }
589
590         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
591
592         return((p == NULL)?NULL:p->string);
593         }
594
595 const char *ERR_reason_error_string(unsigned long e)
596         {
597         ERR_STRING_DATA d,*p=NULL;
598         unsigned long l,r;
599
600         l=ERR_GET_LIB(e);
601         r=ERR_GET_REASON(e);
602
603         CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
604
605         if (error_hash != NULL)
606                 {
607                 d.error=ERR_PACK(l,0,r);
608                 p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
609                 if (p == NULL)
610                         {
611                         d.error=ERR_PACK(0,0,r);
612                         p=(ERR_STRING_DATA *)lh_retrieve(error_hash,&d);
613                         }
614                 }
615
616         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
617
618         return((p == NULL)?NULL:p->string);
619         }
620
621 static unsigned long err_hash(ERR_STRING_DATA *a)
622         {
623         unsigned long ret,l;
624
625         l=a->error;
626         ret=l^ERR_GET_LIB(l)^ERR_GET_FUNC(l);
627         return(ret^ret%19*13);
628         }
629
630 static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b)
631         {
632         return((int)(a->error-b->error));
633         }
634
635 static unsigned long pid_hash(ERR_STATE *a)
636         {
637         return(a->pid*13);
638         }
639
640 static int pid_cmp(ERR_STATE *a, ERR_STATE *b)
641         {
642         return((int)((long)a->pid - (long)b->pid));
643         }
644
645 void ERR_remove_state(unsigned long pid)
646         {
647         ERR_STATE *p = NULL,tmp;
648
649         if (thread_hash == NULL)
650                 return;
651         if (pid == 0)
652                 pid=(unsigned long)CRYPTO_thread_id();
653         tmp.pid=pid;
654         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
655         if (thread_hash)
656                 {
657                 p=(ERR_STATE *)lh_delete(thread_hash,&tmp);
658                 if (lh_num_items(thread_hash) == 0)
659                         {
660                         /* make sure we don't leak memory */
661                         lh_free(thread_hash);
662                         thread_hash = NULL;
663                         }
664                 }
665         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
666
667         if (p != NULL) ERR_STATE_free(p);
668         }
669
670 ERR_STATE *ERR_get_state(void)
671         {
672         static ERR_STATE fallback;
673         ERR_STATE *ret=NULL,tmp,*tmpp=NULL;
674         int thread_state_exists;
675         int i;
676         unsigned long pid;
677
678         pid=(unsigned long)CRYPTO_thread_id();
679
680         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
681         if (thread_hash != NULL)
682                 {
683                 tmp.pid=pid;
684                 ret=(ERR_STATE *)lh_retrieve(thread_hash,&tmp);
685                 }
686         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
687
688         /* ret == the error state, if NULL, make a new one */
689         if (ret == NULL)
690                 {
691                 ret=(ERR_STATE *)OPENSSL_malloc(sizeof(ERR_STATE));
692                 if (ret == NULL) return(&fallback);
693                 ret->pid=pid;
694                 ret->top=0;
695                 ret->bottom=0;
696                 for (i=0; i<ERR_NUM_ERRORS; i++)
697                         {
698                         ret->err_data[i]=NULL;
699                         ret->err_data_flags[i]=0;
700                         }
701
702                 CRYPTO_w_lock(CRYPTO_LOCK_ERR);
703
704                 /* no entry yet in thread_hash for current thread -
705                  * thus, it may have changed since we last looked at it */
706                 if (thread_hash == NULL)
707                         thread_hash = lh_new(pid_hash, pid_cmp);
708                 if (thread_hash == NULL)
709                         thread_state_exists = 0; /* allocation error */
710                 else
711                         {
712                         tmpp=(ERR_STATE *)lh_insert(thread_hash,ret);
713                         thread_state_exists = 1;
714                         }
715
716                 CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
717
718                 if (!thread_state_exists)
719                         {
720                         ERR_STATE_free(ret); /* could not insert it */
721                         return(&fallback);
722                         }
723                 
724                 if (tmpp != NULL) /* old entry - should not happen */
725                         {
726                         ERR_STATE_free(tmpp);
727                         }
728                 }
729         return(ret);
730         }
731
732 int ERR_get_next_error_library(void)
733         {
734         static int value=ERR_LIB_USER;
735
736         return(value++);
737         }
738
739 void ERR_set_error_data(char *data, int flags)
740         {
741         ERR_STATE *es;
742         int i;
743
744         es=ERR_get_state();
745
746         i=es->top;
747         if (i == 0)
748                 i=ERR_NUM_ERRORS-1;
749
750         es->err_data[i]=data;
751         es->err_data_flags[es->top]=flags;
752         }
753
754 void ERR_add_error_data(int num, ...)
755         {
756         va_list args;
757         int i,n,s;
758         char *str,*p,*a;
759
760         s=64;
761         str=OPENSSL_malloc(s+1);
762         if (str == NULL) return;
763         str[0]='\0';
764
765         va_start(args, num);
766         n=0;
767         for (i=0; i<num; i++)
768                 {
769                 a=va_arg(args, char*);
770                 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
771                 if (a != NULL)
772                         {
773                         n+=strlen(a);
774                         if (n > s)
775                                 {
776                                 s=n+20;
777                                 p=OPENSSL_realloc(str,s+1);
778                                 if (p == NULL)
779                                         {
780                                         OPENSSL_free(str);
781                                         return;
782                                         }
783                                 else
784                                         str=p;
785                                 }
786                         strcat(str,a);
787                         }
788                 }
789         ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);
790
791         va_end(args);
792         }
793