source/heimdal/lib/krb5/error_string.c

   1 /*
   2  * Copyright (c) 2001, 2003, 2005 - 2006 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 "krb5_locl.h"
  35
  36 RCSID("$Id: error_string.c 23274 2008-06-23 03:25:08Z lha $");
  37
  38 #undef __attribute__
  39 #define __attribute__(X)
  40
  41 void KRB5_LIB_FUNCTION
  42 krb5_clear_error_string(krb5_context context)
  43 {
  44     HEIMDAL_MUTEX_lock(context->mutex);
  45     if (context->error_string)
  46         free(context->error_string);
  47     context->error_code = 0;
  48     context->error_string = NULL;
  49     HEIMDAL_MUTEX_unlock(context->mutex);
  50 }
  51
  52 /**
  53  * Set the context full error string for a specific error code.
  54  *
  55  * @param context Kerberos 5 context
  56  * @param ret The error code
  57  * @param fmt Error string for the error code
  58  * @param ... printf(3) style parameters.
  59  *
  60  * @ingroup krb5_error
  61  */
  62
  63 void KRB5_LIB_FUNCTION
  64 krb5_set_error_message(krb5_context context, krb5_error_code ret,
  65                        const char *fmt, ...)
  66     __attribute__ ((format (printf, 3, 4)))
  67 {
  68     va_list ap;
  69
  70     va_start(ap, fmt);
  71     krb5_vset_error_message (context, ret, fmt, ap);
  72     va_end(ap);
  73 }
  74
  75 /**
  76  * Set the context full error string for a specific error code.
  77  *
  78  * @param context Kerberos 5 context
  79  * @param ret The error code
  80  * @param fmt Error string for the error code
  81  * @param args printf(3) style parameters.
  82  *
  83  * @ingroup krb5_error
  84  */
  85
  86
  87 void KRB5_LIB_FUNCTION
  88 krb5_vset_error_message (krb5_context context, krb5_error_code ret,
  89                          const char *fmt, va_list args)
  90     __attribute__ ((format (printf, 3, 0)))
  91 {
  92
  93     krb5_clear_error_string(context);
  94     HEIMDAL_MUTEX_lock(context->mutex);
  95     context->error_code = ret;
  96     vasprintf(&context->error_string, fmt, args);
  97     HEIMDAL_MUTEX_unlock(context->mutex);
  98 }
  99
 100
 101 /**
 102  * Return the error message in context. On error or no error string,
 103  * the function returns NULL.
 104  *
 105  * @param context Kerberos 5 context
 106  *
 107  * @return an error string, needs to be freed with
 108  * krb5_free_error_message(). The functions return NULL on error.
 109  *
 110  * @ingroup krb5_error
 111  */
 112
 113 char * KRB5_LIB_FUNCTION
 114 krb5_get_error_string(krb5_context context)
 115 {
 116     char *ret = NULL;
 117
 118     HEIMDAL_MUTEX_lock(context->mutex);
 119     if (context->error_string)
 120         ret = strdup(context->error_string);
 121     HEIMDAL_MUTEX_unlock(context->mutex);
 122     return ret;
 123 }
 124
 125 krb5_boolean KRB5_LIB_FUNCTION
 126 krb5_have_error_string(krb5_context context)
 127 {
 128     char *str;
 129     HEIMDAL_MUTEX_lock(context->mutex);
 130     str = context->error_string;
 131     HEIMDAL_MUTEX_unlock(context->mutex);
 132     return str != NULL;
 133 }
 134
 135 /**
 136  * Return the error message for `code' in context. On memory
 137  * allocation error the function returns NULL.
 138  *
 139  * @param context Kerberos 5 context
 140  * @param code Error code related to the error
 141  *
 142  * @return an error string, needs to be freed with
 143  * krb5_free_error_message(). The functions return NULL on error.
 144  *
 145  * @ingroup krb5_error
 146  */
 147
 148 const char * KRB5_LIB_FUNCTION
 149 krb5_get_error_message(krb5_context context, krb5_error_code code)
 150 {
 151     const char *cstr;
 152     char *str;
 153
 154     HEIMDAL_MUTEX_lock(context->mutex);
 155     if (context->error_string &&
 156         (code == context->error_code || context->error_code == 0))
 157     {
 158         str = strdup(context->error_string);
 159         if (str) {
 160             HEIMDAL_MUTEX_unlock(context->mutex);
 161             return str;
 162         }
 163     }
 164     HEIMDAL_MUTEX_unlock(context->mutex);
 165
 166     cstr = krb5_get_err_text(context, code);
 167     if (cstr)
 168         return strdup(cstr);
 169
 170     if (asprintf(&str, "<unknown error: %d>", (int)code) == -1)
 171         return NULL;
 172
 173     return str;
 174 }
 175
 176
 177 /**
 178  * Free the error message returned by krb5_get_error_message().
 179  *
 180  * @param context Kerberos context
 181  * @param msg error message to free, returned byg
 182  *        krb5_get_error_message().
 183  *
 184  * @ingroup krb5_error
 185  */
 186
 187 void KRB5_LIB_FUNCTION
 188 krb5_free_error_message(krb5_context context, const char *msg)
 189 {
 190     free(rk_UNCONST(msg));
 191 }
 192
 193 #ifndef HEIMDAL_SMALLER
 194
 195 /**
 196  * Free the error message returned by krb5_get_error_string(),
 197  * deprecated, use krb5_free_error_message().
 198  *
 199  * @param context Kerberos context
 200  * @param msg error message to free
 201  *
 202  * @ingroup krb5_error
 203  */
 204
 205 void KRB5_LIB_FUNCTION __attribute__((deprecated))
 206 krb5_free_error_string(krb5_context context, char *str)
 207 {
 208     krb5_free_error_message(context, str);
 209 }
 210
 211 krb5_error_code KRB5_LIB_FUNCTION
 212 krb5_set_error_string(krb5_context context, const char *fmt, ...)
 213     __attribute__((format (printf, 2, 3))) __attribute__((deprecated))
 214 {
 215     va_list ap;
 216
 217     va_start(ap, fmt);
 218     krb5_vset_error_message (context, 0, fmt, ap);
 219     va_end(ap);
 220     return 0;
 221 }
 222
 223 krb5_error_code KRB5_LIB_FUNCTION
 224 krb5_vset_error_string(krb5_context context, const char *fmt, va_list args)
 225     __attribute__ ((format (printf, 2, 0))) __attribute__((deprecated))
 226 {
 227     krb5_vset_error_message(context, 0, fmt, args);
 228     return 0;
 229 }
 230
 231 #endif /* !HEIMDAL_SMALLER */