xref: /freebsd/crypto/heimdal/lib/gssapi/mech/gss_display_status.c (revision ec965063070e5753c166cf592c9336444b74720a)
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, or the credentials were unavailable or inaccessible.",
95 	"No context has been established",
96 	"A token was invalid",
97 	"A credential was invalid",
98 	"The referenced credentials have expired",
99 	"The context has expired",
100 	"Miscellaneous failure (see text)",
101 	"The quality-of-protection requested could not be provide",
102 	"The operation is forbidden by local security policy",
103 	"The operation or option is not available",
104 	"The requested credential element already exists",
105 	"The provided name was not a mechanism name.",
106     };
107 
108     v >>= GSS_C_ROUTINE_ERROR_OFFSET;
109 
110     if (v >= sizeof(msgs)/sizeof(*msgs))
111 	return "unknown routine error";
112     else
113 	return msgs[v];
114 }
115 
116 static const char *
117 supplementary_error(OM_uint32 v)
118 {
119     static const char *msgs[] = {
120 	"normal completion",
121 	"continuation call to routine required",
122 	"duplicate per-message token detected",
123 	"timed-out per-message token detected",
124 	"reordered (early) per-message token detected",
125 	"skipped predecessor token(s) detected"
126     };
127 
128     v >>= GSS_C_SUPPLEMENTARY_OFFSET;
129 
130     if (v >= sizeof(msgs)/sizeof(*msgs))
131 	return "unknown routine error";
132     else
133 	return msgs[v];
134 }
135 
136 
137 GSSAPI_LIB_FUNCTION OM_uint32 GSSAPI_LIB_CALL
138 gss_display_status(OM_uint32 *minor_status,
139     OM_uint32 status_value,
140     int status_type,
141     const gss_OID mech_type,
142     OM_uint32 *message_content,
143     gss_buffer_t status_string)
144 {
145 	OM_uint32 major_status;
146 
147 	_mg_buffer_zero(status_string);
148 	*message_content = 0;
149 
150 	major_status = _gss_mg_get_error(mech_type, status_type,
151 					 status_value, status_string);
152 	if (major_status == GSS_S_COMPLETE) {
153 
154 	    *message_content = 0;
155 	    *minor_status = 0;
156 	    return GSS_S_COMPLETE;
157 	}
158 
159 	*minor_status = 0;
160 	switch (status_type) {
161 	case GSS_C_GSS_CODE: {
162 	    	char *buf = NULL;
163 		int e;
164 
165 		if (GSS_SUPPLEMENTARY_INFO(status_value))
166 		    e = asprintf(&buf, "%s", supplementary_error(
167 		        GSS_SUPPLEMENTARY_INFO(status_value)));
168 		else
169 		    e = asprintf (&buf, "%s %s",
170 		        calling_error(GSS_CALLING_ERROR(status_value)),
171 			routine_error(GSS_ROUTINE_ERROR(status_value)));
172 
173 		if (e < 0 || buf == NULL)
174 		    break;
175 
176 		status_string->length = strlen(buf);
177 		status_string->value  = buf;
178 
179 		return GSS_S_COMPLETE;
180 	}
181 	case GSS_C_MECH_CODE: {
182 		OM_uint32 maj_junk, min_junk;
183 		gss_buffer_desc oid;
184 		char *buf = NULL;
185 		int e;
186 
187 		maj_junk = gss_oid_to_str(&min_junk, mech_type, &oid);
188 		if (maj_junk != GSS_S_COMPLETE) {
189 		    oid.value = rk_UNCONST("unknown");
190 		    oid.length = 7;
191 		}
192 
193 		e = asprintf (&buf, "unknown mech-code %lu for mech %.*s",
194 			  (unsigned long)status_value,
195 			  (int)oid.length, (char *)oid.value);
196 		if (maj_junk == GSS_S_COMPLETE)
197 		    gss_release_buffer(&min_junk, &oid);
198 
199 		if (e < 0 || buf == NULL)
200 		    break;
201 
202 		status_string->length = strlen(buf);
203 		status_string->value  = buf;
204 
205 		return GSS_S_COMPLETE;
206 	}
207 	}
208 	_mg_buffer_zero(status_string);
209 	return (GSS_S_BAD_STATUS);
210 }
211