crypto/dist/heimdal/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 __RCSID("$Heimdal: error.c 22332 2007-12-17 01:03:22Z lha $"
  36         "$NetBSD$");
  37
  38 /**
  39  * @page page_error Hx509 error reporting functions
  40  *
  41  * See the library functions here: @ref hx509_error
  42  */
  43
  44 struct hx509_error_data {
  45     hx509_error next;
  46     int code;
  47     char *msg;
  48 };
  49
  50 static void
  51 free_error_string(hx509_error msg)
  52 {
  53     while(msg) {
  54         hx509_error m2 = msg->next;
  55         free(msg->msg);
  56         free(msg);
  57         msg = m2;
  58     }
  59 }
  60
  61 /**
  62  * Resets the error strings the hx509 context.
  63  *
  64  * @param context A hx509 context.
  65  *
  66  * @ingroup hx509_error
  67  */
  68
  69 void
  70 hx509_clear_error_string(hx509_context context)
  71 {
  72     free_error_string(context->error);
  73     context->error = NULL;
  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     msg = calloc(1, sizeof(*msg));
  97     if (msg == NULL) {
  98         hx509_clear_error_string(context);
  99         return;
 100     }
 101
 102     if (vasprintf(&msg->msg, fmt, ap) == -1) {
 103         hx509_clear_error_string(context);
 104         free(msg);
 105         return;
 106     }
 107     msg->code = code;
 108
 109     if (flags & HX509_ERROR_APPEND) {
 110         msg->next = context->error;
 111         context->error = msg;
 112     } else  {
 113         free_error_string(context->error);
 114         context->error = msg;
 115     }
 116 }
 117
 118 /**
 119  * See hx509_set_error_stringv().
 120  *
 121  * @param context A hx509 context.
 122  * @param flags
 123  * - HX509_ERROR_APPEND appends the error string to the old messages
 124      (code is updated).
 125  * @param code error code related to error message
 126  * @param fmt error message format
 127  * @param ... arguments to error message format
 128  *
 129  * @ingroup hx509_error
 130  */
 131
 132 void
 133 hx509_set_error_string(hx509_context context, int flags, int code,
 134                        const char *fmt, ...)
 135 {
 136     va_list ap;
 137
 138     va_start(ap, fmt);
 139     hx509_set_error_stringv(context, flags, code, fmt, ap);
 140     va_end(ap);
 141 }
 142
 143 /**
 144  * Get an error string from context associated with error_code.
 145  *
 146  * @param context A hx509 context.
 147  * @param error_code Get error message for this error code.
 148  *
 149  * @return error string, free with hx509_free_error_string().
 150  *
 151  * @ingroup hx509_error
 152  */
 153
 154 char *
 155 hx509_get_error_string(hx509_context context, int error_code)
 156 {
 157     struct rk_strpool *p = NULL;
 158     hx509_error msg = context->error;
 159
 160     if (msg == NULL || msg->code != error_code) {
 161         const char *cstr;
 162         char *str;
 163
 164         cstr = com_right(context->et_list, error_code);
 165         if (cstr)
 166             return strdup(cstr);
 167         cstr = strerror(error_code);
 168         if (cstr)
 169             return strdup(cstr);
 170         if (asprintf(&str, "<unknown error: %d>", error_code) == -1)
 171             return NULL;
 172         return str;
 173     }
 174
 175     for (msg = context->error; msg; msg = msg->next)
 176         p = rk_strpoolprintf(p, "%s%s", msg->msg,
 177                              msg->next != NULL ? "; " : "");
 178
 179     return rk_strpoolcollect(p);
 180 }
 181
 182 /**
 183  * Free error string returned by hx509_get_error_string().
 184  *
 185  * @param str error string to free.
 186  *
 187  * @ingroup hx509_error
 188  */
 189
 190 void
 191 hx509_free_error_string(char *str)
 192 {
 193     free(str);
 194 }
 195
 196 /**
 197  * Print error message and fatally exit from error code
 198  *
 199  * @param context A hx509 context.
 200  * @param exit_code exit() code from process.
 201  * @param error_code Error code for the reason to exit.
 202  * @param fmt format string with the exit message.
 203  * @param ... argument to format string.
 204  *
 205  * @ingroup hx509_error
 206  */
 207
 208 void
 209 hx509_err(hx509_context context, int exit_code,
 210           int error_code, const char *fmt, ...)
 211 {
 212     va_list ap;
 213     const char *msg;
 214     char *str;
 215
 216     va_start(ap, fmt);
 217     vasprintf(&str, fmt, ap);
 218     va_end(ap);
 219     msg = hx509_get_error_string(context, error_code);
 220     if (msg == NULL)
 221         msg = "no error";
 222
 223     errx(exit_code, "%s: %s", str, msg);
 224 }