error_string.c revision 178825 
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
36RCSID("$Id: error_string.c 22142 2007-12-04 16:56:02Z lha $");
37
38#undef __attribute__
39#define __attribute__(X)
40
41void KRB5_LIB_FUNCTION
42krb5_free_error_string(krb5_context context, char *str)
43{
44    HEIMDAL_MUTEX_lock(context->mutex);
45    if (str != context->error_buf)
46	free(str);
47    HEIMDAL_MUTEX_unlock(context->mutex);
48}
49
50void KRB5_LIB_FUNCTION
51krb5_clear_error_string(krb5_context context)
52{
53    HEIMDAL_MUTEX_lock(context->mutex);
54    if (context->error_string != NULL
55	&& context->error_string != context->error_buf)
56	free(context->error_string);
57    context->error_string = NULL;
58    HEIMDAL_MUTEX_unlock(context->mutex);
59}
60
61krb5_error_code KRB5_LIB_FUNCTION
62krb5_set_error_string(krb5_context context, const char *fmt, ...)
63    __attribute__((format (printf, 2, 3)))
64{
65    krb5_error_code ret;
66    va_list ap;
67
68    va_start(ap, fmt);
69    ret = krb5_vset_error_string (context, fmt, ap);
70    va_end(ap);
71    return ret;
72}
73
74krb5_error_code KRB5_LIB_FUNCTION
75krb5_vset_error_string(krb5_context context, const char *fmt, va_list args)
76    __attribute__ ((format (printf, 2, 0)))
77{
78    krb5_clear_error_string(context);
79    HEIMDAL_MUTEX_lock(context->mutex);
80    vasprintf(&context->error_string, fmt, args);
81    if(context->error_string == NULL) {
82	vsnprintf (context->error_buf, sizeof(context->error_buf), fmt, args);
83	context->error_string = context->error_buf;
84    }
85    HEIMDAL_MUTEX_unlock(context->mutex);
86    return 0;
87}
88
89/**
90 * Return the error message in context. On error or no error string,
91 * the function returns NULL.
92 *
93 * @param context Kerberos 5 context
94 *
95 * @return an error string, needs to be freed with
96 * krb5_free_error_string(). The functions return NULL on error.
97 *
98 * @ingroup krb5_error
99 */
100
101char * KRB5_LIB_FUNCTION
102krb5_get_error_string(krb5_context context)
103{
104    char *ret = NULL;
105
106    HEIMDAL_MUTEX_lock(context->mutex);
107    if (context->error_string)
108	ret = strdup(context->error_string);
109    HEIMDAL_MUTEX_unlock(context->mutex);
110    return ret;
111}
112
113krb5_boolean KRB5_LIB_FUNCTION
114krb5_have_error_string(krb5_context context)
115{
116    char *str;
117    HEIMDAL_MUTEX_lock(context->mutex);
118    str = context->error_string;
119    HEIMDAL_MUTEX_unlock(context->mutex);
120    return str != NULL;
121}
122
123/**
124 * Return the error message for `code' in context. On error the
125 * function returns NULL.
126 *
127 * @param context Kerberos 5 context
128 * @param code Error code related to the error
129 *
130 * @return an error string, needs to be freed with
131 * krb5_free_error_string(). The functions return NULL on error.
132 *
133 * @ingroup krb5_error
134 */
135
136char * KRB5_LIB_FUNCTION
137krb5_get_error_message(krb5_context context, krb5_error_code code)
138{
139    const char *cstr;
140    char *str;
141
142    str = krb5_get_error_string(context);
143    if (str)
144	return str;
145
146    cstr = krb5_get_err_text(context, code);
147    if (cstr)
148	return strdup(cstr);
149
150    if (asprintf(&str, "<unknown error: %d>", code) == -1)
151	return NULL;
152
153    return str;
154}
155
156