lib/hx509/error.c

   1 /*
   2  * Copyright (c) 2006 - 2007 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  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.
  16  *
  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.
  20  *
  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
  31  * SUCH DAMAGE.
  32  */
  33
  34 #include "hx_locl.h"
  35
  36 /**
  37  * @page page_error Hx509 error reporting functions
  38  *
  39  * See the library functions here: @ref hx509_error
  40  */
  41
  42 struct hx509_error_data {
  43     hx509_error next;
  44     int code;
  45     char *msg;
  46 };
  47
  48 static void
  49 free_error_string(hx509_error msg)
  50 {
  51     while(msg) {
  52         hx509_error m2 = msg->next;
  53         free(msg->msg);
  54         free(msg);
  55         msg = m2;
  56     }
  57 }
  58
  59 /**
  60  * Resets the error strings the hx509 context.
  61  *
  62  * @param context A hx509 context.
  63  *
  64  * @ingroup hx509_error
  65  */
  66
  67 void
  68 hx509_clear_error_string(hx509_context context)
  69 {
  70     if (context) {
  71         free_error_string(context->error);
  72         context->error = NULL;
  73     }
  74 }
  75
  76 /**
  77  * Add an error message to the hx509 context.
  78  *
  79  * @param context A hx509 context.
  80  * @param flags
  81  * - HX509_ERROR_APPEND appends the error string to the old messages
  82      (code is updated).
  83  * @param code error code related to error message
  84  * @param fmt error message format
  85  * @param ap arguments to error message format
  86  *
  87  * @ingroup hx509_error
  88  */
  89
  90 void
  91 hx509_set_error_stringv(hx509_context context, int flags, int code,
  92                         const char *fmt, va_list ap)
  93 {
  94     hx509_error msg;
  95
  96     if (context == NULL)
  97         return;
  98
  99     msg = calloc(1, sizeof(*msg));
 100     if (msg == NULL) {
 101         hx509_clear_error_string(context);
 102         return;
 103     }
 104
 105     if (vasprintf(&msg->msg, fmt, ap) == -1) {
 106         hx509_clear_error_string(context);
 107         free(msg);
 108         return;
 109     }
 110     msg->code = code;
 111
 112     if (flags & HX509_ERROR_APPEND) {
 113         msg->next = context->error;
 114         context->error = msg;
 115     } else  {
 116         free_error_string(context->error);
 117         context->error = msg;
 118     }
 119 }
 120
 121 /**
 122  * See hx509_set_error_stringv().
 123  *
 124  * @param context A hx509 context.
 125  * @param flags
 126  * - HX509_ERROR_APPEND appends the error string to the old messages
 127      (code is updated).
 128  * @param code error code related to error message
 129  * @param fmt error message format
 130  * @param ... arguments to error message format
 131  *
 132  * @ingroup hx509_error
 133  */
 134
 135 void
 136 hx509_set_error_string(hx509_context context, int flags, int code,
 137                        const char *fmt, ...)
 138 {
 139     va_list ap;
 140
 141     va_start(ap, fmt);
 142     hx509_set_error_stringv(context, flags, code, fmt, ap);
 143     va_end(ap);
 144 }
 145
 146 /**
 147  * Get an error string from context associated with error_code.
 148  *
 149  * @param context A hx509 context.
 150  * @param error_code Get error message for this error code.
 151  *
 152  * @return error string, free with hx509_free_error_string().
 153  *
 154  * @ingroup hx509_error
 155  */
 156
 157 char *
 158 hx509_get_error_string(hx509_context context, int error_code)
 159 {
 160     struct rk_strpool *p = NULL;
 161     hx509_error msg = context->error;
 162
 163     if (msg == NULL || msg->code != error_code) {
 164         const char *cstr;
 165         char *str;
 166
 167         cstr = com_right(context->et_list, error_code);
 168         if (cstr)
 169             return strdup(cstr);
 170         cstr = strerror(error_code);
 171         if (cstr)
 172             return strdup(cstr);
 173         if (asprintf(&str, "<unknown error: %d>", error_code) == -1)
 174             return NULL;
 175         return str;
 176     }
 177
 178     for (msg = context->error; msg; msg = msg->next)
 179         p = rk_strpoolprintf(p, "%s%s", msg->msg,
 180                              msg->next != NULL ? "; " : "");
 181
 182     return rk_strpoolcollect(p);
 183 }
 184
 185 /**
 186  * Free error string returned by hx509_get_error_string().
 187  *
 188  * @param str error string to free.
 189  *
 190  * @ingroup hx509_error
 191  */
 192
 193 void
 194 hx509_free_error_string(char *str)
 195 {
 196     free(str);
 197 }
 198
 199 /**
 200  * Print error message and fatally exit from error code
 201  *
 202  * @param context A hx509 context.
 203  * @param exit_code exit() code from process.
 204  * @param error_code Error code for the reason to exit.
 205  * @param fmt format string with the exit message.
 206  * @param ... argument to format string.
 207  *
 208  * @ingroup hx509_error
 209  */
 210
 211 void
 212 hx509_err(hx509_context context, int exit_code,
 213           int error_code, const char *fmt, ...)
 214 {
 215     va_list ap;
 216     const char *msg;
 217     char *str;
 218
 219     va_start(ap, fmt);
 220     vasprintf(&str, fmt, ap);
 221     va_end(ap);
 222     msg = hx509_get_error_string(context, error_code);
 223     if (msg == NULL)
 224         msg = "no error";
 225
 226     errx(exit_code, "%s: %s", str, msg);
 227 }