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