mech_eap/display_status.c

   1 /*
   2  * Copyright (c) 2011, 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 /*
  34  * Function for converting mechanism error codes to strings.
  35  */
  36
  37 #include "gssapiP_eap.h"
  38
  39 struct gss_eap_status_info {
  40     OM_uint32 code;
  41     char *message;
  42     struct gss_eap_status_info *next;
  43 };
  44
  45 void
  46 gssEapDestroyStatusInfo(struct gss_eap_status_info *p)
  47 {
  48     struct gss_eap_status_info *next;
  49
  50     for (; p != NULL; p = next) {
  51         next = p->next;
  52         GSSEAP_FREE(p->message);
  53         GSSEAP_FREE(p);
  54     }
  55 }
  56
  57 /*
  58  * Associate a message with a mechanism (minor) status code. This function
  59  * takes ownership of the message regardless of success. The message must
  60  * be explicitly cleared, if required, so it is suggested that a specific
  61  * minor code is either always or never associated with a message, to avoid
  62  * dangling (and potentially confusing) error messages.
  63  */
  64 static void
  65 saveStatusInfoNoCopy(OM_uint32 minor, char *message)
  66 {
  67     struct gss_eap_status_info **next = NULL, *p = NULL;
  68     struct gss_eap_thread_local_data *tld = gssEapGetThreadLocalData();
  69
  70     if (tld != NULL) {
  71         for (p = tld->statusInfo; p != NULL; p = p->next) {
  72             if (p->code == minor) {
  73                 /* Set message in-place */
  74                 if (p->message != NULL)
  75                     GSSEAP_FREE(p->message);
  76                 p->message = message;
  77                 return;
  78             }
  79             next = &p->next;
  80         }
  81         p = GSSEAP_CALLOC(1, sizeof(*p));
  82     }
  83
  84     if (p == NULL) {
  85         if (message != NULL)
  86             GSSEAP_FREE(message);
  87         return;
  88     }
  89
  90     p->code = minor;
  91     p->message = message;
  92
  93     if (next != NULL)
  94         *next = p;
  95     else
  96         tld->statusInfo = p;
  97 }
  98
  99 static const char *
 100 getStatusInfo(OM_uint32 minor)
 101 {
 102     struct gss_eap_status_info *p;
 103     struct gss_eap_thread_local_data *tld = gssEapGetThreadLocalData();
 104
 105     if (tld != NULL) {
 106         for (p = tld->statusInfo; p != NULL; p = p->next) {
 107             if (p->code == minor)
 108                 return p->message;
 109         }
 110     }
 111     return NULL;
 112 }
 113
 114 void
 115 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...)
 116 {
 117 #ifdef WIN32
 118     OM_uint32 tmpMajor, tmpMinor;
 119     char buf[BUFSIZ];
 120     gss_buffer_desc s = GSS_C_EMPTY_BUFFER;
 121     va_list ap;
 122
 123     if (format != NULL) {
 124         va_start(ap, format);
 125         snprintf(buf, sizeof(buf), format, ap);
 126         va_end(ap);
 127     }
 128
 129     tmpMajor = makeStringBuffer(&tmpMinor, buf, &s);
 130     if (!GSS_ERROR(tmpMajor))
 131         saveStatusInfoNoCopy(minor, (char *)s.value);
 132 #else
 133     char *s = NULL;
 134     int n;
 135     va_list ap;
 136
 137     if (format != NULL) {
 138         va_start(ap, format);
 139         n = vasprintf(&s, format, ap);
 140         if (n == -1) {
 141             if (s) {
 142                 free(s);
 143             }
 144             s = NULL;
 145         }
 146         va_end(ap);
 147     }
 148     /* NOTE: saveStatusInfoNoCopy apparently expects the string to be allocated with
 149      * GSSAPI_MALLOC, so perhaps we should copy the string via gssalloc_strdup or
 150      * equivalent?
 151      */
 152     saveStatusInfoNoCopy(minor, s);
 153 #endif /* WIN32 */
 154 }
 155
 156 OM_uint32
 157 gssEapDisplayStatus(OM_uint32 *minor,
 158                     OM_uint32 status_value,
 159                     gss_buffer_t status_string)
 160 {
 161     OM_uint32 major;
 162     krb5_context krbContext = NULL;
 163     const char *errMsg;
 164
 165     status_string->length = 0;
 166     status_string->value = NULL;
 167
 168     errMsg = getStatusInfo(status_value);
 169     if (errMsg == NULL) {
 170         GSSEAP_KRB_INIT(&krbContext);
 171
 172         /* Try the com_err message */
 173         errMsg = krb5_get_error_message(krbContext, status_value);
 174     }
 175
 176     if (errMsg != NULL) {
 177         major = makeStringBuffer(minor, errMsg, status_string);
 178     } else {
 179         major = GSS_S_COMPLETE;
 180         *minor = 0;
 181     }
 182
 183     if (krbContext != NULL)
 184         krb5_free_error_message(krbContext, errMsg);
 185
 186     return major;
 187 }
 188
 189 OM_uint32 GSSAPI_CALLCONV
 190 gss_display_status(OM_uint32 *minor,
 191                    OM_uint32 status_value,
 192                    int status_type,
 193                    gss_OID mech_type,
 194                    OM_uint32 *message_context,
 195                    gss_buffer_t status_string)
 196 {
 197     if (!gssEapIsMechanismOid(mech_type)) {
 198         *minor = GSSEAP_WRONG_MECH;
 199         return GSS_S_BAD_MECH;
 200     }
 201
 202     if (status_type != GSS_C_MECH_CODE ||
 203         *message_context != 0) {
 204         /* we rely on the mechglue for GSS_C_GSS_CODE */
 205         *minor = 0;
 206         return GSS_S_BAD_STATUS;
 207     }
 208
 209     return gssEapDisplayStatus(minor, status_value, status_string);
 210 }