2 * Copyright (c) 2011, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * 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 * 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.
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
34 * Context establishment state machine.
37 #include "gssapiP_eap.h"
40 gssEapStateToString(enum gss_eap_state state)
45 case GSSEAP_STATE_INITIAL:
48 case GSSEAP_STATE_AUTHENTICATE:
51 case GSSEAP_STATE_INITIATOR_EXTS:
54 case GSSEAP_STATE_ACCEPTOR_EXTS:
57 case GSSEAP_STATE_ESTABLISHED:
69 makeErrorToken(OM_uint32 *minor,
70 OM_uint32 majorStatus,
71 OM_uint32 minorStatus,
72 gss_buffer_set_t *outputToken)
74 unsigned char errorData[8];
75 gss_buffer_desc errorBuffer;
77 assert(GSS_ERROR(majorStatus));
80 * Only return error codes that the initiator could have caused,
81 * to avoid information leakage.
83 if (IS_RADIUS_ERROR(minorStatus)) {
84 /* Squash RADIUS error codes */
85 minorStatus = GSSEAP_RADIUS_PROT_FAILURE;
86 } else if (!IS_WIRE_ERROR(minorStatus)) {
87 /* Don't return non-wire error codes */
88 return GSS_S_COMPLETE;
91 minorStatus -= ERROR_TABLE_BASE_eapg;
93 store_uint32_be(majorStatus, &errorData[0]);
94 store_uint32_be(minorStatus, &errorData[4]);
96 errorBuffer.length = sizeof(errorData);
97 errorBuffer.value = errorData;
99 return gss_add_buffer_set_member(minor, &errorBuffer, outputToken);
103 gssEapSmStep(OM_uint32 *minor,
110 gss_channel_bindings_t chanBindings,
111 gss_buffer_t inputToken,
112 gss_buffer_t outputToken,
113 struct gss_eap_sm *sm,
116 OM_uint32 major, tmpMajor, tmpMinor;
117 gss_buffer_desc unwrappedInputToken = GSS_C_EMPTY_BUFFER;
118 gss_buffer_desc unwrappedOutputToken = GSS_C_EMPTY_BUFFER;
119 gss_buffer_set_t innerInputTokens = GSS_C_NO_BUFFER_SET;
120 gss_buffer_set_t innerOutputTokens = GSS_C_NO_BUFFER_SET;
121 OM_uint32 *inputTokenTypes = NULL, *outputTokenTypes = NULL;
122 unsigned int smFlags = 0;
124 int initialContextToken = 0;
130 outputToken->length = 0;
131 outputToken->value = NULL;
133 if (inputToken != GSS_C_NO_BUFFER && inputToken->length != 0) {
134 enum gss_eap_token_type tokType;
136 major = gssEapVerifyToken(minor, ctx, inputToken, &tokType,
137 &unwrappedInputToken);
138 if (GSS_ERROR(major))
141 if (tokType != TOK_TYPE_ESTABLISH_CONTEXT) {
142 major = GSS_S_DEFECTIVE_TOKEN;
143 *minor = GSSEAP_WRONG_TOK_ID;
146 } else if (!CTX_IS_INITIATOR(ctx) || ctx->state != GSSEAP_STATE_INITIAL) {
147 major = GSS_S_DEFECTIVE_TOKEN;
148 *minor = GSSEAP_WRONG_SIZE;
151 initialContextToken = 1;
154 if (ctx->state == GSSEAP_STATE_ESTABLISHED) {
155 major = GSS_S_BAD_STATUS;
156 *minor = GSSEAP_CONTEXT_ESTABLISHED;
160 assert(ctx->state < GSSEAP_STATE_ESTABLISHED);
162 major = gssEapDecodeInnerTokens(minor, &unwrappedInputToken,
163 &innerInputTokens, &inputTokenTypes);
164 if (GSS_ERROR(major))
167 assert(innerInputTokens != GSS_C_NO_BUFFER_SET);
169 major = gss_create_empty_buffer_set(minor, &innerOutputTokens);
170 if (GSS_ERROR(major))
173 assert(innerOutputTokens->count == 0);
174 assert(innerOutputTokens->elements == NULL);
176 innerOutputTokens->elements = (gss_buffer_desc *)GSSEAP_CALLOC(smCount,
177 sizeof(gss_buffer_desc));
178 if (innerOutputTokens->elements == NULL) {
179 major = GSS_S_FAILURE;
184 outputTokenTypes = (OM_uint32 *)GSSEAP_CALLOC(smCount, sizeof(OM_uint32));
185 if (outputTokenTypes == NULL) {
186 major = GSS_S_FAILURE;
192 * Process all the tokens that are valid for the current state. If
193 * the processToken function returns GSS_S_COMPLETE, the state is
194 * advanced until there is a token to send or the ESTABLISHED state
198 major = GSS_S_COMPLETE;
200 for (i = 0; i < smCount; i++) {
201 struct gss_eap_sm *smp = &sm[i];
202 int processToken = 0;
203 gss_buffer_t innerInputToken = GSS_C_NO_BUFFER;
204 OM_uint32 *inputTokenType = NULL;
205 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
207 if ((smp->validStates & ctx->state) == 0)
210 if (smp->inputTokenType == ITOK_TYPE_NONE || initialContextToken) {
212 } else if ((smFlags & SM_FLAG_TRANSITION) == 0) {
213 for (j = 0; j < innerInputTokens->count; j++) {
214 if ((inputTokenTypes[j] & ITOK_TYPE_MASK) == smp->inputTokenType) {
216 if (innerInputToken != GSS_C_NO_BUFFER) {
217 major = GSS_S_DEFECTIVE_TOKEN;
218 *minor = GSSEAP_DUPLICATE_ITOK;
222 innerInputToken = &innerInputTokens->elements[j];
223 inputTokenType = &inputTokenTypes[j];
228 fprintf(stderr, "GSS-EAP: state %d processToken %d inputTokenType %08x "
229 "innerInputToken %p innerOutputTokensCount %zd\n",
230 ctx->state, processToken, smp->inputTokenType,
231 innerInputToken, innerOutputTokens->count);
237 major = smp->processToken(minor, cred, ctx, target, mech, reqFlags,
238 timeReq, chanBindings, innerInputToken,
239 &innerOutputToken, &smFlags);
240 if (GSS_ERROR(major))
243 if (inputTokenType != NULL)
244 *inputTokenType |= ITOK_FLAG_VERIFIED;
246 if (innerOutputToken.value != NULL) {
247 innerOutputTokens->elements[innerOutputTokens->count] = innerOutputToken;
248 assert(smp->outputTokenType != ITOK_TYPE_NONE);
249 outputTokenTypes[innerOutputTokens->count] = smp->outputTokenType;
250 if (smp->itokFlags & SM_ITOK_FLAG_CRITICAL)
251 outputTokenTypes[innerOutputTokens->count] |= ITOK_FLAG_CRITICAL;
252 innerOutputTokens->count++;
254 if (smFlags & SM_FLAG_STOP_EVAL)
256 } else if ((smp->itokFlags & SM_ITOK_FLAG_REQUIRED) &&
257 smp->inputTokenType != ITOK_TYPE_NONE) {
258 major = GSS_S_DEFECTIVE_TOKEN;
259 *minor = GSSEAP_MISSING_REQUIRED_ITOK;
264 if (GSS_ERROR(major) || (smFlags & SM_FLAG_TRANSITION) == 0)
267 assert(ctx->state < GSSEAP_STATE_ESTABLISHED);
270 fprintf(stderr, "GSS-EAP: state transition %s->%s\n",
271 gssEapStateToString(ctx->state),
272 gssEapStateToString(GSSEAP_STATE_NEXT(ctx->state)));
275 ctx->state = GSSEAP_STATE_NEXT(ctx->state);
277 if (innerOutputTokens->count != 0 || (smFlags & SM_FLAG_FORCE_SEND_TOKEN)) {
278 assert(major == GSS_S_CONTINUE_NEEDED || ctx->state == GSSEAP_STATE_ESTABLISHED);
279 break; /* send any tokens if we have them */
281 } while (ctx->state != GSSEAP_STATE_ESTABLISHED);
283 assert(innerOutputTokens->count <= smCount);
285 /* Check we understood all critical tokens */
286 if (!GSS_ERROR(major)) {
287 for (j = 0; j < innerInputTokens->count; j++) {
288 if ((inputTokenTypes[j] & ITOK_FLAG_CRITICAL) &&
289 (inputTokenTypes[j] & ITOK_FLAG_VERIFIED) == 0) {
290 major = GSS_S_UNAVAILABLE;
291 *minor = GSSEAP_CRIT_ITOK_UNAVAILABLE;
297 /* Emit an error token if we are the acceptor */
298 if (GSS_ERROR(major)) {
299 if (CTX_IS_INITIATOR(ctx))
300 goto cleanup; /* return error directly to caller */
302 /* replace any emitted tokens with error token */
303 gss_release_buffer_set(&tmpMinor, &innerOutputTokens);
305 tmpMajor = makeErrorToken(&tmpMinor, major, *minor, &innerOutputTokens);
306 if (GSS_ERROR(tmpMajor)) {
312 outputTokenTypes[0] = ITOK_TYPE_CONTEXT_ERR | ITOK_FLAG_CRITICAL;
316 for (i = 0; i < innerOutputTokens->count; i++) {
317 fprintf(stderr, "GSS-EAP: type %08x length %zd value %p\n",
319 innerOutputTokens->elements[i].length,
320 innerOutputTokens->elements[i].value);
324 /* Format composite output token */
325 if (innerOutputTokens->count != 0 || /* inner tokens to send */
326 !CTX_IS_INITIATOR(ctx) || /* any leg acceptor */
327 ctx->state != GSSEAP_STATE_ESTABLISHED) { /* non-last leg initiator */
328 tmpMajor = gssEapEncodeInnerTokens(&tmpMinor, innerOutputTokens,
329 outputTokenTypes, &unwrappedOutputToken);
330 if (tmpMajor == GSS_S_COMPLETE) {
331 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &unwrappedOutputToken,
332 TOK_TYPE_ESTABLISH_CONTEXT, outputToken);
333 if (GSS_ERROR(tmpMajor)) {
341 assert(GSS_ERROR(major) ||
342 (major == GSS_S_CONTINUE_NEEDED && (ctx->state > GSSEAP_STATE_INITIAL && ctx->state < GSSEAP_STATE_ESTABLISHED)) ||
343 (major == GSS_S_COMPLETE && ctx->state == GSSEAP_STATE_ESTABLISHED));
346 gss_release_buffer_set(&tmpMinor, &innerInputTokens);
347 gss_release_buffer_set(&tmpMinor, &innerOutputTokens);
348 if (inputTokenTypes != NULL)
349 GSSEAP_FREE(inputTokenTypes);
350 if (outputTokenTypes != NULL)
351 gss_release_buffer(&tmpMinor, &unwrappedOutputToken);
352 GSSEAP_FREE(outputTokenTypes);