1 /*
2  * Copyright (c) 1998 - 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/gsskrb5_locl.h"
35 
36 RCSID("$Id: display_status.c 19031 2006-11-13 18:02:57Z lha $");
37 
38 static const char *
39 calling_error(OM_uint32 v)
40 {
41     static const char *msgs[] = {
42 	NULL,			/* 0 */
43 	"A required input parameter could not be read.", /*  */
44 	"A required output parameter could not be written.", /*  */
45 	"A parameter was malformed"
46     };
47 
48     v >>= GSS_C_CALLING_ERROR_OFFSET;
49 
50     if (v == 0)
51 	return "";
52     else if (v >= sizeof(msgs)/sizeof(*msgs))
53 	return "unknown calling error";
54     else
55 	return msgs[v];
56 }
57 
58 static const char *
59 routine_error(OM_uint32 v)
60 {
61     static const char *msgs[] = {
62 	NULL,			/* 0 */
63 	"An unsupported mechanism was requested",
64 	"An invalid name was supplied",
65 	"A supplied name was of an unsupported type",
66 	"Incorrect channel bindings were supplied",
67 	"An invalid status code was supplied",
68 	"A token had an invalid MIC",
69 	"No credentials were supplied, "
70 	"or the credentials were unavailable or inaccessible.",
71 	"No context has been established",
72 	"A token was invalid",
73 	"A credential was invalid",
74 	"The referenced credentials have expired",
75 	"The context has expired",
76 	"Miscellaneous failure (see text)",
77 	"The quality-of-protection requested could not be provide",
78 	"The operation is forbidden by local security policy",
79 	"The operation or option is not available",
80 	"The requested credential element already exists",
81 	"The provided name was not a mechanism name.",
82     };
83 
84     v >>= GSS_C_ROUTINE_ERROR_OFFSET;
85 
86     if (v == 0)
87 	return "";
88     else if (v >= sizeof(msgs)/sizeof(*msgs))
89 	return "unknown routine error";
90     else
91 	return msgs[v];
92 }
93 
94 static const char *
95 supplementary_error(OM_uint32 v)
96 {
97     static const char *msgs[] = {
98 	"normal completion",
99 	"continuation call to routine required",
100 	"duplicate per-message token detected",
101 	"timed-out per-message token detected",
102 	"reordered (early) per-message token detected",
103 	"skipped predecessor token(s) detected"
104     };
105 
106     v >>= GSS_C_SUPPLEMENTARY_OFFSET;
107 
108     if (v >= sizeof(msgs)/sizeof(*msgs))
109 	return "unknown routine error";
110     else
111 	return msgs[v];
112 }
113 
114 void
115 _gsskrb5_clear_status (void)
116 {
117     krb5_context context;
118 
119     if (_gsskrb5_init (&context) != 0)
120 	return;
121     krb5_clear_error_string(context);
122 }
123 
124 void
125 _gsskrb5_set_status (const char *fmt, ...)
126 {
127     krb5_context context;
128     va_list args;
129     char *str;
130 
131     if (_gsskrb5_init (&context) != 0)
132 	return;
133 
134     va_start(args, fmt);
135     vasprintf(&str, fmt, args);
136     va_end(args);
137     if (str) {
138 	krb5_set_error_string(context, str);
139 	free(str);
140     }
141 }
142 
143 OM_uint32 _gsskrb5_display_status
144 (OM_uint32		*minor_status,
145  OM_uint32		 status_value,
146  int			 status_type,
147  const gss_OID	 mech_type,
148  OM_uint32		*message_context,
149  gss_buffer_t	 status_string)
150 {
151     krb5_context context;
152     char *buf;
153 
154     GSSAPI_KRB5_INIT (&context);
155 
156     status_string->length = 0;
157     status_string->value = NULL;
158 
159     if (gss_oid_equal(mech_type, GSS_C_NO_OID) == 0 &&
160 	gss_oid_equal(mech_type, GSS_KRB5_MECHANISM) == 0) {
161 	*minor_status = 0;
162 	return GSS_C_GSS_CODE;
163     }
164 
165     if (status_type == GSS_C_GSS_CODE) {
166 	if (GSS_SUPPLEMENTARY_INFO(status_value))
167 	    asprintf(&buf, "%s",
168 		     supplementary_error(GSS_SUPPLEMENTARY_INFO(status_value)));
169 	else
170 	    asprintf (&buf, "%s %s",
171 		      calling_error(GSS_CALLING_ERROR(status_value)),
172 		      routine_error(GSS_ROUTINE_ERROR(status_value)));
173     } else if (status_type == GSS_C_MECH_CODE) {
174 	buf = krb5_get_error_string(context);
175 	if (buf == NULL) {
176 	    const char *tmp = krb5_get_err_text (context, status_value);
177 	    if (tmp == NULL)
178 		asprintf(&buf, "unknown mech error-code %u",
179 			 (unsigned)status_value);
180 	    else
181 		buf = strdup(tmp);
182 	}
183     } else {
184 	*minor_status = EINVAL;
185 	return GSS_S_BAD_STATUS;
186     }
187 
188     if (buf == NULL) {
189 	*minor_status = ENOMEM;
190 	return GSS_S_FAILURE;
191     }
192 
193     *message_context = 0;
194     *minor_status = 0;
195 
196     status_string->length = strlen(buf);
197     status_string->value  = buf;
198 
199     return GSS_S_COMPLETE;
200 }
201