2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2005 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
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.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * Copyright (c) 1998 - 2005 Kungliga Tekniska Högskolan
32 * (Royal Institute of Technology, Stockholm, Sweden).
33 * All rights reserved.
35 * Redistribution and use in source and binary forms, with or without
36 * modification, are permitted provided that the following conditions
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
46 * 3. Neither the name of the Institute nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63 * Copyright (c) 1998 - 2005 Kungliga Tekniska Högskolan
64 * (Royal Institute of Technology, Stockholm, Sweden).
65 * All rights reserved.
67 * Redistribution and use in source and binary forms, with or without
68 * modification, are permitted provided that the following conditions
71 * 1. Redistributions of source code must retain the above copyright
72 * notice, this list of conditions and the following disclaimer.
74 * 2. Redistributions in binary form must reproduce the above copyright
75 * notice, this list of conditions and the following disclaimer in the
76 * documentation and/or other materials provided with the distribution.
78 * 3. Neither the name of the Institute nor the names of its contributors
79 * may be used to endorse or promote products derived from this software
80 * without specific prior written permission.
82 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
83 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
84 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
85 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
86 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
87 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
88 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
89 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
90 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
91 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
95 #include <gssapi/gssapi.h>
101 #include "mech_switch.h"
105 calling_error(OM_uint32 v)
107 static const char *msgs[] = {
109 "A required input parameter could not be read.", /* */
110 "A required output parameter could not be written.", /* */
111 "A parameter was malformed"
114 v >>= GSS_C_CALLING_ERROR_OFFSET;
118 else if (v >= sizeof(msgs)/sizeof(*msgs))
119 return "unknown calling error";
125 routine_error(OM_uint32 v)
127 static const char *msgs[] = {
128 "Function completed successfully", /* 0 */
129 "An unsupported mechanism was requested",
130 "An invalid name was supplied",
131 "A supplied name was of an unsupported type",
132 "Incorrect channel bindings were supplied",
133 "An invalid status code was supplied",
134 "A token had an invalid MIC",
135 "No credentials were supplied, "
136 "or the credentials were unavailable or inaccessible.",
137 "No context has been established",
138 "A token was invalid",
139 "A credential was invalid",
140 "The referenced credentials have expired",
141 "The context has expired",
142 "Miscellaneous failure (see text)",
143 "The quality-of-protection requested could not be provide",
144 "The operation is forbidden by local security policy",
145 "The operation or option is not available",
146 "The requested credential element already exists",
147 "The provided name was not a mechanism name.",
150 v >>= GSS_C_ROUTINE_ERROR_OFFSET;
152 if (v >= sizeof(msgs)/sizeof(*msgs))
153 return "unknown routine error";
159 supplementary_error(OM_uint32 v)
161 static const char *msgs[] = {
163 "continuation call to routine required",
164 "duplicate per-message token detected",
165 "timed-out per-message token detected",
166 "reordered (early) per-message token detected",
167 "skipped predecessor token(s) detected"
170 v >>= GSS_C_SUPPLEMENTARY_OFFSET;
172 if (v >= sizeof(msgs)/sizeof(*msgs))
173 return "unknown routine error";
178 #if defined(__NO_TLS)
181 * These platforms don't support TLS on FreeBSD - threads will just
182 * have to step on each other's error values for now.
188 struct mg_thread_ctx {
192 gss_buffer_desc maj_error;
193 gss_buffer_desc min_error;
195 static __thread struct mg_thread_ctx last_error_context;
198 _gss_mg_get_error(const gss_OID mech, OM_uint32 type,
199 OM_uint32 value, gss_buffer_t string)
201 struct mg_thread_ctx *mg;
203 mg = &last_error_context;
205 if (mech != NULL && gss_oid_equal(mg->mech, mech) == 0)
206 return (GSS_S_BAD_STATUS);
209 case GSS_C_GSS_CODE: {
210 if (value != mg->maj_stat || mg->maj_error.length == 0)
212 string->value = malloc(mg->maj_error.length);
213 string->length = mg->maj_error.length;
214 memcpy(string->value, mg->maj_error.value,
215 mg->maj_error.length);
216 return (GSS_S_COMPLETE);
218 case GSS_C_MECH_CODE: {
219 if (value != mg->min_stat || mg->min_error.length == 0)
221 string->value = malloc(mg->min_error.length);
222 string->length = mg->min_error.length;
223 memcpy(string->value, mg->min_error.value,
224 mg->min_error.length);
225 return (GSS_S_COMPLETE);
228 string->value = NULL;
230 return (GSS_S_BAD_STATUS);
234 _gss_mg_error(struct _gss_mech_switch *m, OM_uint32 maj, OM_uint32 min)
236 OM_uint32 major_status, minor_status;
237 OM_uint32 message_content;
238 struct mg_thread_ctx *mg;
240 mg = &last_error_context;
242 gss_release_buffer(&minor_status, &mg->maj_error);
243 gss_release_buffer(&minor_status, &mg->min_error);
245 mg->mech = &m->gm_mech_oid;
249 major_status = m->gm_display_status(&minor_status,
255 if (GSS_ERROR(major_status)) {
256 mg->maj_error.value = NULL;
257 mg->maj_error.length = 0;
259 major_status = m->gm_display_status(&minor_status,
265 if (GSS_ERROR(major_status)) {
266 mg->min_error.value = NULL;
267 mg->min_error.length = 0;
272 gss_display_status(OM_uint32 *minor_status,
273 OM_uint32 status_value,
275 const gss_OID mech_type,
276 OM_uint32 *message_content,
277 gss_buffer_t status_string)
279 OM_uint32 major_status;
281 _gss_buffer_zero(status_string);
282 *message_content = 0;
284 major_status = _gss_mg_get_error(mech_type, status_type,
285 status_value, status_string);
286 if (major_status == GSS_S_COMPLETE) {
288 *message_content = 0;
290 return (GSS_S_COMPLETE);
294 switch (status_type) {
295 case GSS_C_GSS_CODE: {
298 if (GSS_SUPPLEMENTARY_INFO(status_value))
299 asprintf(&buf, "%s", supplementary_error(
300 GSS_SUPPLEMENTARY_INFO(status_value)));
302 asprintf (&buf, "%s %s",
303 calling_error(GSS_CALLING_ERROR(status_value)),
304 routine_error(GSS_ROUTINE_ERROR(status_value)));
309 status_string->length = strlen(buf);
310 status_string->value = buf;
312 return (GSS_S_COMPLETE);
314 case GSS_C_MECH_CODE: {
315 OM_uint32 maj_junk, min_junk;
319 maj_junk = gss_oid_to_str(&min_junk, mech_type, &oid);
320 if (maj_junk != GSS_S_COMPLETE) {
321 oid.value = strdup("unknown");
325 asprintf (&buf, "unknown mech-code %lu for mech %.*s",
326 (unsigned long)status_value,
327 (int)oid.length, (char *)oid.value);
328 if (maj_junk == GSS_S_COMPLETE)
329 gss_release_buffer(&min_junk, &oid);
334 status_string->length = strlen(buf);
335 status_string->value = buf;
337 return (GSS_S_COMPLETE);
340 _gss_buffer_zero(status_string);
341 return (GSS_S_BAD_STATUS);
345 _gss_mg_collect_error(gss_OID mech, OM_uint32 maj, OM_uint32 min)
347 struct _gss_mech_switch *m;
349 m = _gss_find_mech_switch(mech);
351 _gss_mg_error(m, maj, min);