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
46 #include <linux/init.h>
47 #include <linux/module.h>
48 #include <linux/slab.h>
49 #include <linux/mutex.h>
51 #include <liblustre.h>
55 #include <obd_class.h>
56 #include <obd_support.h>
57 #include <lustre/lustre_idl.h>
58 #include <lustre_net.h>
59 #include <lustre_import.h>
60 #include <lustre_sec.h>
63 #include "gss_internal.h"
69 /* TWRITE_STR from gssapiP_generic.h */
70 #define TWRITE_STR(ptr, str, len) \
71 memcpy((ptr), (char *) (str), (len)); \
74 /* XXXX this code currently makes the assumption that a mech oid will
75 never be longer than 127 bytes. This assumption is not inherent in
76 the interfaces, so the code can be fixed if the OSI namespace
77 balloons unexpectedly. */
79 /* Each token looks like this:
81 0x60 tag for APPLICATION 0, SEQUENCE
82 (constructed, definite-length)
83 <length> possible multiple bytes, need to parse/generate
84 0x06 tag for OBJECT IDENTIFIER
85 <moid_length> compile-time constant string (assume 1 byte)
86 <moid_bytes> compile-time constant string
87 <inner_bytes> the ANY containing the application token
88 bytes 0,1 are the token type
89 bytes 2,n are the token data
91 For the purposes of this abstraction, the token "header" consists of
92 the sequence tag and length octets, the mech OID DER encoding, and the
93 first two inner bytes, which indicate the token type. The token
94 "body" consists of everything else.
99 int der_length_size(int length)
101 if (length < (1 << 7))
103 else if (length < (1 << 8))
105 #if (SIZEOF_INT == 2)
109 else if (length < (1 << 16))
111 else if (length < (1 << 24))
119 void der_write_length(unsigned char **buf, int length)
121 if (length < (1 << 7)) {
122 *(*buf)++ = (unsigned char) length;
124 *(*buf)++ = (unsigned char) (der_length_size(length) + 127);
126 if (length >= (1 << 24))
127 *(*buf)++ = (unsigned char) (length >> 24);
128 if (length >= (1 << 16))
129 *(*buf)++ = (unsigned char) ((length >> 16) & 0xff);
131 if (length >= (1 << 8))
132 *(*buf)++ = (unsigned char) ((length >> 8) & 0xff);
133 *(*buf)++ = (unsigned char) (length & 0xff);
138 * returns decoded length, or < 0 on failure. Advances buf and
142 int der_read_length(unsigned char **buf, int *bufsize)
152 if ((sf &= 0x7f) > ((*bufsize) - 1))
158 ret = (ret << 8) + (*(*buf)++);
169 * returns the length of a token, given the mech oid and the body size
171 int g_token_size(rawobj_t *mech, unsigned int body_size)
173 /* set body_size to sequence contents size */
174 body_size += 4 + (int) mech->len; /* NEED overflow check */
175 return (1 + der_length_size(body_size) + body_size);
179 * fills in a buffer with the token header. The buffer is assumed to
180 * be the right size. buf is advanced past the token header
182 void g_make_token_header(rawobj_t *mech, int body_size, unsigned char **buf)
185 der_write_length(buf, 4 + mech->len + body_size);
187 *(*buf)++ = (unsigned char) mech->len;
188 TWRITE_STR(*buf, mech->data, ((int) mech->len));
192 * Given a buffer containing a token, reads and verifies the token,
193 * leaving buf advanced past the token header, and setting body_size
194 * to the number of remaining bytes. Returns 0 on success,
195 * G_BAD_TOK_HEADER for a variety of errors, and G_WRONG_MECH if the
196 * mechanism in the token does not match the mech argument. buf and
197 * *body_size are left unmodified on error.
199 __u32 g_verify_token_header(rawobj_t *mech, int *body_size,
200 unsigned char **buf_in, int toksize)
202 unsigned char *buf = *buf_in;
207 if ((toksize -= 1) < 0)
208 return (G_BAD_TOK_HEADER);
210 return (G_BAD_TOK_HEADER);
212 if ((seqsize = der_read_length(&buf, &toksize)) < 0)
213 return(G_BAD_TOK_HEADER);
215 if (seqsize != toksize)
216 return (G_BAD_TOK_HEADER);
218 if ((toksize -= 1) < 0)
219 return (G_BAD_TOK_HEADER);
221 return (G_BAD_TOK_HEADER);
223 if ((toksize -= 1) < 0)
224 return (G_BAD_TOK_HEADER);
227 if ((toksize -= toid.len) < 0)
228 return (G_BAD_TOK_HEADER);
232 if (!g_OID_equal(&toid, mech))
235 /* G_WRONG_MECH is not returned immediately because it's more
236 * important to return G_BAD_TOK_HEADER if the token header is
239 if ((toksize -= 2) < 0)
240 return (G_BAD_TOK_HEADER);
247 *body_size = toksize;
254 * Given a buffer containing a token, returns a copy of the mech oid in
255 * the parameter mech.
257 __u32 g_get_mech_oid(rawobj_t *mech, rawobj_t *in_buf)
259 unsigned char *buf = in_buf->data;
260 int len = in_buf->len;
265 return (G_BAD_TOK_HEADER);
267 return (G_BAD_TOK_HEADER);
269 if ((seqsize = der_read_length(&buf, &len)) < 0)
270 return (G_BAD_TOK_HEADER);
273 return (G_BAD_TOK_HEADER);
275 return (G_BAD_TOK_HEADER);
278 return (G_BAD_TOK_HEADER);
281 if ((len -= mech->len) < 0)
282 return (G_BAD_TOK_HEADER);
283 OBD_ALLOC_LARGE(mech->data, mech->len);
285 return (G_BUFFER_ALLOC);
286 memcpy(mech->data, buf, mech->len);