/src/openssl/crypto/err/err.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved. |
3 | | * |
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 |
8 | | */ |
9 | | |
10 | | #define OSSL_FORCE_ERR_STATE |
11 | | |
12 | | #include <stdio.h> |
13 | | #include <stdarg.h> |
14 | | #include <string.h> |
15 | | #include "crypto/cryptlib.h" |
16 | | #include "internal/err.h" |
17 | | #include "crypto/err.h" |
18 | | #include <openssl/err.h> |
19 | | #include <openssl/crypto.h> |
20 | | #include <openssl/buffer.h> |
21 | | #include <openssl/bio.h> |
22 | | #include <openssl/opensslconf.h> |
23 | | #include "internal/thread_once.h" |
24 | | #include "crypto/ctype.h" |
25 | | #include "internal/constant_time.h" |
26 | | #include "internal/e_os.h" |
27 | | #include "err_local.h" |
28 | | |
29 | | /* Forward declaration in case it's not published because of configuration */ |
30 | | ERR_STATE *ERR_get_state(void); |
31 | | |
32 | | #ifndef OPENSSL_NO_ERR |
33 | | static int err_load_strings(const ERR_STRING_DATA *str); |
34 | | #endif |
35 | | |
36 | | static void ERR_STATE_free(ERR_STATE *s); |
37 | | #ifndef OPENSSL_NO_ERR |
38 | | static ERR_STRING_DATA ERR_str_libraries[] = { |
39 | | {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"}, |
40 | | {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"}, |
41 | | {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"}, |
42 | | {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"}, |
43 | | {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"}, |
44 | | {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"}, |
45 | | {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"}, |
46 | | {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"}, |
47 | | {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"}, |
48 | | {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"}, |
49 | | {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"}, |
50 | | {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"}, |
51 | | {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"}, |
52 | | {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"}, |
53 | | {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"}, |
54 | | {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"}, |
55 | | {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"}, |
56 | | {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"}, |
57 | | {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"}, |
58 | | {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"}, |
59 | | {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"}, |
60 | | {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"}, |
61 | | {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"}, |
62 | | {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"}, |
63 | | {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"}, |
64 | | {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"}, |
65 | | {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"}, |
66 | | {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"}, |
67 | | {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"}, |
68 | | {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"}, |
69 | | {ERR_PACK(ERR_LIB_CRMF, 0, 0), "CRMF routines"}, |
70 | | {ERR_PACK(ERR_LIB_CMP, 0, 0), "CMP routines"}, |
71 | | {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"}, |
72 | | {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"}, |
73 | | {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"}, |
74 | | {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"}, |
75 | | {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"}, |
76 | | {ERR_PACK(ERR_LIB_SM2, 0, 0), "SM2 routines"}, |
77 | | {ERR_PACK(ERR_LIB_ESS, 0, 0), "ESS routines"}, |
78 | | {ERR_PACK(ERR_LIB_PROV, 0, 0), "Provider routines"}, |
79 | | {ERR_PACK(ERR_LIB_OSSL_ENCODER, 0, 0), "ENCODER routines"}, |
80 | | {ERR_PACK(ERR_LIB_OSSL_DECODER, 0, 0), "DECODER routines"}, |
81 | | {ERR_PACK(ERR_LIB_HTTP, 0, 0), "HTTP routines"}, |
82 | | {0, NULL}, |
83 | | }; |
84 | | |
85 | | /* |
86 | | * Should make sure that all ERR_R_ reasons defined in include/openssl/err.h.in |
87 | | * are listed. For maintainability, please keep all reasons in the same order. |
88 | | */ |
89 | | static ERR_STRING_DATA ERR_str_reasons[] = { |
90 | | {ERR_R_SYS_LIB, "system lib"}, |
91 | | {ERR_R_BN_LIB, "BN lib"}, |
92 | | {ERR_R_RSA_LIB, "RSA lib"}, |
93 | | {ERR_R_DH_LIB, "DH lib"}, |
94 | | {ERR_R_EVP_LIB, "EVP lib"}, |
95 | | {ERR_R_BUF_LIB, "BUF lib"}, |
96 | | {ERR_R_OBJ_LIB, "OBJ lib"}, |
97 | | {ERR_R_PEM_LIB, "PEM lib"}, |
98 | | {ERR_R_DSA_LIB, "DSA lib"}, |
99 | | {ERR_R_X509_LIB, "X509 lib"}, |
100 | | {ERR_R_ASN1_LIB, "ASN1 lib"}, |
101 | | {ERR_R_CRYPTO_LIB, "CRYPTO lib"}, |
102 | | {ERR_R_EC_LIB, "EC lib"}, |
103 | | {ERR_R_BIO_LIB, "BIO lib"}, |
104 | | {ERR_R_PKCS7_LIB, "PKCS7 lib"}, |
105 | | {ERR_R_X509V3_LIB, "X509V3 lib"}, |
106 | | {ERR_R_ENGINE_LIB, "ENGINE lib"}, |
107 | | {ERR_R_UI_LIB, "UI lib"}, |
108 | | {ERR_R_ECDSA_LIB, "ECDSA lib"}, |
109 | | {ERR_R_OSSL_STORE_LIB, "OSSL_STORE lib"}, |
110 | | {ERR_R_OSSL_DECODER_LIB, "OSSL_DECODER lib"}, |
111 | | |
112 | | {ERR_R_FATAL, "fatal"}, |
113 | | {ERR_R_MALLOC_FAILURE, "malloc failure"}, |
114 | | {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, |
115 | | "called a function you should not call"}, |
116 | | {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"}, |
117 | | {ERR_R_INTERNAL_ERROR, "internal error"}, |
118 | | {ERR_R_DISABLED, "called a function that was disabled at compile-time"}, |
119 | | {ERR_R_INIT_FAIL, "init fail"}, |
120 | | {ERR_R_PASSED_INVALID_ARGUMENT, "passed invalid argument"}, |
121 | | {ERR_R_OPERATION_FAIL, "operation fail"}, |
122 | | {ERR_R_INVALID_PROVIDER_FUNCTIONS, "invalid provider functions"}, |
123 | | {ERR_R_INTERRUPTED_OR_CANCELLED, "interrupted or cancelled"}, |
124 | | {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"}, |
125 | | {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"}, |
126 | | /* |
127 | | * Something is unsupported, exactly what is expressed with additional data |
128 | | */ |
129 | | {ERR_R_UNSUPPORTED, "unsupported"}, |
130 | | /* |
131 | | * A fetch failed for other reasons than the name to be fetched being |
132 | | * unsupported. |
133 | | */ |
134 | | {ERR_R_FETCH_FAILED, "fetch failed"}, |
135 | | {ERR_R_INVALID_PROPERTY_DEFINITION, "invalid property definition"}, |
136 | | {ERR_R_UNABLE_TO_GET_READ_LOCK, "unable to get read lock"}, |
137 | | {ERR_R_UNABLE_TO_GET_WRITE_LOCK, "unable to get write lock"}, |
138 | | {0, NULL}, |
139 | | }; |
140 | | #endif |
141 | | |
142 | | static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT; |
143 | | static int set_err_thread_local; |
144 | | static CRYPTO_THREAD_LOCAL err_thread_local; |
145 | | |
146 | | static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT; |
147 | | static CRYPTO_RWLOCK *err_string_lock = NULL; |
148 | | |
149 | | #ifndef OPENSSL_NO_ERR |
150 | | static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *); |
151 | | #endif |
152 | | |
153 | | /* |
154 | | * The internal state |
155 | | */ |
156 | | |
157 | | #ifndef OPENSSL_NO_ERR |
158 | | static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL; |
159 | | #endif |
160 | | static int int_err_library_number = ERR_LIB_USER; |
161 | | |
162 | | typedef enum ERR_GET_ACTION_e { |
163 | | EV_POP, EV_PEEK, EV_PEEK_LAST |
164 | | } ERR_GET_ACTION; |
165 | | |
166 | | static unsigned long get_error_values(ERR_GET_ACTION g, |
167 | | const char **file, int *line, |
168 | | const char **func, const char **data, |
169 | | int *flags); |
170 | | |
171 | | #ifndef OPENSSL_NO_ERR |
172 | | static unsigned long err_string_data_hash(const ERR_STRING_DATA *a) |
173 | 17.9k | { |
174 | 17.9k | unsigned long ret, l; |
175 | | |
176 | 17.9k | l = a->error; |
177 | 17.9k | ret = l ^ ERR_GET_LIB(l); |
178 | 17.9k | return (ret ^ ret % 19 * 13); |
179 | 17.9k | } |
180 | | |
181 | | static int err_string_data_cmp(const ERR_STRING_DATA *a, |
182 | | const ERR_STRING_DATA *b) |
183 | 15.1k | { |
184 | 15.1k | if (a->error == b->error) |
185 | 14.8k | return 0; |
186 | 308 | return a->error > b->error ? 1 : -1; |
187 | 15.1k | } |
188 | | |
189 | | static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d) |
190 | 9.46k | { |
191 | 9.46k | ERR_STRING_DATA *p = NULL; |
192 | | |
193 | 9.46k | if (!CRYPTO_THREAD_read_lock(err_string_lock)) |
194 | 0 | return NULL; |
195 | 9.46k | p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d); |
196 | 9.46k | CRYPTO_THREAD_unlock(err_string_lock); |
197 | | |
198 | 9.46k | return p; |
199 | 9.46k | } |
200 | | #endif |
201 | | |
202 | | static void ERR_STATE_free(ERR_STATE *state) |
203 | 2 | { |
204 | 2 | int i; |
205 | | |
206 | 2 | if (state == NULL) |
207 | 0 | return; |
208 | 34 | for (i = 0; i < ERR_NUM_ERRORS; i++) { |
209 | 32 | err_clear(state, i, 1); |
210 | 32 | } |
211 | 2 | CRYPTO_free(state, OPENSSL_FILE, OPENSSL_LINE); |
212 | 2 | } |
213 | | |
214 | | DEFINE_RUN_ONCE_STATIC(do_err_strings_init) |
215 | 2 | { |
216 | 2 | if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL)) |
217 | 0 | return 0; |
218 | 2 | err_string_lock = CRYPTO_THREAD_lock_new(); |
219 | 2 | if (err_string_lock == NULL) |
220 | 0 | return 0; |
221 | 2 | #ifndef OPENSSL_NO_ERR |
222 | 2 | int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash, |
223 | 2 | err_string_data_cmp); |
224 | 2 | if (int_error_hash == NULL) { |
225 | 0 | CRYPTO_THREAD_lock_free(err_string_lock); |
226 | 0 | err_string_lock = NULL; |
227 | 0 | return 0; |
228 | 0 | } |
229 | 2 | #endif |
230 | 2 | return 1; |
231 | 2 | } |
232 | | |
233 | | void err_cleanup(void) |
234 | 2 | { |
235 | 2 | if (set_err_thread_local != 0) |
236 | 2 | CRYPTO_THREAD_cleanup_local(&err_thread_local); |
237 | 2 | CRYPTO_THREAD_lock_free(err_string_lock); |
238 | 2 | err_string_lock = NULL; |
239 | 2 | #ifndef OPENSSL_NO_ERR |
240 | 2 | lh_ERR_STRING_DATA_free(int_error_hash); |
241 | 2 | int_error_hash = NULL; |
242 | 2 | #endif |
243 | 2 | } |
244 | | |
245 | | #ifndef OPENSSL_NO_ERR |
246 | | /* |
247 | | * Legacy; pack in the library. |
248 | | */ |
249 | | static void err_patch(int lib, ERR_STRING_DATA *str) |
250 | 0 | { |
251 | 0 | unsigned long plib = ERR_PACK(lib, 0, 0); |
252 | |
|
253 | 0 | for (; str->error != 0; str++) |
254 | 0 | str->error |= plib; |
255 | 0 | } |
256 | | |
257 | | /* |
258 | | * Hash in |str| error strings. Assumes the RUN_ONCE was done. |
259 | | */ |
260 | | static int err_load_strings(const ERR_STRING_DATA *str) |
261 | 208 | { |
262 | 208 | if (!CRYPTO_THREAD_write_lock(err_string_lock)) |
263 | 0 | return 0; |
264 | 8.70k | for (; str->error; str++) |
265 | 8.49k | (void)lh_ERR_STRING_DATA_insert(int_error_hash, |
266 | 208 | (ERR_STRING_DATA *)str); |
267 | 208 | CRYPTO_THREAD_unlock(err_string_lock); |
268 | 208 | return 1; |
269 | 208 | } |
270 | | #endif |
271 | | |
272 | | int ossl_err_load_ERR_strings(void) |
273 | 70 | { |
274 | 70 | #ifndef OPENSSL_NO_ERR |
275 | 70 | if (!RUN_ONCE(&err_string_init, do_err_strings_init)) |
276 | 0 | return 0; |
277 | | |
278 | 70 | err_load_strings(ERR_str_libraries); |
279 | 70 | err_load_strings(ERR_str_reasons); |
280 | 70 | #endif |
281 | 70 | return 1; |
282 | 70 | } |
283 | | |
284 | | int ERR_load_strings(int lib, ERR_STRING_DATA *str) |
285 | 0 | { |
286 | 0 | #ifndef OPENSSL_NO_ERR |
287 | 0 | if (ossl_err_load_ERR_strings() == 0) |
288 | 0 | return 0; |
289 | | |
290 | 0 | err_patch(lib, str); |
291 | 0 | err_load_strings(str); |
292 | 0 | #endif |
293 | |
|
294 | 0 | return 1; |
295 | 0 | } |
296 | | |
297 | | int ERR_load_strings_const(const ERR_STRING_DATA *str) |
298 | 68 | { |
299 | 68 | #ifndef OPENSSL_NO_ERR |
300 | 68 | if (ossl_err_load_ERR_strings() == 0) |
301 | 0 | return 0; |
302 | 68 | err_load_strings(str); |
303 | 68 | #endif |
304 | | |
305 | 68 | return 1; |
306 | 68 | } |
307 | | |
308 | | int ERR_unload_strings(int lib, ERR_STRING_DATA *str) |
309 | 0 | { |
310 | 0 | #ifndef OPENSSL_NO_ERR |
311 | 0 | if (!RUN_ONCE(&err_string_init, do_err_strings_init)) |
312 | 0 | return 0; |
313 | | |
314 | 0 | if (!CRYPTO_THREAD_write_lock(err_string_lock)) |
315 | 0 | return 0; |
316 | | /* |
317 | | * We don't need to ERR_PACK the lib, since that was done (to |
318 | | * the table) when it was loaded. |
319 | | */ |
320 | 0 | for (; str->error; str++) |
321 | 0 | (void)lh_ERR_STRING_DATA_delete(int_error_hash, str); |
322 | 0 | CRYPTO_THREAD_unlock(err_string_lock); |
323 | 0 | #endif |
324 | |
|
325 | 0 | return 1; |
326 | 0 | } |
327 | | |
328 | | void err_free_strings_int(void) |
329 | 0 | { |
330 | | /* obsolete */ |
331 | 0 | } |
332 | | |
333 | | /********************************************************/ |
334 | | |
335 | | void ERR_clear_error(void) |
336 | 10.3k | { |
337 | 10.3k | int i; |
338 | 10.3k | ERR_STATE *es; |
339 | | |
340 | 10.3k | es = ossl_err_get_state_int(); |
341 | 10.3k | if (es == NULL) |
342 | 0 | return; |
343 | | |
344 | 175k | for (i = 0; i < ERR_NUM_ERRORS; i++) { |
345 | 165k | err_clear(es, i, 0); |
346 | 165k | } |
347 | 10.3k | es->top = es->bottom = 0; |
348 | 10.3k | } |
349 | | |
350 | | unsigned long ERR_get_error(void) |
351 | 0 | { |
352 | 0 | return get_error_values(EV_POP, NULL, NULL, NULL, NULL, NULL); |
353 | 0 | } |
354 | | |
355 | | unsigned long ERR_get_error_all(const char **file, int *line, |
356 | | const char **func, |
357 | | const char **data, int *flags) |
358 | 9.13k | { |
359 | 9.13k | return get_error_values(EV_POP, file, line, func, data, flags); |
360 | 9.13k | } |
361 | | |
362 | | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
363 | | unsigned long ERR_get_error_line(const char **file, int *line) |
364 | 0 | { |
365 | 0 | return get_error_values(EV_POP, file, line, NULL, NULL, NULL); |
366 | 0 | } |
367 | | |
368 | | unsigned long ERR_get_error_line_data(const char **file, int *line, |
369 | | const char **data, int *flags) |
370 | 0 | { |
371 | 0 | return get_error_values(EV_POP, file, line, NULL, data, flags); |
372 | 0 | } |
373 | | #endif |
374 | | |
375 | | unsigned long ERR_peek_error(void) |
376 | 0 | { |
377 | 0 | return get_error_values(EV_PEEK, NULL, NULL, NULL, NULL, NULL); |
378 | 0 | } |
379 | | |
380 | | unsigned long ERR_peek_error_line(const char **file, int *line) |
381 | 0 | { |
382 | 0 | return get_error_values(EV_PEEK, file, line, NULL, NULL, NULL); |
383 | 0 | } |
384 | | |
385 | | unsigned long ERR_peek_error_func(const char **func) |
386 | 0 | { |
387 | 0 | return get_error_values(EV_PEEK, NULL, NULL, func, NULL, NULL); |
388 | 0 | } |
389 | | |
390 | | unsigned long ERR_peek_error_data(const char **data, int *flags) |
391 | 0 | { |
392 | 0 | return get_error_values(EV_PEEK, NULL, NULL, NULL, data, flags); |
393 | 0 | } |
394 | | |
395 | | unsigned long ERR_peek_error_all(const char **file, int *line, |
396 | | const char **func, |
397 | | const char **data, int *flags) |
398 | 0 | { |
399 | 0 | return get_error_values(EV_PEEK, file, line, func, data, flags); |
400 | 0 | } |
401 | | |
402 | | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
403 | | unsigned long ERR_peek_error_line_data(const char **file, int *line, |
404 | | const char **data, int *flags) |
405 | 0 | { |
406 | 0 | return get_error_values(EV_PEEK, file, line, NULL, data, flags); |
407 | 0 | } |
408 | | #endif |
409 | | |
410 | | unsigned long ERR_peek_last_error(void) |
411 | 227k | { |
412 | 227k | return get_error_values(EV_PEEK_LAST, NULL, NULL, NULL, NULL, NULL); |
413 | 227k | } |
414 | | |
415 | | unsigned long ERR_peek_last_error_line(const char **file, int *line) |
416 | 0 | { |
417 | 0 | return get_error_values(EV_PEEK_LAST, file, line, NULL, NULL, NULL); |
418 | 0 | } |
419 | | |
420 | | unsigned long ERR_peek_last_error_func(const char **func) |
421 | 0 | { |
422 | 0 | return get_error_values(EV_PEEK_LAST, NULL, NULL, func, NULL, NULL); |
423 | 0 | } |
424 | | |
425 | | unsigned long ERR_peek_last_error_data(const char **data, int *flags) |
426 | 0 | { |
427 | 0 | return get_error_values(EV_PEEK_LAST, NULL, NULL, NULL, data, flags); |
428 | 0 | } |
429 | | |
430 | | unsigned long ERR_peek_last_error_all(const char **file, int *line, |
431 | | const char **func, |
432 | | const char **data, int *flags) |
433 | 0 | { |
434 | 0 | return get_error_values(EV_PEEK_LAST, file, line, func, data, flags); |
435 | 0 | } |
436 | | |
437 | | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
438 | | unsigned long ERR_peek_last_error_line_data(const char **file, int *line, |
439 | | const char **data, int *flags) |
440 | 0 | { |
441 | 0 | return get_error_values(EV_PEEK_LAST, file, line, NULL, data, flags); |
442 | 0 | } |
443 | | #endif |
444 | | |
445 | | static unsigned long get_error_values(ERR_GET_ACTION g, |
446 | | const char **file, int *line, |
447 | | const char **func, |
448 | | const char **data, int *flags) |
449 | 236k | { |
450 | 236k | int i = 0; |
451 | 236k | ERR_STATE *es; |
452 | 236k | unsigned long ret; |
453 | | |
454 | 236k | es = ossl_err_get_state_int(); |
455 | 236k | if (es == NULL) |
456 | 0 | return 0; |
457 | | |
458 | | /* |
459 | | * Clear anything that should have been cleared earlier. We do this |
460 | | * here because this doesn't have constant-time issues. |
461 | | */ |
462 | 236k | while (es->bottom != es->top) { |
463 | 227k | if (es->err_flags[es->top] & ERR_FLAG_CLEAR) { |
464 | 0 | err_clear(es, es->top, 0); |
465 | 0 | es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1; |
466 | 0 | continue; |
467 | 0 | } |
468 | 227k | i = (es->bottom + 1) % ERR_NUM_ERRORS; |
469 | 227k | if (es->err_flags[i] & ERR_FLAG_CLEAR) { |
470 | 0 | es->bottom = i; |
471 | 0 | err_clear(es, es->bottom, 0); |
472 | 0 | continue; |
473 | 0 | } |
474 | 227k | break; |
475 | 227k | } |
476 | | |
477 | | /* If everything has been cleared, the stack is empty. */ |
478 | 236k | if (es->bottom == es->top) |
479 | 9.65k | return 0; |
480 | | |
481 | | /* Which error, the top of stack (latest one) or the first one? */ |
482 | 227k | if (g == EV_PEEK_LAST) |
483 | 222k | i = es->top; |
484 | 4.63k | else |
485 | 4.63k | i = (es->bottom + 1) % ERR_NUM_ERRORS; |
486 | | |
487 | 227k | ret = es->err_buffer[i]; |
488 | 227k | if (g == EV_POP) { |
489 | 4.63k | es->bottom = i; |
490 | 4.63k | es->err_buffer[i] = 0; |
491 | 4.63k | } |
492 | | |
493 | 227k | if (file != NULL) { |
494 | 4.63k | *file = es->err_file[i]; |
495 | 4.63k | if (*file == NULL) |
496 | 0 | *file = ""; |
497 | 4.63k | } |
498 | 227k | if (line != NULL) |
499 | 4.63k | *line = es->err_line[i]; |
500 | 227k | if (func != NULL) { |
501 | 4.63k | *func = es->err_func[i]; |
502 | 4.63k | if (*func == NULL) |
503 | 0 | *func = ""; |
504 | 4.63k | } |
505 | 227k | if (flags != NULL) |
506 | 4.63k | *flags = es->err_data_flags[i]; |
507 | 227k | if (data == NULL) { |
508 | 222k | if (g == EV_POP) { |
509 | 0 | err_clear_data(es, i, 0); |
510 | 0 | } |
511 | 222k | } else { |
512 | 4.63k | *data = es->err_data[i]; |
513 | 4.63k | if (*data == NULL) { |
514 | 0 | *data = ""; |
515 | 0 | if (flags != NULL) |
516 | 0 | *flags = 0; |
517 | 0 | } |
518 | 4.63k | } |
519 | 227k | return ret; |
520 | 236k | } |
521 | | |
522 | | void ossl_err_string_int(unsigned long e, const char *func, |
523 | | char *buf, size_t len) |
524 | 4.63k | { |
525 | 4.63k | char lsbuf[64], rsbuf[256]; |
526 | 4.63k | const char *ls, *rs = NULL; |
527 | 4.63k | unsigned long l, r; |
528 | | |
529 | 4.63k | if (len == 0) |
530 | 0 | return; |
531 | | |
532 | 4.63k | l = ERR_GET_LIB(e); |
533 | 4.63k | ls = ERR_lib_error_string(e); |
534 | 4.63k | if (ls == NULL) { |
535 | 0 | BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l); |
536 | 0 | ls = lsbuf; |
537 | 0 | } |
538 | | |
539 | | /* |
540 | | * ERR_reason_error_string() can't safely return system error strings, |
541 | | * since it would call openssl_strerror_r(), which needs a buffer for |
542 | | * thread safety. So for system errors, we call openssl_strerror_r() |
543 | | * directly instead. |
544 | | */ |
545 | 4.63k | r = ERR_GET_REASON(e); |
546 | 4.63k | #ifndef OPENSSL_NO_ERR |
547 | 4.63k | if (ERR_SYSTEM_ERROR(e)) { |
548 | 0 | if (openssl_strerror_r(r, rsbuf, sizeof(rsbuf))) |
549 | 0 | rs = rsbuf; |
550 | 4.63k | } else { |
551 | 4.63k | rs = ERR_reason_error_string(e); |
552 | 4.63k | } |
553 | 4.63k | #endif |
554 | 4.63k | if (rs == NULL) { |
555 | 0 | BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", |
556 | 0 | r & ~(ERR_RFLAGS_MASK << ERR_RFLAGS_OFFSET)); |
557 | 0 | rs = rsbuf; |
558 | 0 | } |
559 | | |
560 | 4.63k | BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, func, rs); |
561 | 4.63k | if (strlen(buf) == len - 1) { |
562 | | /* Didn't fit; use a minimal format. */ |
563 | 0 | BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, 0L, r); |
564 | 0 | } |
565 | 4.63k | } |
566 | | |
567 | | |
568 | | void ERR_error_string_n(unsigned long e, char *buf, size_t len) |
569 | 0 | { |
570 | 0 | ossl_err_string_int(e, "", buf, len); |
571 | 0 | } |
572 | | |
573 | | /* |
574 | | * ERR_error_string_n should be used instead for ret != NULL as |
575 | | * ERR_error_string cannot know how large the buffer is |
576 | | */ |
577 | | char *ERR_error_string(unsigned long e, char *ret) |
578 | 0 | { |
579 | 0 | static char buf[256]; |
580 | |
|
581 | 0 | if (ret == NULL) |
582 | 0 | ret = buf; |
583 | 0 | ERR_error_string_n(e, ret, (int)sizeof(buf)); |
584 | 0 | return ret; |
585 | 0 | } |
586 | | |
587 | | const char *ERR_lib_error_string(unsigned long e) |
588 | 4.63k | { |
589 | 4.63k | #ifndef OPENSSL_NO_ERR |
590 | 4.63k | ERR_STRING_DATA d, *p; |
591 | 4.63k | unsigned long l; |
592 | | |
593 | 4.63k | if (!RUN_ONCE(&err_string_init, do_err_strings_init)) { |
594 | 0 | return NULL; |
595 | 0 | } |
596 | | |
597 | 4.63k | l = ERR_GET_LIB(e); |
598 | 4.63k | d.error = ERR_PACK(l, 0, 0); |
599 | 4.63k | p = int_err_get_item(&d); |
600 | 4.63k | return ((p == NULL) ? NULL : p->string); |
601 | | #else |
602 | | return NULL; |
603 | | #endif |
604 | 4.63k | } |
605 | | |
606 | | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
607 | | const char *ERR_func_error_string(unsigned long e) |
608 | 0 | { |
609 | 0 | return NULL; |
610 | 0 | } |
611 | | #endif |
612 | | |
613 | | const char *ERR_reason_error_string(unsigned long e) |
614 | 4.70k | { |
615 | 4.70k | #ifndef OPENSSL_NO_ERR |
616 | 4.70k | ERR_STRING_DATA d, *p = NULL; |
617 | 4.70k | unsigned long l, r; |
618 | | |
619 | 4.70k | if (!RUN_ONCE(&err_string_init, do_err_strings_init)) { |
620 | 0 | return NULL; |
621 | 0 | } |
622 | | |
623 | | /* |
624 | | * ERR_reason_error_string() can't safely return system error strings, |
625 | | * since openssl_strerror_r() needs a buffer for thread safety, and we |
626 | | * haven't got one that would serve any sensible purpose. |
627 | | */ |
628 | 4.70k | if (ERR_SYSTEM_ERROR(e)) |
629 | 0 | return NULL; |
630 | | |
631 | 4.70k | l = ERR_GET_LIB(e); |
632 | 4.70k | r = ERR_GET_REASON(e); |
633 | 4.70k | d.error = ERR_PACK(l, 0, r); |
634 | 4.70k | p = int_err_get_item(&d); |
635 | 4.70k | if (p == NULL) { |
636 | 129 | d.error = ERR_PACK(0, 0, r); |
637 | 129 | p = int_err_get_item(&d); |
638 | 129 | } |
639 | 4.70k | return ((p == NULL) ? NULL : p->string); |
640 | | #else |
641 | | return NULL; |
642 | | #endif |
643 | 4.70k | } |
644 | | |
645 | | static void err_delete_thread_state(void *unused) |
646 | 2 | { |
647 | 2 | ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local); |
648 | 2 | if (state == NULL) |
649 | 0 | return; |
650 | | |
651 | 2 | CRYPTO_THREAD_set_local(&err_thread_local, NULL); |
652 | 2 | ERR_STATE_free(state); |
653 | 2 | } |
654 | | |
655 | | #ifndef OPENSSL_NO_DEPRECATED_1_1_0 |
656 | | void ERR_remove_thread_state(void *dummy) |
657 | 0 | { |
658 | 0 | } |
659 | | #endif |
660 | | |
661 | | #ifndef OPENSSL_NO_DEPRECATED_1_0_0 |
662 | | void ERR_remove_state(unsigned long pid) |
663 | 0 | { |
664 | 0 | } |
665 | | #endif |
666 | | |
667 | | DEFINE_RUN_ONCE_STATIC(err_do_init) |
668 | 2 | { |
669 | 2 | set_err_thread_local = 1; |
670 | 2 | return CRYPTO_THREAD_init_local(&err_thread_local, NULL); |
671 | 2 | } |
672 | | |
673 | | ERR_STATE *ossl_err_get_state_int(void) |
674 | 2.17M | { |
675 | 2.17M | ERR_STATE *state; |
676 | 2.17M | int saveerrno = get_last_sys_error(); |
677 | | |
678 | 2.17M | if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL)) |
679 | 0 | return NULL; |
680 | | |
681 | 2.17M | if (!RUN_ONCE(&err_init, err_do_init)) |
682 | 0 | return NULL; |
683 | | |
684 | 2.17M | state = CRYPTO_THREAD_get_local(&err_thread_local); |
685 | 2.17M | if (state == (ERR_STATE*)-1) |
686 | 0 | return NULL; |
687 | | |
688 | 2.17M | if (state == NULL) { |
689 | 2 | if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1)) |
690 | 0 | return NULL; |
691 | | |
692 | | /* calling CRYPTO_zalloc(.., NULL, 0) prevents mem alloc error loop */ |
693 | 2 | state = CRYPTO_zalloc(sizeof(*state), NULL, 0); |
694 | 2 | if (state == NULL) { |
695 | 0 | CRYPTO_THREAD_set_local(&err_thread_local, NULL); |
696 | 0 | return NULL; |
697 | 0 | } |
698 | | |
699 | 2 | if (!ossl_init_thread_start(NULL, NULL, err_delete_thread_state) |
700 | 2 | || !CRYPTO_THREAD_set_local(&err_thread_local, state)) { |
701 | 0 | ERR_STATE_free(state); |
702 | 0 | CRYPTO_THREAD_set_local(&err_thread_local, NULL); |
703 | 0 | return NULL; |
704 | 0 | } |
705 | | |
706 | | /* Ignore failures from these */ |
707 | 2 | OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL); |
708 | 2 | } |
709 | | |
710 | 2.17M | set_sys_error(saveerrno); |
711 | 2.17M | return state; |
712 | 2.17M | } |
713 | | |
714 | | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
715 | | ERR_STATE *ERR_get_state(void) |
716 | 0 | { |
717 | 0 | return ossl_err_get_state_int(); |
718 | 0 | } |
719 | | #endif |
720 | | |
721 | | |
722 | | /* |
723 | | * err_shelve_state returns the current thread local error state |
724 | | * and freezes the error module until err_unshelve_state is called. |
725 | | */ |
726 | | int err_shelve_state(void **state) |
727 | 0 | { |
728 | 0 | int saveerrno = get_last_sys_error(); |
729 | | |
730 | | /* |
731 | | * Note, at present our only caller is OPENSSL_init_crypto(), indirectly |
732 | | * via ossl_init_load_crypto_nodelete(), by which point the requested |
733 | | * "base" initialization has already been performed, so the below call is a |
734 | | * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return. |
735 | | * |
736 | | * If are no other valid callers of this function, the call below can be |
737 | | * removed, avoiding the re-entry into OPENSSL_init_crypto(). If there are |
738 | | * potential uses that are not from inside OPENSSL_init_crypto(), then this |
739 | | * call is needed, but some care is required to make sure that the re-entry |
740 | | * remains a NOOP. |
741 | | */ |
742 | 0 | if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL)) |
743 | 0 | return 0; |
744 | | |
745 | 0 | if (!RUN_ONCE(&err_init, err_do_init)) |
746 | 0 | return 0; |
747 | | |
748 | 0 | *state = CRYPTO_THREAD_get_local(&err_thread_local); |
749 | 0 | if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1)) |
750 | 0 | return 0; |
751 | | |
752 | 0 | set_sys_error(saveerrno); |
753 | 0 | return 1; |
754 | 0 | } |
755 | | |
756 | | /* |
757 | | * err_unshelve_state restores the error state that was returned |
758 | | * by err_shelve_state previously. |
759 | | */ |
760 | | void err_unshelve_state(void* state) |
761 | 0 | { |
762 | 0 | if (state != (void*)-1) |
763 | 0 | CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state); |
764 | 0 | } |
765 | | |
766 | | int ERR_get_next_error_library(void) |
767 | 3 | { |
768 | 3 | int ret; |
769 | | |
770 | 3 | if (!RUN_ONCE(&err_string_init, do_err_strings_init)) |
771 | 0 | return 0; |
772 | | |
773 | 3 | if (!CRYPTO_THREAD_write_lock(err_string_lock)) |
774 | 0 | return 0; |
775 | 3 | ret = int_err_library_number++; |
776 | 3 | CRYPTO_THREAD_unlock(err_string_lock); |
777 | 3 | return ret; |
778 | 3 | } |
779 | | |
780 | | static int err_set_error_data_int(char *data, size_t size, int flags, |
781 | | int deallocate) |
782 | 90.7k | { |
783 | 90.7k | ERR_STATE *es; |
784 | | |
785 | 90.7k | es = ossl_err_get_state_int(); |
786 | 90.7k | if (es == NULL) |
787 | 0 | return 0; |
788 | | |
789 | 90.7k | err_clear_data(es, es->top, deallocate); |
790 | 90.7k | err_set_data(es, es->top, data, size, flags); |
791 | | |
792 | 90.7k | return 1; |
793 | 90.7k | } |
794 | | |
795 | | void ERR_set_error_data(char *data, int flags) |
796 | 0 | { |
797 | | /* |
798 | | * This function is void so we cannot propagate the error return. Since it |
799 | | * is also in the public API we can't change the return type. |
800 | | * |
801 | | * We estimate the size of the data. If it's not flagged as allocated, |
802 | | * then this is safe, and if it is flagged as allocated, then our size |
803 | | * may be smaller than the actual allocation, but that doesn't matter |
804 | | * too much, the buffer will remain untouched or will eventually be |
805 | | * reallocated to a new size. |
806 | | * |
807 | | * callers should be advised that this function takes over ownership of |
808 | | * the allocated memory, i.e. they can't count on the pointer to remain |
809 | | * valid. |
810 | | */ |
811 | 0 | err_set_error_data_int(data, strlen(data) + 1, flags, 1); |
812 | 0 | } |
813 | | |
814 | | void ERR_add_error_data(int num, ...) |
815 | 90.7k | { |
816 | 90.7k | va_list args; |
817 | 90.7k | va_start(args, num); |
818 | 90.7k | ERR_add_error_vdata(num, args); |
819 | 90.7k | va_end(args); |
820 | 90.7k | } |
821 | | |
822 | | void ERR_add_error_vdata(int num, va_list args) |
823 | 90.7k | { |
824 | 90.7k | int i, len, size; |
825 | 90.7k | int flags = ERR_TXT_MALLOCED | ERR_TXT_STRING; |
826 | 90.7k | char *str, *arg; |
827 | 90.7k | ERR_STATE *es; |
828 | | |
829 | | /* Get the current error data; if an allocated string get it. */ |
830 | 90.7k | es = ossl_err_get_state_int(); |
831 | 90.7k | if (es == NULL) |
832 | 0 | return; |
833 | 90.7k | i = es->top; |
834 | | |
835 | | /* |
836 | | * If err_data is allocated already, re-use the space. |
837 | | * Otherwise, allocate a small new buffer. |
838 | | */ |
839 | 90.7k | if ((es->err_data_flags[i] & flags) == flags) { |
840 | 0 | str = es->err_data[i]; |
841 | 0 | size = es->err_data_size[i]; |
842 | | |
843 | | /* |
844 | | * To protect the string we just grabbed from tampering by other |
845 | | * functions we may call, or to protect them from freeing a pointer |
846 | | * that may no longer be valid at that point, we clear away the |
847 | | * data pointer and the flags. We will set them again at the end |
848 | | * of this function. |
849 | | */ |
850 | 0 | es->err_data[i] = NULL; |
851 | 0 | es->err_data_flags[i] = 0; |
852 | 90.7k | } else if ((str = OPENSSL_malloc(size = 81)) == NULL) { |
853 | 0 | return; |
854 | 90.7k | } else { |
855 | 90.7k | str[0] = '\0'; |
856 | 90.7k | } |
857 | 90.7k | len = strlen(str); |
858 | | |
859 | 411k | while (--num >= 0) { |
860 | 320k | arg = va_arg(args, char *); |
861 | 320k | if (arg == NULL) |
862 | 0 | arg = "<NULL>"; |
863 | 320k | len += strlen(arg); |
864 | 320k | if (len >= size) { |
865 | 0 | char *p; |
866 | |
|
867 | 0 | size = len + 20; |
868 | 0 | p = OPENSSL_realloc(str, size); |
869 | 0 | if (p == NULL) { |
870 | 0 | OPENSSL_free(str); |
871 | 0 | return; |
872 | 0 | } |
873 | 0 | str = p; |
874 | 0 | } |
875 | 320k | OPENSSL_strlcat(str, arg, (size_t)size); |
876 | 320k | } |
877 | 90.7k | if (!err_set_error_data_int(str, size, flags, 0)) |
878 | 0 | OPENSSL_free(str); |
879 | 90.7k | } |
880 | | |
881 | | void err_clear_last_constant_time(int clear) |
882 | 0 | { |
883 | 0 | ERR_STATE *es; |
884 | 0 | int top; |
885 | |
|
886 | 0 | es = ossl_err_get_state_int(); |
887 | 0 | if (es == NULL) |
888 | 0 | return; |
889 | | |
890 | 0 | top = es->top; |
891 | | |
892 | | /* |
893 | | * Flag error as cleared but remove it elsewhere to avoid two errors |
894 | | * accessing the same error stack location, revealing timing information. |
895 | | */ |
896 | 0 | clear = constant_time_select_int(constant_time_eq_int(clear, 0), |
897 | 0 | 0, ERR_FLAG_CLEAR); |
898 | 0 | es->err_flags[top] |= clear; |
899 | 0 | } |