2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* TODO: When ERR_STATE becomes opaque, this musts be removed */
11 #define OSSL_FORCE_ERR_STATE
16 #include "crypto/cryptlib.h"
17 #include "internal/err.h"
18 #include "crypto/err.h"
19 #include <openssl/err.h>
20 #include <openssl/crypto.h>
21 #include <openssl/buffer.h>
22 #include <openssl/bio.h>
23 #include <openssl/opensslconf.h>
24 #include "internal/thread_once.h"
25 #include "crypto/ctype.h"
26 #include "internal/constant_time_locl.h"
30 /* Forward declaration in case it's not published because of configuration */
31 ERR_STATE
*ERR_get_state(void);
33 static int err_load_strings(const ERR_STRING_DATA
*str
);
35 static void ERR_STATE_free(ERR_STATE
*s
);
36 #ifndef OPENSSL_NO_ERR
37 static ERR_STRING_DATA ERR_str_libraries
[] = {
38 {ERR_PACK(ERR_LIB_NONE
, 0, 0), "unknown library"},
39 {ERR_PACK(ERR_LIB_SYS
, 0, 0), "system library"},
40 {ERR_PACK(ERR_LIB_BN
, 0, 0), "bignum routines"},
41 {ERR_PACK(ERR_LIB_RSA
, 0, 0), "rsa routines"},
42 {ERR_PACK(ERR_LIB_DH
, 0, 0), "Diffie-Hellman routines"},
43 {ERR_PACK(ERR_LIB_EVP
, 0, 0), "digital envelope routines"},
44 {ERR_PACK(ERR_LIB_BUF
, 0, 0), "memory buffer routines"},
45 {ERR_PACK(ERR_LIB_OBJ
, 0, 0), "object identifier routines"},
46 {ERR_PACK(ERR_LIB_PEM
, 0, 0), "PEM routines"},
47 {ERR_PACK(ERR_LIB_DSA
, 0, 0), "dsa routines"},
48 {ERR_PACK(ERR_LIB_X509
, 0, 0), "x509 certificate routines"},
49 {ERR_PACK(ERR_LIB_ASN1
, 0, 0), "asn1 encoding routines"},
50 {ERR_PACK(ERR_LIB_CONF
, 0, 0), "configuration file routines"},
51 {ERR_PACK(ERR_LIB_CRYPTO
, 0, 0), "common libcrypto routines"},
52 {ERR_PACK(ERR_LIB_EC
, 0, 0), "elliptic curve routines"},
53 {ERR_PACK(ERR_LIB_ECDSA
, 0, 0), "ECDSA routines"},
54 {ERR_PACK(ERR_LIB_ECDH
, 0, 0), "ECDH routines"},
55 {ERR_PACK(ERR_LIB_SSL
, 0, 0), "SSL routines"},
56 {ERR_PACK(ERR_LIB_BIO
, 0, 0), "BIO routines"},
57 {ERR_PACK(ERR_LIB_PKCS7
, 0, 0), "PKCS7 routines"},
58 {ERR_PACK(ERR_LIB_X509V3
, 0, 0), "X509 V3 routines"},
59 {ERR_PACK(ERR_LIB_PKCS12
, 0, 0), "PKCS12 routines"},
60 {ERR_PACK(ERR_LIB_RAND
, 0, 0), "random number generator"},
61 {ERR_PACK(ERR_LIB_DSO
, 0, 0), "DSO support routines"},
62 {ERR_PACK(ERR_LIB_TS
, 0, 0), "time stamp routines"},
63 {ERR_PACK(ERR_LIB_ENGINE
, 0, 0), "engine routines"},
64 {ERR_PACK(ERR_LIB_OCSP
, 0, 0), "OCSP routines"},
65 {ERR_PACK(ERR_LIB_UI
, 0, 0), "UI routines"},
66 {ERR_PACK(ERR_LIB_FIPS
, 0, 0), "FIPS routines"},
67 {ERR_PACK(ERR_LIB_CMS
, 0, 0), "CMS routines"},
68 {ERR_PACK(ERR_LIB_CRMF
, 0, 0), "CRMF routines"},
69 {ERR_PACK(ERR_LIB_CMP
, 0, 0), "CMP routines"},
70 {ERR_PACK(ERR_LIB_HMAC
, 0, 0), "HMAC routines"},
71 {ERR_PACK(ERR_LIB_CT
, 0, 0), "CT routines"},
72 {ERR_PACK(ERR_LIB_ASYNC
, 0, 0), "ASYNC routines"},
73 {ERR_PACK(ERR_LIB_OSSL_STORE
, 0, 0), "STORE routines"},
74 {ERR_PACK(ERR_LIB_SM2
, 0, 0), "SM2 routines"},
75 {ERR_PACK(ERR_LIB_ESS
, 0, 0), "ESS routines"},
76 {ERR_PACK(ERR_LIB_PROV
, 0, 0), "Provider routines"},
80 static ERR_STRING_DATA ERR_str_reasons
[] = {
81 {ERR_R_SYS_LIB
, "system lib"},
82 {ERR_R_BN_LIB
, "BN lib"},
83 {ERR_R_RSA_LIB
, "RSA lib"},
84 {ERR_R_DH_LIB
, "DH lib"},
85 {ERR_R_EVP_LIB
, "EVP lib"},
86 {ERR_R_BUF_LIB
, "BUF lib"},
87 {ERR_R_OBJ_LIB
, "OBJ lib"},
88 {ERR_R_PEM_LIB
, "PEM lib"},
89 {ERR_R_DSA_LIB
, "DSA lib"},
90 {ERR_R_X509_LIB
, "X509 lib"},
91 {ERR_R_ASN1_LIB
, "ASN1 lib"},
92 {ERR_R_EC_LIB
, "EC lib"},
93 {ERR_R_BIO_LIB
, "BIO lib"},
94 {ERR_R_PKCS7_LIB
, "PKCS7 lib"},
95 {ERR_R_X509V3_LIB
, "X509V3 lib"},
96 {ERR_R_ENGINE_LIB
, "ENGINE lib"},
97 {ERR_R_UI_LIB
, "UI lib"},
98 {ERR_R_OSSL_STORE_LIB
, "STORE lib"},
99 {ERR_R_ECDSA_LIB
, "ECDSA lib"},
101 {ERR_R_NESTED_ASN1_ERROR
, "nested asn1 error"},
102 {ERR_R_MISSING_ASN1_EOS
, "missing asn1 eos"},
104 {ERR_R_FATAL
, "fatal"},
105 {ERR_R_MALLOC_FAILURE
, "malloc failure"},
106 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
,
107 "called a function you should not call"},
108 {ERR_R_PASSED_NULL_PARAMETER
, "passed a null parameter"},
109 {ERR_R_INTERNAL_ERROR
, "internal error"},
110 {ERR_R_DISABLED
, "called a function that was disabled at compile-time"},
111 {ERR_R_INIT_FAIL
, "init fail"},
112 {ERR_R_OPERATION_FAIL
, "operation fail"},
118 static CRYPTO_ONCE err_init
= CRYPTO_ONCE_STATIC_INIT
;
119 static int set_err_thread_local
;
120 static CRYPTO_THREAD_LOCAL err_thread_local
;
122 static CRYPTO_ONCE err_string_init
= CRYPTO_ONCE_STATIC_INIT
;
123 static CRYPTO_RWLOCK
*err_string_lock
;
125 static ERR_STRING_DATA
*int_err_get_item(const ERR_STRING_DATA
*);
131 static LHASH_OF(ERR_STRING_DATA
) *int_error_hash
= NULL
;
132 static int int_err_library_number
= ERR_LIB_USER
;
134 typedef enum ERR_GET_ACTION_e
{
135 EV_POP
, EV_PEEK
, EV_PEEK_LAST
138 static unsigned long get_error_values(ERR_GET_ACTION g
,
139 const char **file
, int *line
,
140 const char **func
, const char **data
,
143 static unsigned long err_string_data_hash(const ERR_STRING_DATA
*a
)
145 unsigned long ret
, l
;
148 ret
= l
^ ERR_GET_LIB(l
);
149 return (ret
^ ret
% 19 * 13);
152 static int err_string_data_cmp(const ERR_STRING_DATA
*a
,
153 const ERR_STRING_DATA
*b
)
155 if (a
->error
== b
->error
)
157 return a
->error
> b
->error
? 1 : -1;
160 static ERR_STRING_DATA
*int_err_get_item(const ERR_STRING_DATA
*d
)
162 ERR_STRING_DATA
*p
= NULL
;
164 CRYPTO_THREAD_read_lock(err_string_lock
);
165 p
= lh_ERR_STRING_DATA_retrieve(int_error_hash
, d
);
166 CRYPTO_THREAD_unlock(err_string_lock
);
171 #ifndef OPENSSL_NO_ERR
172 /* 2019-05-21: Russian and Ukrainian locales on Linux require more than 6,5 kB */
173 # define SPACE_SYS_STR_REASONS 8 * 1024
174 # define NUM_SYS_STR_REASONS 127
176 static ERR_STRING_DATA SYS_str_reasons
[NUM_SYS_STR_REASONS
+ 1];
178 * SYS_str_reasons is filled with copies of strerror() results at
179 * initialization. 'errno' values up to 127 should cover all usual errors,
180 * others will be displayed numerically by ERR_error_string. It is crucial
181 * that we have something for each reason code that occurs in
182 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
183 * which always gets an errno value and never one of those 'standard' reason
187 static void build_SYS_str_reasons(void)
189 /* OPENSSL_malloc cannot be used here, use static storage instead */
190 static char strerror_pool
[SPACE_SYS_STR_REASONS
];
191 char *cur
= strerror_pool
;
195 int saveerrno
= get_last_sys_error();
197 CRYPTO_THREAD_write_lock(err_string_lock
);
199 CRYPTO_THREAD_unlock(err_string_lock
);
203 for (i
= 1; i
<= NUM_SYS_STR_REASONS
; i
++) {
204 ERR_STRING_DATA
*str
= &SYS_str_reasons
[i
- 1];
206 str
->error
= ERR_PACK(ERR_LIB_SYS
, 0, i
);
208 * If we have used up all the space in strerror_pool,
209 * there's no point in calling openssl_strerror_r()
211 if (str
->string
== NULL
&& cnt
< sizeof(strerror_pool
)) {
212 if (openssl_strerror_r(i
, cur
, sizeof(strerror_pool
) - cnt
)) {
213 size_t l
= strlen(cur
);
220 * VMS has an unusual quirk of adding spaces at the end of
221 * some (most? all?) messages. Lets trim them off.
223 while (cur
> strerror_pool
&& ossl_isspace(cur
[-1])) {
231 if (str
->string
== NULL
)
232 str
->string
= "unknown";
236 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
237 * required by ERR_load_strings.
242 CRYPTO_THREAD_unlock(err_string_lock
);
243 /* openssl_strerror_r could change errno, but we want to preserve it */
244 set_sys_error(saveerrno
);
245 err_load_strings(SYS_str_reasons
);
249 static void ERR_STATE_free(ERR_STATE
*s
)
255 for (i
= 0; i
< ERR_NUM_ERRORS
; i
++) {
256 err_clear_data(s
, i
, 1);
261 DEFINE_RUN_ONCE_STATIC(do_err_strings_init
)
263 if (!OPENSSL_init_crypto(0, NULL
))
265 err_string_lock
= CRYPTO_THREAD_lock_new();
266 if (err_string_lock
== NULL
)
268 int_error_hash
= lh_ERR_STRING_DATA_new(err_string_data_hash
,
269 err_string_data_cmp
);
270 if (int_error_hash
== NULL
) {
271 CRYPTO_THREAD_lock_free(err_string_lock
);
272 err_string_lock
= NULL
;
278 void err_cleanup(void)
280 if (set_err_thread_local
!= 0)
281 CRYPTO_THREAD_cleanup_local(&err_thread_local
);
282 CRYPTO_THREAD_lock_free(err_string_lock
);
283 err_string_lock
= NULL
;
284 lh_ERR_STRING_DATA_free(int_error_hash
);
285 int_error_hash
= NULL
;
289 * Legacy; pack in the library.
291 static void err_patch(int lib
, ERR_STRING_DATA
*str
)
293 unsigned long plib
= ERR_PACK(lib
, 0, 0);
295 for (; str
->error
!= 0; str
++)
300 * Hash in |str| error strings. Assumes the URN_ONCE was done.
302 static int err_load_strings(const ERR_STRING_DATA
*str
)
304 CRYPTO_THREAD_write_lock(err_string_lock
);
305 for (; str
->error
; str
++)
306 (void)lh_ERR_STRING_DATA_insert(int_error_hash
,
307 (ERR_STRING_DATA
*)str
);
308 CRYPTO_THREAD_unlock(err_string_lock
);
312 int ERR_load_ERR_strings(void)
314 #ifndef OPENSSL_NO_ERR
315 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
))
318 err_load_strings(ERR_str_libraries
);
319 err_load_strings(ERR_str_reasons
);
320 build_SYS_str_reasons();
325 int ERR_load_strings(int lib
, ERR_STRING_DATA
*str
)
327 if (ERR_load_ERR_strings() == 0)
331 err_load_strings(str
);
335 int ERR_load_strings_const(const ERR_STRING_DATA
*str
)
337 if (ERR_load_ERR_strings() == 0)
339 err_load_strings(str
);
343 int ERR_unload_strings(int lib
, ERR_STRING_DATA
*str
)
345 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
))
348 CRYPTO_THREAD_write_lock(err_string_lock
);
350 * We don't need to ERR_PACK the lib, since that was done (to
351 * the table) when it was loaded.
353 for (; str
->error
; str
++)
354 (void)lh_ERR_STRING_DATA_delete(int_error_hash
, str
);
355 CRYPTO_THREAD_unlock(err_string_lock
);
360 void err_free_strings_int(void)
362 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
))
366 /********************************************************/
368 void ERR_clear_error(void)
373 es
= err_get_state_int();
377 for (i
= 0; i
< ERR_NUM_ERRORS
; i
++) {
380 es
->top
= es
->bottom
= 0;
383 unsigned long ERR_get_error(void)
385 return get_error_values(EV_POP
, NULL
, NULL
, NULL
, NULL
, NULL
);
388 unsigned long ERR_get_error_line(const char **file
, int *line
)
390 return get_error_values(EV_POP
, file
, line
, NULL
, NULL
, NULL
);
393 unsigned long ERR_get_error_func(const char **func
)
395 return get_error_values(EV_POP
, NULL
, NULL
, func
, NULL
, NULL
);
398 unsigned long ERR_get_error_data(const char **data
, int *flags
)
400 return get_error_values(EV_POP
, NULL
, NULL
, NULL
, data
, flags
);
403 unsigned long ERR_get_error_all(const char **file
, int *line
,
405 const char **data
, int *flags
)
407 return get_error_values(EV_POP
, file
, line
, func
, data
, flags
);
411 unsigned long ERR_get_error_line_data(const char **file
, int *line
,
412 const char **data
, int *flags
)
414 return get_error_values(EV_POP
, file
, line
, NULL
, data
, flags
);
418 unsigned long ERR_peek_error(void)
420 return get_error_values(EV_PEEK
, NULL
, NULL
, NULL
, NULL
, NULL
);
423 unsigned long ERR_peek_error_line(const char **file
, int *line
)
425 return get_error_values(EV_PEEK
, file
, line
, NULL
, NULL
, NULL
);
428 unsigned long ERR_peek_error_func(const char **func
)
430 return get_error_values(EV_PEEK
, NULL
, NULL
, func
, NULL
, NULL
);
433 unsigned long ERR_peek_error_data(const char **data
, int *flags
)
435 return get_error_values(EV_PEEK
, NULL
, NULL
, NULL
, data
, flags
);
438 unsigned long ERR_peek_error_all(const char **file
, int *line
,
440 const char **data
, int *flags
)
442 return get_error_values(EV_PEEK
, file
, line
, func
, data
, flags
);
446 unsigned long ERR_peek_error_line_data(const char **file
, int *line
,
447 const char **data
, int *flags
)
449 return get_error_values(EV_PEEK
, file
, line
, NULL
, data
, flags
);
453 unsigned long ERR_peek_last_error(void)
455 return get_error_values(EV_PEEK_LAST
, NULL
, NULL
, NULL
, NULL
, NULL
);
458 unsigned long ERR_peek_last_error_line(const char **file
, int *line
)
460 return get_error_values(EV_PEEK_LAST
, file
, line
, NULL
, NULL
, NULL
);
463 unsigned long ERR_peek_last_error_func(const char **func
)
465 return get_error_values(EV_PEEK_LAST
, NULL
, NULL
, func
, NULL
, NULL
);
468 unsigned long ERR_peek_last_error_data(const char **data
, int *flags
)
470 return get_error_values(EV_PEEK_LAST
, NULL
, NULL
, NULL
, data
, flags
);
473 unsigned long ERR_peek_last_error_all(const char **file
, int *line
,
475 const char **data
, int *flags
)
477 return get_error_values(EV_PEEK_LAST
, file
, line
, func
, data
, flags
);
481 unsigned long ERR_peek_last_error_line_data(const char **file
, int *line
,
482 const char **data
, int *flags
)
484 return get_error_values(EV_PEEK_LAST
, file
, line
, NULL
, data
, flags
);
488 static unsigned long get_error_values(ERR_GET_ACTION g
,
489 const char **file
, int *line
,
491 const char **data
, int *flags
)
497 es
= err_get_state_int();
502 * Clear anything that should have been cleared earlier. We do this
503 * here because this doesn't have constant-time issues.
505 while (es
->bottom
!= es
->top
) {
506 if (es
->err_flags
[es
->top
] & ERR_FLAG_CLEAR
) {
507 err_clear(es
, es
->top
, 0);
508 es
->top
= es
->top
> 0 ? es
->top
- 1 : ERR_NUM_ERRORS
- 1;
511 i
= (es
->bottom
+ 1) % ERR_NUM_ERRORS
;
512 if (es
->err_flags
[i
] & ERR_FLAG_CLEAR
) {
514 err_clear(es
, es
->bottom
, 0);
520 /* If everything has been cleared, the stack is empty. */
521 if (es
->bottom
== es
->top
)
524 /* Which error, the top of stack (latest one) or the first one? */
525 if (g
== EV_PEEK_LAST
)
528 i
= (es
->bottom
+ 1) % ERR_NUM_ERRORS
;
530 ret
= es
->err_buffer
[i
];
533 es
->err_buffer
[i
] = 0;
536 if (file
!= NULL
&& line
!= NULL
) {
537 if (es
->err_file
[i
] == NULL
) {
541 *file
= es
->err_file
[i
];
542 *line
= es
->err_line
[i
];
547 *func
= es
->err_func
[i
];
554 err_clear_data(es
, i
, 0);
557 if (es
->err_data
[i
] == NULL
) {
562 *data
= es
->err_data
[i
];
564 *flags
= es
->err_data_flags
[i
];
570 void ERR_error_string_n(unsigned long e
, char *buf
, size_t len
)
572 char lsbuf
[64], rsbuf
[64];
574 unsigned long f
= 0, l
, r
;
580 ls
= ERR_lib_error_string(e
);
582 BIO_snprintf(lsbuf
, sizeof(lsbuf
), "lib(%lu)", l
);
586 rs
= ERR_reason_error_string(e
);
587 r
= ERR_GET_REASON(e
);
589 BIO_snprintf(rsbuf
, sizeof(rsbuf
), "reason(%lu)", r
);
593 BIO_snprintf(buf
, len
, "error:%08lX:%s:%s:%s", e
, ls
, "", rs
);
594 if (strlen(buf
) == len
- 1) {
595 /* Didn't fit; use a minimal format. */
596 BIO_snprintf(buf
, len
, "err:%lx:%lx:%lx:%lx", e
, l
, f
, r
);
601 * ERR_error_string_n should be used instead for ret != NULL as
602 * ERR_error_string cannot know how large the buffer is
604 char *ERR_error_string(unsigned long e
, char *ret
)
606 static char buf
[256];
610 ERR_error_string_n(e
, ret
, (int)sizeof(buf
));
614 const char *ERR_lib_error_string(unsigned long e
)
616 ERR_STRING_DATA d
, *p
;
619 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
)) {
624 d
.error
= ERR_PACK(l
, 0, 0);
625 p
= int_err_get_item(&d
);
626 return ((p
== NULL
) ? NULL
: p
->string
);
630 const char *ERR_func_error_string(unsigned long e
)
636 const char *ERR_reason_error_string(unsigned long e
)
638 ERR_STRING_DATA d
, *p
= NULL
;
641 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
)) {
646 r
= ERR_GET_REASON(e
);
647 d
.error
= ERR_PACK(l
, 0, r
);
648 p
= int_err_get_item(&d
);
650 d
.error
= ERR_PACK(0, 0, r
);
651 p
= int_err_get_item(&d
);
653 return ((p
== NULL
) ? NULL
: p
->string
);
656 /* TODO(3.0): arg ignored for now */
657 static void err_delete_thread_state(void *arg
)
659 ERR_STATE
*state
= CRYPTO_THREAD_get_local(&err_thread_local
);
663 CRYPTO_THREAD_set_local(&err_thread_local
, NULL
);
664 ERR_STATE_free(state
);
667 #if !OPENSSL_API_1_1_0
668 void ERR_remove_thread_state(void *dummy
)
673 #if !OPENSSL_API_1_0_0
674 void ERR_remove_state(unsigned long pid
)
679 DEFINE_RUN_ONCE_STATIC(err_do_init
)
681 set_err_thread_local
= 1;
682 return CRYPTO_THREAD_init_local(&err_thread_local
, NULL
);
685 ERR_STATE
*err_get_state_int(void)
688 int saveerrno
= get_last_sys_error();
690 if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY
, NULL
))
693 if (!RUN_ONCE(&err_init
, err_do_init
))
696 state
= CRYPTO_THREAD_get_local(&err_thread_local
);
697 if (state
== (ERR_STATE
*)-1)
701 if (!CRYPTO_THREAD_set_local(&err_thread_local
, (ERR_STATE
*)-1))
704 if ((state
= OPENSSL_zalloc(sizeof(*state
))) == NULL
) {
705 CRYPTO_THREAD_set_local(&err_thread_local
, NULL
);
709 if (!ossl_init_thread_start(NULL
, NULL
, err_delete_thread_state
)
710 || !CRYPTO_THREAD_set_local(&err_thread_local
, state
)) {
711 ERR_STATE_free(state
);
712 CRYPTO_THREAD_set_local(&err_thread_local
, NULL
);
716 /* Ignore failures from these */
717 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS
, NULL
);
720 set_sys_error(saveerrno
);
725 ERR_STATE
*ERR_get_state(void)
727 return err_get_state_int();
733 * err_shelve_state returns the current thread local error state
734 * and freezes the error module until err_unshelve_state is called.
736 int err_shelve_state(void **state
)
738 int saveerrno
= get_last_sys_error();
741 * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
742 * via ossl_init_load_crypto_nodelete(), by which point the requested
743 * "base" initialization has already been performed, so the below call is a
744 * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
746 * If are no other valid callers of this function, the call below can be
747 * removed, avoiding the re-entry into OPENSSL_init_crypto(). If there are
748 * potential uses that are not from inside OPENSSL_init_crypto(), then this
749 * call is needed, but some care is required to make sure that the re-entry
752 if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY
, NULL
))
755 if (!RUN_ONCE(&err_init
, err_do_init
))
758 *state
= CRYPTO_THREAD_get_local(&err_thread_local
);
759 if (!CRYPTO_THREAD_set_local(&err_thread_local
, (ERR_STATE
*)-1))
762 set_sys_error(saveerrno
);
767 * err_unshelve_state restores the error state that was returned
768 * by err_shelve_state previously.
770 void err_unshelve_state(void* state
)
772 if (state
!= (void*)-1)
773 CRYPTO_THREAD_set_local(&err_thread_local
, (ERR_STATE
*)state
);
776 int ERR_get_next_error_library(void)
780 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
))
783 CRYPTO_THREAD_write_lock(err_string_lock
);
784 ret
= int_err_library_number
++;
785 CRYPTO_THREAD_unlock(err_string_lock
);
789 static int err_set_error_data_int(char *data
, size_t size
, int flags
,
794 es
= err_get_state_int();
798 err_clear_data(es
, es
->top
, deallocate
);
799 err_set_data(es
, es
->top
, data
, size
, flags
);
804 void ERR_set_error_data(char *data
, int flags
)
807 * This function is void so we cannot propagate the error return. Since it
808 * is also in the public API we can't change the return type.
810 * We estimate the size of the data. If it's not flagged as allocated,
811 * then this is safe, and if it is flagged as allocated, then our size
812 * may be smaller than the actual allocation, but that doesn't matter
813 * too much, the buffer will remain untouched or will eventually be
814 * reallocated to a new size.
816 * callers should be advised that this function takes over ownership of
817 * the allocated memory, i.e. they can't count on the pointer to remain
820 err_set_error_data_int(data
, strlen(data
) + 1, flags
, 1);
823 void ERR_add_error_data(int num
, ...)
827 ERR_add_error_vdata(num
, args
);
831 void ERR_add_error_vdata(int num
, va_list args
)
834 int flags
= ERR_TXT_MALLOCED
| ERR_TXT_STRING
;
838 /* Get the current error data; if an allocated string get it. */
839 es
= err_get_state_int();
845 * If err_data is allocated already, re-use the space.
846 * Otherwise, allocate a small new buffer.
848 if ((es
->err_data_flags
[i
] & flags
) == flags
) {
849 str
= es
->err_data
[i
];
850 size
= es
->err_data_size
[i
];
853 * To protect the string we just grabbed from tampering by other
854 * functions we may call, or to protect them from freeing a pointer
855 * that may no longer be valid at that point, we clear away the
856 * data pointer and the flags. We will set them again at the end
859 es
->err_data
[i
] = NULL
;
860 es
->err_data_flags
[i
] = 0;
861 } else if ((str
= OPENSSL_malloc(size
= 81)) == NULL
) {
869 arg
= va_arg(args
, char *);
877 p
= OPENSSL_realloc(str
, size
);
884 OPENSSL_strlcat(str
, arg
, (size_t)size
);
886 if (!err_set_error_data_int(str
, size
, flags
, 0))
890 int ERR_set_mark(void)
894 es
= err_get_state_int();
898 if (es
->bottom
== es
->top
)
900 es
->err_flags
[es
->top
] |= ERR_FLAG_MARK
;
904 int ERR_pop_to_mark(void)
908 es
= err_get_state_int();
912 while (es
->bottom
!= es
->top
913 && (es
->err_flags
[es
->top
] & ERR_FLAG_MARK
) == 0) {
914 err_clear(es
, es
->top
, 0);
915 es
->top
= es
->top
> 0 ? es
->top
- 1 : ERR_NUM_ERRORS
- 1;
918 if (es
->bottom
== es
->top
)
920 es
->err_flags
[es
->top
] &= ~ERR_FLAG_MARK
;
924 int ERR_clear_last_mark(void)
929 es
= err_get_state_int();
934 while (es
->bottom
!= top
935 && (es
->err_flags
[top
] & ERR_FLAG_MARK
) == 0) {
936 top
= top
> 0 ? top
- 1 : ERR_NUM_ERRORS
- 1;
939 if (es
->bottom
== top
)
941 es
->err_flags
[top
] &= ~ERR_FLAG_MARK
;
945 void err_clear_last_constant_time(int clear
)
950 es
= err_get_state_int();
957 * Flag error as cleared but remove it elsewhere to avoid two errors
958 * accessing the same error stack location, revealing timing information.
960 clear
= constant_time_select_int(constant_time_eq_int(clear
, 0),
962 es
->err_flags
[top
] |= clear
;