xref: /freebsd/crypto/heimdal/lib/gssapi/mech/gss_display_status.c (revision b9f654b163bce26de79705e77b872427c9f2afa1)
1 /*-
2  * Copyright (c) 2005 Doug Rabson
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  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  *	$FreeBSD: src/lib/libgssapi/gss_display_status.c,v 1.1 2005/12/29 14:40:20 dfr Exp $
27  */
28 /*
29  * Copyright (c) 1998 - 2005 Kungliga Tekniska Högskolan
30  * (Royal Institute of Technology, Stockholm, Sweden).
31  * All rights reserved.
32  *
33  * Redistribution and use in source and binary forms, with or without
34  * modification, are permitted provided that the following conditions
35  * are met:
36  *
37  * 1. Redistributions of source code must retain the above copyright
38  *    notice, this list of conditions and the following disclaimer.
39  *
40  * 2. Redistributions in binary form must reproduce the above copyright
41  *    notice, this list of conditions and the following disclaimer in the
42  *    documentation and/or other materials provided with the distribution.
43  *
44  * 3. Neither the name of the Institute nor the names of its contributors
45  *    may be used to endorse or promote products derived from this software
46  *    without specific prior written permission.
47  *
48  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  */
60 
61 #include "mech_locl.h"
62 
63 static const char *
64 calling_error(OM_uint32 v)
65 {
66     static const char *msgs[] = {
67 	NULL,			/* 0 */
68 	"A required input parameter could not be read.", /*  */
69 	"A required output parameter could not be written.", /*  */
70 	"A parameter was malformed"
71     };
72 
73     v >>= GSS_C_CALLING_ERROR_OFFSET;
74 
75     if (v == 0)
76 	return "";
77     else if (v >= sizeof(msgs)/sizeof(*msgs))
78 	return "unknown calling error";
79     else
80 	return msgs[v];
81 }
82 
83 static const char *
84 routine_error(OM_uint32 v)
85 {
86     static const char *msgs[] = {
87 	"Function completed successfully",			/* 0 */
88 	"An unsupported mechanism was requested",
89 	"An invalid name was supplied",
90 	"A supplied name was of an unsupported type",
91 	"Incorrect channel bindings were supplied",
92 	"An invalid status code was supplied",
93 	"A token had an invalid MIC",
94 	"No credentials were supplied, "
95 	"or the credentials were unavailable or inaccessible.",
96 	"No context has been established",
97 	"A token was invalid",
98 	"A credential was invalid",
99 	"The referenced credentials have expired",
100 	"The context has expired",
101 	"Miscellaneous failure (see text)",
102 	"The quality-of-protection requested could not be provide",
103 	"The operation is forbidden by local security policy",
104 	"The operation or option is not available",
105 	"The requested credential element already exists",
106 	"The provided name was not a mechanism name.",
107     };
108 
109     v >>= GSS_C_ROUTINE_ERROR_OFFSET;
110 
111     if (v >= sizeof(msgs)/sizeof(*msgs))
112 	return "unknown routine error";
113     else
114 	return msgs[v];
115 }
116 
117 static const char *
118 supplementary_error(OM_uint32 v)
119 {
120     static const char *msgs[] = {
121 	"normal completion",
122 	"continuation call to routine required",
123 	"duplicate per-message token detected",
124 	"timed-out per-message token detected",
125 	"reordered (early) per-message token detected",
126 	"skipped predecessor token(s) detected"
127     };
128 
129     v >>= GSS_C_SUPPLEMENTARY_OFFSET;
130 
131     if (v >= sizeof(msgs)/sizeof(*msgs))
132 	return "unknown routine error";
133     else
134 	return msgs[v];
135 }
136 
137 
138 GSSAPI_LIB_FUNCTION OM_uint32 GSSAPI_LIB_CALL
139 gss_display_status(OM_uint32 *minor_status,
140     OM_uint32 status_value,
141     int status_type,
142     const gss_OID mech_type,
143     OM_uint32 *message_content,
144     gss_buffer_t status_string)
145 {
146 	OM_uint32 major_status;
147 
148 	_mg_buffer_zero(status_string);
149 	*message_content = 0;
150 
151 	major_status = _gss_mg_get_error(mech_type, status_type,
152 					 status_value, status_string);
153 	if (major_status == GSS_S_COMPLETE) {
154 
155 	    *message_content = 0;
156 	    *minor_status = 0;
157 	    return GSS_S_COMPLETE;
158 	}
159 
160 	*minor_status = 0;
161 	switch (status_type) {
162 	case GSS_C_GSS_CODE: {
163 	    	char *buf = NULL;
164 		int e;
165 
166 		if (GSS_SUPPLEMENTARY_INFO(status_value))
167 		    e = asprintf(&buf, "%s", supplementary_error(
168 		        GSS_SUPPLEMENTARY_INFO(status_value)));
169 		else
170 		    e = asprintf (&buf, "%s %s",
171 		        calling_error(GSS_CALLING_ERROR(status_value)),
172 			routine_error(GSS_ROUTINE_ERROR(status_value)));
173 
174 		if (e < 0 || buf == NULL)
175 		    break;
176 
177 		status_string->length = strlen(buf);
178 		status_string->value  = buf;
179 
180 		return GSS_S_COMPLETE;
181 	}
182 	case GSS_C_MECH_CODE: {
183 		OM_uint32 maj_junk, min_junk;
184 		gss_buffer_desc oid;
185 		char *buf = NULL;
186 		int e;
187 
188 		maj_junk = gss_oid_to_str(&min_junk, mech_type, &oid);
189 		if (maj_junk != GSS_S_COMPLETE) {
190 		    oid.value = rk_UNCONST("unknown");
191 		    oid.length = 7;
192 		}
193 
194 		e = asprintf (&buf, "unknown mech-code %lu for mech %.*s",
195 			  (unsigned long)status_value,
196 			  (int)oid.length, (char *)oid.value);
197 		if (maj_junk == GSS_S_COMPLETE)
198 		    gss_release_buffer(&min_junk, &oid);
199 
200 		if (e < 0 || buf == NULL)
201 		    break;
202 
203 		status_string->length = strlen(buf);
204 		status_string->value  = buf;
205 
206 		return GSS_S_COMPLETE;
207 	}
208 	}
209 	_mg_buffer_zero(status_string);
210 	return (GSS_S_BAD_STATUS);
211 }
212