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