1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Modifications for Lustre
5 * Copyright 2004, Cluster File Systems, Inc.
7 * Author: Eric Mei <ericm@clusterfs.com>
11 * linux/net/sunrpc/auth_gss.c
13 * RPCSEC_GSS client authentication.
15 * Copyright (c) 2000 The Regents of the University of Michigan.
16 * All rights reserved.
18 * Dug Song <dugsong@monkey.org>
19 * Andy Adamson <andros@umich.edu>
21 * Redistribution and use in source and binary forms, with or without
22 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the above copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. Neither the name of the University nor the names of its
31 * contributors may be used to endorse or promote products derived
32 * from this software without specific prior written permission.
34 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
35 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
36 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
39 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
40 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
41 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
42 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
43 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
44 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
49 # define EXPORT_SYMTAB
51 #define DEBUG_SUBSYSTEM S_SEC
53 #include <linux/init.h>
54 #include <linux/module.h>
55 #include <linux/slab.h>
56 #include <linux/dcache.h>
58 #include <linux/random.h>
61 #include <linux/sunrpc/rpc_pipe_fs.h>
63 #include <liblustre.h>
66 #include <libcfs/kp30.h>
67 #include <linux/obd.h>
68 #include <linux/obd_class.h>
69 #include <linux/obd_support.h>
70 #include <linux/lustre_idl.h>
71 #include <linux/lustre_net.h>
72 #include <linux/lustre_import.h>
73 #include <linux/lustre_sec.h>
76 #include "gss_internal.h"
79 #define LUSTRE_PIPEDIR "/lustre"
81 #define GSS_CREDCACHE_EXPIRE (30 * 60) /* 30 minute */
83 #define GSS_TIMEOUT_DELTA (5)
84 #define CRED_REFRESH_UPCALL_TIMEOUT \
86 int timeout = obd_timeout - GSS_TIMEOUT_DELTA; \
88 if (timeout < GSS_TIMEOUT_DELTA * 2) \
89 timeout = GSS_TIMEOUT_DELTA * 2; \
92 #define SECINIT_RPC_TIMEOUT \
94 int timeout = CRED_REFRESH_UPCALL_TIMEOUT - \
96 if (timeout < GSS_TIMEOUT_DELTA) \
97 timeout = GSS_TIMEOUT_DELTA; \
100 #define SECFINI_RPC_TIMEOUT (GSS_TIMEOUT_DELTA)
103 /**********************************************
104 * gss security init/fini helper *
105 **********************************************/
107 static int secinit_compose_request(struct obd_import *imp,
108 char *buf, int bufsize,
110 uid_t uid, gid_t gid,
114 struct ptlrpcs_wire_hdr *hdr;
115 struct lustre_msg *lmsg;
116 struct mds_req_sec_desc *secdesc;
117 int size = sizeof(*secdesc);
121 lmsg_size = lustre_msg_size(1, &size);
123 if (sizeof(*hdr) + lmsg_size + size_round(token_size) > bufsize) {
124 CERROR("token size %ld too large\n", token_size);
128 /* security wire hdr */
129 hdr = buf_to_sec_hdr(buf);
130 hdr->flavor = cpu_to_le32(PTLRPCS_FLVR_GSS_NONE);
131 hdr->msg_len = cpu_to_le32(lmsg_size);
132 hdr->sec_len = cpu_to_le32(8 * 4 + token_size);
134 /* lustre message & secdesc */
135 lmsg = buf_to_lustre_msg(buf);
137 lustre_init_msg(lmsg, 1, &size, NULL);
138 secdesc = lustre_msg_buf(lmsg, 0, size);
139 secdesc->rsd_uid = secdesc->rsd_fsuid = uid;
140 secdesc->rsd_gid = secdesc->rsd_fsgid = gid;
141 secdesc->rsd_cap = secdesc->rsd_ngroups = 0;
143 lmsg->handle = imp->imp_remote_handle;
144 lmsg->type = PTL_RPC_MSG_REQUEST;
145 lmsg->opc = SEC_INIT;
147 lmsg->conn_cnt = imp->imp_conn_cnt;
149 p = (__u32 *) (buf + sizeof(*hdr) + lmsg_size);
152 *p++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION); /* gss version */
153 *p++ = cpu_to_le32(PTLRPCS_FLVR_KRB5I); /* subflavor */
154 *p++ = cpu_to_le32(PTLRPCS_GSS_PROC_INIT); /* proc */
155 *p++ = cpu_to_le32(0); /* seq */
156 *p++ = cpu_to_le32(PTLRPCS_GSS_SVC_NONE); /* service */
157 *p++ = cpu_to_le32(0); /* context handle */
159 /* plus lustre svc type */
160 *p++ = cpu_to_le32(lustre_srv);
162 /* now the token part */
163 *p++ = cpu_to_le32((__u32) token_size);
164 LASSERT(((char *)p - buf) + token_size <= bufsize);
166 rc = copy_from_user(p, token, token_size);
168 CERROR("can't copy token\n");
172 rc = size_round(((char *)p - buf) + token_size);
176 static int secinit_parse_reply(char *repbuf, int replen,
177 char __user *outbuf, long outlen)
179 __u32 *p = (__u32 *)repbuf;
180 struct ptlrpcs_wire_hdr *hdr = (struct ptlrpcs_wire_hdr *) repbuf;
181 __u32 lmsg_len, sec_len, status;
182 __u32 major, minor, seq, obj_len, round_len;
185 if (replen <= (4 + 6) * 4) {
186 CERROR("reply size %d too small\n", replen);
190 hdr->flavor = le32_to_cpu(hdr->flavor);
191 hdr->msg_len = le32_to_cpu(hdr->msg_len);
192 hdr->sec_len = le32_to_cpu(hdr->sec_len);
194 lmsg_len = le32_to_cpu(p[2]);
195 sec_len = le32_to_cpu(p[3]);
198 if (hdr->flavor != PTLRPCS_FLVR_GSS_NONE) {
199 CERROR("unexpected reply\n");
202 if (hdr->msg_len % 8 ||
203 sizeof(*hdr) + hdr->msg_len + hdr->sec_len > replen) {
204 CERROR("unexpected reply\n");
207 if (hdr->sec_len > outlen) {
208 CERROR("outbuf too small\n");
212 p = (__u32 *) buf_to_sec_data(repbuf);
215 p += 2; /* skip the leading unused bytes */
216 seq = le32_to_cpu(*p++);
217 major = le32_to_cpu(*p++);
218 minor = le32_to_cpu(*p++);
223 if (copy_to_user(outbuf, &status, 4))
226 if (copy_to_user(outbuf, &major, 4))
229 if (copy_to_user(outbuf, &minor, 4))
232 if (copy_to_user(outbuf, &seq, 4))
236 obj_len = le32_to_cpu(*p++);
237 round_len = (obj_len + 3) & ~ 3;
238 if (copy_to_user(outbuf, &obj_len, 4))
241 if (copy_to_user(outbuf, (char *)p, round_len))
245 effective += 4 + round_len;
247 obj_len = le32_to_cpu(*p++);
248 round_len = (obj_len + 3) & ~ 3;
249 if (copy_to_user(outbuf, &obj_len, 4))
252 if (copy_to_user(outbuf, (char *)p, round_len))
256 effective += 4 + round_len;
261 /* XXX move to where lgssd could see */
262 struct lgssd_ioctl_param {
263 int version; /* in */
265 int lustre_svc; /* in */
268 long send_token_size;/* in */
269 char *send_token; /* in */
270 long reply_buf_size; /* in */
271 char *reply_buf; /* in */
272 long status; /* out */
273 long reply_length; /* out */
276 static int gss_send_secinit_rpc(__user char *buffer, unsigned long count)
278 struct obd_import *imp;
279 struct ptlrpc_request *request = NULL;
280 struct lgssd_ioctl_param param;
281 const int reqbuf_size = 1024;
282 const int repbuf_size = 1024;
283 char *reqbuf, *repbuf;
284 struct obd_device *obd;
287 int rc, reqlen, replen;
289 if (count != sizeof(param)) {
290 CERROR("ioctl size %lu, expect %d, please check lgssd version\n",
291 count, sizeof(param));
294 if (copy_from_user(¶m, buffer, sizeof(param))) {
295 CERROR("failed copy data from lgssd\n");
299 if (param.version != GSSD_INTERFACE_VERSION) {
300 CERROR("gssd interface version %d (expect %d)\n",
301 param.version, GSSD_INTERFACE_VERSION);
306 if (strncpy_from_user(obdname, param.uuid,
307 sizeof(obdname)) <= 0) {
308 CERROR("Invalid obdname pointer\n");
312 obd = class_name2obd(obdname);
314 CERROR("no such obd %s\n", obdname);
318 imp = class_import_get(obd->u.cli.cl_import);
320 OBD_ALLOC(reqbuf, reqbuf_size);
321 OBD_ALLOC(repbuf, reqbuf_size);
323 if (!reqbuf || !repbuf) {
324 CERROR("Can't alloc buffer: %p/%p\n", reqbuf, repbuf);
325 param.status = -ENOMEM;
330 reqlen = secinit_compose_request(imp, reqbuf, reqbuf_size,
332 param.uid, param.gid,
333 param.send_token_size,
336 param.status = reqlen;
340 request = ptl_do_rawrpc(imp, reqbuf, reqbuf_size, reqlen,
341 repbuf, repbuf_size, &replen,
342 SECINIT_RPC_TIMEOUT, &rc);
343 if (request == NULL || rc) {
348 if (replen > param.reply_buf_size) {
349 CERROR("output buffer size %ld too small, need %d\n",
350 param.reply_buf_size, replen);
351 param.status = -EINVAL;
355 lsize = secinit_parse_reply(repbuf, replen,
356 param.reply_buf, param.reply_buf_size);
358 param.status = (int) lsize;
363 param.reply_length = lsize;
366 if (copy_to_user(buffer, ¶m, sizeof(param)))
371 class_import_put(imp);
372 if (request == NULL) {
374 OBD_FREE(repbuf, repbuf_size);
376 OBD_FREE(reqbuf, reqbuf_size);
378 rawrpc_req_finished(request);
383 /**********************************************
384 * structure definitions *
385 **********************************************/
387 struct ptlrpc_sec gs_base;
388 struct gss_api_mech *gs_mech;
390 struct list_head gs_upcalls;
392 struct dentry *gs_depipe;
395 struct gss_upcall_msg_data {
404 struct gss_upcall_msg {
405 struct rpc_pipe_msg gum_base;
406 atomic_t gum_refcount;
407 struct list_head gum_list;
408 struct gss_sec *gum_gsec;
409 wait_queue_head_t gum_waitq;
410 char gum_obdname[64];
411 struct gss_upcall_msg_data gum_data;
415 static rwlock_t gss_ctx_lock = RW_LOCK_UNLOCKED;
416 /**********************************************
417 * rpc_pipe upcall helpers *
418 **********************************************/
420 void gss_release_msg(struct gss_upcall_msg *gmsg)
423 LASSERT(atomic_read(&gmsg->gum_refcount) > 0);
425 if (!atomic_dec_and_test(&gmsg->gum_refcount)) {
426 CDEBUG(D_SEC, "gmsg %p ref %d\n", gmsg,
427 atomic_read(&gmsg->gum_refcount));
431 LASSERT(list_empty(&gmsg->gum_list));
433 LASSERT(list_empty(&gmsg->gum_base.list));
436 if (!list_empty(&gmsg->gum_base.list)) {
437 int error = gmsg->gum_base.errno;
439 CWARN("msg %p: list: %p/%p/%p, copied %d, err %d, wq %d\n",
440 gmsg, &gmsg->gum_base.list, gmsg->gum_base.list.prev,
441 gmsg->gum_base.list.next, gmsg->gum_base.copied, error,
442 list_empty(&gmsg->gum_waitq.task_list));
446 OBD_FREE(gmsg, sizeof(*gmsg));
451 gss_unhash_msg_nolock(struct gss_upcall_msg *gmsg)
453 LASSERT_SPIN_LOCKED(&gmsg->gum_gsec->gs_lock);
455 if (list_empty(&gmsg->gum_list))
458 list_del_init(&gmsg->gum_list);
459 wake_up(&gmsg->gum_waitq);
460 LASSERT(atomic_read(&gmsg->gum_refcount) > 1);
461 atomic_dec(&gmsg->gum_refcount);
465 gss_unhash_msg(struct gss_upcall_msg *gmsg)
467 struct gss_sec *gsec = gmsg->gum_gsec;
469 spin_lock(&gsec->gs_lock);
470 gss_unhash_msg_nolock(gmsg);
471 spin_unlock(&gsec->gs_lock);
475 struct gss_upcall_msg * gss_find_upcall(struct gss_sec *gsec,
477 struct gss_upcall_msg_data *gmd)
479 struct gss_upcall_msg *gmsg;
482 LASSERT_SPIN_LOCKED(&gsec->gs_lock);
484 list_for_each_entry(gmsg, &gsec->gs_upcalls, gum_list) {
485 if (memcmp(&gmsg->gum_data, gmd, sizeof(*gmd)))
487 if (strcmp(gmsg->gum_obdname, obdname))
489 LASSERT(atomic_read(&gmsg->gum_refcount) > 0);
490 atomic_inc(&gmsg->gum_refcount);
491 CDEBUG(D_SEC, "found gmsg at %p: obdname %s, uid %d, ref %d\n",
492 gmsg, obdname, gmd->gum_uid,
493 atomic_read(&gmsg->gum_refcount));
499 static void gss_init_upcall_msg(struct gss_upcall_msg *gmsg,
500 struct gss_sec *gsec, char *obdname,
501 struct gss_upcall_msg_data *gmd)
503 struct rpc_pipe_msg *rpcmsg;
506 /* 2 refs: 1 for hash, 1 for current user */
507 init_waitqueue_head(&gmsg->gum_waitq);
508 list_add(&gmsg->gum_list, &gsec->gs_upcalls);
509 atomic_set(&gmsg->gum_refcount, 2);
510 gmsg->gum_gsec = gsec;
511 strncpy(gmsg->gum_obdname, obdname, sizeof(gmsg->gum_obdname));
512 memcpy(&gmsg->gum_data, gmd, sizeof(*gmd));
514 rpcmsg = &gmsg->gum_base;
515 INIT_LIST_HEAD(&rpcmsg->list);
516 rpcmsg->data = &gmsg->gum_data;
517 rpcmsg->len = sizeof(gmsg->gum_data);
522 #endif /* __KERNEL__ */
524 /* this seems to be used only from userspace code */
526 /********************************************
527 * gss cred manipulation helpers *
528 ********************************************/
530 int gss_cred_is_uptodate_ctx(struct ptlrpc_cred *cred)
532 struct gss_cred *gcred = container_of(cred, struct gss_cred, gc_base);
535 read_lock(&gss_ctx_lock);
536 if (((cred->pc_flags & PTLRPC_CRED_FLAGS_MASK) ==
537 PTLRPC_CRED_UPTODATE) &&
540 read_unlock(&gss_ctx_lock);
546 struct gss_cl_ctx *gss_get_ctx(struct gss_cl_ctx *ctx)
548 atomic_inc(&ctx->gc_refcount);
553 void gss_destroy_ctx(struct gss_cl_ctx *ctx)
557 CDEBUG(D_SEC, "destroy cl_ctx %p\n", ctx);
559 kgss_delete_sec_context(&ctx->gc_gss_ctx);
561 if (ctx->gc_wire_ctx.len > 0) {
562 OBD_FREE(ctx->gc_wire_ctx.data, ctx->gc_wire_ctx.len);
563 ctx->gc_wire_ctx.len = 0;
566 OBD_FREE(ctx, sizeof(*ctx));
570 void gss_put_ctx(struct gss_cl_ctx *ctx)
572 if (atomic_dec_and_test(&ctx->gc_refcount))
573 gss_destroy_ctx(ctx);
577 struct gss_cl_ctx *gss_cred_get_ctx(struct ptlrpc_cred *cred)
579 struct gss_cred *gcred = container_of(cred, struct gss_cred, gc_base);
580 struct gss_cl_ctx *ctx = NULL;
582 read_lock(&gss_ctx_lock);
584 ctx = gss_get_ctx(gcred->gc_ctx);
585 read_unlock(&gss_ctx_lock);
590 void gss_cred_set_ctx(struct ptlrpc_cred *cred, struct gss_cl_ctx *ctx)
592 struct gss_cred *gcred = container_of(cred, struct gss_cred, gc_base);
593 struct gss_cl_ctx *old;
597 if (kgss_inquire_context(ctx->gc_gss_ctx, &ctx_expiry)) {
598 CERROR("unable to get expire time\n");
599 ctx_expiry = 1; /* make it expired now */
601 cred->pc_expire = (unsigned long) ctx_expiry;
603 write_lock(&gss_ctx_lock);
606 set_bit(PTLRPC_CRED_UPTODATE_BIT, &cred->pc_flags);
607 write_unlock(&gss_ctx_lock);
611 CDEBUG(D_SEC, "client refreshed gss cred %p(uid %u)\n",
617 simple_get_bytes(char **buf, __u32 *buflen, void *res, __u32 reslen)
619 if (*buflen < reslen) {
620 CERROR("buflen %u < %u\n", *buflen, reslen);
624 memcpy(res, *buf, reslen);
634 * - wire_ctx (rawobj)
635 * - mech_ctx? (rawobj)
638 int gss_parse_init_downcall(struct gss_api_mech *gm, rawobj_t *buf,
639 struct gss_cl_ctx **gc,
640 struct gss_upcall_msg_data *gmd, int *gss_err)
642 char *p = (char *)buf->data;
643 struct gss_cl_ctx *ctx;
644 __u32 len = buf->len;
645 unsigned int timeout;
653 OBD_ALLOC(ctx, sizeof(*ctx));
657 ctx->gc_proc = RPC_GSS_PROC_DATA;
659 spin_lock_init(&ctx->gc_seq_lock);
660 atomic_set(&ctx->gc_refcount,1);
662 if (simple_get_bytes(&p, &len, &gmd->gum_pag, sizeof(gmd->gum_pag)))
664 if (simple_get_bytes(&p, &len, &gmd->gum_uid, sizeof(gmd->gum_uid)))
666 if (simple_get_bytes(&p, &len, &gmd->gum_svc, sizeof(gmd->gum_svc)))
668 if (simple_get_bytes(&p, &len, &gmd->gum_nal, sizeof(gmd->gum_nal)))
670 if (simple_get_bytes(&p, &len, &gmd->gum_netid, sizeof(gmd->gum_netid)))
672 if (simple_get_bytes(&p, &len, &gmd->gum_nid, sizeof(gmd->gum_nid)))
674 /* FIXME: discarded timeout for now */
675 if (simple_get_bytes(&p, &len, &timeout, sizeof(timeout)))
677 if (simple_get_bytes(&p, &len, &ctx->gc_win, sizeof(ctx->gc_win)))
680 /* lgssd signals an error by passing ctx->gc_win = 0: */
682 /* in which case the next 2 int are:
686 if (simple_get_bytes(&p, &len, &err, sizeof(err))) {
690 if (simple_get_bytes(&p, &len, gss_err, sizeof(*gss_err))) {
694 if (err == 0 && *gss_err == 0) {
695 CERROR("no error passed from downcall\n");
701 if (rawobj_extract_local(&tmp_buf, (__u32 **) ((void *)&p), &len))
703 if (rawobj_dup(&ctx->gc_wire_ctx, &tmp_buf)) {
707 if (rawobj_extract_local(&tmp_buf, (__u32 **) ((void *)&p), &len))
708 goto err_free_wire_ctx;
710 CERROR("unexpected trailing %u bytes\n", len);
711 goto err_free_wire_ctx;
713 if (kgss_import_sec_context(&tmp_buf, gm, &ctx->gc_gss_ctx))
714 goto err_free_wire_ctx;
720 if (ctx->gc_wire_ctx.data)
721 OBD_FREE(ctx->gc_wire_ctx.data, ctx->gc_wire_ctx.len);
723 OBD_FREE(ctx, sizeof(*ctx));
724 CDEBUG(D_SEC, "err_code %d, gss code %d\n", err, *gss_err);
728 /***************************************
730 ***************************************/
732 static int gss_cred_refresh(struct ptlrpc_cred *cred)
734 struct obd_import *import;
735 struct gss_sec *gsec;
736 struct gss_upcall_msg *gss_msg, *gss_new;
737 struct gss_upcall_msg_data gmd;
738 struct dentry *dentry;
739 char *obdname, *obdtype;
746 /* any flags means it has been handled, do nothing */
747 if (cred->pc_flags & PTLRPC_CRED_FLAGS_MASK)
750 LASSERT(cred->pc_sec);
751 LASSERT(cred->pc_sec->ps_import);
752 LASSERT(cred->pc_sec->ps_import->imp_obd);
754 import = cred->pc_sec->ps_import;
755 if (!import->imp_connection) {
756 CERROR("import has no connection set\n");
760 gmd.gum_pag = cred->pc_pag;
761 gmd.gum_uid = cred->pc_uid;
762 gmd.gum_nal = import->imp_connection->c_peer.peer_ni->pni_number;
764 gmd.gum_nid = import->imp_connection->c_peer.peer_id.nid;
766 obdtype = import->imp_obd->obd_type->typ_name;
767 if (!strcmp(obdtype, OBD_MDC_DEVICENAME))
768 gmd.gum_svc = LUSTRE_GSS_SVC_MDS;
769 else if (!strcmp(obdtype, OBD_OSC_DEVICENAME))
770 gmd.gum_svc = LUSTRE_GSS_SVC_OSS;
772 CERROR("gss on %s?\n", obdtype);
776 gsec = container_of(cred->pc_sec, struct gss_sec, gs_base);
777 obdname = import->imp_obd->obd_name;
778 dentry = gsec->gs_depipe;
782 CDEBUG(D_SEC, "Initiate gss context %p(%u@%s)\n",
783 container_of(cred, struct gss_cred, gc_base),
784 cred->pc_uid, import->imp_target_uuid.uuid);
787 spin_lock(&gsec->gs_lock);
788 gss_msg = gss_find_upcall(gsec, obdname, &gmd);
791 OBD_FREE(gss_new, sizeof(*gss_new));
798 spin_unlock(&gsec->gs_lock);
799 OBD_ALLOC(gss_new, sizeof(*gss_new));
804 /* so far we'v created gss_new */
805 gss_init_upcall_msg(gss_new, gsec, obdname, &gmd);
807 /* we'v created upcall msg, nobody else should touch the
808 * flag of this cred, unless be set as dead/expire by
809 * administrator via lctl etc.
811 if (cred->pc_flags & PTLRPC_CRED_FLAGS_MASK) {
812 CWARN("cred %p("LPU64"/%u) was set flags %lx unexpectedly\n",
813 cred, cred->pc_pag, cred->pc_uid, cred->pc_flags);
814 cred->pc_flags |= PTLRPC_CRED_DEAD | PTLRPC_CRED_ERROR;
815 gss_unhash_msg_nolock(gss_new);
816 spin_unlock(&gsec->gs_lock);
817 gss_release_msg(gss_new);
821 /* need to make upcall now */
822 spin_unlock(&gsec->gs_lock);
823 res = rpc_queue_upcall(dentry->d_inode, &gss_new->gum_base);
825 CERROR("rpc_queue_upcall failed: %d\n", res);
826 gss_unhash_msg(gss_new);
827 gss_release_msg(gss_new);
828 cred->pc_flags |= PTLRPC_CRED_DEAD | PTLRPC_CRED_ERROR;
832 spin_lock(&gsec->gs_lock);
835 /* upcall might finish quickly */
836 if (list_empty(&gss_msg->gum_list)) {
837 spin_unlock(&gsec->gs_lock);
842 init_waitqueue_entry(&wait, current);
843 set_current_state(TASK_INTERRUPTIBLE);
844 add_wait_queue(&gss_msg->gum_waitq, &wait);
845 spin_unlock(&gsec->gs_lock);
848 res = schedule_timeout(CRED_REFRESH_UPCALL_TIMEOUT * HZ);
854 remove_wait_queue(&gss_msg->gum_waitq, &wait);
856 /* - the one who refresh the cred for us should also be responsible
857 * to set the status of cred, we can simply return.
858 * - if cred flags has been set, we also don't need to do that again,
859 * no matter signal pending or timeout etc.
861 if (!gss_new || cred->pc_flags & PTLRPC_CRED_FLAGS_MASK)
864 if (signal_pending(current)) {
865 CERROR("%s: cred %p: interrupted upcall\n",
866 current->comm, cred);
867 cred->pc_flags |= PTLRPC_CRED_DEAD | PTLRPC_CRED_ERROR;
869 } else if (res == 0) {
870 CERROR("cred %p: upcall timedout\n", cred);
871 set_bit(PTLRPC_CRED_DEAD_BIT, &cred->pc_flags);
877 gss_release_msg(gss_msg);
881 #else /* !__KERNEL__ */
882 extern int lgss_handle_krb5_upcall(uid_t uid, __u32 dest_ip,
883 char *obd_name, char *buf, int bufsize,
884 int (*callback)(char*, unsigned long));
886 static int gss_cred_refresh(struct ptlrpc_cred *cred)
890 struct obd_import *imp;
891 struct gss_sec *gsec;
892 struct gss_api_mech *mech;
893 struct gss_cl_ctx *ctx = NULL;
898 struct gss_upcall_msg_data gmd = { 0 };
901 LASSERT(cred->pc_sec);
902 LASSERT(cred->pc_sec->ps_import);
903 LASSERT(cred->pc_sec->ps_import->imp_obd);
905 if (ptlrpcs_cred_is_uptodate(cred))
908 imp = cred->pc_sec->ps_import;
909 peer_nid = imp->imp_connection->c_peer.peer_id.nid;
910 dest_ip = (__u32) (peer_nid & 0xFFFFFFFF);
911 subflavor = cred->pc_sec->ps_flavor;
913 if (subflavor != PTLRPCS_SUBFLVR_KRB5I) {
914 CERROR("unknown subflavor %u\n", subflavor);
915 GOTO(err_out, rc = -EINVAL);
918 rc = lgss_handle_krb5_upcall(cred->pc_uid, dest_ip,
919 imp->imp_obd->obd_name,
921 gss_send_secinit_rpc);
929 gsec = container_of(cred->pc_sec, struct gss_sec, gs_base);
930 mech = gsec->gs_mech;
933 rc = gss_parse_init_downcall(mech, &obj, &ctx, &gmd,
936 CERROR("parse init downcall: rpc %d, gss 0x%x\n", rc, gss_err);
937 if (rc != -ERESTART || gss_err != 0)
938 set_bit(PTLRPC_CRED_ERROR_BIT, &cred->pc_flags);
945 gss_cred_set_ctx(cred, ctx);
946 LASSERT(gss_cred_is_uptodate_ctx(cred));
950 set_bit(PTLRPC_CRED_DEAD_BIT, &cred->pc_flags);
955 static int gss_cred_match(struct ptlrpc_cred *cred,
956 struct vfs_cred *vcred)
958 RETURN(cred->pc_pag == vcred->vc_pag);
961 static int gss_cred_sign(struct ptlrpc_cred *cred,
962 struct ptlrpc_request *req)
964 struct gss_cred *gcred;
965 struct gss_cl_ctx *ctx;
967 __u32 *vp, *vpsave, vlen, seclen;
968 __u32 seqnum, major, rc = 0;
971 LASSERT(req->rq_reqbuf);
972 LASSERT(req->rq_cred == cred);
974 gcred = container_of(cred, struct gss_cred, gc_base);
975 ctx = gss_cred_get_ctx(cred);
977 CERROR("cred %p("LPU64"/%u) invalidated?\n",
978 cred, cred->pc_pag, cred->pc_uid);
982 lmsg.len = req->rq_reqlen;
983 lmsg.data = (__u8 *) req->rq_reqmsg;
985 vp = (__u32 *) (lmsg.data + lmsg.len);
986 vlen = req->rq_reqbuf_len - sizeof(struct ptlrpcs_wire_hdr) -
990 if (vlen < 6 * 4 + size_round4(ctx->gc_wire_ctx.len)) {
991 CERROR("vlen %d, need %d\n",
992 vlen, 6 * 4 + size_round4(ctx->gc_wire_ctx.len));
997 spin_lock(&ctx->gc_seq_lock);
998 seqnum = ctx->gc_seq++;
999 spin_unlock(&ctx->gc_seq_lock);
1001 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION); /* version */
1002 *vp++ = cpu_to_le32(PTLRPCS_FLVR_KRB5I); /* subflavor */
1003 *vp++ = cpu_to_le32(ctx->gc_proc); /* proc */
1004 *vp++ = cpu_to_le32(seqnum); /* seq */
1005 *vp++ = cpu_to_le32(PTLRPCS_GSS_SVC_INTEGRITY); /* service */
1008 if (rawobj_serialize(&ctx->gc_wire_ctx, &vp, &vlen)) {
1012 CDEBUG(D_SEC, "encoded wire_ctx length %d\n", ctx->gc_wire_ctx.len);
1014 vpsave = vp++; /* reserve for size */
1018 mic.data = (unsigned char *)vp;
1020 CDEBUG(D_SEC, "reqbuf at %p, lmsg at %p, len %d, mic at %p, len %d\n",
1021 req->rq_reqbuf, lmsg.data, lmsg.len, mic.data, mic.len);
1022 major = kgss_get_mic(ctx->gc_gss_ctx, GSS_C_QOP_DEFAULT, &lmsg, &mic);
1024 CERROR("cred %p: req %p compute mic error, major %x\n",
1030 *vpsave = cpu_to_le32(mic.len);
1032 seclen = seclen - vlen + mic.len;
1033 buf_to_sec_hdr(req->rq_reqbuf)->sec_len = cpu_to_le32(seclen);
1034 req->rq_reqdata_len += size_round(seclen);
1035 CDEBUG(D_SEC, "msg size %d, checksum size %d, total sec size %d\n",
1036 lmsg.len, mic.len, seclen);
1042 static int gss_cred_verify(struct ptlrpc_cred *cred,
1043 struct ptlrpc_request *req)
1045 struct gss_cred *gcred;
1046 struct gss_cl_ctx *ctx;
1047 struct ptlrpcs_wire_hdr *sec_hdr;
1049 __u32 *vp, vlen, subflavor, proc, seq, svc;
1050 __u32 major, minor, rc;
1053 LASSERT(req->rq_repbuf);
1054 LASSERT(req->rq_cred == cred);
1056 sec_hdr = buf_to_sec_hdr(req->rq_repbuf);
1057 vp = (__u32 *) (req->rq_repbuf + sizeof(*sec_hdr) + sec_hdr->msg_len);
1058 vlen = sec_hdr->sec_len;
1061 CERROR("reply sec size %u too small\n", vlen);
1065 if (*vp++ != cpu_to_le32(PTLRPC_SEC_GSS_VERSION)) {
1066 CERROR("reply have different gss version\n");
1069 subflavor = le32_to_cpu(*vp++);
1070 proc = le32_to_cpu(*vp++);
1074 case PTLRPCS_GSS_PROC_DATA:
1075 seq = le32_to_cpu(*vp++);
1076 svc = le32_to_cpu(*vp++);
1077 if (svc != PTLRPCS_GSS_SVC_INTEGRITY) {
1078 CERROR("Unknown svc %d\n", svc);
1082 CERROR("Unexpected ctx handle\n");
1085 mic.len = le32_to_cpu(*vp++);
1087 if (vlen < mic.len) {
1088 CERROR("vlen %d, mic.len %d\n", vlen, mic.len);
1091 mic.data = (unsigned char *)vp;
1093 gcred = container_of(cred, struct gss_cred, gc_base);
1094 ctx = gss_cred_get_ctx(cred);
1097 lmsg.len = sec_hdr->msg_len;
1098 lmsg.data = (__u8 *) buf_to_lustre_msg(req->rq_repbuf);
1100 major = kgss_verify_mic(ctx->gc_gss_ctx, &lmsg, &mic, NULL);
1101 if (major != GSS_S_COMPLETE) {
1102 CERROR("cred %p: req %p verify mic error: major %x\n",
1105 if (major == GSS_S_CREDENTIALS_EXPIRED ||
1106 major == GSS_S_CONTEXT_EXPIRED) {
1107 ptlrpcs_cred_expire(cred);
1108 req->rq_ptlrpcs_restart = 1;
1113 GOTO(proc_data_out, rc);
1116 req->rq_repmsg = (struct lustre_msg *) lmsg.data;
1117 req->rq_replen = lmsg.len;
1119 /* here we could check the seq number is the same one
1120 * we sent to server. but portals has prevent us from
1121 * replay attack, so maybe we don't need check it again.
1127 case PTLRPCS_GSS_PROC_ERR:
1128 major = le32_to_cpu(*vp++);
1129 minor = le32_to_cpu(*vp++);
1130 /* server return NO_CONTEXT might be caused by context expire
1131 * or server reboot/failover. we refresh the cred transparently
1133 * In some cases, our gss handle is possible to be incidentally
1134 * identical to another handle since the handle itself is not
1135 * fully random. In krb5 case, the GSS_S_BAD_SIG will be
1136 * returned, maybe other gss error for other mechanism. Here we
1137 * only consider krb5 mech (FIXME) and try to establish new
1140 if (major == GSS_S_NO_CONTEXT ||
1141 major == GSS_S_BAD_SIG) {
1142 CWARN("req %p: server report cred %p %s\n",
1143 req, cred, (major == GSS_S_NO_CONTEXT) ?
1144 "NO_CONTEXT" : "BAD_SIG");
1146 ptlrpcs_cred_expire(cred);
1147 req->rq_ptlrpcs_restart = 1;
1150 CERROR("req %p: unrecognized gss error (%x/%x)\n",
1156 CERROR("unknown gss proc %d\n", proc);
1163 static int gss_cred_seal(struct ptlrpc_cred *cred,
1164 struct ptlrpc_request *req)
1166 struct gss_cred *gcred;
1167 struct gss_cl_ctx *ctx;
1168 struct ptlrpcs_wire_hdr *sec_hdr;
1169 rawobj_buf_t msg_buf;
1170 rawobj_t cipher_buf;
1171 __u32 *vp, *vpsave, vlen, seclen;
1172 __u32 major, seqnum, rc = 0;
1175 LASSERT(req->rq_reqbuf);
1176 LASSERT(req->rq_cred == cred);
1178 gcred = container_of(cred, struct gss_cred, gc_base);
1179 ctx = gss_cred_get_ctx(cred);
1181 CERROR("cred %p("LPU64"/%u) invalidated?\n",
1182 cred, cred->pc_pag, cred->pc_uid);
1186 vp = (__u32 *) (req->rq_reqbuf + sizeof(*sec_hdr));
1187 vlen = req->rq_reqbuf_len - sizeof(*sec_hdr);
1190 if (vlen < 6 * 4 + size_round4(ctx->gc_wire_ctx.len)) {
1191 CERROR("vlen %d, need %d\n",
1192 vlen, 6 * 4 + size_round4(ctx->gc_wire_ctx.len));
1197 spin_lock(&ctx->gc_seq_lock);
1198 seqnum = ctx->gc_seq++;
1199 spin_unlock(&ctx->gc_seq_lock);
1201 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION); /* version */
1202 *vp++ = cpu_to_le32(PTLRPCS_FLVR_KRB5P); /* subflavor */
1203 *vp++ = cpu_to_le32(ctx->gc_proc); /* proc */
1204 *vp++ = cpu_to_le32(seqnum); /* seq */
1205 *vp++ = cpu_to_le32(PTLRPCS_GSS_SVC_PRIVACY); /* service */
1208 if (rawobj_serialize(&ctx->gc_wire_ctx, &vp, &vlen)) {
1212 CDEBUG(D_SEC, "encoded wire_ctx length %d\n", ctx->gc_wire_ctx.len);
1214 vpsave = vp++; /* reserve for size */
1217 msg_buf.buf = (__u8 *) req->rq_reqmsg - GSS_PRIVBUF_PREFIX_LEN;
1218 msg_buf.buflen = req->rq_reqlen + GSS_PRIVBUF_PREFIX_LEN +
1219 GSS_PRIVBUF_SUFFIX_LEN;
1220 msg_buf.dataoff = GSS_PRIVBUF_PREFIX_LEN;
1221 msg_buf.datalen = req->rq_reqlen;
1223 cipher_buf.data = (__u8 *) vp;
1224 cipher_buf.len = vlen;
1226 major = kgss_wrap(ctx->gc_gss_ctx, GSS_C_QOP_DEFAULT,
1227 &msg_buf, &cipher_buf);
1229 CERROR("cred %p: error wrap: major 0x%x\n", cred, major);
1230 GOTO(out, rc = -EINVAL);
1233 *vpsave = cpu_to_le32(cipher_buf.len);
1235 seclen = seclen - vlen + cipher_buf.len;
1236 sec_hdr = buf_to_sec_hdr(req->rq_reqbuf);
1237 sec_hdr->sec_len = cpu_to_le32(seclen);
1238 req->rq_reqdata_len += size_round(seclen);
1240 CDEBUG(D_SEC, "msg size %d, total sec size %d\n",
1241 req->rq_reqlen, seclen);
1247 static int gss_cred_unseal(struct ptlrpc_cred *cred,
1248 struct ptlrpc_request *req)
1250 struct gss_cred *gcred;
1251 struct gss_cl_ctx *ctx;
1252 struct ptlrpcs_wire_hdr *sec_hdr;
1253 rawobj_t cipher_text, plain_text;
1254 __u32 *vp, vlen, subflavor, proc, seq, svc;
1258 LASSERT(req->rq_repbuf);
1259 LASSERT(req->rq_cred == cred);
1261 sec_hdr = buf_to_sec_hdr(req->rq_repbuf);
1262 if (sec_hdr->msg_len != 0) {
1263 CERROR("unexpected msg_len %u\n", sec_hdr->msg_len);
1267 vp = (__u32 *) (req->rq_repbuf + sizeof(*sec_hdr));
1268 vlen = sec_hdr->sec_len;
1271 CERROR("reply sec size %u too small\n", vlen);
1275 if (*vp++ != cpu_to_le32(PTLRPC_SEC_GSS_VERSION)) {
1276 CERROR("reply have different gss version\n");
1279 subflavor = le32_to_cpu(*vp++);
1280 proc = le32_to_cpu(*vp++);
1281 seq = le32_to_cpu(*vp++);
1282 svc = le32_to_cpu(*vp++);
1286 case PTLRPCS_GSS_PROC_DATA:
1287 if (svc != PTLRPCS_GSS_SVC_PRIVACY) {
1288 CERROR("Unknown svc %d\n", svc);
1292 CERROR("Unexpected ctx handle\n");
1297 cipher_text.len = le32_to_cpu(*vp++);
1298 cipher_text.data = (__u8 *) vp;
1301 if (vlen < cipher_text.len) {
1302 CERROR("cipher text to be %u while buf only %u\n",
1303 cipher_text.len, vlen);
1307 plain_text = cipher_text;
1309 gcred = container_of(cred, struct gss_cred, gc_base);
1310 ctx = gss_cred_get_ctx(cred);
1313 major = kgss_unwrap(ctx->gc_gss_ctx, GSS_C_QOP_DEFAULT,
1314 &cipher_text, &plain_text);
1316 CERROR("cred %p: error unwrap: major 0x%x\n",
1319 if (major == GSS_S_CREDENTIALS_EXPIRED ||
1320 major == GSS_S_CONTEXT_EXPIRED) {
1321 ptlrpcs_cred_expire(cred);
1322 req->rq_ptlrpcs_restart = 1;
1330 req->rq_repmsg = (struct lustre_msg *) vp;
1331 req->rq_replen = plain_text.len;
1338 CERROR("unknown gss proc %d\n", proc);
1345 static void destroy_gss_context(struct ptlrpc_cred *cred)
1347 struct ptlrpcs_wire_hdr *hdr;
1348 struct lustre_msg *lmsg;
1349 struct gss_cred *gcred;
1350 struct ptlrpc_request req;
1351 struct obd_import *imp;
1352 __u32 *vp, lmsg_size;
1353 struct ptlrpc_request *raw_req = NULL;
1354 const int repbuf_len = 256;
1359 imp = cred->pc_sec->ps_import;
1362 if (test_bit(PTLRPC_CRED_ERROR_BIT, &cred->pc_flags) ||
1363 !test_bit(PTLRPC_CRED_UPTODATE_BIT, &cred->pc_flags)) {
1364 CDEBUG(D_SEC, "Destroy dead cred %p(%u@%s)\n",
1365 cred, cred->pc_uid, imp->imp_target_uuid.uuid);
1372 /* cred's refcount is 0, steal one */
1373 atomic_inc(&cred->pc_refcount);
1375 gcred = container_of(cred, struct gss_cred, gc_base);
1376 gcred->gc_ctx->gc_proc = PTLRPCS_GSS_PROC_DESTROY;
1378 CDEBUG(D_SEC, "client destroy gss cred %p(%u@%s)\n",
1379 gcred, cred->pc_uid, imp->imp_target_uuid.uuid);
1381 lmsg_size = lustre_msg_size(0, NULL);
1382 req.rq_req_secflvr = cred->pc_sec->ps_flavor;
1384 req.rq_reqbuf_len = sizeof(*hdr) + lmsg_size +
1385 ptlrpcs_est_req_payload(&req, lmsg_size);
1387 OBD_ALLOC(req.rq_reqbuf, req.rq_reqbuf_len);
1388 if (!req.rq_reqbuf) {
1389 CERROR("Fail to alloc reqbuf, cancel anyway\n");
1390 atomic_dec(&cred->pc_refcount);
1396 hdr = buf_to_sec_hdr(req.rq_reqbuf);
1397 hdr->flavor = cpu_to_le32(PTLRPCS_FLVR_GSS_AUTH);
1398 hdr->msg_len = cpu_to_le32(lmsg_size);
1399 hdr->sec_len = cpu_to_le32(0);
1401 /* lustre message */
1402 lmsg = buf_to_lustre_msg(req.rq_reqbuf);
1403 lustre_init_msg(lmsg, 0, NULL, NULL);
1404 lmsg->handle = imp->imp_remote_handle;
1405 lmsg->type = PTL_RPC_MSG_REQUEST;
1406 lmsg->opc = SEC_FINI;
1408 lmsg->conn_cnt = imp->imp_conn_cnt;
1409 /* add this for randomize */
1410 get_random_bytes(&lmsg->last_xid, sizeof(lmsg->last_xid));
1411 get_random_bytes(&lmsg->transno, sizeof(lmsg->transno));
1413 vp = (__u32 *) req.rq_reqbuf;
1416 req.rq_reqmsg = buf_to_lustre_msg(req.rq_reqbuf);
1417 req.rq_reqlen = lmsg_size;
1418 req.rq_reqdata_len = sizeof(*hdr) + lmsg_size;
1420 if (gss_cred_sign(cred, &req)) {
1421 CERROR("failed to sign, cancel anyway\n");
1422 atomic_dec(&cred->pc_refcount);
1425 atomic_dec(&cred->pc_refcount);
1427 OBD_ALLOC(repbuf, repbuf_len);
1431 raw_req = ptl_do_rawrpc(imp, req.rq_reqbuf, req.rq_reqbuf_len,
1432 req.rq_reqdata_len, repbuf, repbuf_len, &replen,
1433 SECFINI_RPC_TIMEOUT, &rc);
1435 OBD_FREE(repbuf, repbuf_len);
1438 if (raw_req == NULL)
1439 OBD_FREE(req.rq_reqbuf, req.rq_reqbuf_len);
1441 rawrpc_req_finished(raw_req);
1445 static void gss_cred_destroy(struct ptlrpc_cred *cred)
1447 struct gss_cred *gcred;
1451 LASSERT(!atomic_read(&cred->pc_refcount));
1453 gcred = container_of(cred, struct gss_cred, gc_base);
1454 if (gcred->gc_ctx) {
1455 destroy_gss_context(cred);
1456 gss_put_ctx(gcred->gc_ctx);
1459 CDEBUG(D_SEC, "sec.gss %p: destroy cred %p\n", cred->pc_sec, gcred);
1461 OBD_FREE(gcred, sizeof(*gcred));
1465 static struct ptlrpc_credops gss_credops = {
1466 .refresh = gss_cred_refresh,
1467 .match = gss_cred_match,
1468 .sign = gss_cred_sign,
1469 .verify = gss_cred_verify,
1470 .seal = gss_cred_seal,
1471 .unseal = gss_cred_unseal,
1472 .destroy = gss_cred_destroy,
1476 /*******************************************
1478 *******************************************/
1480 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
1481 char *dst, size_t buflen)
1483 char *data = (char *)msg->data + msg->copied;
1484 ssize_t mlen = msg->len;
1490 left = copy_to_user(dst, data, mlen);
1496 msg->copied += mlen;
1502 gss_pipe_downcall(struct file *filp, const char *src, size_t mlen)
1505 const int bufsize = 1024;
1507 struct inode *inode = filp->f_dentry->d_inode;
1508 struct rpc_inode *rpci = RPC_I(inode);
1509 struct obd_import *import;
1510 struct ptlrpc_sec *sec;
1511 struct gss_sec *gsec;
1513 struct gss_api_mech *mech;
1514 struct vfs_cred vcred = { 0 };
1515 struct ptlrpc_cred *cred;
1516 struct gss_upcall_msg *gss_msg;
1517 struct gss_upcall_msg_data gmd = { 0 };
1518 struct gss_cl_ctx *ctx = NULL;
1523 if (mlen > bufsize) {
1524 CERROR("mlen %ld > bufsize %d\n", (long)mlen, bufsize);
1528 OBD_ALLOC(buf, bufsize);
1530 CERROR("alloc mem failed\n");
1534 left = copy_from_user(buf, src, mlen);
1536 GOTO(err_free, err = -EFAULT);
1538 obj.data = (unsigned char *)buf;
1541 LASSERT(rpci->private);
1542 gsec = (struct gss_sec *)rpci->private;
1543 sec = &gsec->gs_base;
1544 LASSERT(sec->ps_import);
1545 import = class_import_get(sec->ps_import);
1546 LASSERT(import->imp_obd);
1547 obdname = import->imp_obd->obd_name;
1548 mech = gsec->gs_mech;
1550 err = gss_parse_init_downcall(mech, &obj, &ctx, &gmd, &gss_err);
1552 CERROR("parse init downcall err %d\n", err);
1554 vcred.vc_pag = gmd.gum_pag;
1555 vcred.vc_uid = gmd.gum_uid;
1557 cred = ptlrpcs_cred_lookup(sec, &vcred);
1559 CWARN("didn't find cred for uid %u\n", vcred.vc_uid);
1560 GOTO(err, err = -EINVAL);
1563 if (err || gss_err) {
1564 set_bit(PTLRPC_CRED_DEAD_BIT, &cred->pc_flags);
1565 if (err != -ERESTART || gss_err != 0)
1566 set_bit(PTLRPC_CRED_ERROR_BIT, &cred->pc_flags);
1567 CERROR("cred %p: rpc err %d, gss err 0x%x, fatal %d\n",
1569 (test_bit(PTLRPC_CRED_ERROR_BIT, &cred->pc_flags) != 0));
1571 CDEBUG(D_SEC, "get initial ctx:\n");
1572 gss_cred_set_ctx(cred, ctx);
1575 spin_lock(&gsec->gs_lock);
1576 gss_msg = gss_find_upcall(gsec, obdname, &gmd);
1578 gss_unhash_msg_nolock(gss_msg);
1579 spin_unlock(&gsec->gs_lock);
1580 gss_release_msg(gss_msg);
1582 spin_unlock(&gsec->gs_lock);
1584 ptlrpcs_cred_put(cred, 1);
1585 class_import_put(import);
1586 OBD_FREE(buf, bufsize);
1590 gss_destroy_ctx(ctx);
1591 class_import_put(import);
1593 OBD_FREE(buf, bufsize);
1594 CDEBUG(D_SEC, "gss_pipe_downcall returning %d\n", err);
1599 void gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
1601 struct gss_upcall_msg *gmsg;
1602 static unsigned long ratelimit;
1605 LASSERT(list_empty(&msg->list));
1607 if (msg->errno >= 0) {
1612 gmsg = container_of(msg, struct gss_upcall_msg, gum_base);
1613 CDEBUG(D_SEC, "destroy gmsg %p\n", gmsg);
1614 LASSERT(atomic_read(&gmsg->gum_refcount) > 0);
1615 atomic_inc(&gmsg->gum_refcount);
1616 gss_unhash_msg(gmsg);
1617 if (msg->errno == -ETIMEDOUT || msg->errno == -EPIPE) {
1618 unsigned long now = get_seconds();
1619 if (time_after(now, ratelimit)) {
1620 CWARN("sec.gss upcall timed out.\n"
1621 "Please check user daemon is running!\n");
1622 ratelimit = now + 15;
1625 gss_release_msg(gmsg);
1630 void gss_pipe_release(struct inode *inode)
1632 struct rpc_inode *rpci = RPC_I(inode);
1633 struct ptlrpc_sec *sec;
1634 struct gss_sec *gsec;
1637 gsec = (struct gss_sec *)rpci->private;
1638 sec = &gsec->gs_base;
1639 spin_lock(&gsec->gs_lock);
1640 while (!list_empty(&gsec->gs_upcalls)) {
1641 struct gss_upcall_msg *gmsg;
1643 gmsg = list_entry(gsec->gs_upcalls.next,
1644 struct gss_upcall_msg, gum_list);
1645 LASSERT(list_empty(&gmsg->gum_base.list));
1646 gmsg->gum_base.errno = -EPIPE;
1647 atomic_inc(&gmsg->gum_refcount);
1648 gss_unhash_msg_nolock(gmsg);
1649 gss_release_msg(gmsg);
1651 spin_unlock(&gsec->gs_lock);
1655 static struct rpc_pipe_ops gss_upcall_ops = {
1656 .upcall = gss_pipe_upcall,
1657 .downcall = gss_pipe_downcall,
1658 .destroy_msg = gss_pipe_destroy_msg,
1659 .release_pipe = gss_pipe_release,
1661 #endif /* __KERNEL__ */
1663 /*********************************************
1664 * GSS security APIs *
1665 *********************************************/
1668 struct ptlrpc_sec* gss_create_sec(__u32 flavor,
1669 const char *pipe_dir,
1672 struct gss_sec *gsec;
1673 struct ptlrpc_sec *sec;
1682 LASSERT(SEC_FLAVOR_MAJOR(flavor) == PTLRPCS_FLVR_MAJOR_GSS);
1684 OBD_ALLOC(gsec, sizeof(*gsec));
1686 CERROR("can't alloc gsec\n");
1690 gsec->gs_mech = kgss_subflavor_to_mech(SEC_FLAVOR_SUB(flavor));
1691 if (!gsec->gs_mech) {
1692 CERROR("subflavor 0x%x not found\n", flavor);
1696 /* initialize gss sec */
1698 INIT_LIST_HEAD(&gsec->gs_upcalls);
1699 spin_lock_init(&gsec->gs_lock);
1701 pipepath_len = strlen(LUSTRE_PIPEDIR) + strlen(pipe_dir) +
1702 strlen(gsec->gs_mech->gm_name) + 3;
1703 OBD_ALLOC(gsec->gs_pipepath, pipepath_len);
1704 if (!gsec->gs_pipepath)
1707 /* pipe rpc require root permission */
1708 save_uid = current->fsuid;
1711 sprintf(gsec->gs_pipepath, LUSTRE_PIPEDIR"/%s", pipe_dir);
1712 if (IS_ERR(rpc_mkdir(gsec->gs_pipepath, NULL))) {
1713 CERROR("can't make pipedir %s\n", gsec->gs_pipepath);
1717 sprintf(gsec->gs_pipepath, LUSTRE_PIPEDIR"/%s/%s", pipe_dir,
1718 gsec->gs_mech->gm_name);
1719 gsec->gs_depipe = rpc_mkpipe(gsec->gs_pipepath, gsec,
1720 &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
1721 if (IS_ERR(gsec->gs_depipe)) {
1722 CERROR("failed to make rpc_pipe %s: %ld\n",
1723 gsec->gs_pipepath, PTR_ERR(gsec->gs_depipe));
1726 CDEBUG(D_SEC, "gss sec %p, pipe path %s\n", gsec, gsec->gs_pipepath);
1729 sec = &gsec->gs_base;
1730 sec->ps_expire = GSS_CREDCACHE_EXPIRE;
1731 sec->ps_nextgc = get_seconds() + sec->ps_expire;
1734 current->fsuid = save_uid;
1736 CDEBUG(D_SEC, "Create sec.gss %p\n", gsec);
1741 pos = strrchr(gsec->gs_pipepath, '/');
1744 rpc_rmdir(gsec->gs_pipepath);
1746 current->fsuid = save_uid;
1747 OBD_FREE(gsec->gs_pipepath, pipepath_len);
1750 kgss_mech_put(gsec->gs_mech);
1752 OBD_FREE(gsec, sizeof(*gsec));
1757 void gss_destroy_sec(struct ptlrpc_sec *sec)
1759 struct gss_sec *gsec;
1766 gsec = container_of(sec, struct gss_sec, gs_base);
1767 CDEBUG(D_SEC, "Destroy sec.gss %p\n", gsec);
1769 LASSERT(gsec->gs_mech);
1770 LASSERT(!atomic_read(&sec->ps_refcount));
1771 LASSERT(!atomic_read(&sec->ps_credcount));
1773 pipepath_len = strlen(gsec->gs_pipepath) + 1;
1774 rpc_unlink(gsec->gs_pipepath);
1775 pos = strrchr(gsec->gs_pipepath, '/');
1778 rpc_rmdir(gsec->gs_pipepath);
1779 OBD_FREE(gsec->gs_pipepath, pipepath_len);
1782 kgss_mech_put(gsec->gs_mech);
1783 OBD_FREE(gsec, sizeof(*gsec));
1788 struct ptlrpc_cred * gss_create_cred(struct ptlrpc_sec *sec,
1789 struct vfs_cred *vcred)
1791 struct gss_cred *gcred;
1792 struct ptlrpc_cred *cred;
1795 OBD_ALLOC(gcred, sizeof(*gcred));
1799 cred = &gcred->gc_base;
1800 INIT_LIST_HEAD(&cred->pc_hash);
1801 atomic_set(&cred->pc_refcount, 0);
1803 cred->pc_ops = &gss_credops;
1804 cred->pc_expire = 0;
1806 cred->pc_pag = vcred->vc_pag;
1807 cred->pc_uid = vcred->vc_uid;
1808 CDEBUG(D_SEC, "create a gss cred at %p("LPU64"/%u)\n",
1809 cred, vcred->vc_pag, vcred->vc_uid);
1814 static int gss_estimate_payload(struct ptlrpc_sec *sec,
1815 struct ptlrpc_request *req,
1818 switch (SEC_FLAVOR_SVC(req->rq_req_secflvr)) {
1819 case PTLRPCS_SVC_AUTH:
1820 return GSS_MAX_AUTH_PAYLOAD;
1821 case PTLRPCS_SVC_PRIV:
1822 return size_round16(GSS_MAX_AUTH_PAYLOAD + msgsize +
1823 GSS_PRIVBUF_PREFIX_LEN +
1824 GSS_PRIVBUF_SUFFIX_LEN);
1831 static int gss_alloc_reqbuf(struct ptlrpc_sec *sec,
1832 struct ptlrpc_request *req,
1835 int msg_payload, sec_payload;
1839 /* In PRIVACY mode, lustre message is always 0 (already encoded into
1840 * security payload).
1842 privacy = (SEC_FLAVOR_SVC(req->rq_req_secflvr) == PTLRPCS_SVC_PRIV);
1843 msg_payload = privacy ? 0 : lmsg_size;
1844 sec_payload = gss_estimate_payload(sec, req, lmsg_size);
1846 rc = sec_alloc_reqbuf(sec, req, msg_payload, sec_payload);
1851 int buflen = lmsg_size + GSS_PRIVBUF_PREFIX_LEN +
1852 GSS_PRIVBUF_SUFFIX_LEN;
1855 OBD_ALLOC(buf, buflen);
1857 CERROR("Fail to alloc %d\n", buflen);
1858 sec_free_reqbuf(sec, req);
1861 req->rq_reqmsg = (struct lustre_msg *)
1862 (buf + GSS_PRIVBUF_PREFIX_LEN);
1868 static void gss_free_reqbuf(struct ptlrpc_sec *sec,
1869 struct ptlrpc_request *req)
1875 LASSERT(req->rq_reqmsg);
1876 LASSERT(req->rq_reqlen);
1878 privacy = SEC_FLAVOR_SVC(req->rq_req_secflvr) == PTLRPCS_SVC_PRIV;
1880 buf = (char *) req->rq_reqmsg - GSS_PRIVBUF_PREFIX_LEN;
1881 LASSERT(buf < req->rq_reqbuf ||
1882 buf >= req->rq_reqbuf + req->rq_reqbuf_len);
1883 OBD_FREE(buf, req->rq_reqlen + GSS_PRIVBUF_PREFIX_LEN +
1884 GSS_PRIVBUF_SUFFIX_LEN);
1885 req->rq_reqmsg = NULL;
1888 sec_free_reqbuf(sec, req);
1891 static struct ptlrpc_secops gss_secops = {
1892 .create_sec = gss_create_sec,
1893 .destroy_sec = gss_destroy_sec,
1894 .create_cred = gss_create_cred,
1895 .est_req_payload = gss_estimate_payload,
1896 .est_rep_payload = gss_estimate_payload,
1897 .alloc_reqbuf = gss_alloc_reqbuf,
1898 .free_reqbuf = gss_free_reqbuf,
1901 static struct ptlrpc_sec_type gss_type = {
1902 .pst_owner = THIS_MODULE,
1903 .pst_name = "sec.gss",
1904 .pst_inst = ATOMIC_INIT(0),
1905 .pst_flavor = PTLRPCS_FLVR_MAJOR_GSS,
1906 .pst_ops = &gss_secops,
1910 (*lustre_secinit_downcall_handler)(char *buffer, unsigned long count);
1912 int __init ptlrpcs_gss_init(void)
1916 rc = ptlrpcs_register(&gss_type);
1923 rc = PTR_ERR(rpc_mkdir(LUSTRE_PIPEDIR, NULL));
1924 if (IS_ERR((void *)rc) && rc != -EEXIST) {
1925 CERROR("fail to make rpcpipedir for lustre\n");
1927 ptlrpcs_unregister(&gss_type);
1933 rc = init_kerberos_module();
1935 ptlrpcs_unregister(&gss_type);
1938 lustre_secinit_downcall_handler = gss_send_secinit_rpc;
1944 static void __exit ptlrpcs_gss_exit(void)
1946 lustre_secinit_downcall_handler = NULL;
1948 cleanup_kerberos_module();
1949 rpc_rmdir(LUSTRE_PIPEDIR);
1951 ptlrpcs_unregister(&gss_type);
1955 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
1956 MODULE_DESCRIPTION("GSS Security module for Lustre");
1957 MODULE_LICENSE("GPL");
1959 module_init(ptlrpcs_gss_init);
1960 module_exit(ptlrpcs_gss_exit);