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
33 * Portions Copyright 1993 by OpenVision Technologies, Inc.
35 * Permission to use, copy, modify, distribute, and sell this software
36 * and its documentation for any purpose is hereby granted without fee,
37 * provided that the above copyright notice appears in all copies and
38 * that both that copyright notice and this permission notice appear in
39 * supporting documentation, and that the name of OpenVision not be used
40 * in advertising or publicity pertaining to distribution of the software
41 * without specific, written prior permission. OpenVision makes no
42 * representations about the suitability of this software for any
43 * purpose. It is provided "as is" without express or implied warranty.
45 * OPENVISION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
46 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
47 * EVENT SHALL OPENVISION BE LIABLE FOR ANY SPECIAL, INDIRECT OR
48 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
49 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
50 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
51 * PERFORMANCE OF THIS SOFTWARE.
55 * Utility routines for GSS tokens.
58 #include "gssapiP_eap.h"
61 gssEapEncodeInnerTokens(OM_uint32 *minor,
62 gss_buffer_set_t extensions,
66 OM_uint32 major, tmpMinor;
67 size_t required = 0, i;
73 if (extensions != GSS_C_NO_BUFFER_SET) {
74 for (i = 0; i < extensions->count; i++) {
75 required += 8 + extensions->elements[i].length;
80 * We must always return a non-NULL token otherwise the calling state
81 * machine assumes we are finished. Hence care in case malloc(0) does
84 buffer->value = GSSEAP_MALLOC(required ? required : 1);
85 if (buffer->value == NULL) {
86 major = GSS_S_FAILURE;
91 buffer->length = required;
92 p = (unsigned char *)buffer->value;
94 if (extensions != GSS_C_NO_BUFFER_SET) {
95 for (i = 0; i < extensions->count; i++) {
96 gss_buffer_t extension = &extensions->elements[i];
98 assert((types[i] & ITOK_FLAG_VERIFIED) == 0); /* private flag */
101 * Extensions are encoded as type-length-value, where the upper
102 * bit of the type indicates criticality.
104 store_uint32_be(types[i], &p[0]);
105 store_uint32_be(extension->length, &p[4]);
106 memcpy(&p[8], extension->value, extension->length);
108 p += 8 + extension->length;
112 assert(p == (unsigned char *)buffer->value + required);
113 assert(buffer->value != NULL);
115 major = GSS_S_COMPLETE;
119 if (GSS_ERROR(major)) {
120 gss_release_buffer(&tmpMinor, buffer);
127 gssEapDecodeInnerTokens(OM_uint32 *minor,
128 const gss_buffer_t buffer,
129 gss_buffer_set_t *pExtensions,
132 OM_uint32 major, tmpMinor;
133 gss_buffer_set_t extensions = GSS_C_NO_BUFFER_SET;
134 OM_uint32 *types = NULL;
138 *pExtensions = GSS_C_NO_BUFFER_SET;
141 major = gss_create_empty_buffer_set(minor, &extensions);
142 if (GSS_ERROR(major))
145 if (buffer->length == 0) {
146 major = GSS_S_COMPLETE;
150 p = (unsigned char *)buffer->value;
151 remain = buffer->length;
155 gss_buffer_desc extension;
158 major = GSS_S_DEFECTIVE_TOKEN;
159 *minor = GSSEAP_TOK_TRUNC;
163 ntypes = GSSEAP_REALLOC(types,
164 (extensions->count + 1) * sizeof(OM_uint32));
165 if (ntypes == NULL) {
166 major = GSS_S_FAILURE;
172 types[extensions->count] = load_uint32_be(&p[0]);
173 extension.length = load_uint32_be(&p[4]);
175 if (remain < 8 + extension.length) {
176 major = GSS_S_DEFECTIVE_TOKEN;
177 *minor = GSSEAP_TOK_TRUNC;
180 extension.value = &p[8];
182 major = gss_add_buffer_set_member(minor, &extension, &extensions);
183 if (GSS_ERROR(major))
186 p += 8 + extension.length;
187 remain -= 8 + extension.length;
188 } while (remain != 0);
191 if (GSS_ERROR(major)) {
192 gss_release_buffer_set(&tmpMinor, &extensions);
196 *pExtensions = extensions;
204 * $Id: util_token.c 23457 2009-12-08 00:04:48Z tlyu $
207 /* XXXX this code currently makes the assumption that a mech oid will
208 never be longer than 127 bytes. This assumption is not inherent in
209 the interfaces, so the code can be fixed if the OSI namespace
210 balloons unexpectedly. */
213 * Each token looks like this:
214 * 0x60 tag for APPLICATION 0, SEQUENCE
215 * (constructed, definite-length)
216 * <length> possible multiple bytes, need to parse/generate
217 * 0x06 tag for OBJECT IDENTIFIER
218 * <moid_length> compile-time constant string (assume 1 byte)
219 * <moid_bytes> compile-time constant string
220 * <inner_bytes> the ANY containing the application token
221 * bytes 0,1 are the token type
222 * bytes 2,n are the token data
224 * Note that the token type field is a feature of RFC 1964 mechanisms and
225 * is not used by other GSSAPI mechanisms. As such, a token type of -1
226 * is interpreted to mean that no token type should be expected or
229 * For the purposes of this abstraction, the token "header" consists of
230 * the sequence tag and length octets, the mech OID DER encoding, and the
231 * first two inner bytes, which indicate the token type. The token
232 * "body" consists of everything else.
236 der_length_size(size_t length)
240 else if (length < (1<<8))
242 #if INT_MAX == 0x7fff
246 else if (length < (1<<16))
248 else if (length < (1<<24))
256 der_write_length(unsigned char **buf, size_t length)
258 if (length < (1<<7)) {
259 *(*buf)++ = (unsigned char)length;
261 *(*buf)++ = (unsigned char)(der_length_size(length)+127);
263 if (length >= (1<<24))
264 *(*buf)++ = (unsigned char)(length>>24);
265 if (length >= (1<<16))
266 *(*buf)++ = (unsigned char)((length>>16)&0xff);
268 if (length >= (1<<8))
269 *(*buf)++ = (unsigned char)((length>>8)&0xff);
270 *(*buf)++ = (unsigned char)(length&0xff);
274 /* returns decoded length, or < 0 on failure. Advances buf and
275 decrements bufsize */
278 der_read_length(unsigned char **buf, ssize_t *bufsize)
289 if ((sf &= 0x7f) > ((*bufsize)-1))
291 if (sf > sizeof(int))
295 ret = (ret<<8) + (*(*buf)++);
305 /* returns the length of a token, given the mech oid and the body size */
308 tokenSize(const gss_OID_desc *mech, size_t body_size)
310 assert(mech != GSS_C_NO_OID);
312 /* set body_size to sequence contents size */
313 body_size += 4 + (size_t) mech->length; /* NEED overflow check */
314 return 1 + der_length_size(body_size) + body_size;
317 /* fills in a buffer with the token header. The buffer is assumed to
318 be the right size. buf is advanced past the token header */
322 const gss_OID_desc *mech,
325 enum gss_eap_token_type tok_type)
328 der_write_length(buf, (tok_type == -1) ?2:4 + mech->length + body_size);
330 *(*buf)++ = (unsigned char)mech->length;
331 memcpy(*buf, mech->elements, mech->length);
332 *buf += mech->length;
333 assert(tok_type != TOK_TYPE_NONE);
334 *(*buf)++ = (unsigned char)((tok_type>>8) & 0xff);
335 *(*buf)++ = (unsigned char)(tok_type & 0xff);
339 * Given a buffer containing a token, reads and verifies the token,
340 * leaving buf advanced past the token header, and setting body_size
341 * to the number of remaining bytes. Returns 0 on success,
342 * G_BAD_TOK_HEADER for a variety of errors, and G_WRONG_MECH if the
343 * mechanism in the token does not match the mech argument. buf and
344 * *body_size are left unmodified on error.
348 verifyTokenHeader(OM_uint32 *minor,
351 unsigned char **buf_in,
353 enum gss_eap_token_type *ret_tok_type)
355 unsigned char *buf = *buf_in;
358 ssize_t toksize = (ssize_t)toksize_in;
360 *minor = GSSEAP_BAD_TOK_HEADER;
362 if (ret_tok_type != NULL)
363 *ret_tok_type = TOK_TYPE_NONE;
365 if ((toksize -= 1) < 0)
366 return GSS_S_DEFECTIVE_TOKEN;
369 return GSS_S_DEFECTIVE_TOKEN;
371 seqsize = der_read_length(&buf, &toksize);
373 return GSS_S_DEFECTIVE_TOKEN;
375 if (seqsize != toksize)
376 return GSS_S_DEFECTIVE_TOKEN;
378 if ((toksize -= 1) < 0)
379 return GSS_S_DEFECTIVE_TOKEN;
382 return GSS_S_DEFECTIVE_TOKEN;
384 if ((toksize -= 1) < 0)
385 return GSS_S_DEFECTIVE_TOKEN;
387 toid.length = *buf++;
389 if ((toksize -= toid.length) < 0)
390 return GSS_S_DEFECTIVE_TOKEN;
395 if (mech->elements == NULL) {
397 if (toid.length == 0)
398 return GSS_S_BAD_MECH;
399 } else if (!oidEqual(&toid, mech)) {
400 *minor = GSSEAP_WRONG_MECH;
401 return GSS_S_BAD_MECH;
404 if (ret_tok_type != NULL) {
405 if ((toksize -= 2) < 0)
406 return GSS_S_DEFECTIVE_TOKEN;
408 *ret_tok_type = load_uint16_be(buf);
413 *body_size = toksize;
416 return GSS_S_COMPLETE;