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