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 - 2006, 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>
59 #include <linux/mutex.h>
60 #include <linux/crypto.h>
61 #include <asm/atomic.h>
62 struct rpc_clnt; /* for rpc_pipefs */
63 #include <linux/sunrpc/rpc_pipe_fs.h>
65 #include <liblustre.h>
69 #include <obd_class.h>
70 #include <obd_support.h>
71 #include <lustre/lustre_idl.h>
72 #include <lustre_sec.h>
73 #include <lustre_net.h>
74 #include <lustre_import.h>
77 #include "gss_internal.h"
80 static struct ptlrpc_sec_policy gss_policy_pipefs;
81 static struct ptlrpc_ctx_ops gss_pipefs_ctxops;
83 static int gss_cli_ctx_refresh_pf(struct ptlrpc_cli_ctx *ctx);
85 static int gss_sec_pipe_upcall_init(struct gss_sec *gsec)
90 static void gss_sec_pipe_upcall_fini(struct gss_sec *gsec)
94 /****************************************
95 * internel context helpers *
96 ****************************************/
99 struct ptlrpc_cli_ctx *ctx_create_pf(struct ptlrpc_sec *sec,
100 struct vfs_cred *vcred)
102 struct gss_cli_ctx *gctx;
108 if (gss_cli_ctx_init_common(sec, &gctx->gc_base, &gss_pipefs_ctxops,
114 return &gctx->gc_base;
118 void ctx_destroy_pf(struct ptlrpc_sec *sec, struct ptlrpc_cli_ctx *ctx)
120 struct gss_cli_ctx *gctx = ctx2gctx(ctx);
123 rc = gss_cli_ctx_fini_common(sec, ctx);
127 CWARN("released the last ctx, proceed to destroy sec %s@%p\n",
128 sec->ps_policy->sp_name, sec);
129 sptlrpc_sec_destroy(sec);
134 void ctx_enhash_pf(struct ptlrpc_cli_ctx *ctx, struct hlist_head *hash)
136 set_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags);
137 atomic_inc(&ctx->cc_refcount);
138 hlist_add_head(&ctx->cc_hash, hash);
142 * caller must hold spinlock
145 void ctx_unhash_pf(struct ptlrpc_cli_ctx *ctx, struct hlist_head *freelist)
147 LASSERT_SPIN_LOCKED(&ctx->cc_sec->ps_lock);
148 LASSERT(atomic_read(&ctx->cc_refcount) > 0);
149 LASSERT(test_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags));
150 LASSERT(!hlist_unhashed(&ctx->cc_hash));
152 clear_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags);
154 if (atomic_dec_and_test(&ctx->cc_refcount)) {
155 __hlist_del(&ctx->cc_hash);
156 hlist_add_head(&ctx->cc_hash, freelist);
158 hlist_del_init(&ctx->cc_hash);
162 * return 1 if the context is dead.
165 int ctx_check_death_pf(struct ptlrpc_cli_ctx *ctx, struct hlist_head *freelist)
167 if (cli_ctx_check_death(ctx)) {
169 ctx_unhash_pf(ctx, freelist);
177 int ctx_check_death_locked_pf(struct ptlrpc_cli_ctx *ctx,
178 struct hlist_head *freelist)
180 LASSERT(ctx->cc_sec);
181 LASSERT(atomic_read(&ctx->cc_refcount) > 0);
182 LASSERT(test_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags));
184 return ctx_check_death_pf(ctx, freelist);
188 int ctx_match_pf(struct ptlrpc_cli_ctx *ctx, struct vfs_cred *vcred)
190 /* a little bit optimization for null policy */
191 if (!ctx->cc_ops->match)
194 return ctx->cc_ops->match(ctx, vcred);
198 void ctx_list_destroy_pf(struct hlist_head *head)
200 struct ptlrpc_cli_ctx *ctx;
202 while (!hlist_empty(head)) {
203 ctx = hlist_entry(head->first, struct ptlrpc_cli_ctx, cc_hash);
205 LASSERT(atomic_read(&ctx->cc_refcount) == 0);
206 LASSERT(test_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags) == 0);
208 hlist_del_init(&ctx->cc_hash);
209 ctx_destroy_pf(ctx->cc_sec, ctx);
213 /****************************************
215 ****************************************/
218 int gss_cli_ctx_validate_pf(struct ptlrpc_cli_ctx *ctx)
220 if (ctx_check_death_pf(ctx, NULL))
222 if (cli_ctx_is_uptodate(ctx))
228 void gss_cli_ctx_die_pf(struct ptlrpc_cli_ctx *ctx, int grace)
230 LASSERT(ctx->cc_sec);
231 LASSERT(atomic_read(&ctx->cc_refcount) > 0);
235 spin_lock(&ctx->cc_sec->ps_lock);
237 if (test_and_clear_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags)) {
238 LASSERT(!hlist_unhashed(&ctx->cc_hash));
239 LASSERT(atomic_read(&ctx->cc_refcount) > 1);
241 hlist_del_init(&ctx->cc_hash);
242 if (atomic_dec_and_test(&ctx->cc_refcount))
246 spin_unlock(&ctx->cc_sec->ps_lock);
249 /****************************************
250 * reverse context installation *
251 ****************************************/
254 unsigned int ctx_hash_index(int hashsize, __u64 key)
256 return (unsigned int) (key & ((__u64) hashsize - 1));
260 void gss_sec_ctx_replace_pf(struct gss_sec *gsec,
261 struct ptlrpc_cli_ctx *new)
263 struct gss_sec_pipefs *gsec_pf;
264 struct ptlrpc_cli_ctx *ctx;
265 struct hlist_node *pos, *next;
266 HLIST_HEAD(freelist);
270 gsec_pf = container_of(gsec, struct gss_sec_pipefs, gsp_base);
272 hash = ctx_hash_index(gsec_pf->gsp_chash_size,
273 (__u64) new->cc_vcred.vc_uid);
274 LASSERT(hash < gsec_pf->gsp_chash_size);
276 spin_lock(&gsec->gs_base.ps_lock);
278 hlist_for_each_entry_safe(ctx, pos, next,
279 &gsec_pf->gsp_chash[hash], cc_hash) {
280 if (!ctx_match_pf(ctx, &new->cc_vcred))
284 ctx_unhash_pf(ctx, &freelist);
288 ctx_enhash_pf(new, &gsec_pf->gsp_chash[hash]);
289 atomic_inc(&gsec->gs_base.ps_busy);
291 spin_unlock(&gsec->gs_base.ps_lock);
293 ctx_list_destroy_pf(&freelist);
298 int gss_install_rvs_cli_ctx_pf(struct gss_sec *gsec,
299 struct ptlrpc_svc_ctx *svc_ctx)
301 struct vfs_cred vcred;
302 struct ptlrpc_cli_ctx *cli_ctx;
309 cli_ctx = ctx_create_pf(&gsec->gs_base, &vcred);
313 rc = gss_copy_rvc_cli_ctx(cli_ctx, svc_ctx);
315 ctx_destroy_pf(cli_ctx->cc_sec, cli_ctx);
319 gss_sec_ctx_replace_pf(gsec, cli_ctx);
324 void gss_ctx_cache_gc_pf(struct gss_sec_pipefs *gsec_pf,
325 struct hlist_head *freelist)
327 struct ptlrpc_sec *sec;
328 struct ptlrpc_cli_ctx *ctx;
329 struct hlist_node *pos, *next;
333 sec = &gsec_pf->gsp_base.gs_base;
335 CDEBUG(D_SEC, "do gc on sec %s@%p\n", sec->ps_policy->sp_name, sec);
337 for (i = 0; i < gsec_pf->gsp_chash_size; i++) {
338 hlist_for_each_entry_safe(ctx, pos, next,
339 &gsec_pf->gsp_chash[i], cc_hash)
340 ctx_check_death_locked_pf(ctx, freelist);
343 sec->ps_gc_next = cfs_time_current_sec() + sec->ps_gc_interval;
348 struct ptlrpc_sec* gss_sec_create_pf(struct obd_import *imp,
349 struct ptlrpc_svc_ctx *ctx,
353 struct gss_sec_pipefs *gsec_pf;
354 int alloc_size, hash_size, i;
357 #define GSS_SEC_PIPEFS_CTX_HASH_SIZE (32)
359 if (ctx || flags & (PTLRPC_SEC_FL_ROOTONLY | PTLRPC_SEC_FL_REVERSE))
362 hash_size = GSS_SEC_PIPEFS_CTX_HASH_SIZE;
364 alloc_size = sizeof(*gsec_pf) +
365 sizeof(struct hlist_head) * hash_size;
367 OBD_ALLOC(gsec_pf, alloc_size);
371 gsec_pf->gsp_chash_size = hash_size;
372 for (i = 0; i < hash_size; i++)
373 INIT_HLIST_HEAD(&gsec_pf->gsp_chash[i]);
375 if (gss_sec_create_common(&gsec_pf->gsp_base, &gss_policy_pipefs,
376 imp, ctx, flavor, flags))
380 if (gss_sec_pipe_upcall_init(&gsec_pf->gsp_base))
383 if (gss_install_rvs_cli_ctx_pf(&gsec_pf->gsp_base, ctx))
387 RETURN(&gsec_pf->gsp_base.gs_base);
390 gss_sec_destroy_common(&gsec_pf->gsp_base);
392 OBD_FREE(gsec_pf, alloc_size);
397 void gss_sec_destroy_pf(struct ptlrpc_sec *sec)
399 struct gss_sec_pipefs *gsec_pf;
400 struct gss_sec *gsec;
402 CWARN("destroy %s@%p\n", sec->ps_policy->sp_name, sec);
404 gsec = container_of(sec, struct gss_sec, gs_base);
405 gsec_pf = container_of(gsec, struct gss_sec_pipefs, gsp_base);
407 LASSERT(gsec_pf->gsp_chash);
408 LASSERT(gsec_pf->gsp_chash_size);
410 gss_sec_pipe_upcall_fini(gsec);
412 gss_sec_destroy_common(gsec);
414 OBD_FREE(gsec, sizeof(*gsec_pf) +
415 sizeof(struct hlist_head) * gsec_pf->gsp_chash_size);
419 struct ptlrpc_cli_ctx * gss_sec_lookup_ctx_pf(struct ptlrpc_sec *sec,
420 struct vfs_cred *vcred,
421 int create, int remove_dead)
423 struct gss_sec *gsec;
424 struct gss_sec_pipefs *gsec_pf;
425 struct ptlrpc_cli_ctx *ctx = NULL, *new = NULL;
426 struct hlist_head *hash_head;
427 struct hlist_node *pos, *next;
428 HLIST_HEAD(freelist);
429 unsigned int hash, gc = 0, found = 0;
434 gsec = container_of(sec, struct gss_sec, gs_base);
435 gsec_pf = container_of(gsec, struct gss_sec_pipefs, gsp_base);
437 hash = ctx_hash_index(gsec_pf->gsp_chash_size,
438 (__u64) vcred->vc_uid);
439 hash_head = &gsec_pf->gsp_chash[hash];
440 LASSERT(hash < gsec_pf->gsp_chash_size);
443 spin_lock(&sec->ps_lock);
445 /* gc_next == 0 means never do gc */
446 if (remove_dead && sec->ps_gc_next &&
447 cfs_time_after(cfs_time_current_sec(), sec->ps_gc_next)) {
448 gss_ctx_cache_gc_pf(gsec_pf, &freelist);
452 hlist_for_each_entry_safe(ctx, pos, next, hash_head, cc_hash) {
454 ctx_check_death_locked_pf(ctx,
455 remove_dead ? &freelist : NULL))
458 if (ctx_match_pf(ctx, vcred)) {
465 if (new && new != ctx) {
466 /* lost the race, just free it */
467 hlist_add_head(&new->cc_hash, &freelist);
471 /* hot node, move to head */
472 if (hash_head->first != &ctx->cc_hash) {
473 __hlist_del(&ctx->cc_hash);
474 hlist_add_head(&ctx->cc_hash, hash_head);
477 /* don't allocate for reverse sec */
478 if (sec->ps_flags & PTLRPC_SEC_FL_REVERSE) {
479 spin_unlock(&sec->ps_lock);
484 ctx_enhash_pf(new, hash_head);
487 spin_unlock(&sec->ps_lock);
488 new = ctx_create_pf(sec, vcred);
490 clear_bit(PTLRPC_CTX_NEW_BIT, &new->cc_flags);
499 atomic_inc(&ctx->cc_refcount);
501 spin_unlock(&sec->ps_lock);
503 /* the allocator of the context must give the first push to refresh */
506 gss_cli_ctx_refresh_pf(new);
509 ctx_list_destroy_pf(&freelist);
514 void gss_sec_release_ctx_pf(struct ptlrpc_sec *sec,
515 struct ptlrpc_cli_ctx *ctx,
518 LASSERT(test_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags) == 0);
519 LASSERT(hlist_unhashed(&ctx->cc_hash));
521 /* if required async, we must clear the UPTODATE bit to prevent extra
522 * rpcs during destroy procedure.
525 clear_bit(PTLRPC_CTX_UPTODATE_BIT, &ctx->cc_flags);
527 /* destroy this context */
528 ctx_destroy_pf(sec, ctx);
532 * @uid: which user. "-1" means flush all.
533 * @grace: mark context DEAD, allow graceful destroy like notify
535 * @force: also flush busy entries.
537 * return the number of busy context encountered.
539 * In any cases, never touch "eternal" contexts.
542 int gss_sec_flush_ctx_cache_pf(struct ptlrpc_sec *sec,
544 int grace, int force)
546 struct gss_sec *gsec;
547 struct gss_sec_pipefs *gsec_pf;
548 struct ptlrpc_cli_ctx *ctx;
549 struct hlist_node *pos, *next;
550 HLIST_HEAD(freelist);
554 might_sleep_if(grace);
556 gsec = container_of(sec, struct gss_sec, gs_base);
557 gsec_pf = container_of(gsec, struct gss_sec_pipefs, gsp_base);
559 spin_lock(&sec->ps_lock);
560 for (i = 0; i < gsec_pf->gsp_chash_size; i++) {
561 hlist_for_each_entry_safe(ctx, pos, next,
562 &gsec_pf->gsp_chash[i], cc_hash) {
563 LASSERT(atomic_read(&ctx->cc_refcount) > 0);
565 if (uid != -1 && uid != ctx->cc_vcred.vc_uid)
568 if (atomic_read(&ctx->cc_refcount) > 1) {
573 CWARN("flush busy(%d) ctx %p(%u->%s) by force, "
575 atomic_read(&ctx->cc_refcount),
576 ctx, ctx->cc_vcred.vc_uid,
577 sec2target_str(ctx->cc_sec), grace);
579 ctx_unhash_pf(ctx, &freelist);
581 set_bit(PTLRPC_CTX_DEAD_BIT, &ctx->cc_flags);
583 clear_bit(PTLRPC_CTX_UPTODATE_BIT,
587 spin_unlock(&sec->ps_lock);
589 ctx_list_destroy_pf(&freelist);
593 /****************************************
595 ****************************************/
598 int gss_svc_accept_pf(struct ptlrpc_request *req)
600 return gss_svc_accept(&gss_policy_pipefs, req);
604 int gss_svc_install_rctx_pf(struct obd_import *imp,
605 struct ptlrpc_svc_ctx *ctx)
607 struct gss_sec *gsec;
609 LASSERT(imp->imp_sec);
612 gsec = container_of(imp->imp_sec, struct gss_sec, gs_base);
613 return gss_install_rvs_cli_ctx_pf(gsec, ctx);
616 /****************************************
617 * rpc_pipefs definitions *
618 ****************************************/
620 #define LUSTRE_PIPE_ROOT "/lustre"
621 #define LUSTRE_PIPE_KRB5 LUSTRE_PIPE_ROOT"/krb5"
623 struct gss_upcall_msg_data {
627 __u32 gum_svc; /* MDS/OSS... */
628 __u64 gum_nid; /* peer NID */
629 __u8 gum_obd[64]; /* client obd name */
632 struct gss_upcall_msg {
633 struct rpc_pipe_msg gum_base;
634 atomic_t gum_refcount;
635 struct list_head gum_list;
637 struct gss_sec *gum_gsec;
638 struct gss_cli_ctx *gum_gctx;
639 struct gss_upcall_msg_data gum_data;
642 static atomic_t upcall_seq = ATOMIC_INIT(0);
645 __u32 upcall_get_sequence(void)
647 return (__u32) atomic_inc_return(&upcall_seq);
656 __u32 mech_name2idx(const char *name)
658 LASSERT(!strcmp(name, "krb5"));
662 /* pipefs dentries for each mechanisms */
663 static struct dentry *de_pipes[MECH_MAX] = { NULL, };
664 /* all upcall messgaes linked here */
665 static struct list_head upcall_lists[MECH_MAX];
666 /* and protected by this */
667 static spinlock_t upcall_locks[MECH_MAX];
670 void upcall_list_lock(int idx)
672 spin_lock(&upcall_locks[idx]);
676 void upcall_list_unlock(int idx)
678 spin_unlock(&upcall_locks[idx]);
682 void upcall_msg_enlist(struct gss_upcall_msg *msg)
684 __u32 idx = msg->gum_mechidx;
686 upcall_list_lock(idx);
687 list_add(&msg->gum_list, &upcall_lists[idx]);
688 upcall_list_unlock(idx);
692 void upcall_msg_delist(struct gss_upcall_msg *msg)
694 __u32 idx = msg->gum_mechidx;
696 upcall_list_lock(idx);
697 list_del_init(&msg->gum_list);
698 upcall_list_unlock(idx);
701 /****************************************
702 * rpc_pipefs upcall helpers *
703 ****************************************/
706 void gss_release_msg(struct gss_upcall_msg *gmsg)
709 LASSERT(atomic_read(&gmsg->gum_refcount) > 0);
711 if (!atomic_dec_and_test(&gmsg->gum_refcount)) {
716 if (gmsg->gum_gctx) {
717 sptlrpc_cli_ctx_wakeup(&gmsg->gum_gctx->gc_base);
718 sptlrpc_cli_ctx_put(&gmsg->gum_gctx->gc_base, 1);
719 gmsg->gum_gctx = NULL;
722 LASSERT(list_empty(&gmsg->gum_list));
723 LASSERT(list_empty(&gmsg->gum_base.list));
729 void gss_unhash_msg_nolock(struct gss_upcall_msg *gmsg)
731 __u32 idx = gmsg->gum_mechidx;
733 LASSERT(idx < MECH_MAX);
734 LASSERT_SPIN_LOCKED(&upcall_locks[idx]);
736 if (list_empty(&gmsg->gum_list))
739 list_del_init(&gmsg->gum_list);
740 LASSERT(atomic_read(&gmsg->gum_refcount) > 1);
741 atomic_dec(&gmsg->gum_refcount);
745 void gss_unhash_msg(struct gss_upcall_msg *gmsg)
747 __u32 idx = gmsg->gum_mechidx;
749 LASSERT(idx < MECH_MAX);
750 upcall_list_lock(idx);
751 gss_unhash_msg_nolock(gmsg);
752 upcall_list_unlock(idx);
756 void gss_msg_fail_ctx(struct gss_upcall_msg *gmsg)
758 if (gmsg->gum_gctx) {
759 struct ptlrpc_cli_ctx *ctx = &gmsg->gum_gctx->gc_base;
761 LASSERT(atomic_read(&ctx->cc_refcount) > 0);
762 sptlrpc_cli_ctx_expire(ctx);
763 set_bit(PTLRPC_CTX_ERROR_BIT, &ctx->cc_flags);
768 struct gss_upcall_msg * gss_find_upcall(__u32 mechidx, __u32 seq)
770 struct gss_upcall_msg *gmsg;
772 upcall_list_lock(mechidx);
773 list_for_each_entry(gmsg, &upcall_lists[mechidx], gum_list) {
774 if (gmsg->gum_data.gum_seq != seq)
777 LASSERT(atomic_read(&gmsg->gum_refcount) > 0);
778 LASSERT(gmsg->gum_mechidx == mechidx);
780 atomic_inc(&gmsg->gum_refcount);
781 upcall_list_unlock(mechidx);
784 upcall_list_unlock(mechidx);
789 int simple_get_bytes(char **buf, __u32 *buflen, void *res, __u32 reslen)
791 if (*buflen < reslen) {
792 CERROR("buflen %u < %u\n", *buflen, reslen);
796 memcpy(res, *buf, reslen);
802 /****************************************
804 ****************************************/
807 ssize_t gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
808 char *dst, size_t buflen)
810 char *data = (char *)msg->data + msg->copied;
811 ssize_t mlen = msg->len;
817 left = copy_to_user(dst, data, mlen);
829 ssize_t gss_pipe_downcall(struct file *filp, const char *src, size_t mlen)
831 struct rpc_inode *rpci = RPC_I(filp->f_dentry->d_inode);
832 struct gss_upcall_msg *gss_msg;
833 struct ptlrpc_cli_ctx *ctx;
834 struct gss_cli_ctx *gctx = NULL;
838 __u32 mechidx, seq, gss_err;
841 mechidx = (__u32) (long) rpci->private;
842 LASSERT(mechidx < MECH_MAX);
844 OBD_ALLOC(buf, mlen);
848 if (copy_from_user(buf, src, mlen)) {
849 CERROR("failed copy user space data\n");
850 GOTO(out_free, rc = -EFAULT);
855 /* data passed down format:
859 * - wire_ctx (rawobj)
860 * - mech_ctx (rawobj)
862 if (simple_get_bytes(&data, &datalen, &seq, sizeof(seq))) {
863 CERROR("fail to get seq\n");
864 GOTO(out_free, rc = -EFAULT);
867 gss_msg = gss_find_upcall(mechidx, seq);
869 CERROR("upcall %u has aborted earlier\n", seq);
870 GOTO(out_free, rc = -EINVAL);
873 gss_unhash_msg(gss_msg);
874 gctx = gss_msg->gum_gctx;
876 LASSERT(atomic_read(&gctx->gc_base.cc_refcount) > 0);
878 /* timeout is not in use for now */
879 if (simple_get_bytes(&data, &datalen, &timeout, sizeof(timeout)))
880 GOTO(out_msg, rc = -EFAULT);
882 /* lgssd signal an error by gc_win == 0 */
883 if (simple_get_bytes(&data, &datalen, &gctx->gc_win,
884 sizeof(gctx->gc_win)))
885 GOTO(out_msg, rc = -EFAULT);
887 if (gctx->gc_win == 0) {
892 if (simple_get_bytes(&data, &datalen, &rc, sizeof(rc)))
893 GOTO(out_msg, rc = -EFAULT);
894 if (simple_get_bytes(&data, &datalen, &gss_err,sizeof(gss_err)))
895 GOTO(out_msg, rc = -EFAULT);
897 if (rc == 0 && gss_err == GSS_S_COMPLETE) {
898 CWARN("both rpc & gss error code not set\n");
905 if (rawobj_extract_local(&tmpobj, (__u32 **) &data, &datalen))
906 GOTO(out_msg, rc = -EFAULT);
907 if (rawobj_dup(&gctx->gc_handle, &tmpobj))
908 GOTO(out_msg, rc = -ENOMEM);
911 if (rawobj_extract_local(&tmpobj, (__u32 **) &data, &datalen))
912 GOTO(out_msg, rc = -EFAULT);
913 gss_err = lgss_import_sec_context(&tmpobj,
914 gss_msg->gum_gsec->gs_mech,
919 if (likely(rc == 0 && gss_err == GSS_S_COMPLETE)) {
920 gss_cli_ctx_uptodate(gctx);
922 ctx = &gctx->gc_base;
923 sptlrpc_cli_ctx_expire(ctx);
924 if (rc != -ERESTART || gss_err != GSS_S_COMPLETE)
925 set_bit(PTLRPC_CTX_ERROR_BIT, &ctx->cc_flags);
927 CERROR("refresh ctx %p(uid %d) failed: %d/0x%08x: %s\n",
928 ctx, ctx->cc_vcred.vc_uid, rc, gss_err,
929 test_bit(PTLRPC_CTX_ERROR_BIT, &ctx->cc_flags) ?
930 "fatal error" : "non-fatal");
936 gss_release_msg(gss_msg);
941 * hack pipefs: always return asked length unless all following
942 * downcalls might be messed up.
949 void gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
951 struct gss_upcall_msg *gmsg;
952 struct gss_upcall_msg_data *gumd;
953 static cfs_time_t ratelimit = 0;
956 LASSERT(list_empty(&msg->list));
958 /* normally errno is >= 0 */
959 if (msg->errno >= 0) {
964 gmsg = container_of(msg, struct gss_upcall_msg, gum_base);
965 gumd = &gmsg->gum_data;
966 LASSERT(atomic_read(&gmsg->gum_refcount) > 0);
968 CERROR("failed msg %p (seq %u, uid %u, svc %u, nid "LPX64", obd %.*s): "
969 "errno %d\n", msg, gumd->gum_seq, gumd->gum_uid, gumd->gum_svc,
970 gumd->gum_nid, (int) sizeof(gumd->gum_obd),
971 gumd->gum_obd, msg->errno);
973 atomic_inc(&gmsg->gum_refcount);
974 gss_unhash_msg(gmsg);
975 if (msg->errno == -ETIMEDOUT || msg->errno == -EPIPE) {
976 cfs_time_t now = cfs_time_current_sec();
978 if (cfs_time_after(now, ratelimit)) {
979 CWARN("upcall timed out, is lgssd running?\n");
980 ratelimit = now + 15;
983 gss_msg_fail_ctx(gmsg);
984 gss_release_msg(gmsg);
989 void gss_pipe_release(struct inode *inode)
991 struct rpc_inode *rpci = RPC_I(inode);
995 idx = (__u32) (long) rpci->private;
996 LASSERT(idx < MECH_MAX);
998 upcall_list_lock(idx);
999 while (!list_empty(&upcall_lists[idx])) {
1000 struct gss_upcall_msg *gmsg;
1001 struct gss_upcall_msg_data *gumd;
1003 gmsg = list_entry(upcall_lists[idx].next,
1004 struct gss_upcall_msg, gum_list);
1005 gumd = &gmsg->gum_data;
1006 LASSERT(list_empty(&gmsg->gum_base.list));
1008 CERROR("failing remaining msg %p:seq %u, uid %u, svc %u, "
1009 "nid "LPX64", obd %.*s\n", gmsg,
1010 gumd->gum_seq, gumd->gum_uid, gumd->gum_svc,
1011 gumd->gum_nid, (int) sizeof(gumd->gum_obd),
1014 gmsg->gum_base.errno = -EPIPE;
1015 atomic_inc(&gmsg->gum_refcount);
1016 gss_unhash_msg_nolock(gmsg);
1018 gss_msg_fail_ctx(gmsg);
1020 upcall_list_unlock(idx);
1021 gss_release_msg(gmsg);
1022 upcall_list_lock(idx);
1024 upcall_list_unlock(idx);
1028 static struct rpc_pipe_ops gss_upcall_ops = {
1029 .upcall = gss_pipe_upcall,
1030 .downcall = gss_pipe_downcall,
1031 .destroy_msg = gss_pipe_destroy_msg,
1032 .release_pipe = gss_pipe_release,
1035 /****************************************
1036 * upcall helper functions *
1037 ****************************************/
1040 int gss_ctx_refresh_pf(struct ptlrpc_cli_ctx *ctx)
1042 struct obd_import *imp;
1043 struct gss_sec *gsec;
1044 struct gss_upcall_msg *gmsg;
1050 LASSERT(ctx->cc_sec);
1051 LASSERT(ctx->cc_sec->ps_import);
1052 LASSERT(ctx->cc_sec->ps_import->imp_obd);
1054 imp = ctx->cc_sec->ps_import;
1055 if (!imp->imp_connection) {
1056 CERROR("import has no connection set\n");
1060 gsec = container_of(ctx->cc_sec, struct gss_sec, gs_base);
1062 OBD_ALLOC_PTR(gmsg);
1066 /* initialize pipefs base msg */
1067 INIT_LIST_HEAD(&gmsg->gum_base.list);
1068 gmsg->gum_base.data = &gmsg->gum_data;
1069 gmsg->gum_base.len = sizeof(gmsg->gum_data);
1070 gmsg->gum_base.copied = 0;
1071 gmsg->gum_base.errno = 0;
1073 /* init upcall msg */
1074 atomic_set(&gmsg->gum_refcount, 1);
1075 gmsg->gum_mechidx = mech_name2idx(gsec->gs_mech->gm_name);
1076 gmsg->gum_gsec = gsec;
1077 gmsg->gum_gctx = container_of(sptlrpc_cli_ctx_get(ctx),
1078 struct gss_cli_ctx, gc_base);
1079 gmsg->gum_data.gum_seq = upcall_get_sequence();
1080 gmsg->gum_data.gum_uid = ctx->cc_vcred.vc_uid;
1081 gmsg->gum_data.gum_gid = 0; /* not used for now */
1082 gmsg->gum_data.gum_svc = import_to_gss_svc(imp);
1083 gmsg->gum_data.gum_nid = imp->imp_connection->c_peer.nid;
1084 strncpy(gmsg->gum_data.gum_obd, imp->imp_obd->obd_name,
1085 sizeof(gmsg->gum_data.gum_obd));
1087 /* This only could happen when sysadmin set it dead/expired
1088 * using lctl by force.
1090 if (ctx->cc_flags & PTLRPC_CTX_STATUS_MASK) {
1091 CWARN("ctx %p(%u->%s) was set flags %lx unexpectedly\n",
1092 ctx, ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec),
1095 LASSERT(!(ctx->cc_flags & PTLRPC_CTX_UPTODATE));
1096 ctx->cc_flags |= PTLRPC_CTX_DEAD | PTLRPC_CTX_ERROR;
1102 upcall_msg_enlist(gmsg);
1104 rc = rpc_queue_upcall(de_pipes[gmsg->gum_mechidx]->d_inode,
1107 CERROR("rpc_queue_upcall failed: %d\n", rc);
1109 upcall_msg_delist(gmsg);
1120 int gss_cli_ctx_refresh_pf(struct ptlrpc_cli_ctx *ctx)
1122 /* if we are refreshing for root, also update the reverse
1123 * handle index, do not confuse reverse contexts.
1125 if (ctx->cc_vcred.vc_uid == 0) {
1126 struct gss_sec *gsec;
1128 gsec = container_of(ctx->cc_sec, struct gss_sec, gs_base);
1129 gsec->gs_rvs_hdl = gss_get_next_ctx_index();
1132 return gss_ctx_refresh_pf(ctx);
1135 /****************************************
1136 * lustre gss pipefs policy *
1137 ****************************************/
1139 static struct ptlrpc_ctx_ops gss_pipefs_ctxops = {
1140 .match = gss_cli_ctx_match,
1141 .refresh = gss_cli_ctx_refresh_pf,
1142 .validate = gss_cli_ctx_validate_pf,
1143 .die = gss_cli_ctx_die_pf,
1144 .display = gss_cli_ctx_display,
1145 .sign = gss_cli_ctx_sign,
1146 .verify = gss_cli_ctx_verify,
1147 .seal = gss_cli_ctx_seal,
1148 .unseal = gss_cli_ctx_unseal,
1149 .wrap_bulk = gss_cli_ctx_wrap_bulk,
1150 .unwrap_bulk = gss_cli_ctx_unwrap_bulk,
1153 static struct ptlrpc_sec_cops gss_sec_pipefs_cops = {
1154 .create_sec = gss_sec_create_pf,
1155 .destroy_sec = gss_sec_destroy_pf,
1156 .lookup_ctx = gss_sec_lookup_ctx_pf,
1157 .release_ctx = gss_sec_release_ctx_pf,
1158 .flush_ctx_cache = gss_sec_flush_ctx_cache_pf,
1159 .install_rctx = gss_sec_install_rctx,
1160 .alloc_reqbuf = gss_alloc_reqbuf,
1161 .free_reqbuf = gss_free_reqbuf,
1162 .alloc_repbuf = gss_alloc_repbuf,
1163 .free_repbuf = gss_free_repbuf,
1164 .enlarge_reqbuf = gss_enlarge_reqbuf,
1167 static struct ptlrpc_sec_sops gss_sec_pipefs_sops = {
1168 .accept = gss_svc_accept_pf,
1169 .invalidate_ctx = gss_svc_invalidate_ctx,
1170 .alloc_rs = gss_svc_alloc_rs,
1171 .authorize = gss_svc_authorize,
1172 .free_rs = gss_svc_free_rs,
1173 .free_ctx = gss_svc_free_ctx,
1174 .unwrap_bulk = gss_svc_unwrap_bulk,
1175 .wrap_bulk = gss_svc_wrap_bulk,
1176 .install_rctx = gss_svc_install_rctx_pf,
1179 static struct ptlrpc_sec_policy gss_policy_pipefs = {
1180 .sp_owner = THIS_MODULE,
1181 .sp_name = "gss.pipefs",
1182 .sp_policy = SPTLRPC_POLICY_GSS_PIPEFS,
1183 .sp_cops = &gss_sec_pipefs_cops,
1184 .sp_sops = &gss_sec_pipefs_sops,
1188 int __init gss_init_pipefs_upcall(void)
1193 de = rpc_mkdir(LUSTRE_PIPE_ROOT, NULL);
1194 if (IS_ERR(de) && PTR_ERR(de) != -EEXIST) {
1195 CERROR("Failed to create gss pipe dir: %ld\n", PTR_ERR(de));
1199 * hack pipefs: dput will sometimes cause oops during module unload
1200 * and lgssd close the pipe fds.
1204 /* krb5 mechanism */
1205 de = rpc_mkpipe(LUSTRE_PIPE_KRB5, (void *) MECH_KRB5, &gss_upcall_ops,
1206 RPC_PIPE_WAIT_FOR_OPEN);
1207 if (!de || IS_ERR(de)) {
1208 CERROR("failed to make rpc_pipe %s: %ld\n",
1209 LUSTRE_PIPE_KRB5, PTR_ERR(de));
1210 rpc_rmdir(LUSTRE_PIPE_ROOT);
1214 de_pipes[MECH_KRB5] = de;
1215 INIT_LIST_HEAD(&upcall_lists[MECH_KRB5]);
1216 upcall_locks[MECH_KRB5] = SPIN_LOCK_UNLOCKED;
1222 void __exit gss_exit_pipefs_upcall(void)
1226 for (i = 0; i < MECH_MAX; i++) {
1227 LASSERT(list_empty(&upcall_lists[i]));
1229 * dput pipe dentry here might cause lgssd oops.
1231 //dput(de_pipes[i]);
1235 rpc_unlink(LUSTRE_PIPE_KRB5);
1236 rpc_rmdir(LUSTRE_PIPE_ROOT);
1239 int __init gss_init_pipefs(void)
1243 rc = gss_init_pipefs_upcall();
1247 rc = sptlrpc_register_policy(&gss_policy_pipefs);
1249 gss_exit_pipefs_upcall();
1256 void __exit gss_exit_pipefs(void)
1258 gss_exit_pipefs_upcall();
1259 sptlrpc_unregister_policy(&gss_policy_pipefs);