2 * Modifications for Lustre
4 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
6 * Copyright (c) 2011, 2014, 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/lustre_idl.h>
54 #include <lustre_net.h>
55 #include <lustre_import.h>
56 #include <lustre_sec.h>
59 #include "gss_internal.h"
65 /* TWRITE_STR from gssapiP_generic.h */
66 #define TWRITE_STR(ptr, str, len) \
67 memcpy((ptr), (char *) (str), (len)); \
70 /* XXXX this code currently makes the assumption that a mech oid will
71 never be longer than 127 bytes. This assumption is not inherent in
72 the interfaces, so the code can be fixed if the OSI namespace
73 balloons unexpectedly. */
75 /* Each token looks like this:
77 0x60 tag for APPLICATION 0, SEQUENCE
78 (constructed, definite-length)
79 <length> possible multiple bytes, need to parse/generate
80 0x06 tag for OBJECT IDENTIFIER
81 <moid_length> compile-time constant string (assume 1 byte)
82 <moid_bytes> compile-time constant string
83 <inner_bytes> the ANY containing the application token
84 bytes 0,1 are the token type
85 bytes 2,n are the token data
87 For the purposes of this abstraction, the token "header" consists of
88 the sequence tag and length octets, the mech OID DER encoding, and the
89 first two inner bytes, which indicate the token type. The token
90 "body" consists of everything else.
95 int der_length_size(int length)
97 if (length < (1 << 7))
99 else if (length < (1 << 8))
101 #if (SIZEOF_INT == 2)
105 else if (length < (1 << 16))
107 else if (length < (1 << 24))
115 void der_write_length(unsigned char **buf, int length)
117 if (length < (1 << 7)) {
118 *(*buf)++ = (unsigned char) length;
120 *(*buf)++ = (unsigned char) (der_length_size(length) + 127);
122 if (length >= (1 << 24))
123 *(*buf)++ = (unsigned char) (length >> 24);
124 if (length >= (1 << 16))
125 *(*buf)++ = (unsigned char) ((length >> 16) & 0xff);
127 if (length >= (1 << 8))
128 *(*buf)++ = (unsigned char) ((length >> 8) & 0xff);
129 *(*buf)++ = (unsigned char) (length & 0xff);
134 * returns decoded length, or < 0 on failure. Advances buf and
138 int der_read_length(unsigned char **buf, int *bufsize)
148 if ((sf &= 0x7f) > ((*bufsize) - 1))
154 ret = (ret << 8) + (*(*buf)++);
165 * returns the length of a token, given the mech oid and the body size
167 int g_token_size(rawobj_t *mech, unsigned int body_size)
169 /* set body_size to sequence contents size */
170 body_size += 4 + (int) mech->len; /* NEED overflow check */
171 return (1 + der_length_size(body_size) + body_size);
175 * fills in a buffer with the token header. The buffer is assumed to
176 * be the right size. buf is advanced past the token header
178 void g_make_token_header(rawobj_t *mech, int body_size, unsigned char **buf)
181 der_write_length(buf, 4 + mech->len + body_size);
183 *(*buf)++ = (unsigned char) mech->len;
184 TWRITE_STR(*buf, mech->data, ((int) mech->len));
188 * Given a buffer containing a token, reads and verifies the token,
189 * leaving buf advanced past the token header, and setting body_size
190 * to the number of remaining bytes. Returns 0 on success,
191 * G_BAD_TOK_HEADER for a variety of errors, and G_WRONG_MECH if the
192 * mechanism in the token does not match the mech argument. buf and
193 * *body_size are left unmodified on error.
195 __u32 g_verify_token_header(rawobj_t *mech, int *body_size,
196 unsigned char **buf_in, int toksize)
198 unsigned char *buf = *buf_in;
203 if ((toksize -= 1) < 0)
204 return (G_BAD_TOK_HEADER);
206 return (G_BAD_TOK_HEADER);
208 if ((seqsize = der_read_length(&buf, &toksize)) < 0)
209 return(G_BAD_TOK_HEADER);
211 if (seqsize != toksize)
212 return (G_BAD_TOK_HEADER);
214 if ((toksize -= 1) < 0)
215 return (G_BAD_TOK_HEADER);
217 return (G_BAD_TOK_HEADER);
219 if ((toksize -= 1) < 0)
220 return (G_BAD_TOK_HEADER);
223 if ((toksize -= toid.len) < 0)
224 return (G_BAD_TOK_HEADER);
228 if (!g_OID_equal(&toid, mech))
231 /* G_WRONG_MECH is not returned immediately because it's more
232 * important to return G_BAD_TOK_HEADER if the token header is
235 if ((toksize -= 2) < 0)
236 return (G_BAD_TOK_HEADER);
243 *body_size = toksize;
250 * Given a buffer containing a token, returns a copy of the mech oid in
251 * the parameter mech.
253 __u32 g_get_mech_oid(rawobj_t *mech, rawobj_t *in_buf)
255 unsigned char *buf = in_buf->data;
256 int len = in_buf->len;
261 return (G_BAD_TOK_HEADER);
263 return (G_BAD_TOK_HEADER);
265 if ((seqsize = der_read_length(&buf, &len)) < 0)
266 return (G_BAD_TOK_HEADER);
269 return (G_BAD_TOK_HEADER);
271 return (G_BAD_TOK_HEADER);
274 return (G_BAD_TOK_HEADER);
277 if ((len -= mech->len) < 0)
278 return (G_BAD_TOK_HEADER);
279 OBD_ALLOC_LARGE(mech->data, mech->len);
281 return (G_BUFFER_ALLOC);
282 memcpy(mech->data, buf, mech->len);