2 * Copyright 1995-2020 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.h"
28 #include "err_local.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_KDF
, 0, 0), "KDF routines"},
74 {ERR_PACK(ERR_LIB_OSSL_STORE
, 0, 0), "STORE routines"},
75 {ERR_PACK(ERR_LIB_SM2
, 0, 0), "SM2 routines"},
76 {ERR_PACK(ERR_LIB_ESS
, 0, 0), "ESS routines"},
77 {ERR_PACK(ERR_LIB_PROV
, 0, 0), "Provider routines"},
78 {ERR_PACK(ERR_LIB_OSSL_SERIALIZER
, 0, 0), "SERIALIZER routines"},
79 {ERR_PACK(ERR_LIB_OSSL_DESERIALIZER
, 0, 0), "DESERIALIZER routines"},
80 {ERR_PACK(ERR_LIB_HTTP
, 0, 0), "HTTP routines"},
84 static ERR_STRING_DATA ERR_str_reasons
[] = {
85 {ERR_R_SYS_LIB
, "system lib"},
86 {ERR_R_BN_LIB
, "BN lib"},
87 {ERR_R_RSA_LIB
, "RSA lib"},
88 {ERR_R_DH_LIB
, "DH lib"},
89 {ERR_R_EVP_LIB
, "EVP lib"},
90 {ERR_R_BUF_LIB
, "BUF lib"},
91 {ERR_R_OBJ_LIB
, "OBJ lib"},
92 {ERR_R_PEM_LIB
, "PEM lib"},
93 {ERR_R_DSA_LIB
, "DSA lib"},
94 {ERR_R_X509_LIB
, "X509 lib"},
95 {ERR_R_ASN1_LIB
, "ASN1 lib"},
96 {ERR_R_EC_LIB
, "EC lib"},
97 {ERR_R_BIO_LIB
, "BIO lib"},
98 {ERR_R_PKCS7_LIB
, "PKCS7 lib"},
99 {ERR_R_X509V3_LIB
, "X509V3 lib"},
100 {ERR_R_ENGINE_LIB
, "ENGINE lib"},
101 {ERR_R_UI_LIB
, "UI lib"},
102 {ERR_R_OSSL_STORE_LIB
, "STORE lib"},
103 {ERR_R_ECDSA_LIB
, "ECDSA lib"},
105 {ERR_R_NESTED_ASN1_ERROR
, "nested asn1 error"},
106 {ERR_R_MISSING_ASN1_EOS
, "missing asn1 eos"},
108 {ERR_R_FATAL
, "fatal"},
109 {ERR_R_MALLOC_FAILURE
, "malloc failure"},
110 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
,
111 "called a function you should not call"},
112 {ERR_R_PASSED_NULL_PARAMETER
, "passed a null parameter"},
113 {ERR_R_INTERNAL_ERROR
, "internal error"},
114 {ERR_R_DISABLED
, "called a function that was disabled at compile-time"},
115 {ERR_R_INIT_FAIL
, "init fail"},
116 {ERR_R_OPERATION_FAIL
, "operation fail"},
117 {ERR_R_INVALID_PROVIDER_FUNCTIONS
, "invalid provider functions"},
118 {ERR_R_INTERRUPTED_OR_CANCELLED
, "interrupted or cancelled"},
124 static CRYPTO_ONCE err_init
= CRYPTO_ONCE_STATIC_INIT
;
125 static int set_err_thread_local
;
126 static CRYPTO_THREAD_LOCAL err_thread_local
;
128 static CRYPTO_ONCE err_string_init
= CRYPTO_ONCE_STATIC_INIT
;
129 static CRYPTO_RWLOCK
*err_string_lock
;
131 static ERR_STRING_DATA
*int_err_get_item(const ERR_STRING_DATA
*);
137 static LHASH_OF(ERR_STRING_DATA
) *int_error_hash
= NULL
;
138 static int int_err_library_number
= ERR_LIB_USER
;
140 typedef enum ERR_GET_ACTION_e
{
141 EV_POP
, EV_PEEK
, EV_PEEK_LAST
144 static unsigned long get_error_values(ERR_GET_ACTION g
,
145 const char **file
, int *line
,
146 const char **func
, const char **data
,
149 static unsigned long err_string_data_hash(const ERR_STRING_DATA
*a
)
151 unsigned long ret
, l
;
154 ret
= l
^ ERR_GET_LIB(l
);
155 return (ret
^ ret
% 19 * 13);
158 static int err_string_data_cmp(const ERR_STRING_DATA
*a
,
159 const ERR_STRING_DATA
*b
)
161 if (a
->error
== b
->error
)
163 return a
->error
> b
->error
? 1 : -1;
166 static ERR_STRING_DATA
*int_err_get_item(const ERR_STRING_DATA
*d
)
168 ERR_STRING_DATA
*p
= NULL
;
170 CRYPTO_THREAD_read_lock(err_string_lock
);
171 p
= lh_ERR_STRING_DATA_retrieve(int_error_hash
, d
);
172 CRYPTO_THREAD_unlock(err_string_lock
);
177 static void ERR_STATE_free(ERR_STATE
*s
)
183 for (i
= 0; i
< ERR_NUM_ERRORS
; i
++) {
184 err_clear_data(s
, i
, 1);
189 DEFINE_RUN_ONCE_STATIC(do_err_strings_init
)
191 if (!OPENSSL_init_crypto(0, NULL
))
193 err_string_lock
= CRYPTO_THREAD_lock_new();
194 if (err_string_lock
== NULL
)
196 int_error_hash
= lh_ERR_STRING_DATA_new(err_string_data_hash
,
197 err_string_data_cmp
);
198 if (int_error_hash
== NULL
) {
199 CRYPTO_THREAD_lock_free(err_string_lock
);
200 err_string_lock
= NULL
;
206 void err_cleanup(void)
208 if (set_err_thread_local
!= 0)
209 CRYPTO_THREAD_cleanup_local(&err_thread_local
);
210 CRYPTO_THREAD_lock_free(err_string_lock
);
211 err_string_lock
= NULL
;
212 lh_ERR_STRING_DATA_free(int_error_hash
);
213 int_error_hash
= NULL
;
217 * Legacy; pack in the library.
219 static void err_patch(int lib
, ERR_STRING_DATA
*str
)
221 unsigned long plib
= ERR_PACK(lib
, 0, 0);
223 for (; str
->error
!= 0; str
++)
228 * Hash in |str| error strings. Assumes the URN_ONCE was done.
230 static int err_load_strings(const ERR_STRING_DATA
*str
)
232 CRYPTO_THREAD_write_lock(err_string_lock
);
233 for (; str
->error
; str
++)
234 (void)lh_ERR_STRING_DATA_insert(int_error_hash
,
235 (ERR_STRING_DATA
*)str
);
236 CRYPTO_THREAD_unlock(err_string_lock
);
240 int ERR_load_ERR_strings(void)
242 #ifndef OPENSSL_NO_ERR
243 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
))
246 err_load_strings(ERR_str_libraries
);
247 err_load_strings(ERR_str_reasons
);
252 int ERR_load_strings(int lib
, ERR_STRING_DATA
*str
)
254 if (ERR_load_ERR_strings() == 0)
258 err_load_strings(str
);
262 int ERR_load_strings_const(const ERR_STRING_DATA
*str
)
264 if (ERR_load_ERR_strings() == 0)
266 err_load_strings(str
);
270 int ERR_unload_strings(int lib
, ERR_STRING_DATA
*str
)
272 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
))
275 CRYPTO_THREAD_write_lock(err_string_lock
);
277 * We don't need to ERR_PACK the lib, since that was done (to
278 * the table) when it was loaded.
280 for (; str
->error
; str
++)
281 (void)lh_ERR_STRING_DATA_delete(int_error_hash
, str
);
282 CRYPTO_THREAD_unlock(err_string_lock
);
287 void err_free_strings_int(void)
289 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
))
293 /********************************************************/
295 void ERR_clear_error(void)
300 es
= err_get_state_int();
304 for (i
= 0; i
< ERR_NUM_ERRORS
; i
++) {
307 es
->top
= es
->bottom
= 0;
310 unsigned long ERR_get_error(void)
312 return get_error_values(EV_POP
, NULL
, NULL
, NULL
, NULL
, NULL
);
315 unsigned long ERR_get_error_line(const char **file
, int *line
)
317 return get_error_values(EV_POP
, file
, line
, NULL
, NULL
, NULL
);
320 unsigned long ERR_get_error_func(const char **func
)
322 return get_error_values(EV_POP
, NULL
, NULL
, func
, NULL
, NULL
);
325 unsigned long ERR_get_error_data(const char **data
, int *flags
)
327 return get_error_values(EV_POP
, NULL
, NULL
, NULL
, data
, flags
);
330 unsigned long ERR_get_error_all(const char **file
, int *line
,
332 const char **data
, int *flags
)
334 return get_error_values(EV_POP
, file
, line
, func
, data
, flags
);
337 #ifndef OPENSSL_NO_DEPRECATED_3_0
338 unsigned long ERR_get_error_line_data(const char **file
, int *line
,
339 const char **data
, int *flags
)
341 return get_error_values(EV_POP
, file
, line
, NULL
, data
, flags
);
345 unsigned long ERR_peek_error(void)
347 return get_error_values(EV_PEEK
, NULL
, NULL
, NULL
, NULL
, NULL
);
350 unsigned long ERR_peek_error_line(const char **file
, int *line
)
352 return get_error_values(EV_PEEK
, file
, line
, NULL
, NULL
, NULL
);
355 unsigned long ERR_peek_error_func(const char **func
)
357 return get_error_values(EV_PEEK
, NULL
, NULL
, func
, NULL
, NULL
);
360 unsigned long ERR_peek_error_data(const char **data
, int *flags
)
362 return get_error_values(EV_PEEK
, NULL
, NULL
, NULL
, data
, flags
);
365 unsigned long ERR_peek_error_all(const char **file
, int *line
,
367 const char **data
, int *flags
)
369 return get_error_values(EV_PEEK
, file
, line
, func
, data
, flags
);
372 #ifndef OPENSSL_NO_DEPRECATED_3_0
373 unsigned long ERR_peek_error_line_data(const char **file
, int *line
,
374 const char **data
, int *flags
)
376 return get_error_values(EV_PEEK
, file
, line
, NULL
, data
, flags
);
380 unsigned long ERR_peek_last_error(void)
382 return get_error_values(EV_PEEK_LAST
, NULL
, NULL
, NULL
, NULL
, NULL
);
385 unsigned long ERR_peek_last_error_line(const char **file
, int *line
)
387 return get_error_values(EV_PEEK_LAST
, file
, line
, NULL
, NULL
, NULL
);
390 unsigned long ERR_peek_last_error_func(const char **func
)
392 return get_error_values(EV_PEEK_LAST
, NULL
, NULL
, func
, NULL
, NULL
);
395 unsigned long ERR_peek_last_error_data(const char **data
, int *flags
)
397 return get_error_values(EV_PEEK_LAST
, NULL
, NULL
, NULL
, data
, flags
);
400 unsigned long ERR_peek_last_error_all(const char **file
, int *line
,
402 const char **data
, int *flags
)
404 return get_error_values(EV_PEEK_LAST
, file
, line
, func
, data
, flags
);
407 #ifndef OPENSSL_NO_DEPRECATED_3_0
408 unsigned long ERR_peek_last_error_line_data(const char **file
, int *line
,
409 const char **data
, int *flags
)
411 return get_error_values(EV_PEEK_LAST
, file
, line
, NULL
, data
, flags
);
415 static unsigned long get_error_values(ERR_GET_ACTION g
,
416 const char **file
, int *line
,
418 const char **data
, int *flags
)
424 es
= err_get_state_int();
429 * Clear anything that should have been cleared earlier. We do this
430 * here because this doesn't have constant-time issues.
432 while (es
->bottom
!= es
->top
) {
433 if (es
->err_flags
[es
->top
] & ERR_FLAG_CLEAR
) {
434 err_clear(es
, es
->top
, 0);
435 es
->top
= es
->top
> 0 ? es
->top
- 1 : ERR_NUM_ERRORS
- 1;
438 i
= (es
->bottom
+ 1) % ERR_NUM_ERRORS
;
439 if (es
->err_flags
[i
] & ERR_FLAG_CLEAR
) {
441 err_clear(es
, es
->bottom
, 0);
447 /* If everything has been cleared, the stack is empty. */
448 if (es
->bottom
== es
->top
)
451 /* Which error, the top of stack (latest one) or the first one? */
452 if (g
== EV_PEEK_LAST
)
455 i
= (es
->bottom
+ 1) % ERR_NUM_ERRORS
;
457 ret
= es
->err_buffer
[i
];
460 es
->err_buffer
[i
] = 0;
464 *file
= es
->err_file
[i
];
469 *line
= es
->err_line
[i
];
471 *func
= es
->err_func
[i
];
476 *flags
= es
->err_data_flags
[i
];
479 err_clear_data(es
, i
, 0);
482 *data
= es
->err_data
[i
];
492 void ERR_error_string_n(unsigned long e
, char *buf
, size_t len
)
494 char lsbuf
[64], rsbuf
[256];
495 const char *ls
, *rs
= NULL
;
496 unsigned long f
= 0, l
, r
;
502 ls
= ERR_lib_error_string(e
);
504 BIO_snprintf(lsbuf
, sizeof(lsbuf
), "lib(%lu)", l
);
509 * ERR_reason_error_string() can't safely return system error strings,
510 * since it would call openssl_strerror_r(), which needs a buffer for
511 * thread safety. So for system errors, we call openssl_strerror_r()
514 r
= ERR_GET_REASON(e
);
515 if (ERR_SYSTEM_ERROR(e
)) {
516 if (openssl_strerror_r(r
, rsbuf
, sizeof(rsbuf
)))
519 rs
= ERR_reason_error_string(e
);
522 BIO_snprintf(rsbuf
, sizeof(rsbuf
), "reason(%lu)", r
);
526 BIO_snprintf(buf
, len
, "error:%08lX:%s:%s:%s", e
, ls
, "", rs
);
527 if (strlen(buf
) == len
- 1) {
528 /* Didn't fit; use a minimal format. */
529 BIO_snprintf(buf
, len
, "err:%lx:%lx:%lx:%lx", e
, l
, f
, r
);
534 * ERR_error_string_n should be used instead for ret != NULL as
535 * ERR_error_string cannot know how large the buffer is
537 char *ERR_error_string(unsigned long e
, char *ret
)
539 static char buf
[256];
543 ERR_error_string_n(e
, ret
, (int)sizeof(buf
));
547 const char *ERR_lib_error_string(unsigned long e
)
549 ERR_STRING_DATA d
, *p
;
552 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
)) {
557 d
.error
= ERR_PACK(l
, 0, 0);
558 p
= int_err_get_item(&d
);
559 return ((p
== NULL
) ? NULL
: p
->string
);
562 #ifndef OPENSSL_NO_DEPRECATED_3_0
563 const char *ERR_func_error_string(unsigned long e
)
569 const char *ERR_reason_error_string(unsigned long e
)
571 ERR_STRING_DATA d
, *p
= NULL
;
574 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
)) {
579 * ERR_reason_error_string() can't safely return system error strings,
580 * since openssl_strerror_r() needs a buffer for thread safety, and we
581 * haven't got one that would serve any sensible purpose.
583 if (ERR_SYSTEM_ERROR(e
))
587 r
= ERR_GET_REASON(e
);
588 d
.error
= ERR_PACK(l
, 0, r
);
589 p
= int_err_get_item(&d
);
591 d
.error
= ERR_PACK(0, 0, r
);
592 p
= int_err_get_item(&d
);
594 return ((p
== NULL
) ? NULL
: p
->string
);
597 /* TODO(3.0): arg ignored for now */
598 static void err_delete_thread_state(void *arg
)
600 ERR_STATE
*state
= CRYPTO_THREAD_get_local(&err_thread_local
);
604 CRYPTO_THREAD_set_local(&err_thread_local
, NULL
);
605 ERR_STATE_free(state
);
608 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
609 void ERR_remove_thread_state(void *dummy
)
614 #ifndef OPENSSL_NO_DEPRECATED_1_0_0
615 void ERR_remove_state(unsigned long pid
)
620 DEFINE_RUN_ONCE_STATIC(err_do_init
)
622 set_err_thread_local
= 1;
623 return CRYPTO_THREAD_init_local(&err_thread_local
, NULL
);
626 ERR_STATE
*err_get_state_int(void)
629 int saveerrno
= get_last_sys_error();
631 if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY
, NULL
))
634 if (!RUN_ONCE(&err_init
, err_do_init
))
637 state
= CRYPTO_THREAD_get_local(&err_thread_local
);
638 if (state
== (ERR_STATE
*)-1)
642 if (!CRYPTO_THREAD_set_local(&err_thread_local
, (ERR_STATE
*)-1))
645 if ((state
= OPENSSL_zalloc(sizeof(*state
))) == NULL
) {
646 CRYPTO_THREAD_set_local(&err_thread_local
, NULL
);
650 if (!ossl_init_thread_start(NULL
, NULL
, err_delete_thread_state
)
651 || !CRYPTO_THREAD_set_local(&err_thread_local
, state
)) {
652 ERR_STATE_free(state
);
653 CRYPTO_THREAD_set_local(&err_thread_local
, NULL
);
657 /* Ignore failures from these */
658 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS
, NULL
);
661 set_sys_error(saveerrno
);
665 #ifndef OPENSSL_NO_DEPRECATED_3_0
666 ERR_STATE
*ERR_get_state(void)
668 return err_get_state_int();
674 * err_shelve_state returns the current thread local error state
675 * and freezes the error module until err_unshelve_state is called.
677 int err_shelve_state(void **state
)
679 int saveerrno
= get_last_sys_error();
682 * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
683 * via ossl_init_load_crypto_nodelete(), by which point the requested
684 * "base" initialization has already been performed, so the below call is a
685 * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
687 * If are no other valid callers of this function, the call below can be
688 * removed, avoiding the re-entry into OPENSSL_init_crypto(). If there are
689 * potential uses that are not from inside OPENSSL_init_crypto(), then this
690 * call is needed, but some care is required to make sure that the re-entry
693 if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY
, NULL
))
696 if (!RUN_ONCE(&err_init
, err_do_init
))
699 *state
= CRYPTO_THREAD_get_local(&err_thread_local
);
700 if (!CRYPTO_THREAD_set_local(&err_thread_local
, (ERR_STATE
*)-1))
703 set_sys_error(saveerrno
);
708 * err_unshelve_state restores the error state that was returned
709 * by err_shelve_state previously.
711 void err_unshelve_state(void* state
)
713 if (state
!= (void*)-1)
714 CRYPTO_THREAD_set_local(&err_thread_local
, (ERR_STATE
*)state
);
717 int ERR_get_next_error_library(void)
721 if (!RUN_ONCE(&err_string_init
, do_err_strings_init
))
724 CRYPTO_THREAD_write_lock(err_string_lock
);
725 ret
= int_err_library_number
++;
726 CRYPTO_THREAD_unlock(err_string_lock
);
730 static int err_set_error_data_int(char *data
, size_t size
, int flags
,
735 es
= err_get_state_int();
739 err_clear_data(es
, es
->top
, deallocate
);
740 err_set_data(es
, es
->top
, data
, size
, flags
);
745 void ERR_set_error_data(char *data
, int flags
)
748 * This function is void so we cannot propagate the error return. Since it
749 * is also in the public API we can't change the return type.
751 * We estimate the size of the data. If it's not flagged as allocated,
752 * then this is safe, and if it is flagged as allocated, then our size
753 * may be smaller than the actual allocation, but that doesn't matter
754 * too much, the buffer will remain untouched or will eventually be
755 * reallocated to a new size.
757 * callers should be advised that this function takes over ownership of
758 * the allocated memory, i.e. they can't count on the pointer to remain
761 err_set_error_data_int(data
, strlen(data
) + 1, flags
, 1);
764 void ERR_add_error_data(int num
, ...)
768 ERR_add_error_vdata(num
, args
);
772 void ERR_add_error_vdata(int num
, va_list args
)
775 int flags
= ERR_TXT_MALLOCED
| ERR_TXT_STRING
;
779 /* Get the current error data; if an allocated string get it. */
780 es
= err_get_state_int();
786 * If err_data is allocated already, re-use the space.
787 * Otherwise, allocate a small new buffer.
789 if ((es
->err_data_flags
[i
] & flags
) == flags
) {
790 str
= es
->err_data
[i
];
791 size
= es
->err_data_size
[i
];
794 * To protect the string we just grabbed from tampering by other
795 * functions we may call, or to protect them from freeing a pointer
796 * that may no longer be valid at that point, we clear away the
797 * data pointer and the flags. We will set them again at the end
800 es
->err_data
[i
] = NULL
;
801 es
->err_data_flags
[i
] = 0;
802 } else if ((str
= OPENSSL_malloc(size
= 81)) == NULL
) {
810 arg
= va_arg(args
, char *);
818 p
= OPENSSL_realloc(str
, size
);
825 OPENSSL_strlcat(str
, arg
, (size_t)size
);
827 if (!err_set_error_data_int(str
, size
, flags
, 0))
831 int ERR_set_mark(void)
835 es
= err_get_state_int();
839 if (es
->bottom
== es
->top
)
841 es
->err_flags
[es
->top
] |= ERR_FLAG_MARK
;
845 int ERR_pop_to_mark(void)
849 es
= err_get_state_int();
853 while (es
->bottom
!= es
->top
854 && (es
->err_flags
[es
->top
] & ERR_FLAG_MARK
) == 0) {
855 err_clear(es
, es
->top
, 0);
856 es
->top
= es
->top
> 0 ? es
->top
- 1 : ERR_NUM_ERRORS
- 1;
859 if (es
->bottom
== es
->top
)
861 es
->err_flags
[es
->top
] &= ~ERR_FLAG_MARK
;
865 int ERR_clear_last_mark(void)
870 es
= err_get_state_int();
875 while (es
->bottom
!= top
876 && (es
->err_flags
[top
] & ERR_FLAG_MARK
) == 0) {
877 top
= top
> 0 ? top
- 1 : ERR_NUM_ERRORS
- 1;
880 if (es
->bottom
== top
)
882 es
->err_flags
[top
] &= ~ERR_FLAG_MARK
;
886 void err_clear_last_constant_time(int clear
)
891 es
= err_get_state_int();
898 * Flag error as cleared but remove it elsewhere to avoid two errors
899 * accessing the same error stack location, revealing timing information.
901 clear
= constant_time_select_int(constant_time_eq_int(clear
, 0),
903 es
->err_flags
[top
] |= clear
;