1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
|
/*
* Copyright (c) 2001, 2003, 2005 - 2006 Kungliga Tekniska Högskolan
* (Royal Institute of Technology, Stockholm, Sweden).
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the Institute nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include "krb5_locl.h"
#undef __attribute__
#define __attribute__(x)
/**
* Clears the error message from the Kerberos 5 context.
*
* @param context The Kerberos 5 context to clear
*
* @ingroup krb5_error
*/
KRB5_LIB_FUNCTION void KRB5_LIB_CALL
krb5_clear_error_message(krb5_context context)
{
HEIMDAL_MUTEX_lock(&context->mutex);
if (context->error_string)
free(context->error_string);
context->error_code = 0;
context->error_string = NULL;
HEIMDAL_MUTEX_unlock(&context->mutex);
}
/**
* Set the context full error string for a specific error code.
* The error that is stored should be internationalized.
*
* The if context is NULL, no error string is stored.
*
* @param context Kerberos 5 context
* @param ret The error code
* @param fmt Error string for the error code
* @param ... printf(3) style parameters.
*
* @ingroup krb5_error
*/
KRB5_LIB_FUNCTION void KRB5_LIB_CALL
krb5_set_error_message(krb5_context context, krb5_error_code ret,
const char *fmt, ...)
__attribute__ ((format (printf, 3, 4)))
{
va_list ap;
va_start(ap, fmt);
krb5_vset_error_message (context, ret, fmt, ap);
va_end(ap);
}
/**
* Set the context full error string for a specific error code.
*
* The if context is NULL, no error string is stored.
*
* @param context Kerberos 5 context
* @param ret The error code
* @param fmt Error string for the error code
* @param args printf(3) style parameters.
*
* @ingroup krb5_error
*/
KRB5_LIB_FUNCTION void KRB5_LIB_CALL
krb5_vset_error_message (krb5_context context, krb5_error_code ret,
const char *fmt, va_list args)
__attribute__ ((format (printf, 3, 0)))
{
int r;
if (context == NULL)
return;
HEIMDAL_MUTEX_lock(&context->mutex);
if (context->error_string) {
free(context->error_string);
context->error_string = NULL;
}
context->error_code = ret;
r = vasprintf(&context->error_string, fmt, args);
if (r < 0)
context->error_string = NULL;
HEIMDAL_MUTEX_unlock(&context->mutex);
if (context->error_string)
_krb5_debug(context, 100, "error message: %s: %d", context->error_string, ret);
}
/**
* Prepend the context full error string for a specific error code.
* The error that is stored should be internationalized.
*
* The if context is NULL, no error string is stored.
*
* @param context Kerberos 5 context
* @param ret The error code
* @param fmt Error string for the error code
* @param ... printf(3) style parameters.
*
* @ingroup krb5_error
*/
KRB5_LIB_FUNCTION void KRB5_LIB_CALL
krb5_prepend_error_message(krb5_context context, krb5_error_code ret,
const char *fmt, ...)
__attribute__ ((format (printf, 3, 4)))
{
va_list ap;
va_start(ap, fmt);
krb5_vprepend_error_message(context, ret, fmt, ap);
va_end(ap);
}
/**
* Prepend the contexts's full error string for a specific error code.
*
* The if context is NULL, no error string is stored.
*
* @param context Kerberos 5 context
* @param ret The error code
* @param fmt Error string for the error code
* @param args printf(3) style parameters.
*
* @ingroup krb5_error
*/
KRB5_LIB_FUNCTION void KRB5_LIB_CALL
krb5_vprepend_error_message(krb5_context context, krb5_error_code ret,
const char *fmt, va_list args)
__attribute__ ((format (printf, 3, 0)))
{
char *str = NULL, *str2 = NULL;
if (context == NULL)
return;
HEIMDAL_MUTEX_lock(&context->mutex);
if (context->error_code != ret) {
HEIMDAL_MUTEX_unlock(&context->mutex);
return;
}
if (vasprintf(&str, fmt, args) < 0 || str == NULL) {
HEIMDAL_MUTEX_unlock(&context->mutex);
return;
}
if (context->error_string) {
int e;
e = asprintf(&str2, "%s: %s", str, context->error_string);
free(context->error_string);
if (e < 0 || str2 == NULL)
context->error_string = NULL;
else
context->error_string = str2;
free(str);
} else
context->error_string = str;
HEIMDAL_MUTEX_unlock(&context->mutex);
}
/**
* Return the error message for `code' in context. On memory
* allocation error the function returns NULL.
*
* @param context Kerberos 5 context
* @param code Error code related to the error
*
* @return an error string, needs to be freed with
* krb5_free_error_message(). The functions return NULL on error.
*
* @ingroup krb5_error
*/
KRB5_LIB_FUNCTION const char * KRB5_LIB_CALL
krb5_get_error_message(krb5_context context, krb5_error_code code)
{
char *str = NULL;
const char *cstr = NULL;
char buf[128];
int free_context = 0;
if (code == 0)
return strdup("Success");
/*
* The MIT version of this function ignores the krb5_context
* and several widely deployed applications call krb5_get_error_message()
* with a NULL context in order to translate an error code as a
* replacement for error_message(). Another reason a NULL context
* might be provided is if the krb5_init_context() call itself
* failed.
*/
if (context)
{
HEIMDAL_MUTEX_lock(&context->mutex);
if (context->error_string &&
(code == context->error_code || context->error_code == 0))
{
str = strdup(context->error_string);
}
HEIMDAL_MUTEX_unlock(&context->mutex);
if (str)
return str;
}
else
{
if (krb5_init_context(&context) == 0)
free_context = 1;
}
if (context)
cstr = com_right_r(context->et_list, code, buf, sizeof(buf));
if (free_context)
krb5_free_context(context);
if (cstr)
return strdup(cstr);
cstr = error_message(code);
if (cstr)
return strdup(cstr);
if (asprintf(&str, "<unknown error: %d>", (int)code) == -1 || str == NULL)
return NULL;
return str;
}
/**
* Free the error message returned by krb5_get_error_message().
*
* @param context Kerberos context
* @param msg error message to free, returned byg
* krb5_get_error_message().
*
* @ingroup krb5_error
*/
KRB5_LIB_FUNCTION void KRB5_LIB_CALL
krb5_free_error_message(krb5_context context, const char *msg)
{
free(rk_UNCONST(msg));
}
/**
* Return the error string for the error code. The caller must not
* free the string.
*
* This function is deprecated since its not threadsafe.
*
* @param context Kerberos 5 context.
* @param code Kerberos error code.
*
* @return the error message matching code
*
* @ingroup krb5
*/
KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL
krb5_get_err_text(krb5_context context, krb5_error_code code)
KRB5_DEPRECATED_FUNCTION("Use krb5_get_error_message instead")
{
const char *p = NULL;
if(context != NULL)
p = com_right(context->et_list, code);
if(p == NULL)
p = strerror(code);
if (p == NULL)
p = "Unknown error";
return p;
}
|