More error reporting
[mech_eap.orig] / display_status.c
1 /*
2  * Copyright (c) 2010, JANET(UK)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * 3. Neither the name of JANET(UK) nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32
33 #include "gssapiP_eap.h"
34
35 static GSSEAP_THREAD_ONCE gssEapStatusInfoKeyOnce = GSSEAP_ONCE_INITIALIZER;
36 static GSSEAP_THREAD_KEY gssEapStatusInfoKey;
37
38 struct gss_eap_status_info {
39     OM_uint32 code;
40     char *message;
41     struct gss_eap_status_info *next;
42 };
43
44 static void
45 destroyStatusInfo(void *arg)
46 {
47     struct gss_eap_status_info *p = arg, *next;
48
49     for (p = arg; p != NULL; p = next) {
50         next = p->next;
51         GSSEAP_FREE(p->message);
52         GSSEAP_FREE(p);
53     }
54 }
55
56 static void
57 createStatusInfoKey(void)
58 {
59     GSSEAP_KEY_CREATE(&gssEapStatusInfoKey, destroyStatusInfo);
60 }
61
62 /*
63  * Associate a message with a mechanism (minor) status code. This function
64  * takes ownership of the message regardless of success. The message must
65  * be explicitly cleared, if required, so it is suggested that a specific
66  * minor code is either always or never associated with a message, to avoid
67  * dangling (and potentially confusing) error messages.
68  */
69 static void
70 saveStatusInfoNoCopy(OM_uint32 minor, char *message)
71 {
72     struct gss_eap_status_info **next = NULL, *p;
73
74     GSSEAP_ONCE(&gssEapStatusInfoKeyOnce, createStatusInfoKey);
75
76     p = GSSEAP_GETSPECIFIC(gssEapStatusInfoKey);
77     for (; p != NULL; p = p->next) {
78         if (p->code == minor) {
79             /* Set message in-place */
80             if (p->message != NULL)
81                 GSSEAP_FREE(p->message);
82             p->message = message;
83             return;
84         }
85         next = &p->next;
86     }
87
88     p = GSSEAP_CALLOC(1, sizeof(*p));
89     if (p == NULL) {
90         if (message != NULL)
91             GSSEAP_FREE(message);
92         return;
93     }
94
95     p->code = minor;
96     p->message = message;
97
98     if (p != NULL)
99         *next = p;
100     else
101         GSSEAP_SETSPECIFIC(gssEapStatusInfoKey, p);
102 }
103
104 static const char *
105 getStatusInfo(OM_uint32 minor)
106 {
107     struct gss_eap_status_info *p;
108
109     GSSEAP_ONCE(&gssEapStatusInfoKeyOnce, createStatusInfoKey);
110
111     for (p = GSSEAP_GETSPECIFIC(gssEapStatusInfoKey);
112          p != NULL;
113          p = p->next) {
114         if (p->code == minor)
115             return p->message;
116     }
117
118     return NULL;
119 }
120
121 void
122 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...)
123 {
124     char *s;
125     int n;
126     va_list ap;
127
128     va_start(ap, format);
129     n = vasprintf(&s, format, ap);
130     va_end(ap);
131
132     if (n >= 0)
133         saveStatusInfoNoCopy(minor, s);
134 }
135
136 OM_uint32
137 gss_display_status(OM_uint32 *minor,
138                    OM_uint32 status_value,
139                    int status_type,
140                    gss_OID mech_type,
141                    OM_uint32 *message_context,
142                    gss_buffer_t status_string)
143 {
144     OM_uint32 major = GSS_S_COMPLETE;
145     krb5_context krbContext = NULL;
146     const char *errMsg;
147
148     status_string->length = 0;
149     status_string->value = NULL;
150
151     if (!gssEapIsMechanismOid(mech_type)) {
152         return GSS_S_BAD_MECH;
153     }
154
155     if (status_type != GSS_C_MECH_CODE) {
156         /* we rely on the mechglue for GSS_C_GSS_CODE */
157         return GSS_S_BAD_STATUS;
158     }
159
160     errMsg = getStatusInfo(status_value);
161     if (errMsg == NULL) {
162         GSSEAP_KRB_INIT(&krbContext);
163
164         /* Try the com_err message */
165         errMsg = krb5_get_error_message(krbContext, status_value);
166     }
167
168     if (errMsg != NULL)
169         major = makeStringBuffer(minor, errMsg, status_string);
170
171     if (krbContext != NULL)
172         krb5_free_error_message(krbContext, errMsg);
173
174     return major;
175 }