2 * Modifications for Lustre
4 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
6 * Copyright (c) 2011, Intel Corporation.
8 * Author: Eric Mei <ericm@clusterfs.com>
12 * linux/net/sunrpc/gss_generic_token.c
14 * Adapted from MIT Kerberos 5-1.2.1 lib/gssapi/generic/util_token.c
16 * Copyright (c) 2000 The Regents of the University of Michigan.
17 * All rights reserved.
19 * Andy Adamson <andros@umich.edu>
23 * Copyright 1993 by OpenVision Technologies, Inc.
25 * Permission to use, copy, modify, distribute, and sell this software
26 * and its documentation for any purpose is hereby granted without fee,
27 * provided that the above copyright notice appears in all copies and
28 * that both that copyright notice and this permission notice appear in
29 * supporting documentation, and that the name of OpenVision not be used
30 * in advertising or publicity pertaining to distribution of the software
31 * without specific, written prior permission. OpenVision makes no
32 * representations about the suitability of this software for any
33 * purpose. It is provided "as is" without express or implied warranty.
35 * OPENVISION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
36 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
37 * EVENT SHALL OPENVISION BE LIABLE FOR ANY SPECIAL, INDIRECT OR
38 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
39 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
40 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
41 * PERFORMANCE OF THIS SOFTWARE.
44 #define DEBUG_SUBSYSTEM S_SEC
45 #include <linux/init.h>
46 #include <linux/module.h>
47 #include <linux/slab.h>
48 #include <linux/mutex.h>
51 #include <obd_class.h>
52 #include <obd_support.h>
53 #include <lustre_net.h>
54 #include <lustre_import.h>
55 #include <lustre_sec.h>
58 #include "gss_internal.h"
64 /* TWRITE_STR from gssapiP_generic.h */
65 #define TWRITE_STR(ptr, str, len) \
66 memcpy((ptr), (char *) (str), (len)); \
69 /* XXXX this code currently makes the assumption that a mech oid will
70 never be longer than 127 bytes. This assumption is not inherent in
71 the interfaces, so the code can be fixed if the OSI namespace
72 balloons unexpectedly. */
74 /* Each token looks like this:
76 0x60 tag for APPLICATION 0, SEQUENCE
77 (constructed, definite-length)
78 <length> possible multiple bytes, need to parse/generate
79 0x06 tag for OBJECT IDENTIFIER
80 <moid_length> compile-time constant string (assume 1 byte)
81 <moid_bytes> compile-time constant string
82 <inner_bytes> the ANY containing the application token
83 bytes 0,1 are the token type
84 bytes 2,n are the token data
86 For the purposes of this abstraction, the token "header" consists of
87 the sequence tag and length octets, the mech OID DER encoding, and the
88 first two inner bytes, which indicate the token type. The token
89 "body" consists of everything else.
94 int der_length_size(int length)
96 if (length < (1 << 7))
98 else if (length < (1 << 8))
100 #if (SIZEOF_INT == 2)
104 else if (length < (1 << 16))
106 else if (length < (1 << 24))
114 void der_write_length(unsigned char **buf, int length)
116 if (length < (1 << 7)) {
117 *(*buf)++ = (unsigned char) length;
119 *(*buf)++ = (unsigned char) (der_length_size(length) + 127);
121 if (length >= (1 << 24))
122 *(*buf)++ = (unsigned char) (length >> 24);
123 if (length >= (1 << 16))
124 *(*buf)++ = (unsigned char) ((length >> 16) & 0xff);
126 if (length >= (1 << 8))
127 *(*buf)++ = (unsigned char) ((length >> 8) & 0xff);
128 *(*buf)++ = (unsigned char) (length & 0xff);
133 * returns decoded length, or < 0 on failure. Advances buf and
137 int der_read_length(unsigned char **buf, int *bufsize)
147 if ((sf &= 0x7f) > ((*bufsize) - 1))
153 ret = (ret << 8) + (*(*buf)++);
164 * returns the length of a token, given the mech oid and the body size
166 int g_token_size(rawobj_t *mech, unsigned int body_size)
168 /* set body_size to sequence contents size */
169 body_size += 4 + (int) mech->len; /* NEED overflow check */
170 return (1 + der_length_size(body_size) + body_size);
174 * fills in a buffer with the token header. The buffer is assumed to
175 * be the right size. buf is advanced past the token header
177 void g_make_token_header(rawobj_t *mech, int body_size, unsigned char **buf)
180 der_write_length(buf, 4 + mech->len + body_size);
182 *(*buf)++ = (unsigned char) mech->len;
183 TWRITE_STR(*buf, mech->data, ((int) mech->len));
187 * Given a buffer containing a token, reads and verifies the token,
188 * leaving buf advanced past the token header, and setting body_size
189 * to the number of remaining bytes. Returns 0 on success,
190 * G_BAD_TOK_HEADER for a variety of errors, and G_WRONG_MECH if the
191 * mechanism in the token does not match the mech argument. buf and
192 * *body_size are left unmodified on error.
194 __u32 g_verify_token_header(rawobj_t *mech, int *body_size,
195 unsigned char **buf_in, int toksize)
197 unsigned char *buf = *buf_in;
202 if ((toksize -= 1) < 0)
203 return (G_BAD_TOK_HEADER);
205 return (G_BAD_TOK_HEADER);
207 if ((seqsize = der_read_length(&buf, &toksize)) < 0)
208 return(G_BAD_TOK_HEADER);
210 if (seqsize != toksize)
211 return (G_BAD_TOK_HEADER);
213 if ((toksize -= 1) < 0)
214 return (G_BAD_TOK_HEADER);
216 return (G_BAD_TOK_HEADER);
218 if ((toksize -= 1) < 0)
219 return (G_BAD_TOK_HEADER);
222 if ((toksize -= toid.len) < 0)
223 return (G_BAD_TOK_HEADER);
227 if (!g_OID_equal(&toid, mech))
230 /* G_WRONG_MECH is not returned immediately because it's more
231 * important to return G_BAD_TOK_HEADER if the token header is
234 if ((toksize -= 2) < 0)
235 return (G_BAD_TOK_HEADER);
242 *body_size = toksize;
249 * Given a buffer containing a token, returns a copy of the mech oid in
250 * the parameter mech.
252 __u32 g_get_mech_oid(rawobj_t *mech, rawobj_t *in_buf)
254 unsigned char *buf = in_buf->data;
255 int len = in_buf->len;
260 return (G_BAD_TOK_HEADER);
262 return (G_BAD_TOK_HEADER);
264 if ((seqsize = der_read_length(&buf, &len)) < 0)
265 return (G_BAD_TOK_HEADER);
268 return (G_BAD_TOK_HEADER);
270 return (G_BAD_TOK_HEADER);
273 return (G_BAD_TOK_HEADER);
276 if ((len -= mech->len) < 0)
277 return (G_BAD_TOK_HEADER);
278 OBD_ALLOC_LARGE(mech->data, mech->len);
280 return (G_BUFFER_ALLOC);
281 memcpy(mech->data, buf, mech->len);