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 GSS_CREDCACHE_EXPIRE (60) /* 1 minute */
80 #define GSS_CRED_EXPIRE (8 * 60 * 60) /* 8 hours */
81 #define GSS_CRED_SIGN_SIZE (1024)
82 #define GSS_CRED_VERIFY_SIZE (56)
84 #define LUSTRE_PIPEDIR "/lustre"
86 /**********************************************
87 * gss security init/fini helper *
88 **********************************************/
90 #define SECINIT_RPC_TIMEOUT (30)
91 #define SECFINI_RPC_TIMEOUT (30)
93 static int secinit_compose_request(struct obd_import *imp,
94 char *buf, int bufsize,
99 struct ptlrpcs_wire_hdr *hdr;
100 struct lustre_msg *lmsg;
101 struct mds_req_sec_desc *secdesc;
102 int size = sizeof(*secdesc);
106 lmsg_size = lustre_msg_size(1, &size);
108 if (sizeof(*hdr) + lmsg_size + size_round(token_size) > bufsize) {
109 CERROR("token size %ld too large\n", token_size);
113 /* security wire hdr */
114 hdr = buf_to_sec_hdr(buf);
115 hdr->flavor = cpu_to_le32(PTLRPC_SEC_GSS);
116 hdr->sectype = cpu_to_le32(PTLRPC_SEC_TYPE_NONE);
117 hdr->msg_len = cpu_to_le32(lmsg_size);
118 hdr->sec_len = cpu_to_le32(7 * 4 + token_size);
120 /* lustre message & secdesc */
121 lmsg = buf_to_lustre_msg(buf);
123 lustre_init_msg(lmsg, 1, &size, NULL);
124 secdesc = lustre_msg_buf(lmsg, 0, size);
125 secdesc->rsd_uid = secdesc->rsd_fsuid = uid;
126 secdesc->rsd_gid = secdesc->rsd_fsgid = gid;
127 secdesc->rsd_cap = secdesc->rsd_ngroups = 0;
129 lmsg->handle = imp->imp_remote_handle;
130 lmsg->type = PTL_RPC_MSG_REQUEST;
131 lmsg->opc = SEC_INIT;
133 lmsg->conn_cnt = imp->imp_conn_cnt;
135 p = (__u32 *) (buf + sizeof(*hdr) + lmsg_size);
138 *p++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION); /* gss version */
139 *p++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I); /* subflavor */
140 *p++ = cpu_to_le32(PTLRPC_GSS_PROC_INIT); /* proc */
141 *p++ = cpu_to_le32(0); /* seq */
142 *p++ = cpu_to_le32(PTLRPC_GSS_SVC_NONE); /* service */
143 *p++ = cpu_to_le32(0); /* context handle */
145 /* now the token part */
146 *p++ = cpu_to_le32((__u32) token_size);
147 LASSERT(((char *)p - buf) + token_size <= bufsize);
149 rc = copy_from_user(p, token, token_size);
151 CERROR("can't copy token\n");
155 rc = size_round(((char *)p - buf) + token_size);
159 static int secinit_parse_reply(char *repbuf, int replen,
160 char __user *outbuf, long outlen)
162 __u32 *p = (__u32 *)repbuf;
163 struct ptlrpcs_wire_hdr *hdr = (struct ptlrpcs_wire_hdr *) repbuf;
164 __u32 lmsg_len, sec_len, status;
165 __u32 major, minor, seq, obj_len, round_len;
168 if (replen <= (4 + 6) * 4) {
169 CERROR("reply size %d too small\n", replen);
173 hdr->flavor = le32_to_cpu(hdr->flavor);
174 hdr->sectype = le32_to_cpu(hdr->sectype);
175 hdr->msg_len = le32_to_cpu(hdr->msg_len);
176 hdr->sec_len = le32_to_cpu(hdr->sec_len);
178 lmsg_len = le32_to_cpu(p[2]);
179 sec_len = le32_to_cpu(p[3]);
182 if (hdr->flavor != PTLRPC_SEC_GSS ||
183 hdr->sectype != PTLRPC_SEC_TYPE_NONE) {
184 CERROR("unexpected reply\n");
187 if (hdr->msg_len % 8 ||
188 sizeof(*hdr) + hdr->msg_len + hdr->sec_len > replen) {
189 CERROR("unexpected reply\n");
192 if (hdr->sec_len > outlen) {
193 CERROR("outbuf too small\n");
197 p = (__u32 *) buf_to_sec_data(repbuf);
200 status = le32_to_cpu(*p++);
201 major = le32_to_cpu(*p++);
202 minor = le32_to_cpu(*p++);
203 seq = le32_to_cpu(*p++);
206 if (copy_to_user(outbuf, &status, 4))
209 if (copy_to_user(outbuf, &major, 4))
212 if (copy_to_user(outbuf, &minor, 4))
215 if (copy_to_user(outbuf, &seq, 4))
219 obj_len = le32_to_cpu(*p++);
220 round_len = (obj_len + 3) & ~ 3;
221 if (copy_to_user(outbuf, &obj_len, 4))
224 if (copy_to_user(outbuf, (char *)p, round_len))
228 effective += 4 + round_len;
230 obj_len = le32_to_cpu(*p++);
231 round_len = (obj_len + 3) & ~ 3;
232 if (copy_to_user(outbuf, &obj_len, 4))
235 if (copy_to_user(outbuf, (char *)p, round_len))
239 effective += 4 + round_len;
244 /* XXX move to where lgssd could see */
245 struct lgssd_ioctl_param {
246 int version; /* in */
250 long send_token_size;/* in */
251 char *send_token; /* in */
252 long reply_buf_size; /* in */
253 char *reply_buf; /* in */
254 long status; /* out */
255 long reply_length; /* out */
258 static int gss_send_secinit_rpc(__user char *buffer, unsigned long count)
260 struct obd_import *imp;
261 struct lgssd_ioctl_param param;
262 const int reqbuf_size = 1024;
263 const int repbuf_size = 1024;
264 char *reqbuf, *repbuf;
265 struct obd_device *obd;
268 int rc, reqlen, replen;
270 if (count != sizeof(param)) {
271 CERROR("partial write\n");
274 if (copy_from_user(¶m, buffer, sizeof(param)))
277 if (param.version != GSSD_INTERFACE_VERSION) {
278 CERROR("gssd interface version %d (expect %d)\n",
279 param.version, GSSD_INTERFACE_VERSION);
284 if (strncpy_from_user(obdname, param.uuid,
285 sizeof(obdname)) <= 0) {
286 CERROR("Invalid obdname pointer\n");
290 obd = class_name2obd(obdname);
292 CERROR("no such obd %s\n", obdname);
295 if (strcmp(obd->obd_type->typ_name, "mdc") &&
296 strcmp(obd->obd_type->typ_name, "osc")) {
297 CERROR("%s not a mdc/osc device\n", obdname);
301 imp = class_import_get(obd->u.cli.cl_import);
303 OBD_ALLOC(reqbuf, reqbuf_size);
304 OBD_ALLOC(repbuf, reqbuf_size);
306 if (!reqbuf || !repbuf) {
307 CERROR("Can't alloc buffer: %p/%p\n", reqbuf, repbuf);
308 param.status = -ENOMEM;
313 reqlen = secinit_compose_request(imp, reqbuf, reqbuf_size,
314 param.uid, param.gid,
315 param.send_token_size,
318 param.status = reqlen;
322 replen = repbuf_size;
323 rc = ptlrpc_do_rawrpc(imp, reqbuf, reqlen,
324 repbuf, &replen, SECINIT_RPC_TIMEOUT);
330 if (replen > param.reply_buf_size) {
331 CERROR("output buffer size %ld too small, need %d\n",
332 param.reply_buf_size, replen);
333 param.status = -EINVAL;
337 lsize = secinit_parse_reply(repbuf, replen,
338 param.reply_buf, param.reply_buf_size);
340 param.status = (int) lsize;
345 param.reply_length = lsize;
348 if (copy_to_user(buffer, ¶m, sizeof(param)))
353 class_import_put(imp);
355 OBD_FREE(repbuf, repbuf_size);
357 OBD_FREE(reqbuf, reqbuf_size);
361 static int gss_send_secfini_rpc(struct obd_import *imp,
362 char *reqbuf, int reqlen)
364 const int repbuf_size = 1024;
366 int replen = repbuf_size;
369 OBD_ALLOC(repbuf, repbuf_size);
371 CERROR("Out of memory\n");
375 rc = ptlrpc_do_rawrpc(imp, reqbuf, reqlen, repbuf, &replen,
376 SECFINI_RPC_TIMEOUT);
378 OBD_FREE(repbuf, repbuf_size);
382 /**********************************************
383 * structure definitions *
384 **********************************************/
386 struct ptlrpc_sec gs_base;
387 struct gss_api_mech *gs_mech;
390 struct list_head gs_upcalls;
392 struct dentry *gs_depipe;
398 static rwlock_t gss_ctx_lock = RW_LOCK_UNLOCKED;
400 struct gss_upcall_msg_data {
408 struct gss_upcall_msg {
409 struct rpc_pipe_msg gum_base;
410 atomic_t gum_refcount;
411 struct list_head gum_list;
412 struct gss_sec *gum_gsec;
413 wait_queue_head_t gum_waitq;
414 char gum_obdname[64];
415 struct gss_upcall_msg_data gum_data;
418 /**********************************************
419 * rpc_pipe upcall helpers *
420 **********************************************/
422 void gss_release_msg(struct gss_upcall_msg *gmsg)
425 LASSERT(atomic_read(&gmsg->gum_refcount) > 0);
427 if (!atomic_dec_and_test(&gmsg->gum_refcount)) {
428 CDEBUG(D_SEC, "gmsg %p ref %d\n", gmsg,
429 atomic_read(&gmsg->gum_refcount));
433 LASSERT(list_empty(&gmsg->gum_list));
434 LASSERT(list_empty(&gmsg->gum_base.list));
435 OBD_FREE(gmsg, sizeof(*gmsg));
440 gss_unhash_msg_nolock(struct gss_upcall_msg *gmsg)
443 if (list_empty(&gmsg->gum_list)) {
448 list_del_init(&gmsg->gum_list);
449 wake_up(&gmsg->gum_waitq);
450 atomic_dec(&gmsg->gum_refcount);
451 CDEBUG(D_SEC, "gmsg %p refcount now %d\n",
452 gmsg, atomic_read(&gmsg->gum_refcount));
453 LASSERT(atomic_read(&gmsg->gum_refcount) > 0);
458 gss_unhash_msg(struct gss_upcall_msg *gmsg)
460 struct gss_sec *gsec = gmsg->gum_gsec;
462 spin_lock(&gsec->gs_lock);
463 gss_unhash_msg_nolock(gmsg);
464 spin_unlock(&gsec->gs_lock);
468 struct gss_upcall_msg * gss_find_upcall(struct gss_sec *gsec,
470 struct gss_upcall_msg_data *gmd)
472 struct gss_upcall_msg *gmsg;
475 list_for_each_entry(gmsg, &gsec->gs_upcalls, gum_list) {
476 if (memcmp(&gmsg->gum_data, gmd, sizeof(*gmd)))
478 if (strcmp(gmsg->gum_obdname, obdname))
480 atomic_inc(&gmsg->gum_refcount);
481 CDEBUG(D_SEC, "found gmsg at %p: obdname %s, uid %d, ref %d\n",
482 gmsg, obdname, gmd->gum_uid,
483 atomic_read(&gmsg->gum_refcount));
489 static void gss_init_upcall_msg(struct gss_upcall_msg *gmsg,
490 struct gss_sec *gsec, char *obdname,
491 struct gss_upcall_msg_data *gmd)
493 struct rpc_pipe_msg *rpcmsg;
496 /* 2 refs: 1 for hash, 1 for current user */
497 init_waitqueue_head(&gmsg->gum_waitq);
498 list_add(&gmsg->gum_list, &gsec->gs_upcalls);
499 atomic_set(&gmsg->gum_refcount, 2);
500 gmsg->gum_gsec = gsec;
501 strncpy(gmsg->gum_obdname, obdname, sizeof(gmsg->gum_obdname));
502 memcpy(&gmsg->gum_data, gmd, sizeof(*gmd));
504 rpcmsg = &gmsg->gum_base;
505 rpcmsg->data = &gmsg->gum_data;
506 rpcmsg->len = sizeof(gmsg->gum_data);
509 #endif /* __KERNEL__ */
511 /********************************************
512 * gss cred manipulation helpers *
513 ********************************************/
516 int gss_cred_is_uptodate_ctx(struct ptlrpc_cred *cred)
518 struct gss_cred *gcred = container_of(cred, struct gss_cred, gc_base);
521 read_lock(&gss_ctx_lock);
522 if (((cred->pc_flags & PTLRPC_CRED_FLAGS_MASK) ==
523 PTLRPC_CRED_UPTODATE) &&
526 read_unlock(&gss_ctx_lock);
532 struct gss_cl_ctx * gss_get_ctx(struct gss_cl_ctx *ctx)
534 atomic_inc(&ctx->gc_refcount);
539 void gss_destroy_ctx(struct gss_cl_ctx *ctx)
543 CDEBUG(D_SEC, "destroy cl_ctx %p\n", ctx);
545 kgss_delete_sec_context(&ctx->gc_gss_ctx);
547 if (ctx->gc_wire_ctx.len > 0) {
548 OBD_FREE(ctx->gc_wire_ctx.data, ctx->gc_wire_ctx.len);
549 ctx->gc_wire_ctx.len = 0;
552 OBD_FREE(ctx, sizeof(*ctx));
556 void gss_put_ctx(struct gss_cl_ctx *ctx)
558 if (atomic_dec_and_test(&ctx->gc_refcount))
559 gss_destroy_ctx(ctx);
563 struct gss_cl_ctx *gss_cred_get_ctx(struct ptlrpc_cred *cred)
565 struct gss_cred *gcred = container_of(cred, struct gss_cred, gc_base);
566 struct gss_cl_ctx *ctx = NULL;
568 read_lock(&gss_ctx_lock);
570 ctx = gss_get_ctx(gcred->gc_ctx);
571 read_unlock(&gss_ctx_lock);
576 void gss_cred_set_ctx(struct ptlrpc_cred *cred, struct gss_cl_ctx *ctx)
578 struct gss_cred *gcred = container_of(cred, struct gss_cred, gc_base);
579 struct gss_cl_ctx *old;
583 if (kgss_inquire_context(ctx->gc_gss_ctx, &ctx_expiry)) {
584 CERROR("unable to get expire time\n");
585 ctx_expiry = 1; /* make it expired now */
587 cred->pc_expire = (unsigned long) ctx_expiry;
589 write_lock(&gss_ctx_lock);
592 cred->pc_flags |= PTLRPC_CRED_UPTODATE;
593 write_unlock(&gss_ctx_lock);
597 CDEBUG(D_SEC, "client refreshed gss cred %p(uid %u)\n",
603 simple_get_bytes(char **buf, __u32 *buflen, void *res, __u32 reslen)
605 if (*buflen < reslen) {
606 CERROR("buflen %u < %u\n", *buflen, reslen);
610 memcpy(res, *buf, reslen);
620 * - wire_ctx (rawobj)
621 * - mech_ctx? (rawobj)
624 int gss_parse_init_downcall(struct gss_api_mech *gm, rawobj_t *buf,
625 struct gss_cl_ctx **gc,
626 struct gss_upcall_msg_data *gmd, int *gss_err)
628 char *p = (char *)buf->data;
629 struct gss_cl_ctx *ctx;
630 __u32 len = buf->len;
631 unsigned int timeout;
639 OBD_ALLOC(ctx, sizeof(*ctx));
643 ctx->gc_proc = RPC_GSS_PROC_DATA;
645 spin_lock_init(&ctx->gc_seq_lock);
646 atomic_set(&ctx->gc_refcount,1);
648 if (simple_get_bytes(&p, &len, &gmd->gum_uid, sizeof(gmd->gum_uid)))
650 if (simple_get_bytes(&p, &len, &gmd->gum_svc, sizeof(gmd->gum_svc)))
652 if (simple_get_bytes(&p, &len, &gmd->gum_nal, sizeof(gmd->gum_nal)))
654 if (simple_get_bytes(&p, &len, &gmd->gum_netid, sizeof(gmd->gum_netid)))
656 if (simple_get_bytes(&p, &len, &gmd->gum_nid, sizeof(gmd->gum_nid)))
658 /* FIXME: discarded timeout for now */
659 if (simple_get_bytes(&p, &len, &timeout, sizeof(timeout)))
661 if (simple_get_bytes(&p, &len, &ctx->gc_win, sizeof(ctx->gc_win)))
664 /* lgssd signals an error by passing ctx->gc_win = 0: */
666 /* in which case the next 2 int are:
670 if (simple_get_bytes(&p, &len, &err, sizeof(err))) {
674 if (simple_get_bytes(&p, &len, gss_err, sizeof(*gss_err))) {
678 if (err == 0 && *gss_err == 0) {
679 CERROR("no error passed from downcall\n");
685 if (rawobj_extract_local(&tmp_buf, (__u32 **) ((void *)&p), &len))
687 if (rawobj_dup(&ctx->gc_wire_ctx, &tmp_buf)) {
691 if (rawobj_extract_local(&tmp_buf, (__u32 **) ((void *)&p), &len))
692 goto err_free_wire_ctx;
694 CERROR("unexpected trailing %u bytes\n", len);
695 goto err_free_wire_ctx;
697 if (kgss_import_sec_context(&tmp_buf, gm, &ctx->gc_gss_ctx))
698 goto err_free_wire_ctx;
704 if (ctx->gc_wire_ctx.data)
705 OBD_FREE(ctx->gc_wire_ctx.data, ctx->gc_wire_ctx.len);
707 OBD_FREE(ctx, sizeof(*ctx));
708 CDEBUG(D_SEC, "err_code %d, gss code %d\n", err, *gss_err);
712 /***************************************
714 ***************************************/
716 #define CRED_REFRESH_UPCALL_TIMEOUT (50)
717 static int gss_cred_refresh(struct ptlrpc_cred *cred)
719 struct obd_import *import;
720 struct gss_sec *gsec;
721 struct gss_upcall_msg *gss_msg, *gss_new;
722 struct gss_upcall_msg_data gmd;
723 struct dentry *dentry;
724 char *obdname, *obdtype;
726 uid_t uid = cred->pc_uid;
730 /* any flags means it has been handled, do nothing */
731 if (cred->pc_flags & PTLRPC_CRED_FLAGS_MASK)
734 LASSERT(cred->pc_sec);
735 LASSERT(cred->pc_sec->ps_import);
736 LASSERT(cred->pc_sec->ps_import->imp_obd);
738 import = cred->pc_sec->ps_import;
739 if (!import->imp_connection) {
740 CERROR("import has no connection set\n");
745 gmd.gum_nal = import->imp_connection->c_peer.peer_ni->pni_number;
747 gmd.gum_nid = import->imp_connection->c_peer.peer_id.nid;
749 obdtype = import->imp_obd->obd_type->typ_name;
750 if (!strcmp(obdtype, "mdc"))
752 else if (!strcmp(obdtype, "osc"))
755 CERROR("gss on %s?\n", obdtype);
759 gsec = container_of(cred->pc_sec, struct gss_sec, gs_base);
760 obdname = import->imp_obd->obd_name;
761 dentry = gsec->gs_depipe;
765 CDEBUG(D_SEC, "Initiate gss context %p(%u@%s)\n",
766 container_of(cred, struct gss_cred, gc_base),
767 uid, import->imp_target_uuid.uuid);
770 spin_lock(&gsec->gs_lock);
771 gss_msg = gss_find_upcall(gsec, obdname, &gmd);
774 OBD_FREE(gss_new, sizeof(*gss_new));
781 spin_unlock(&gsec->gs_lock);
782 OBD_ALLOC(gss_new, sizeof(*gss_new));
787 /* so far we'v created gss_new */
788 gss_init_upcall_msg(gss_new, gsec, obdname, &gmd);
790 /* we'v created upcall msg, nobody else should touch the
791 * flag of this cred, unless be set as dead/expire by
792 * administrator via lctl etc.
794 if (cred->pc_flags & PTLRPC_CRED_FLAGS_MASK) {
795 CWARN("cred %p("LPU64"/%u) was set flags %x unexpectedly\n",
796 cred, cred->pc_pag, cred->pc_uid, cred->pc_flags);
797 cred->pc_flags |= PTLRPC_CRED_DEAD | PTLRPC_CRED_ERROR;
798 gss_unhash_msg_nolock(gss_new);
799 spin_unlock(&gsec->gs_lock);
800 gss_release_msg(gss_new);
804 /* need to make upcall now */
805 spin_unlock(&gsec->gs_lock);
806 res = rpc_queue_upcall(dentry->d_inode, &gss_new->gum_base);
808 CERROR("rpc_queue_upcall failed: %d\n", res);
809 gss_unhash_msg(gss_new);
810 gss_release_msg(gss_new);
811 cred->pc_flags |= PTLRPC_CRED_DEAD | PTLRPC_CRED_ERROR;
815 spin_lock(&gsec->gs_lock);
818 /* upcall might finish quickly */
819 if (list_empty(&gss_msg->gum_list)) {
820 spin_unlock(&gsec->gs_lock);
825 init_waitqueue_entry(&wait, current);
826 set_current_state(TASK_INTERRUPTIBLE);
827 add_wait_queue(&gss_msg->gum_waitq, &wait);
828 spin_unlock(&gsec->gs_lock);
831 res = schedule_timeout(CRED_REFRESH_UPCALL_TIMEOUT * HZ);
837 remove_wait_queue(&gss_msg->gum_waitq, &wait);
839 /* - the one who refresh the cred for us should also be responsible
840 * to set the status of cred, we can simply return.
841 * - if cred flags has been set, we also don't need to do that again,
842 * no matter signal pending or timeout etc.
844 if (!gss_new || cred->pc_flags & PTLRPC_CRED_FLAGS_MASK)
847 if (signal_pending(current)) {
848 CERROR("cred %p: interrupted upcall\n", cred);
849 cred->pc_flags |= PTLRPC_CRED_DEAD | PTLRPC_CRED_ERROR;
851 } else if (res == 0) {
852 CERROR("cred %p: upcall timedout\n", cred);
853 cred->pc_flags |= PTLRPC_CRED_DEAD;
859 gss_release_msg(gss_msg);
863 #else /* !__KERNEL__ */
864 extern int lgss_handle_krb5_upcall(uid_t uid, __u32 dest_ip,
866 char *buf, int bufsize,
867 int (*callback)(char*, unsigned long));
869 static int gss_cred_refresh(struct ptlrpc_cred *cred)
873 struct obd_import *imp;
874 struct gss_sec *gsec;
875 struct gss_api_mech *mech;
876 struct gss_cl_ctx *ctx = NULL;
877 struct vfs_cred vcred = { 0 };
884 LASSERT(cred->pc_sec);
885 LASSERT(cred->pc_sec->ps_import);
886 LASSERT(cred->pc_sec->ps_import->imp_obd);
888 if (ptlrpcs_cred_is_uptodate(cred))
891 imp = cred->pc_sec->ps_import;
892 peer_nid = imp->imp_connection->c_peer.peer_id.nid;
893 dest_ip = (__u32) (peer_nid & 0xFFFFFFFF);
894 subflavor = cred->pc_sec->ps_flavor.subflavor;
896 if (subflavor != PTLRPC_SEC_GSS_KRB5I) {
897 CERROR("unknown subflavor %u\n", subflavor);
898 GOTO(err_out, rc = -EINVAL);
901 rc = lgss_handle_krb5_upcall(cred->pc_uid, dest_ip,
902 imp->imp_obd->obd_name,
904 gss_send_secinit_rpc);
912 gsec = container_of(cred->pc_sec, struct gss_sec, gs_base);
913 mech = gsec->gs_mech;
915 rc = gss_parse_init_downcall(mech, &obj, &ctx, &vcred, &dest_ip,
918 CERROR("parse init downcall: rpc %d, gss 0x%x\n", rc, gss_err);
919 if (rc != -ERESTART || gss_err != 0)
920 cred->pc_flags |= PTLRPC_CRED_ERROR;
927 gss_cred_set_ctx(cred, ctx);
928 LASSERT(gss_cred_is_uptodate_ctx(cred));
932 cred->pc_flags |= PTLRPC_CRED_DEAD;
937 static int gss_cred_match(struct ptlrpc_cred *cred,
938 struct vfs_cred *vcred)
940 RETURN(cred->pc_pag == vcred->vc_pag);
943 static int gss_cred_sign(struct ptlrpc_cred *cred,
944 struct ptlrpc_request *req)
946 struct gss_cred *gcred;
947 struct gss_cl_ctx *ctx;
949 __u32 *vp, *vpsave, vlen, seclen;
950 __u32 seqnum, major, rc = 0;
953 LASSERT(req->rq_reqbuf);
954 LASSERT(req->rq_cred == cred);
956 gcred = container_of(cred, struct gss_cred, gc_base);
957 ctx = gss_cred_get_ctx(cred);
959 CERROR("cred %p("LPU64"/%u) invalidated?\n",
960 cred, cred->pc_pag, cred->pc_uid);
964 lmsg.len = req->rq_reqlen;
965 lmsg.data = (__u8 *) req->rq_reqmsg;
967 vp = (__u32 *) (lmsg.data + lmsg.len);
968 vlen = req->rq_reqbuf_len - sizeof(struct ptlrpcs_wire_hdr) -
972 if (vlen < 6 * 4 + size_round4(ctx->gc_wire_ctx.len)) {
973 CERROR("vlen %d, need %d\n",
974 vlen, 6 * 4 + size_round4(ctx->gc_wire_ctx.len));
979 spin_lock(&ctx->gc_seq_lock);
980 seqnum = ctx->gc_seq++;
981 spin_unlock(&ctx->gc_seq_lock);
983 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION); /* version */
984 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I); /* subflavor */
985 *vp++ = cpu_to_le32(ctx->gc_proc); /* proc */
986 *vp++ = cpu_to_le32(seqnum); /* seq */
987 *vp++ = cpu_to_le32(PTLRPC_GSS_SVC_INTEGRITY); /* service */
990 if (rawobj_serialize(&ctx->gc_wire_ctx, &vp, &vlen)) {
994 CDEBUG(D_SEC, "encoded wire_ctx length %d\n", ctx->gc_wire_ctx.len);
996 vpsave = vp++; /* reserve for size */
1000 mic.data = (unsigned char *)vp;
1002 CDEBUG(D_SEC, "reqbuf at %p, lmsg at %p, len %d, mic at %p, len %d\n",
1003 req->rq_reqbuf, lmsg.data, lmsg.len, mic.data, mic.len);
1004 major = kgss_get_mic(ctx->gc_gss_ctx, GSS_C_QOP_DEFAULT, &lmsg, &mic);
1006 CERROR("gss compute mic error, major %x\n", major);
1011 *vpsave = cpu_to_le32(mic.len);
1013 seclen = seclen - vlen + mic.len;
1014 buf_to_sec_hdr(req->rq_reqbuf)->sec_len = cpu_to_le32(seclen);
1015 req->rq_reqdata_len += size_round(seclen);
1016 CDEBUG(D_SEC, "msg size %d, checksum size %d, total sec size %d\n",
1017 lmsg.len, mic.len, seclen);
1023 static int gss_cred_verify(struct ptlrpc_cred *cred,
1024 struct ptlrpc_request *req)
1026 struct gss_cred *gcred;
1027 struct gss_cl_ctx *ctx;
1028 struct ptlrpcs_wire_hdr *sec_hdr;
1030 __u32 *vp, vlen, subflavor, proc, seq, svc;
1031 __u32 major, minor, rc;
1034 LASSERT(req->rq_repbuf);
1035 LASSERT(req->rq_cred == cred);
1037 sec_hdr = buf_to_sec_hdr(req->rq_repbuf);
1038 vp = (__u32 *) (req->rq_repbuf + sizeof(*sec_hdr) + sec_hdr->msg_len);
1039 vlen = sec_hdr->sec_len;
1042 CERROR("reply sec size %u too small\n", vlen);
1046 if (*vp++ != cpu_to_le32(PTLRPC_SEC_GSS_VERSION)) {
1047 CERROR("reply have different gss version\n");
1050 subflavor = le32_to_cpu(*vp++);
1051 proc = le32_to_cpu(*vp++);
1055 case PTLRPC_GSS_PROC_DATA:
1056 seq = le32_to_cpu(*vp++);
1057 svc = le32_to_cpu(*vp++);
1058 if (svc != PTLRPC_GSS_SVC_INTEGRITY) {
1059 CERROR("Unknown svc %d\n", svc);
1063 CERROR("Unexpected ctx handle\n");
1066 mic.len = le32_to_cpu(*vp++);
1068 if (vlen < mic.len) {
1069 CERROR("vlen %d, mic.len %d\n", vlen, mic.len);
1072 mic.data = (unsigned char *)vp;
1074 gcred = container_of(cred, struct gss_cred, gc_base);
1075 ctx = gss_cred_get_ctx(cred);
1078 lmsg.len = sec_hdr->msg_len;
1079 lmsg.data = (__u8 *) buf_to_lustre_msg(req->rq_repbuf);
1081 major = kgss_verify_mic(ctx->gc_gss_ctx, &lmsg, &mic, NULL);
1082 if (major != GSS_S_COMPLETE) {
1083 CERROR("gss verify mic error: major %x\n", major);
1084 GOTO(proc_data_out, rc = -EINVAL);
1087 req->rq_repmsg = (struct lustre_msg *) lmsg.data;
1088 req->rq_replen = lmsg.len;
1090 /* here we could check the seq number is the same one
1091 * we sent to server. but portals has prevent us from
1092 * replay attack, so maybe we don't need check it again.
1098 case PTLRPC_GSS_PROC_ERR:
1099 major = le32_to_cpu(*vp++);
1100 minor = le32_to_cpu(*vp++);
1101 /* server return NO_CONTEXT might be caused by context expire
1102 * or server reboot/failover. we refresh the cred transparently
1104 * In some cases, our gss handle is possible to be incidentally
1105 * identical to another handle since the handle itself is not
1106 * fully random. In krb5 case, the GSS_S_BAD_SIG will be
1107 * returned, maybe other gss error for other mechanism. Here we
1108 * only consider krb5 mech (FIXME) and try to establish new
1111 if (major == GSS_S_NO_CONTEXT ||
1112 major == GSS_S_BAD_SIG) {
1113 CWARN("req %p: server report cred %p %s, expired?\n",
1114 req, cred, (major == GSS_S_NO_CONTEXT) ?
1115 "NO_CONTEXT" : "BAD_SIG");
1117 ptlrpcs_cred_die(cred);
1118 rc = ptlrpcs_req_replace_dead_cred(req);
1120 req->rq_ptlrpcs_restart = 1;
1122 CERROR("replace dead cred failed %d\n", rc);
1124 CERROR("req %p: unrecognized gss error (%x/%x)\n",
1130 CERROR("unknown gss proc %d\n", proc);
1137 static int gss_cred_seal(struct ptlrpc_cred *cred,
1138 struct ptlrpc_request *req)
1140 struct gss_cred *gcred;
1141 struct gss_cl_ctx *ctx;
1142 struct ptlrpcs_wire_hdr *sec_hdr;
1143 rawobj_buf_t msg_buf;
1144 rawobj_t cipher_buf;
1145 __u32 *vp, *vpsave, vlen, seclen;
1146 __u32 major, seqnum, rc = 0;
1149 LASSERT(req->rq_reqbuf);
1150 LASSERT(req->rq_cred == cred);
1152 gcred = container_of(cred, struct gss_cred, gc_base);
1153 ctx = gss_cred_get_ctx(cred);
1155 CERROR("cred %p("LPU64"/%u) invalidated?\n",
1156 cred, cred->pc_pag, cred->pc_uid);
1160 vp = (__u32 *) (req->rq_reqbuf + sizeof(*sec_hdr));
1161 vlen = req->rq_reqbuf_len - sizeof(*sec_hdr);
1164 if (vlen < 6 * 4 + size_round4(ctx->gc_wire_ctx.len)) {
1165 CERROR("vlen %d, need %d\n",
1166 vlen, 6 * 4 + size_round4(ctx->gc_wire_ctx.len));
1171 spin_lock(&ctx->gc_seq_lock);
1172 seqnum = ctx->gc_seq++;
1173 spin_unlock(&ctx->gc_seq_lock);
1175 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION); /* version */
1176 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5P); /* subflavor */
1177 *vp++ = cpu_to_le32(ctx->gc_proc); /* proc */
1178 *vp++ = cpu_to_le32(seqnum); /* seq */
1179 *vp++ = cpu_to_le32(PTLRPC_GSS_SVC_PRIVACY); /* service */
1182 if (rawobj_serialize(&ctx->gc_wire_ctx, &vp, &vlen)) {
1186 CDEBUG(D_SEC, "encoded wire_ctx length %d\n", ctx->gc_wire_ctx.len);
1188 vpsave = vp++; /* reserve for size */
1191 msg_buf.buf = (__u8 *) req->rq_reqmsg - GSS_PRIVBUF_PREFIX_LEN;
1192 msg_buf.buflen = req->rq_reqlen + GSS_PRIVBUF_PREFIX_LEN + GSS_PRIVBUF_SUFFIX_LEN;
1193 msg_buf.dataoff = GSS_PRIVBUF_PREFIX_LEN;
1194 msg_buf.datalen = req->rq_reqlen;
1196 cipher_buf.data = (__u8 *) vp;
1197 cipher_buf.len = vlen;
1199 major = kgss_wrap(ctx->gc_gss_ctx, GSS_C_QOP_DEFAULT,
1200 &msg_buf, &cipher_buf);
1202 CERROR("error wrap: major 0x%x\n", major);
1203 GOTO(out, rc = -EINVAL);
1206 *vpsave = cpu_to_le32(cipher_buf.len);
1208 seclen = seclen - vlen + cipher_buf.len;
1209 sec_hdr = buf_to_sec_hdr(req->rq_reqbuf);
1210 sec_hdr->sec_len = cpu_to_le32(seclen);
1211 req->rq_reqdata_len += size_round(seclen);
1213 CDEBUG(D_SEC, "msg size %d, total sec size %d\n",
1214 req->rq_reqlen, seclen);
1220 static int gss_cred_unseal(struct ptlrpc_cred *cred,
1221 struct ptlrpc_request *req)
1223 struct gss_cred *gcred;
1224 struct gss_cl_ctx *ctx;
1225 struct ptlrpcs_wire_hdr *sec_hdr;
1226 rawobj_t cipher_text, plain_text;
1227 __u32 *vp, vlen, subflavor, proc, seq, svc;
1231 LASSERT(req->rq_repbuf);
1232 LASSERT(req->rq_cred == cred);
1234 sec_hdr = buf_to_sec_hdr(req->rq_repbuf);
1235 if (sec_hdr->msg_len != 0) {
1236 CERROR("unexpected msg_len %u\n", sec_hdr->msg_len);
1240 vp = (__u32 *) (req->rq_repbuf + sizeof(*sec_hdr));
1241 vlen = sec_hdr->sec_len;
1244 CERROR("reply sec size %u too small\n", vlen);
1248 if (*vp++ != cpu_to_le32(PTLRPC_SEC_GSS_VERSION)) {
1249 CERROR("reply have different gss version\n");
1252 subflavor = le32_to_cpu(*vp++);
1253 proc = le32_to_cpu(*vp++);
1254 seq = le32_to_cpu(*vp++);
1255 svc = le32_to_cpu(*vp++);
1259 case PTLRPC_GSS_PROC_DATA:
1260 if (svc != PTLRPC_GSS_SVC_PRIVACY) {
1261 CERROR("Unknown svc %d\n", svc);
1265 CERROR("Unexpected ctx handle\n");
1270 cipher_text.len = le32_to_cpu(*vp++);
1271 cipher_text.data = (__u8 *) vp;
1274 if (vlen < cipher_text.len) {
1275 CERROR("cipher text to be %u while buf only %u\n",
1276 cipher_text.len, vlen);
1280 plain_text = cipher_text;
1282 gcred = container_of(cred, struct gss_cred, gc_base);
1283 ctx = gss_cred_get_ctx(cred);
1286 rc = kgss_unwrap(ctx->gc_gss_ctx, GSS_C_QOP_DEFAULT,
1287 &cipher_text, &plain_text);
1289 CERROR("error unwrap: 0x%x\n", rc);
1290 GOTO(proc_out, rc = -EINVAL);
1293 req->rq_repmsg = (struct lustre_msg *) vp;
1294 req->rq_replen = plain_text.len;
1301 CERROR("unknown gss proc %d\n", proc);
1308 static void destroy_gss_context(struct ptlrpc_cred *cred)
1310 struct ptlrpcs_wire_hdr *hdr;
1311 struct lustre_msg *lmsg;
1312 struct gss_cred *gcred;
1313 struct ptlrpc_request req;
1314 struct obd_import *imp;
1315 __u32 *vp, lmsg_size;
1318 /* cred's refcount is 0, steal one */
1319 atomic_inc(&cred->pc_refcount);
1321 gcred = container_of(cred, struct gss_cred, gc_base);
1322 gcred->gc_ctx->gc_proc = PTLRPC_GSS_PROC_DESTROY;
1323 imp = cred->pc_sec->ps_import;
1326 if (!(cred->pc_flags & PTLRPC_CRED_UPTODATE)) {
1327 CDEBUG(D_SEC, "Destroy a dead gss cred %p(%u@%s)\n",
1328 gcred, cred->pc_uid, imp->imp_target_uuid.uuid);
1329 atomic_dec(&cred->pc_refcount);
1334 CDEBUG(D_SEC, "client destroy gss cred %p(%u@%s)\n",
1335 gcred, cred->pc_uid, imp->imp_target_uuid.uuid);
1337 lmsg_size = lustre_msg_size(0, NULL);
1338 req.rq_reqbuf_len = sizeof(*hdr) + lmsg_size +
1339 ptlrpcs_est_req_payload(cred->pc_sec, lmsg_size);
1341 OBD_ALLOC(req.rq_reqbuf, req.rq_reqbuf_len);
1342 if (!req.rq_reqbuf) {
1343 CERROR("Fail to alloc reqbuf, cancel anyway\n");
1344 atomic_dec(&cred->pc_refcount);
1350 hdr = buf_to_sec_hdr(req.rq_reqbuf);
1351 hdr->flavor = cpu_to_le32(PTLRPC_SEC_GSS);
1352 hdr->sectype = cpu_to_le32(PTLRPC_SEC_TYPE_AUTH);
1353 hdr->msg_len = cpu_to_le32(lmsg_size);
1354 hdr->sec_len = cpu_to_le32(0);
1356 /* lustre message */
1357 lmsg = buf_to_lustre_msg(req.rq_reqbuf);
1358 lustre_init_msg(lmsg, 0, NULL, NULL);
1359 lmsg->handle = imp->imp_remote_handle;
1360 lmsg->type = PTL_RPC_MSG_REQUEST;
1361 lmsg->opc = SEC_FINI;
1363 lmsg->conn_cnt = imp->imp_conn_cnt;
1364 /* add this for randomize */
1365 get_random_bytes(&lmsg->last_xid, sizeof(lmsg->last_xid));
1366 get_random_bytes(&lmsg->transno, sizeof(lmsg->transno));
1368 vp = (__u32 *) req.rq_reqbuf;
1371 req.rq_reqmsg = buf_to_lustre_msg(req.rq_reqbuf);
1372 req.rq_reqlen = lmsg_size;
1373 req.rq_reqdata_len = sizeof(*hdr) + lmsg_size;
1375 if (gss_cred_sign(cred, &req)) {
1376 CERROR("failed to sign, cancel anyway\n");
1377 atomic_dec(&cred->pc_refcount);
1380 atomic_dec(&cred->pc_refcount);
1383 gss_send_secfini_rpc(imp, req.rq_reqbuf, req.rq_reqdata_len);
1385 OBD_FREE(req.rq_reqbuf, req.rq_reqbuf_len);
1389 static void gss_cred_destroy(struct ptlrpc_cred *cred)
1391 struct gss_cred *gcred;
1395 LASSERT(!atomic_read(&cred->pc_refcount));
1397 gcred = container_of(cred, struct gss_cred, gc_base);
1398 if (gcred->gc_ctx) {
1399 destroy_gss_context(cred);
1400 gss_put_ctx(gcred->gc_ctx);
1403 CDEBUG(D_SEC, "GSS_SEC: destroy cred %p\n", gcred);
1405 OBD_FREE(gcred, sizeof(*gcred));
1409 static struct ptlrpc_credops gss_credops = {
1410 .refresh = gss_cred_refresh,
1411 .match = gss_cred_match,
1412 .sign = gss_cred_sign,
1413 .verify = gss_cred_verify,
1414 .seal = gss_cred_seal,
1415 .unseal = gss_cred_unseal,
1416 .destroy = gss_cred_destroy,
1420 /*******************************************
1422 *******************************************/
1424 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
1425 char *dst, size_t buflen)
1427 char *data = (char *)msg->data + msg->copied;
1428 ssize_t mlen = msg->len;
1434 left = copy_to_user(dst, data, mlen);
1440 msg->copied += mlen;
1446 gss_pipe_downcall(struct file *filp, const char *src, size_t mlen)
1449 const int bufsize = 1024;
1451 struct inode *inode = filp->f_dentry->d_inode;
1452 struct rpc_inode *rpci = RPC_I(inode);
1453 struct obd_import *import;
1454 struct ptlrpc_sec *sec;
1455 struct gss_sec *gsec;
1457 struct gss_api_mech *mech;
1458 struct vfs_cred vcred = { 0 };
1459 struct ptlrpc_cred *cred;
1460 struct gss_upcall_msg *gss_msg;
1461 struct gss_upcall_msg_data gmd = { 0 };
1462 struct gss_cl_ctx *ctx = NULL;
1467 if (mlen > bufsize) {
1468 CERROR("mlen %ld > bufsize %d\n", (long)mlen, bufsize);
1472 OBD_ALLOC(buf, bufsize);
1474 CERROR("alloc mem failed\n");
1478 left = copy_from_user(buf, src, mlen);
1480 GOTO(err_free, err = -EFAULT);
1482 obj.data = (unsigned char *)buf;
1485 LASSERT(rpci->private);
1486 gsec = (struct gss_sec *)rpci->private;
1487 sec = &gsec->gs_base;
1488 LASSERT(sec->ps_import);
1489 import = class_import_get(sec->ps_import);
1490 LASSERT(import->imp_obd);
1491 obdname = import->imp_obd->obd_name;
1492 mech = gsec->gs_mech;
1494 err = gss_parse_init_downcall(mech, &obj, &ctx, &gmd, &gss_err);
1496 CERROR("parse init downcall err %d\n", err);
1498 vcred.vc_uid = gmd.gum_uid;
1499 vcred.vc_pag = vcred.vc_uid; /* FIXME */
1501 cred = ptlrpcs_cred_lookup(sec, &vcred);
1503 CWARN("didn't find cred for uid %u\n", vcred.vc_uid);
1504 GOTO(err, err = -EINVAL);
1507 if (err || gss_err) {
1508 cred->pc_flags |= PTLRPC_CRED_DEAD;
1509 if (err != -ERESTART || gss_err != 0)
1510 cred->pc_flags |= PTLRPC_CRED_ERROR;
1511 CERROR("cred %p: rpc err %d, gss err 0x%x, fatal %d\n",
1513 ((cred->pc_flags & PTLRPC_CRED_ERROR) != 0));
1515 CDEBUG(D_SEC, "get initial ctx:\n");
1516 gss_cred_set_ctx(cred, ctx);
1519 spin_lock(&gsec->gs_lock);
1520 gss_msg = gss_find_upcall(gsec, obdname, &gmd);
1522 gss_unhash_msg_nolock(gss_msg);
1523 spin_unlock(&gsec->gs_lock);
1524 gss_release_msg(gss_msg);
1526 spin_unlock(&gsec->gs_lock);
1528 ptlrpcs_cred_put(cred, 1);
1529 class_import_put(import);
1530 OBD_FREE(buf, bufsize);
1534 gss_destroy_ctx(ctx);
1535 class_import_put(import);
1537 OBD_FREE(buf, bufsize);
1538 CDEBUG(D_SEC, "gss_pipe_downcall returning %d\n", err);
1543 void gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
1545 struct gss_upcall_msg *gmsg;
1546 static unsigned long ratelimit;
1549 if (msg->errno >= 0) {
1554 gmsg = container_of(msg, struct gss_upcall_msg, gum_base);
1555 CDEBUG(D_SEC, "destroy gmsg %p\n", gmsg);
1556 atomic_inc(&gmsg->gum_refcount);
1557 gss_unhash_msg(gmsg);
1558 if (msg->errno == -ETIMEDOUT || msg->errno == -EPIPE) {
1559 unsigned long now = get_seconds();
1560 if (time_after(now, ratelimit)) {
1561 CWARN("GSS_SEC upcall timed out.\n"
1562 "Please check user daemon is running!\n");
1563 ratelimit = now + 15;
1566 gss_release_msg(gmsg);
1571 void gss_pipe_release(struct inode *inode)
1573 struct rpc_inode *rpci = RPC_I(inode);
1574 struct ptlrpc_sec *sec;
1575 struct gss_sec *gsec;
1578 gsec = (struct gss_sec *)rpci->private;
1579 sec = &gsec->gs_base;
1580 spin_lock(&gsec->gs_lock);
1581 while (!list_empty(&gsec->gs_upcalls)) {
1582 struct gss_upcall_msg *gmsg;
1584 gmsg = list_entry(gsec->gs_upcalls.next,
1585 struct gss_upcall_msg, gum_list);
1586 gmsg->gum_base.errno = -EPIPE;
1587 atomic_inc(&gmsg->gum_refcount);
1588 gss_unhash_msg_nolock(gmsg);
1589 gss_release_msg(gmsg);
1591 spin_unlock(&gsec->gs_lock);
1595 static struct rpc_pipe_ops gss_upcall_ops = {
1596 .upcall = gss_pipe_upcall,
1597 .downcall = gss_pipe_downcall,
1598 .destroy_msg = gss_pipe_destroy_msg,
1599 .release_pipe = gss_pipe_release,
1601 #endif /* __KERNEL__ */
1603 /*********************************************
1604 * GSS security APIs *
1605 *********************************************/
1608 struct ptlrpc_sec* gss_create_sec(ptlrpcs_flavor_t *flavor,
1609 const char *pipe_dir,
1612 struct gss_sec *gsec;
1613 struct ptlrpc_sec *sec;
1620 LASSERT(flavor->flavor == PTLRPC_SEC_GSS);
1622 OBD_ALLOC(gsec, sizeof(*gsec));
1624 CERROR("can't alloc gsec\n");
1628 gsec->gs_mech = kgss_subflavor_to_mech(flavor->subflavor);
1629 if (!gsec->gs_mech) {
1630 CERROR("subflavor %d not found\n", flavor->subflavor);
1634 /* initialize gss sec */
1636 INIT_LIST_HEAD(&gsec->gs_upcalls);
1637 spin_lock_init(&gsec->gs_lock);
1639 pipepath_len = strlen(LUSTRE_PIPEDIR) + strlen(pipe_dir) +
1640 strlen(gsec->gs_mech->gm_name) + 3;
1641 OBD_ALLOC(gsec->gs_pipepath, pipepath_len);
1642 if (!gsec->gs_pipepath)
1645 sprintf(gsec->gs_pipepath, LUSTRE_PIPEDIR"/%s", pipe_dir);
1646 if (IS_ERR(rpc_mkdir(gsec->gs_pipepath, NULL))) {
1647 CERROR("can't make pipedir %s\n", gsec->gs_pipepath);
1651 sprintf(gsec->gs_pipepath, LUSTRE_PIPEDIR"/%s/%s", pipe_dir,
1652 gsec->gs_mech->gm_name);
1653 gsec->gs_depipe = rpc_mkpipe(gsec->gs_pipepath, gsec,
1654 &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
1655 if (IS_ERR(gsec->gs_depipe)) {
1656 CERROR("failed to make rpc_pipe %s: %ld\n",
1657 gsec->gs_pipepath, PTR_ERR(gsec->gs_depipe));
1660 CDEBUG(D_SEC, "gss sec %p, pipe path %s\n", gsec, gsec->gs_pipepath);
1663 sec = &gsec->gs_base;
1665 switch (flavor->subflavor) {
1666 case PTLRPC_SEC_GSS_KRB5I:
1667 sec->ps_sectype = PTLRPC_SEC_TYPE_AUTH;
1669 case PTLRPC_SEC_GSS_KRB5P:
1670 sec->ps_sectype = PTLRPC_SEC_TYPE_PRIV;
1676 sec->ps_expire = GSS_CREDCACHE_EXPIRE;
1677 sec->ps_nextgc = get_seconds() + sec->ps_expire;
1680 CDEBUG(D_SEC, "Create GSS security instance at %p(external %p)\n",
1686 pos = strrchr(gsec->gs_pipepath, '/');
1689 rpc_rmdir(gsec->gs_pipepath);
1691 OBD_FREE(gsec->gs_pipepath, pipepath_len);
1694 kgss_mech_put(gsec->gs_mech);
1696 OBD_FREE(gsec, sizeof(*gsec));
1701 void gss_destroy_sec(struct ptlrpc_sec *sec)
1703 struct gss_sec *gsec;
1710 gsec = container_of(sec, struct gss_sec, gs_base);
1711 CDEBUG(D_SEC, "Destroy GSS security instance at %p\n", gsec);
1713 LASSERT(gsec->gs_mech);
1714 LASSERT(!atomic_read(&sec->ps_refcount));
1715 LASSERT(!atomic_read(&sec->ps_credcount));
1717 pipepath_len = strlen(gsec->gs_pipepath) + 1;
1718 rpc_unlink(gsec->gs_pipepath);
1719 pos = strrchr(gsec->gs_pipepath, '/');
1722 rpc_rmdir(gsec->gs_pipepath);
1723 OBD_FREE(gsec->gs_pipepath, pipepath_len);
1726 kgss_mech_put(gsec->gs_mech);
1727 OBD_FREE(gsec, sizeof(*gsec));
1732 struct ptlrpc_cred * gss_create_cred(struct ptlrpc_sec *sec,
1733 struct vfs_cred *vcred)
1735 struct gss_cred *gcred;
1736 struct ptlrpc_cred *cred;
1739 OBD_ALLOC(gcred, sizeof(*gcred));
1743 cred = &gcred->gc_base;
1744 INIT_LIST_HEAD(&cred->pc_hash);
1745 atomic_set(&cred->pc_refcount, 0);
1747 cred->pc_ops = &gss_credops;
1748 cred->pc_expire = get_seconds() + GSS_CRED_EXPIRE;
1750 cred->pc_pag = vcred->vc_pag;
1751 cred->pc_uid = vcred->vc_uid;
1752 CDEBUG(D_SEC, "create a gss cred at %p("LPU64"/%u)\n",
1753 cred, vcred->vc_pag, vcred->vc_uid);
1758 static int gss_estimate_payload(struct ptlrpc_sec *sec, int msgsize)
1760 switch (sec->ps_sectype) {
1761 case PTLRPC_SEC_TYPE_AUTH:
1762 return GSS_MAX_AUTH_PAYLOAD;
1763 case PTLRPC_SEC_TYPE_PRIV:
1764 return size_round16(GSS_MAX_AUTH_PAYLOAD + msgsize +
1765 GSS_PRIVBUF_PREFIX_LEN +
1766 GSS_PRIVBUF_SUFFIX_LEN);
1773 static int gss_alloc_reqbuf(struct ptlrpc_sec *sec,
1774 struct ptlrpc_request *req,
1777 int msg_payload, sec_payload;
1781 /* In PRIVACY mode, lustre message is always 0 (already encoded into
1782 * security payload).
1784 privacy = sec->ps_sectype == PTLRPC_SEC_TYPE_PRIV;
1785 msg_payload = privacy ? 0 : lmsg_size;
1786 sec_payload = gss_estimate_payload(sec, lmsg_size);
1788 rc = sec_alloc_reqbuf(sec, req, msg_payload, sec_payload);
1793 int buflen = lmsg_size + GSS_PRIVBUF_PREFIX_LEN +
1794 GSS_PRIVBUF_SUFFIX_LEN;
1797 OBD_ALLOC(buf, buflen);
1799 CERROR("Fail to alloc %d\n", buflen);
1800 sec_free_reqbuf(sec, req);
1803 req->rq_reqmsg = (struct lustre_msg *)
1804 (buf + GSS_PRIVBUF_PREFIX_LEN);
1810 static void gss_free_reqbuf(struct ptlrpc_sec *sec,
1811 struct ptlrpc_request *req)
1817 LASSERT(req->rq_reqmsg);
1818 LASSERT(req->rq_reqlen);
1820 privacy = sec->ps_sectype == PTLRPC_SEC_TYPE_PRIV;
1822 buf = (char *) req->rq_reqmsg - GSS_PRIVBUF_PREFIX_LEN;
1823 LASSERT(buf < req->rq_reqbuf ||
1824 buf >= req->rq_reqbuf + req->rq_reqbuf_len);
1825 OBD_FREE(buf, req->rq_reqlen + GSS_PRIVBUF_PREFIX_LEN +
1826 GSS_PRIVBUF_SUFFIX_LEN);
1827 req->rq_reqmsg = NULL;
1830 sec_free_reqbuf(sec, req);
1833 static struct ptlrpc_secops gss_secops = {
1834 .create_sec = gss_create_sec,
1835 .destroy_sec = gss_destroy_sec,
1836 .create_cred = gss_create_cred,
1837 .est_req_payload = gss_estimate_payload,
1838 .est_rep_payload = gss_estimate_payload,
1839 .alloc_reqbuf = gss_alloc_reqbuf,
1840 .free_reqbuf = gss_free_reqbuf,
1843 static struct ptlrpc_sec_type gss_type = {
1844 .pst_owner = THIS_MODULE,
1845 .pst_name = "GSS_SEC",
1846 .pst_inst = ATOMIC_INIT(0),
1847 .pst_flavor = {PTLRPC_SEC_GSS, 0},
1848 .pst_ops = &gss_secops,
1852 (*lustre_secinit_downcall_handler)(char *buffer, unsigned long count);
1854 int __init ptlrpcs_gss_init(void)
1858 rc = ptlrpcs_register(&gss_type);
1865 rc = PTR_ERR(rpc_mkdir(LUSTRE_PIPEDIR, NULL));
1866 if (IS_ERR((void *)rc) && rc != -EEXIST) {
1867 CERROR("fail to make rpcpipedir for lustre\n");
1869 ptlrpcs_unregister(&gss_type);
1875 rc = init_kerberos_module();
1877 ptlrpcs_unregister(&gss_type);
1880 lustre_secinit_downcall_handler = gss_send_secinit_rpc;
1886 static void __exit ptlrpcs_gss_exit(void)
1888 lustre_secinit_downcall_handler = NULL;
1890 cleanup_kerberos_module();
1891 rpc_rmdir(LUSTRE_PIPEDIR);
1893 ptlrpcs_unregister(&gss_type);
1897 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
1898 MODULE_DESCRIPTION("GSS Security module for Lustre");
1899 MODULE_LICENSE("GPL");
1901 module_init(ptlrpcs_gss_init);
1902 module_exit(ptlrpcs_gss_exit);