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
  69     struct gss_eap_thread_local_data* tld = gssEapGetThreadLocalData();
  70     if (tld != NULL) {
  71         for (p = tld->status_info; 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
  82         p = GSSEAP_CALLOC(1, sizeof(*p));
  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->status_info = 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     if (tld != NULL) {
 105         for (p = tld->status_info;
 106              p != NULL;
 107              p = p->next) {
 108             if (p->code == minor)
 109                 return p->message;
 110         }
 111     }
 112     return NULL;
 113 }
 114
 115 void
 116 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...)
 117 {
 118     char *s = NULL;
 119     int n;
 120     va_list ap;
 121
 122     if (format != NULL) {
 123         va_start(ap, format);
 124         n = vasprintf(&s, format, ap);
 125         va_end(ap);
 126     }
 127
 128     saveStatusInfoNoCopy(minor, s);
 129 }
 130
 131 OM_uint32 KRB5_CALLCONV
 132 gss_display_status(OM_uint32 *minor,
 133                    OM_uint32 status_value,
 134                    int status_type,
 135                    gss_OID mech_type,
 136                    OM_uint32 *message_context,
 137                    gss_buffer_t status_string)
 138 {
 139     OM_uint32 major;
 140     krb5_context krbContext = NULL;
 141     const char *errMsg;
 142
 143     status_string->length = 0;
 144     status_string->value = NULL;
 145
 146     if (!gssEapIsMechanismOid(mech_type)) {
 147         *minor = GSSEAP_WRONG_MECH;
 148         return GSS_S_BAD_MECH;
 149     }
 150
 151     if (status_type != GSS_C_MECH_CODE ||
 152         *message_context != 0) {
 153         /* we rely on the mechglue for GSS_C_GSS_CODE */
 154         *minor = 0;
 155         return GSS_S_BAD_STATUS;
 156     }
 157
 158     errMsg = getStatusInfo(status_value);
 159     if (errMsg == NULL) {
 160         GSSEAP_KRB_INIT(&krbContext);
 161
 162         /* Try the com_err message */
 163         errMsg = krb5_get_error_message(krbContext, status_value);
 164     }
 165
 166     if (errMsg != NULL) {
 167         major = makeStringBuffer(minor, errMsg, status_string);
 168     } else {
 169         major = GSS_S_COMPLETE;
 170         *minor = 0;
 171     }
 172
 173     if (krbContext != NULL)
 174         krb5_free_error_message(krbContext, errMsg);
 175
 176     return major;
 177 }