2 * Copyright (c) 2006 - 2007 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * @page page_error Hx509 error reporting functions
39 * See the library functions here: @ref hx509_error
42 struct hx509_error_data {
49 * Resets the error strings the hx509 context.
51 * @param context A hx509 context.
53 * @ingroup hx509_error
56 HX509_LIB_FUNCTION void HX509_LIB_CALL
57 hx509_clear_error_string(hx509_context context)
60 heim_release(context->error);
61 context->error = NULL;
66 * Add an error message to the hx509 context.
68 * @param context A hx509 context.
70 * - HX509_ERROR_APPEND appends the error string to the old messages
72 * @param code error code related to error message
73 * @param fmt error message format
74 * @param ap arguments to error message format
76 * @ingroup hx509_error
79 HX509_LIB_FUNCTION void HX509_LIB_CALL
80 hx509_set_error_stringv(hx509_context context, int flags, int code,
81 const char *fmt, va_list ap)
88 msg = heim_error_createv(code, fmt, ap);
90 if (flags & HX509_ERROR_APPEND)
91 heim_error_append(msg, context->error);
92 heim_release(context->error);
98 * See hx509_set_error_stringv().
100 * @param context A hx509 context.
102 * - HX509_ERROR_APPEND appends the error string to the old messages
104 * @param code error code related to error message
105 * @param fmt error message format
106 * @param ... arguments to error message format
108 * @ingroup hx509_error
111 HX509_LIB_FUNCTION void HX509_LIB_CALL
112 hx509_set_error_string(hx509_context context, int flags, int code,
113 const char *fmt, ...)
118 hx509_set_error_stringv(context, flags, code, fmt, ap);
123 * Sets ENOMEM as the error on a hx509 context.
125 * @param context A hx509 context.
127 * @ingroup hx509_error
130 HX509_LIB_FUNCTION int HX509_LIB_CALL
131 hx509_enomem(hx509_context context)
133 return heim_enomem(context->hcontext);
137 * Get an error string from context associated with error_code.
139 * @param context A hx509 context.
140 * @param error_code Get error message for this error code.
142 * @return error string, free with hx509_free_error_string().
144 * @ingroup hx509_error
147 HX509_LIB_FUNCTION char * HX509_LIB_CALL
148 hx509_get_error_string(hx509_context context, int error_code)
154 if (context == NULL) {
155 const char *sys_err_msg;
157 /* This case should only happen on hx509_context_init() failure */
158 if ((sys_err_msg = strerror(error_code))) {
159 if (asprintf(&str, "hx509_context_init system error: %s (%d)",
160 sys_err_msg, error_code) == -1)
164 if (asprintf(&str, "hx509_context_init unknown error: %d",
170 msg = context->error;
171 if (msg == NULL || heim_error_get_code(msg) != error_code) {
174 cstr = com_right(context->et_list, error_code);
177 cstr = strerror(error_code);
180 if (asprintf(&str, "<unknown error: %d>", error_code) == -1)
185 s = heim_error_copy_string(msg);
187 const char *cstr = heim_string_get_utf8(s);
196 * Free error string returned by hx509_get_error_string().
198 * @param str error string to free.
200 * @ingroup hx509_error
203 HX509_LIB_FUNCTION void HX509_LIB_CALL
204 hx509_free_error_string(char *str)
210 * Print error message and fatally exit from error code
212 * @param context A hx509 context.
213 * @param exit_code exit() code from process.
214 * @param error_code Error code for the reason to exit.
215 * @param fmt format string with the exit message.
216 * @param ... argument to format string.
218 * @ingroup hx509_error
221 HX509_LIB_FUNCTION void HX509_LIB_CALL
222 hx509_err(hx509_context context, int exit_code,
223 int error_code, const char *fmt, ...)
231 ret = vasprintf(&str, fmt, ap);
233 msg = hx509_get_error_string(context, error_code);
237 errx(exit_code, "%s: %s", ret != -1 ? str : "ENOMEM", msg);