1ERR_PUT_ERROR(3ossl) OpenSSL ERR_PUT_ERROR(3ossl)
2
6 ERR_raise, ERR_raise_data, ERR_put_error, ERR_add_error_data,
7 ERR_add_error_vdata, ERR_add_error_txt, ERR_add_error_mem_bio - record
8 an error
9
11 #include <openssl/err.h>
12 void ERR_raise(int lib, int reason);
14 void ERR_raise_data(int lib, int reason, const char *fmt, ...);
15 void ERR_add_error_data(int num, ...);
17 void ERR_add_error_vdata(int num, va_list arg);
18 void ERR_add_error_txt(const char *sep, const char *txt);
19 void ERR_add_error_mem_bio(const char *sep, BIO *bio);
20 The following function has been deprecated since OpenSSL 3.0, and can
22 be hidden entirely by defining OPENSSL_API_COMPAT with a suitable
23 version value, see openssl_user_macros(7):
24 void ERR_put_error(int lib, int func, int reason, const char *file, int line);
26
28 ERR_raise() adds a new error to the thread's error queue. The error
29 occurred in the library lib for the reason given by the reason code.
30 Furthermore, the name of the file, the line, and name of the function
31 where the error occurred is saved with the error record.
32 ERR_raise_data() does the same thing as ERR_raise(), but also lets the
34 caller specify additional information as a format string fmt and an
35 arbitrary number of values, which are processed with BIO_snprintf(3).
36 ERR_put_error() adds an error code to the thread's error queue. It
38 signals that the error of reason code reason occurred in function func
39 of library lib, in line number line of file. This function is usually
40 called by a macro.
41 ERR_add_error_data() associates the concatenation of its num string
43 arguments as additional data with the error code added last.
44 ERR_add_error_vdata() is similar except the argument is a va_list.
45 Multiple calls to these functions append to the current top of the
46 error queue. The total length of the string data per error is limited
47 to 4096 characters.
48 ERR_add_error_txt() appends the given text string as additional data to
50 the last error queue entry, after inserting the optional separator
51 string if it is not NULL and the top error entry does not yet have
52 additional data. In case the separator is at the end of the text it is
53 not appended to the data. The sep argument may be for instance "\n" to
54 insert a line break when needed. If the associated data would become
55 more than 4096 characters long (which is the limit given above) it is
56 split over sufficiently many new copies of the last error queue entry.
57 ERR_add_error_mem_bio() is the same as ERR_add_error_txt() except that
59 the text string is taken from the given memory BIO. It appends '\0' to
60 the BIO contents if not already NUL-terminated.
61 ERR_load_strings(3) can be used to register error strings so that the
63 application can a generate human-readable error messages for the error
64 code.
65 Reporting errors
67 OpenSSL library reports
68 Each OpenSSL sub-library has library code ERR_LIB_XXX and has its own
70 set of reason codes XXX_R_.... These are both passed in combination to
71 ERR_raise() and ERR_raise_data(), and the combination ultimately
72 produces the correct error text for the reported error.
73 All these macros and the numbers they have as values are specific to
75 OpenSSL's libraries. OpenSSL reason codes normally consist of textual
76 error descriptions. For example, the function ssl3_read_bytes() reports
77 a "handshake failure" as follows:
78 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_HANDSHAKE_FAILURE);
80 There are two exceptions:
82 ERR_LIB_SYS
84 This "library code" indicates that a system error is being
85 reported. In this case, the reason code given to ERR_raise() and
86 ERR_raise_data() must be errno(3).
87 ERR_raise(ERR_LIB_SYS, errno);
89 ERR_R_XXX
91 This set of error codes is considered global, and may be used in
92 combination with any sub-library code.
93 ERR_raise(ERR_LIB_RSA, ERR_R_PASSED_INVALID_ARGUMENT);
95 Other pieces of software
97 Other pieces of software that may want to use OpenSSL's error reporting
99 system, such as engines or applications, must normally get their own
100 numbers.
101 • To get a "library" code, call ERR_get_next_error_library(3); this
103 gives the calling code a dynamic number, usable for the duration of
104 the process.
105 • Reason codes for each such "library" are determined or generated by
107 the authors of that code. They must be numbers in the range 1 to
108 524287 (in other words, they must be nonzero unsigned 18 bit
109 integers).
110 The exceptions mentioned in "OpenSSL library reports" above are valid
112 for other pieces of software, i.e. they may use ERR_LIB_SYS to report
113 system errors:
114 ERR_raise(ERR_LIB_SYS, errno);
116 ... and they may use ERR_R_XXX macros together with their own "library"
118 code.
119 int app_lib_code = ERR_get_next_error_library();
121 /* ... */
123 ERR_raise(app_lib_code, ERR_R_PASSED_INVALID_ARGUMENT);
125
127 ERR_raise(), ERR_raise_data(), ERR_put_error(), ERR_add_error_data(),
128 ERR_add_error_vdata() ERR_add_error_txt(), and ERR_add_error_mem_bio()
129 return no values.
130
132 ERR_raise(), ERR_raise() and ERR_put_error() are implemented as macros.
133
135 ERR_load_strings(3), ERR_get_next_error_library(3)
136
138 ERR_raise, ERR_raise_data, ERR_add_error_txt() and
139 ERR_add_error_mem_bio() were added in OpenSSL 3.0.
140
142 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
143 Licensed under the Apache License 2.0 (the "License"). You may not use
145 this file except in compliance with the License. You can obtain a copy
146 in the file LICENSE in the source distribution or at
147 <https://www.openssl.org/source/license.html>.
1483.0.9 2023-07-27 ERR_PUT_ERROR(3ossl)