err.c revision 1.16
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-2001 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 "cryptlib.h"
116#include <openssl/lhash.h>
117#include <openssl/crypto.h>
118#include <openssl/buffer.h>
119#include <openssl/bio.h>
120#include <openssl/err.h>
121
122static void err_load_strings(int lib, ERR_STRING_DATA *str);
123
124static void ERR_STATE_free(ERR_STATE *s);
125#ifndef OPENSSL_NO_ERR
126static ERR_STRING_DATA ERR_str_libraries[]=
127	{
128{ERR_PACK(ERR_LIB_NONE,0,0)		,"unknown library"},
129{ERR_PACK(ERR_LIB_SYS,0,0)		,"system library"},
130{ERR_PACK(ERR_LIB_BN,0,0)		,"bignum routines"},
131{ERR_PACK(ERR_LIB_RSA,0,0)		,"rsa routines"},
132{ERR_PACK(ERR_LIB_DH,0,0)		,"Diffie-Hellman routines"},
133{ERR_PACK(ERR_LIB_EVP,0,0)		,"digital envelope routines"},
134{ERR_PACK(ERR_LIB_BUF,0,0)		,"memory buffer routines"},
135{ERR_PACK(ERR_LIB_OBJ,0,0)		,"object identifier routines"},
136{ERR_PACK(ERR_LIB_PEM,0,0)		,"PEM routines"},
137{ERR_PACK(ERR_LIB_DSA,0,0)		,"dsa routines"},
138{ERR_PACK(ERR_LIB_X509,0,0)		,"x509 certificate routines"},
139{ERR_PACK(ERR_LIB_ASN1,0,0)		,"asn1 encoding routines"},
140{ERR_PACK(ERR_LIB_CONF,0,0)		,"configuration file routines"},
141{ERR_PACK(ERR_LIB_CRYPTO,0,0)		,"common libcrypto routines"},
142{ERR_PACK(ERR_LIB_EC,0,0)		,"elliptic curve routines"},
143{ERR_PACK(ERR_LIB_SSL,0,0)		,"SSL routines"},
144{ERR_PACK(ERR_LIB_BIO,0,0)		,"BIO routines"},
145{ERR_PACK(ERR_LIB_PKCS7,0,0)		,"PKCS7 routines"},
146{ERR_PACK(ERR_LIB_X509V3,0,0)		,"X509 V3 routines"},
147{ERR_PACK(ERR_LIB_PKCS12,0,0)		,"PKCS12 routines"},
148{ERR_PACK(ERR_LIB_RAND,0,0)		,"random number generator"},
149{ERR_PACK(ERR_LIB_DSO,0,0)		,"DSO support routines"},
150{ERR_PACK(ERR_LIB_ENGINE,0,0)		,"engine routines"},
151{ERR_PACK(ERR_LIB_OCSP,0,0)		,"OCSP routines"},
152{ERR_PACK(ERR_LIB_FIPS,0,0)		,"FIPS routines"},
153{ERR_PACK(ERR_LIB_CMS,0,0)		,"CMS routines"},
154{0,NULL},
155	};
156
157static ERR_STRING_DATA ERR_str_functs[]=
158	{
159	{ERR_PACK(0,SYS_F_FOPEN,0),     	"fopen"},
160	{ERR_PACK(0,SYS_F_CONNECT,0),		"connect"},
161	{ERR_PACK(0,SYS_F_GETSERVBYNAME,0),	"getservbyname"},
162	{ERR_PACK(0,SYS_F_SOCKET,0),		"socket"},
163	{ERR_PACK(0,SYS_F_IOCTLSOCKET,0),	"ioctlsocket"},
164	{ERR_PACK(0,SYS_F_BIND,0),		"bind"},
165	{ERR_PACK(0,SYS_F_LISTEN,0),		"listen"},
166	{ERR_PACK(0,SYS_F_ACCEPT,0),		"accept"},
167#ifdef OPENSSL_SYS_WINDOWS
168	{ERR_PACK(0,SYS_F_WSASTARTUP,0),	"WSAstartup"},
169#endif
170	{ERR_PACK(0,SYS_F_OPENDIR,0),		"opendir"},
171	{ERR_PACK(0,SYS_F_FREAD,0),		"fread"},
172	{0,NULL},
173	};
174
175static ERR_STRING_DATA ERR_str_reasons[]=
176	{
177{ERR_R_SYS_LIB				,"system lib"},
178{ERR_R_BN_LIB				,"BN lib"},
179{ERR_R_RSA_LIB				,"RSA lib"},
180{ERR_R_DH_LIB				,"DH lib"},
181{ERR_R_EVP_LIB				,"EVP lib"},
182{ERR_R_BUF_LIB				,"BUF lib"},
183{ERR_R_OBJ_LIB				,"OBJ lib"},
184{ERR_R_PEM_LIB				,"PEM lib"},
185{ERR_R_DSA_LIB				,"DSA lib"},
186{ERR_R_X509_LIB				,"X509 lib"},
187{ERR_R_ASN1_LIB				,"ASN1 lib"},
188{ERR_R_CONF_LIB				,"CONF lib"},
189{ERR_R_CRYPTO_LIB			,"CRYPTO lib"},
190{ERR_R_EC_LIB				,"EC lib"},
191{ERR_R_SSL_LIB				,"SSL lib"},
192{ERR_R_BIO_LIB				,"BIO lib"},
193{ERR_R_PKCS7_LIB			,"PKCS7 lib"},
194{ERR_R_X509V3_LIB			,"X509V3 lib"},
195{ERR_R_PKCS12_LIB			,"PKCS12 lib"},
196{ERR_R_RAND_LIB				,"RAND lib"},
197{ERR_R_DSO_LIB				,"DSO lib"},
198{ERR_R_ENGINE_LIB			,"ENGINE lib"},
199{ERR_R_OCSP_LIB				,"OCSP lib"},
200
201{ERR_R_NESTED_ASN1_ERROR		,"nested asn1 error"},
202{ERR_R_BAD_ASN1_OBJECT_HEADER		,"bad asn1 object header"},
203{ERR_R_BAD_GET_ASN1_OBJECT_CALL		,"bad get asn1 object call"},
204{ERR_R_EXPECTING_AN_ASN1_SEQUENCE	,"expecting an asn1 sequence"},
205{ERR_R_ASN1_LENGTH_MISMATCH		,"asn1 length mismatch"},
206{ERR_R_MISSING_ASN1_EOS			,"missing asn1 eos"},
207
208{ERR_R_FATAL                            ,"fatal"},
209{ERR_R_MALLOC_FAILURE			,"malloc failure"},
210{ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED	,"called a function you should not call"},
211{ERR_R_PASSED_NULL_PARAMETER		,"passed a null parameter"},
212{ERR_R_INTERNAL_ERROR			,"internal error"},
213{ERR_R_DISABLED				,"called a function that was disabled at compile-time"},
214
215{0,NULL},
216	};
217#endif
218
219
220/* Define the predeclared (but externally opaque) "ERR_FNS" type */
221struct st_ERR_FNS
222	{
223	/* Works on the "error_hash" string table */
224	LHASH *(*cb_err_get)(int create);
225	void (*cb_err_del)(void);
226	ERR_STRING_DATA *(*cb_err_get_item)(const ERR_STRING_DATA *);
227	ERR_STRING_DATA *(*cb_err_set_item)(ERR_STRING_DATA *);
228	ERR_STRING_DATA *(*cb_err_del_item)(ERR_STRING_DATA *);
229	/* Works on the "thread_hash" error-state table */
230	LHASH *(*cb_thread_get)(int create);
231	void (*cb_thread_release)(LHASH **hash);
232	ERR_STATE *(*cb_thread_get_item)(const ERR_STATE *);
233	ERR_STATE *(*cb_thread_set_item)(ERR_STATE *);
234	void (*cb_thread_del_item)(const ERR_STATE *);
235	/* Returns the next available error "library" numbers */
236	int (*cb_get_next_lib)(void);
237	};
238
239/* Predeclarations of the "err_defaults" functions */
240static LHASH *int_err_get(int create);
241static void int_err_del(void);
242static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
243static ERR_STRING_DATA *int_err_set_item(ERR_STRING_DATA *);
244static ERR_STRING_DATA *int_err_del_item(ERR_STRING_DATA *);
245static LHASH *int_thread_get(int create);
246static void int_thread_release(LHASH **hash);
247static ERR_STATE *int_thread_get_item(const ERR_STATE *);
248static ERR_STATE *int_thread_set_item(ERR_STATE *);
249static void int_thread_del_item(const ERR_STATE *);
250static int int_err_get_next_lib(void);
251/* The static ERR_FNS table using these defaults functions */
252static const ERR_FNS err_defaults =
253	{
254	int_err_get,
255	int_err_del,
256	int_err_get_item,
257	int_err_set_item,
258	int_err_del_item,
259	int_thread_get,
260	int_thread_release,
261	int_thread_get_item,
262	int_thread_set_item,
263	int_thread_del_item,
264	int_err_get_next_lib
265	};
266
267/* The replacable table of ERR_FNS functions we use at run-time */
268static const ERR_FNS *err_fns = NULL;
269
270/* Eg. rather than using "err_get()", use "ERRFN(err_get)()". */
271#define ERRFN(a) err_fns->cb_##a
272
273/* The internal state used by "err_defaults" - as such, the setting, reading,
274 * creating, and deleting of this data should only be permitted via the
275 * "err_defaults" functions. This way, a linked module can completely defer all
276 * ERR state operation (together with requisite locking) to the implementations
277 * and state in the loading application. */
278static LHASH *int_error_hash = NULL;
279static LHASH *int_thread_hash = NULL;
280static int int_thread_hash_references = 0;
281static int int_err_library_number= ERR_LIB_USER;
282
283/* Internal function that checks whether "err_fns" is set and if not, sets it to
284 * the defaults. */
285static void err_fns_check(void)
286	{
287	if (err_fns) return;
288
289	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
290	if (!err_fns)
291		err_fns = &err_defaults;
292	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
293	}
294
295/* API functions to get or set the underlying ERR functions. */
296
297const ERR_FNS *ERR_get_implementation(void)
298	{
299	err_fns_check();
300	return err_fns;
301	}
302
303int ERR_set_implementation(const ERR_FNS *fns)
304	{
305	int ret = 0;
306
307	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
308	/* It's too late if 'err_fns' is non-NULL. BTW: not much point setting
309	 * an error is there?! */
310	if (!err_fns)
311		{
312		err_fns = fns;
313		ret = 1;
314		}
315	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
316	return ret;
317	}
318
319/* These are the callbacks provided to "lh_new()" when creating the LHASH tables
320 * internal to the "err_defaults" implementation. */
321
322/* static unsigned long err_hash(ERR_STRING_DATA *a); */
323static unsigned long err_hash(const void *a_void);
324/* static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b); */
325static int err_cmp(const void *a_void, const void *b_void);
326/* static unsigned long pid_hash(ERR_STATE *pid); */
327static unsigned long pid_hash(const void *pid_void);
328/* static int pid_cmp(ERR_STATE *a,ERR_STATE *pid); */
329static int pid_cmp(const void *a_void,const void *pid_void);
330static unsigned long get_error_values(int inc,int top,const char **file,int *line,
331				      const char **data,int *flags);
332
333/* The internal functions used in the "err_defaults" implementation */
334
335static LHASH *int_err_get(int create)
336	{
337	LHASH *ret = NULL;
338
339	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
340	if (!int_error_hash && create)
341		{
342		CRYPTO_push_info("int_err_get (err.c)");
343		int_error_hash = lh_new(err_hash, err_cmp);
344		CRYPTO_pop_info();
345		}
346	if (int_error_hash)
347		ret = int_error_hash;
348	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
349
350	return ret;
351	}
352
353static void int_err_del(void)
354	{
355	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
356	if (int_error_hash)
357		{
358		lh_free(int_error_hash);
359		int_error_hash = NULL;
360		}
361	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
362	}
363
364static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
365	{
366	ERR_STRING_DATA *p;
367	LHASH *hash;
368
369	err_fns_check();
370	hash = ERRFN(err_get)(0);
371	if (!hash)
372		return NULL;
373
374	CRYPTO_r_lock(CRYPTO_LOCK_ERR);
375	p = (ERR_STRING_DATA *)lh_retrieve(hash, d);
376	CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
377
378	return p;
379	}
380
381static ERR_STRING_DATA *int_err_set_item(ERR_STRING_DATA *d)
382	{
383	ERR_STRING_DATA *p;
384	LHASH *hash;
385
386	err_fns_check();
387	hash = ERRFN(err_get)(1);
388	if (!hash)
389		return NULL;
390
391	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
392	p = (ERR_STRING_DATA *)lh_insert(hash, d);
393	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
394
395	return p;
396	}
397
398static ERR_STRING_DATA *int_err_del_item(ERR_STRING_DATA *d)
399	{
400	ERR_STRING_DATA *p;
401	LHASH *hash;
402
403	err_fns_check();
404	hash = ERRFN(err_get)(0);
405	if (!hash)
406		return NULL;
407
408	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
409	p = (ERR_STRING_DATA *)lh_delete(hash, d);
410	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
411
412	return p;
413	}
414
415static LHASH *int_thread_get(int create)
416	{
417	LHASH *ret = NULL;
418
419	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
420	if (!int_thread_hash && create)
421		{
422		CRYPTO_push_info("int_thread_get (err.c)");
423		int_thread_hash = lh_new(pid_hash, pid_cmp);
424		CRYPTO_pop_info();
425		}
426	if (int_thread_hash)
427		{
428		int_thread_hash_references++;
429		ret = int_thread_hash;
430		}
431	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
432	return ret;
433	}
434
435static void int_thread_release(LHASH **hash)
436	{
437	int i;
438
439	if (hash == NULL || *hash == NULL)
440		return;
441
442	i = CRYPTO_add(&int_thread_hash_references, -1, CRYPTO_LOCK_ERR);
443
444#ifdef REF_PRINT
445	fprintf(stderr,"%4d:%s\n",int_thread_hash_references,"ERR");
446#endif
447	if (i > 0) return;
448#ifdef REF_CHECK
449	if (i < 0)
450		{
451		fprintf(stderr,"int_thread_release, bad reference count\n");
452		abort(); /* ok */
453		}
454#endif
455	*hash = NULL;
456	}
457
458static ERR_STATE *int_thread_get_item(const ERR_STATE *d)
459	{
460	ERR_STATE *p;
461	LHASH *hash;
462
463	err_fns_check();
464	hash = ERRFN(thread_get)(0);
465	if (!hash)
466		return NULL;
467
468	CRYPTO_r_lock(CRYPTO_LOCK_ERR);
469	p = (ERR_STATE *)lh_retrieve(hash, d);
470	CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
471
472	ERRFN(thread_release)(&hash);
473	return p;
474	}
475
476static ERR_STATE *int_thread_set_item(ERR_STATE *d)
477	{
478	ERR_STATE *p;
479	LHASH *hash;
480
481	err_fns_check();
482	hash = ERRFN(thread_get)(1);
483	if (!hash)
484		return NULL;
485
486	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
487	p = (ERR_STATE *)lh_insert(hash, d);
488	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
489
490	ERRFN(thread_release)(&hash);
491	return p;
492	}
493
494static void int_thread_del_item(const ERR_STATE *d)
495	{
496	ERR_STATE *p;
497	LHASH *hash;
498
499	err_fns_check();
500	hash = ERRFN(thread_get)(0);
501	if (!hash)
502		return;
503
504	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
505	p = (ERR_STATE *)lh_delete(hash, d);
506	/* make sure we don't leak memory */
507	if (int_thread_hash_references == 1
508		&& int_thread_hash && (lh_num_items(int_thread_hash) == 0))
509		{
510		lh_free(int_thread_hash);
511		int_thread_hash = NULL;
512		}
513	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
514
515	ERRFN(thread_release)(&hash);
516	if (p)
517		ERR_STATE_free(p);
518	}
519
520static int int_err_get_next_lib(void)
521	{
522	int ret;
523
524	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
525	ret = int_err_library_number++;
526	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
527
528	return ret;
529	}
530
531
532#ifndef OPENSSL_NO_ERR
533#define NUM_SYS_STR_REASONS 127
534#define LEN_SYS_STR_REASON 32
535
536static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
537/* SYS_str_reasons is filled with copies of strerror() results at
538 * initialization.
539 * 'errno' values up to 127 should cover all usual errors,
540 * others will be displayed numerically by ERR_error_string.
541 * It is crucial that we have something for each reason code
542 * that occurs in ERR_str_reasons, or bogus reason strings
543 * will be returned for SYSerr(), which always gets an errno
544 * value and never one of those 'standard' reason codes. */
545
546static void build_SYS_str_reasons(void)
547	{
548	/* OPENSSL_malloc cannot be used here, use static storage instead */
549	static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
550	int i;
551	static int init = 1;
552
553	CRYPTO_r_lock(CRYPTO_LOCK_ERR);
554	if (!init)
555		{
556		CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
557		return;
558		}
559
560	CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
561	CRYPTO_w_lock(CRYPTO_LOCK_ERR);
562	if (!init)
563		{
564		CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
565		return;
566		}
567
568	for (i = 1; i <= NUM_SYS_STR_REASONS; i++)
569		{
570		ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
571
572		str->error = (unsigned long)i;
573		if (str->string == NULL)
574			{
575			char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
576			char *src = strerror(i);
577			if (src != NULL)
578				{
579				strncpy(*dest, src, sizeof *dest);
580				(*dest)[sizeof *dest - 1] = '\0';
581				str->string = *dest;
582				}
583			}
584		if (str->string == NULL)
585			str->string = "unknown";
586		}
587
588	/* Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL},
589	 * as required by ERR_load_strings. */
590
591	init = 0;
592
593	CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
594	}
595#endif
596
597#define err_clear_data(p,i) \
598	do { \
599	if (((p)->err_data[i] != NULL) && \
600		(p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
601		{  \
602		OPENSSL_free((p)->err_data[i]); \
603		(p)->err_data[i]=NULL; \
604		} \
605	(p)->err_data_flags[i]=0; \
606	} while(0)
607
608#define err_clear(p,i) \
609	do { \
610	(p)->err_flags[i]=0; \
611	(p)->err_buffer[i]=0; \
612	err_clear_data(p,i); \
613	(p)->err_file[i]=NULL; \
614	(p)->err_line[i]= -1; \
615	} while(0)
616
617static void ERR_STATE_free(ERR_STATE *s)
618	{
619	int i;
620
621	if (s == NULL)
622	    return;
623
624	for (i=0; i<ERR_NUM_ERRORS; i++)
625		{
626		err_clear_data(s,i);
627		}
628	OPENSSL_free(s);
629	}
630
631void ERR_load_ERR_strings(void)
632	{
633	err_fns_check();
634#ifndef OPENSSL_NO_ERR
635	err_load_strings(0,ERR_str_libraries);
636	err_load_strings(0,ERR_str_reasons);
637	err_load_strings(ERR_LIB_SYS,ERR_str_functs);
638	build_SYS_str_reasons();
639	err_load_strings(ERR_LIB_SYS,SYS_str_reasons);
640#endif
641	}
642
643static void err_load_strings(int lib, ERR_STRING_DATA *str)
644	{
645	while (str->error)
646		{
647		if (lib)
648			str->error|=ERR_PACK(lib,0,0);
649		ERRFN(err_set_item)(str);
650		str++;
651		}
652	}
653
654void ERR_load_strings(int lib, ERR_STRING_DATA *str)
655	{
656	ERR_load_ERR_strings();
657	err_load_strings(lib, str);
658	}
659
660void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
661	{
662	while (str->error)
663		{
664		if (lib)
665			str->error|=ERR_PACK(lib,0,0);
666		ERRFN(err_del_item)(str);
667		str++;
668		}
669	}
670
671void ERR_free_strings(void)
672	{
673	err_fns_check();
674	ERRFN(err_del)();
675	}
676
677/********************************************************/
678
679void ERR_put_error(int lib, int func, int reason, const char *file,
680	     int line)
681	{
682	ERR_STATE *es;
683
684#ifdef _OSD_POSIX
685	/* In the BS2000-OSD POSIX subsystem, the compiler generates
686	 * path names in the form "*POSIX(/etc/passwd)".
687	 * This dirty hack strips them to something sensible.
688	 * @@@ We shouldn't modify a const string, though.
689	 */
690	if (strncmp(file,"*POSIX(", sizeof("*POSIX(")-1) == 0) {
691		char *end;
692
693		/* Skip the "*POSIX(" prefix */
694		file += sizeof("*POSIX(")-1;
695		end = &file[strlen(file)-1];
696		if (*end == ')')
697			*end = '\0';
698		/* Optional: use the basename of the path only. */
699		if ((end = strrchr(file, '/')) != NULL)
700			file = &end[1];
701	}
702#endif
703	es=ERR_get_state();
704
705	es->top=(es->top+1)%ERR_NUM_ERRORS;
706	if (es->top == es->bottom)
707		es->bottom=(es->bottom+1)%ERR_NUM_ERRORS;
708	es->err_flags[es->top]=0;
709	es->err_buffer[es->top]=ERR_PACK(lib,func,reason);
710	es->err_file[es->top]=file;
711	es->err_line[es->top]=line;
712	err_clear_data(es,es->top);
713	}
714
715void ERR_clear_error(void)
716	{
717	int i;
718	ERR_STATE *es;
719
720	es=ERR_get_state();
721
722	for (i=0; i<ERR_NUM_ERRORS; i++)
723		{
724		err_clear(es,i);
725		}
726	es->top=es->bottom=0;
727	}
728
729
730unsigned long ERR_get_error(void)
731	{ return(get_error_values(1,0,NULL,NULL,NULL,NULL)); }
732
733unsigned long ERR_get_error_line(const char **file,
734	     int *line)
735	{ return(get_error_values(1,0,file,line,NULL,NULL)); }
736
737unsigned long ERR_get_error_line_data(const char **file, int *line,
738	     const char **data, int *flags)
739	{ return(get_error_values(1,0,file,line,data,flags)); }
740
741
742unsigned long ERR_peek_error(void)
743	{ return(get_error_values(0,0,NULL,NULL,NULL,NULL)); }
744
745unsigned long ERR_peek_error_line(const char **file, int *line)
746	{ return(get_error_values(0,0,file,line,NULL,NULL)); }
747
748unsigned long ERR_peek_error_line_data(const char **file, int *line,
749	     const char **data, int *flags)
750	{ return(get_error_values(0,0,file,line,data,flags)); }
751
752
753unsigned long ERR_peek_last_error(void)
754	{ return(get_error_values(0,1,NULL,NULL,NULL,NULL)); }
755
756unsigned long ERR_peek_last_error_line(const char **file, int *line)
757	{ return(get_error_values(0,1,file,line,NULL,NULL)); }
758
759unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
760	     const char **data, int *flags)
761	{ return(get_error_values(0,1,file,line,data,flags)); }
762
763
764static unsigned long get_error_values(int inc, int top, const char **file, int *line,
765	     const char **data, int *flags)
766	{
767	int i=0;
768	ERR_STATE *es;
769	unsigned long ret;
770
771	es=ERR_get_state();
772
773	if (inc && top)
774		{
775		if (file) *file = "";
776		if (line) *line = 0;
777		if (data) *data = "";
778		if (flags) *flags = 0;
779
780		return ERR_R_INTERNAL_ERROR;
781		}
782
783	if (es->bottom == es->top) return 0;
784	if (top)
785		i=es->top;			 /* last error */
786	else
787		i=(es->bottom+1)%ERR_NUM_ERRORS; /* first error */
788
789	ret=es->err_buffer[i];
790	if (inc)
791		{
792		es->bottom=i;
793		es->err_buffer[i]=0;
794		}
795
796	if ((file != NULL) && (line != NULL))
797		{
798		if (es->err_file[i] == NULL)
799			{
800			*file="NA";
801			if (line != NULL) *line=0;
802			}
803		else
804			{
805			*file=es->err_file[i];
806			if (line != NULL) *line=es->err_line[i];
807			}
808		}
809
810	if (data == NULL)
811		{
812		if (inc)
813			{
814			err_clear_data(es, i);
815			}
816		}
817	else
818		{
819		if (es->err_data[i] == NULL)
820			{
821			*data="";
822			if (flags != NULL) *flags=0;
823			}
824		else
825			{
826			*data=es->err_data[i];
827			if (flags != NULL) *flags=es->err_data_flags[i];
828			}
829		}
830	return ret;
831	}
832
833void ERR_error_string_n(unsigned long e, char *buf, size_t len)
834	{
835	char lsbuf[64], fsbuf[64], rsbuf[64];
836	const char *ls,*fs,*rs;
837	unsigned long l,f,r;
838
839	l=ERR_GET_LIB(e);
840	f=ERR_GET_FUNC(e);
841	r=ERR_GET_REASON(e);
842
843	ls=ERR_lib_error_string(e);
844	fs=ERR_func_error_string(e);
845	rs=ERR_reason_error_string(e);
846
847	if (ls == NULL)
848		BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
849	if (fs == NULL)
850		BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
851	if (rs == NULL)
852		BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
853
854	BIO_snprintf(buf, len,"error:%08lX:%s:%s:%s", e, ls?ls:lsbuf,
855		fs?fs:fsbuf, rs?rs:rsbuf);
856	if (strlen(buf) == len-1)
857		{
858		/* output may be truncated; make sure we always have 5
859		 * colon-separated fields, i.e. 4 colons ... */
860#define NUM_COLONS 4
861		if (len > NUM_COLONS) /* ... if possible */
862			{
863			int i;
864			char *s = buf;
865
866			for (i = 0; i < NUM_COLONS; i++)
867				{
868				char *colon = strchr(s, ':');
869				if (colon == NULL || colon > &buf[len-1] - NUM_COLONS + i)
870					{
871					/* set colon no. i at last possible position
872					 * (buf[len-1] is the terminating 0)*/
873					colon = &buf[len-1] - NUM_COLONS + i;
874					*colon = ':';
875					}
876				s = colon + 1;
877				}
878			}
879		}
880	}
881
882/* BAD for multi-threading: uses a local buffer if ret == NULL */
883/* ERR_error_string_n should be used instead for ret != NULL
884 * as ERR_error_string cannot know how large the buffer is */
885char *ERR_error_string(unsigned long e, char *ret)
886	{
887	static char buf[256];
888
889	if (ret == NULL) ret=buf;
890	ERR_error_string_n(e, ret, 256);
891
892	return ret;
893	}
894
895LHASH *ERR_get_string_table(void)
896	{
897	err_fns_check();
898	return ERRFN(err_get)(0);
899	}
900
901LHASH *ERR_get_err_state_table(void)
902	{
903	err_fns_check();
904	return ERRFN(thread_get)(0);
905	}
906
907void ERR_release_err_state_table(LHASH **hash)
908	{
909	err_fns_check();
910	ERRFN(thread_release)(hash);
911	}
912
913const char *ERR_lib_error_string(unsigned long e)
914	{
915	ERR_STRING_DATA d,*p;
916	unsigned long l;
917
918	err_fns_check();
919	l=ERR_GET_LIB(e);
920	d.error=ERR_PACK(l,0,0);
921	p=ERRFN(err_get_item)(&d);
922	return((p == NULL)?NULL:p->string);
923	}
924
925const char *ERR_func_error_string(unsigned long e)
926	{
927	ERR_STRING_DATA d,*p;
928	unsigned long l,f;
929
930	err_fns_check();
931	l=ERR_GET_LIB(e);
932	f=ERR_GET_FUNC(e);
933	d.error=ERR_PACK(l,f,0);
934	p=ERRFN(err_get_item)(&d);
935	return((p == NULL)?NULL:p->string);
936	}
937
938const char *ERR_reason_error_string(unsigned long e)
939	{
940	ERR_STRING_DATA d,*p=NULL;
941	unsigned long l,r;
942
943	err_fns_check();
944	l=ERR_GET_LIB(e);
945	r=ERR_GET_REASON(e);
946	d.error=ERR_PACK(l,0,r);
947	p=ERRFN(err_get_item)(&d);
948	if (!p)
949		{
950		d.error=ERR_PACK(0,0,r);
951		p=ERRFN(err_get_item)(&d);
952		}
953	return((p == NULL)?NULL:p->string);
954	}
955
956/* static unsigned long err_hash(ERR_STRING_DATA *a) */
957static unsigned long err_hash(const void *a_void)
958	{
959	unsigned long ret,l;
960
961	l=((const ERR_STRING_DATA *)a_void)->error;
962	ret=l^ERR_GET_LIB(l)^ERR_GET_FUNC(l);
963	return(ret^ret%19*13);
964	}
965
966/* static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b) */
967static int err_cmp(const void *a_void, const void *b_void)
968	{
969	return((int)(((const ERR_STRING_DATA *)a_void)->error -
970			((const ERR_STRING_DATA *)b_void)->error));
971	}
972
973/* static unsigned long pid_hash(ERR_STATE *a) */
974static unsigned long pid_hash(const void *a_void)
975	{
976	return(((const ERR_STATE *)a_void)->pid*13);
977	}
978
979/* static int pid_cmp(ERR_STATE *a, ERR_STATE *b) */
980static int pid_cmp(const void *a_void, const void *b_void)
981	{
982	return((int)((long)((const ERR_STATE *)a_void)->pid -
983			(long)((const ERR_STATE *)b_void)->pid));
984	}
985
986void ERR_remove_state(unsigned long pid)
987	{
988	ERR_STATE tmp;
989
990	err_fns_check();
991	if (pid == 0)
992		pid=(unsigned long)CRYPTO_thread_id();
993	tmp.pid=pid;
994	/* thread_del_item automatically destroys the LHASH if the number of
995	 * items reaches zero. */
996	ERRFN(thread_del_item)(&tmp);
997	}
998
999ERR_STATE *ERR_get_state(void)
1000	{
1001	static ERR_STATE fallback;
1002	ERR_STATE *ret,tmp,*tmpp=NULL;
1003	int i;
1004	unsigned long pid;
1005
1006	err_fns_check();
1007	pid=(unsigned long)CRYPTO_thread_id();
1008	tmp.pid=pid;
1009	ret=ERRFN(thread_get_item)(&tmp);
1010
1011	/* ret == the error state, if NULL, make a new one */
1012	if (ret == NULL)
1013		{
1014		ret=(ERR_STATE *)OPENSSL_malloc(sizeof(ERR_STATE));
1015		if (ret == NULL) return(&fallback);
1016		ret->pid=pid;
1017		ret->top=0;
1018		ret->bottom=0;
1019		for (i=0; i<ERR_NUM_ERRORS; i++)
1020			{
1021			ret->err_data[i]=NULL;
1022			ret->err_data_flags[i]=0;
1023			}
1024		tmpp = ERRFN(thread_set_item)(ret);
1025		/* To check if insertion failed, do a get. */
1026		if (ERRFN(thread_get_item)(ret) != ret)
1027			{
1028			ERR_STATE_free(ret); /* could not insert it */
1029			return(&fallback);
1030			}
1031		/* If a race occured in this function and we came second, tmpp
1032		 * is the first one that we just replaced. */
1033		if (tmpp)
1034			ERR_STATE_free(tmpp);
1035		}
1036	return ret;
1037	}
1038
1039int ERR_get_next_error_library(void)
1040	{
1041	err_fns_check();
1042	return ERRFN(get_next_lib)();
1043	}
1044
1045void ERR_set_error_data(char *data, int flags)
1046	{
1047	ERR_STATE *es;
1048	int i;
1049
1050	es=ERR_get_state();
1051
1052	i=es->top;
1053	if (i == 0)
1054		i=ERR_NUM_ERRORS-1;
1055
1056	err_clear_data(es,i);
1057	es->err_data[i]=data;
1058	es->err_data_flags[i]=flags;
1059	}
1060
1061void ERR_add_error_data(int num, ...)
1062	{
1063	va_list args;
1064	int i,n,s;
1065	char *str,*p,*a;
1066
1067	s=80;
1068	str=OPENSSL_malloc(s+1);
1069	if (str == NULL) return;
1070	str[0]='\0';
1071
1072	va_start(args, num);
1073	n=0;
1074	for (i=0; i<num; i++)
1075		{
1076		a=va_arg(args, char*);
1077		/* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
1078		if (a != NULL)
1079			{
1080			n+=strlen(a);
1081			if (n > s)
1082				{
1083				s=n+20;
1084				p=OPENSSL_realloc(str,s+1);
1085				if (p == NULL)
1086					{
1087					OPENSSL_free(str);
1088					goto err;
1089					}
1090				else
1091					str=p;
1092				}
1093			BUF_strlcat(str,a,(size_t)s+1);
1094			}
1095		}
1096	ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);
1097
1098err:
1099	va_end(args);
1100	}
1101
1102int ERR_set_mark(void)
1103	{
1104	ERR_STATE *es;
1105
1106	es=ERR_get_state();
1107
1108	if (es->bottom == es->top) return 0;
1109	es->err_flags[es->top]|=ERR_FLAG_MARK;
1110	return 1;
1111	}
1112
1113int ERR_pop_to_mark(void)
1114	{
1115	ERR_STATE *es;
1116
1117	es=ERR_get_state();
1118
1119	while(es->bottom != es->top
1120		&& (es->err_flags[es->top] & ERR_FLAG_MARK) == 0)
1121		{
1122		err_clear(es,es->top);
1123		es->top-=1;
1124		if (es->top == -1) es->top=ERR_NUM_ERRORS-1;
1125		}
1126
1127	if (es->bottom == es->top) return 0;
1128	es->err_flags[es->top]&=~ERR_FLAG_MARK;
1129	return 1;
1130	}
1131