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 * Neil Brown <neilb@cse.unsw.edu.au>
12 * J. Bruce Fields <bfields@umich.edu>
13 * Andy Adamson <andros@umich.edu>
14 * Dug Song <dugsong@monkey.org>
16 * RPCSEC_GSS server authentication.
17 * This implements RPCSEC_GSS as defined in rfc2203 (rpcsec_gss) and rfc2078
20 * The RPCSEC_GSS involves three stages:
23 * 3/ context destruction
25 * Context creation is handled largely by upcalls to user-space.
26 * In particular, GSS_Accept_sec_context is handled by an upcall
27 * Data exchange is handled entirely within the kernel
28 * In particular, GSS_GetMIC, GSS_VerifyMIC, GSS_Seal, GSS_Unseal are in-kernel.
29 * Context destruction is handled in-kernel
30 * GSS_Delete_sec_context is in-kernel
32 * Context creation is initiated by a RPCSEC_GSS_INIT request arriving.
33 * The context handle and gss_token are used as a key into the rpcsec_init cache.
34 * The content of this cache includes some of the outputs of GSS_Accept_sec_context,
35 * being major_status, minor_status, context_handle, reply_token.
36 * These are sent back to the client.
37 * Sequence window management is handled by the kernel. The window size if currently
38 * a compile time constant.
40 * When user-space is happy that a context is established, it places an entry
41 * in the rpcsec_context cache. The key for this cache is the context_handle.
42 * The content includes:
43 * uid/gidlist - for determining access rights
45 * mechanism specific information, such as a key
49 #define DEBUG_SUBSYSTEM S_SEC
51 #include <linux/types.h>
52 #include <linux/init.h>
53 #include <linux/module.h>
54 #include <linux/slab.h>
55 #include <linux/hash.h>
57 #include <liblustre.h>
60 #include <linux/sunrpc/cache.h>
62 #include <libcfs/kp30.h>
63 #include <linux/obd.h>
64 #include <linux/obd_class.h>
65 #include <linux/obd_support.h>
66 #include <linux/lustre_idl.h>
67 #include <linux/lustre_net.h>
68 #include <linux/lustre_import.h>
69 #include <linux/lustre_sec.h>
72 #include "gss_internal.h"
75 static inline unsigned long hash_mem(char *buf, int length, int bits)
77 unsigned long hash = 0;
83 c = (char)len; len = -1;
88 if ((len & (BITS_PER_LONG/8-1))==0)
89 hash = hash_long(hash^l, BITS_PER_LONG);
91 return hash >> (BITS_PER_LONG - bits);
94 /* The rpcsec_init cache is used for mapping RPCSEC_GSS_{,CONT_}INIT requests
97 * Key is context handle (\x if empty) and gss_token.
98 * Content is major_status minor_status (integers) context_handle, reply_token.
102 #define RSI_HASHBITS 6
103 #define RSI_HASHMAX (1<<RSI_HASHBITS)
104 #define RSI_HASHMASK (RSI_HASHMAX-1)
111 rawobj_t in_handle, in_token;
112 rawobj_t out_handle, out_token;
113 int major_status, minor_status;
116 static struct cache_head *rsi_table[RSI_HASHMAX];
117 static struct cache_detail rsi_cache;
119 static void rsi_free(struct rsi *rsii)
121 rawobj_free(&rsii->in_handle);
122 rawobj_free(&rsii->in_token);
123 rawobj_free(&rsii->out_handle);
124 rawobj_free(&rsii->out_token);
127 static void rsi_put(struct cache_head *item, struct cache_detail *cd)
129 struct rsi *rsii = container_of(item, struct rsi, h);
130 LASSERT(atomic_read(&item->refcnt) > 0);
131 if (cache_put(item, cd)) {
132 LASSERT(item->next == NULL);
134 OBD_FREE(rsii, sizeof(*rsii));
138 static inline int rsi_hash(struct rsi *item)
140 return hash_mem((char *)item->in_handle.data, item->in_handle.len, RSI_HASHBITS)
141 ^ hash_mem((char *)item->in_token.data, item->in_token.len, RSI_HASHBITS);
144 static inline int rsi_match(struct rsi *item, struct rsi *tmp)
146 return (rawobj_equal(&item->in_handle, &tmp->in_handle) &&
147 rawobj_equal(&item->in_token, &tmp->in_token));
150 static void rsi_request(struct cache_detail *cd,
151 struct cache_head *h,
152 char **bpp, int *blen)
154 struct rsi *rsii = container_of(h, struct rsi, h);
156 qword_addhex(bpp, blen, (char *)&rsii->naltype, sizeof(rsii->naltype));
157 qword_addhex(bpp, blen, (char *)&rsii->netid, sizeof(rsii->netid));
158 qword_addhex(bpp, blen, (char *)&rsii->nid, sizeof(rsii->nid));
159 qword_addhex(bpp, blen, (char *)rsii->in_handle.data, rsii->in_handle.len);
160 qword_addhex(bpp, blen, (char *)rsii->in_token.data, rsii->in_token.len);
165 gssd_reply(struct rsi *item)
168 struct cache_head **hp, **head;
171 head = &rsi_cache.hash_table[rsi_hash(item)];
172 write_lock(&rsi_cache.hash_lock);
173 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
174 tmp = container_of(*hp, struct rsi, h);
175 if (rsi_match(tmp, item)) {
177 clear_bit(CACHE_HASHED, &tmp->h.flags);
181 if (test_bit(CACHE_VALID, &tmp->h.flags)) {
182 CERROR("rsi is valid\n");
183 write_unlock(&rsi_cache.hash_lock);
184 rsi_put(&tmp->h, &rsi_cache);
187 set_bit(CACHE_HASHED, &item->h.flags);
191 set_bit(CACHE_VALID, &item->h.flags);
192 item->h.last_refresh = get_seconds();
193 write_unlock(&rsi_cache.hash_lock);
194 cache_fresh(&rsi_cache, &tmp->h, 0);
195 rsi_put(&tmp->h, &rsi_cache);
199 write_unlock(&rsi_cache.hash_lock);
204 * here we just wait here for its completion or timedout. it's a
205 * hacking but works, and we'll comeup with real fix if we decided
206 * to still stick with NFS4 cache code
209 gssd_upcall(struct rsi *item, struct cache_req *chandle)
212 struct cache_head **hp, **head;
213 unsigned long starttime;
216 head = &rsi_cache.hash_table[rsi_hash(item)];
217 read_lock(&rsi_cache.hash_lock);
218 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
219 tmp = container_of(*hp, struct rsi, h);
220 if (rsi_match(tmp, item)) {
222 if (!test_bit(CACHE_VALID, &tmp->h.flags)) {
223 CERROR("found rsi without VALID\n");
224 read_unlock(&rsi_cache.hash_lock);
231 read_unlock(&rsi_cache.hash_lock);
236 //set_bit(CACHE_HASHED, &item->h.flags);
237 item->h.next = *head;
240 read_unlock(&rsi_cache.hash_lock);
241 //cache_get(&item->h);
243 cache_check(&rsi_cache, &item->h, chandle);
244 starttime = get_seconds();
246 set_current_state(TASK_UNINTERRUPTIBLE);
247 schedule_timeout(HZ/2);
248 read_lock(&rsi_cache.hash_lock);
249 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
250 tmp = container_of(*hp, struct rsi, h);
253 if (rsi_match(tmp, item)) {
254 if (!test_bit(CACHE_VALID, &tmp->h.flags)) {
255 read_unlock(&rsi_cache.hash_lock);
259 clear_bit(CACHE_HASHED, &tmp->h.flags);
263 read_unlock(&rsi_cache.hash_lock);
267 read_unlock(&rsi_cache.hash_lock);
268 } while ((get_seconds() - starttime) <= 15);
269 CERROR("15s timeout while waiting cache refill\n");
273 static int rsi_parse(struct cache_detail *cd,
274 char *mesg, int mlen)
276 /* context token expiry major minor context token */
282 int status = -EINVAL;
285 OBD_ALLOC(rsii, sizeof(*rsii));
288 cache_init(&rsii->h);
291 len = qword_get(&mesg, buf, mlen);
294 if (rawobj_alloc(&rsii->in_handle, buf, len)) {
300 len = qword_get(&mesg, buf, mlen);
303 if (rawobj_alloc(&rsii->in_token, buf, len)) {
309 expiry = get_expiry(&mesg);
314 len = qword_get(&mesg, buf, mlen);
317 rsii->major_status = simple_strtol(buf, &ep, 10);
322 len = qword_get(&mesg, buf, mlen);
325 rsii->minor_status = simple_strtol(buf, &ep, 10);
330 len = qword_get(&mesg, buf, mlen);
333 if (rawobj_alloc(&rsii->out_handle, buf, len)) {
339 len = qword_get(&mesg, buf, mlen);
342 if (rawobj_alloc(&rsii->out_token, buf, len)) {
347 rsii->h.expiry_time = expiry;
348 status = gssd_reply(rsii);
351 rsi_put(&rsii->h, &rsi_cache);
355 static struct cache_detail rsi_cache = {
356 .hash_size = RSI_HASHMAX,
357 .hash_table = rsi_table,
358 .name = "auth.ptlrpcs.init",
359 .cache_put = rsi_put,
360 .cache_request = rsi_request,
361 .cache_parse = rsi_parse,
365 * The rpcsec_context cache is used to store a context that is
366 * used in data exchange.
367 * The key is a context handle. The content is:
368 * uid, gidlist, mechanism, service-set, mech-specific-data
371 #define RSC_HASHBITS 10
372 #define RSC_HASHMAX (1<<RSC_HASHBITS)
373 #define RSC_HASHMASK (RSC_HASHMAX-1)
375 #define GSS_SEQ_WIN 512
377 struct gss_svc_seq_data {
378 /* highest seq number seen so far: */
380 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
381 * sd_win is nonzero iff sequence number i has been seen already: */
382 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
390 struct vfs_cred cred;
392 struct gss_svc_seq_data seqdata;
393 struct gss_ctx *mechctx;
396 static struct cache_head *rsc_table[RSC_HASHMAX];
397 static struct cache_detail rsc_cache;
399 static void rsc_free(struct rsc *rsci)
401 rawobj_free(&rsci->handle);
403 kgss_delete_sec_context(&rsci->mechctx);
405 if (rsci->cred.vc_ginfo)
406 put_group_info(rsci->cred.vc_ginfo);
410 static void rsc_put(struct cache_head *item, struct cache_detail *cd)
412 struct rsc *rsci = container_of(item, struct rsc, h);
414 LASSERT(atomic_read(&item->refcnt) > 0);
415 if (cache_put(item, cd)) {
416 LASSERT(item->next == NULL);
418 OBD_FREE(rsci, sizeof(*rsci));
423 rsc_hash(struct rsc *rsci)
425 return hash_mem((char *)rsci->handle.data,
426 rsci->handle.len, RSC_HASHBITS);
430 rsc_match(struct rsc *new, struct rsc *tmp)
432 return rawobj_equal(&new->handle, &tmp->handle);
435 static struct rsc *rsc_lookup(struct rsc *item, int set)
437 struct rsc *tmp = NULL;
438 struct cache_head **hp, **head;
439 head = &rsc_cache.hash_table[rsc_hash(item)];
443 write_lock(&rsc_cache.hash_lock);
445 read_lock(&rsc_cache.hash_lock);
446 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
447 tmp = container_of(*hp, struct rsc, h);
448 if (!rsc_match(tmp, item))
455 clear_bit(CACHE_HASHED, &tmp->h.flags);
456 rsc_put(&tmp->h, &rsc_cache);
459 /* Didn't find anything */
464 set_bit(CACHE_HASHED, &item->h.flags);
465 item->h.next = *head;
467 write_unlock(&rsc_cache.hash_lock);
468 cache_fresh(&rsc_cache, &item->h, item->h.expiry_time);
474 read_unlock(&rsc_cache.hash_lock);
478 static int rsc_parse(struct cache_detail *cd,
479 char *mesg, int mlen)
481 /* contexthandle expiry [ uid gid N <n gids> mechname
482 * ...mechdata... ] */
485 struct rsc *rsci, *res = NULL;
487 int status = -EINVAL;
489 OBD_ALLOC(rsci, sizeof(*rsci));
491 CERROR("fail to alloc rsci\n");
494 cache_init(&rsci->h);
497 len = qword_get(&mesg, buf, mlen);
498 if (len < 0) goto out;
500 if (rawobj_alloc(&rsci->handle, buf, len))
504 expiry = get_expiry(&mesg);
510 rv = get_int(&mesg, (int *)&rsci->remote_realm);
512 CERROR("fail to get remote flag\n");
517 rv = get_int(&mesg, (int *)&rsci->mapped_uid);
519 CERROR("fail to get mapped uid\n");
523 /* uid, or NEGATIVE */
524 rv = get_int(&mesg, (int *)&rsci->cred.vc_uid);
528 CERROR("NOENT? set rsc entry negative\n");
529 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
531 struct gss_api_mech *gm;
536 if (get_int(&mesg, (int *)&rsci->cred.vc_gid))
540 len = qword_get(&mesg, buf, mlen);
543 gm = kgss_name_to_mech(buf);
544 status = -EOPNOTSUPP;
549 /* mech-specific data: */
550 len = qword_get(&mesg, buf, mlen);
556 tmp_buf.data = (unsigned char *)buf;
557 if (kgss_import_sec_context(&tmp_buf, gm, &rsci->mechctx)) {
562 /* currently the expiry time passed down from user-space
563 * is invalid, here we retrive it from mech.
565 if (kgss_inquire_context(rsci->mechctx, &ctx_expiry)) {
566 CERROR("unable to get expire time, drop it\n");
567 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
571 expiry = (time_t) ctx_expiry;
575 rsci->h.expiry_time = expiry;
576 spin_lock_init(&rsci->seqdata.sd_lock);
577 res = rsc_lookup(rsci, 1);
578 rsc_put(&res->h, &rsc_cache);
582 rsc_put(&rsci->h, &rsc_cache);
587 * flush all entries with @uid. @uid == -1 will match all.
588 * we only know the uid, maybe netid/nid in the future, in all cases
589 * we must search the whole cache
591 static void rsc_flush(uid_t uid)
593 struct cache_head **ch;
598 write_lock(&rsc_cache.hash_lock);
599 for (n = 0; n < RSC_HASHMAX; n++) {
600 for (ch = &rsc_cache.hash_table[n]; *ch;) {
601 rscp = container_of(*ch, struct rsc, h);
602 if (uid == -1 || rscp->cred.vc_uid == uid) {
603 /* it seems simply set NEGATIVE doesn't work */
607 set_bit(CACHE_NEGATIVE, &rscp->h.flags);
608 clear_bit(CACHE_HASHED, &rscp->h.flags);
609 CDEBUG(D_SEC, "flush rsc %p for uid %u\n",
610 rscp, rscp->cred.vc_uid);
611 rsc_put(&rscp->h, &rsc_cache);
618 write_unlock(&rsc_cache.hash_lock);
622 static struct cache_detail rsc_cache = {
623 .hash_size = RSC_HASHMAX,
624 .hash_table = rsc_table,
625 .name = "auth.ptlrpcs.context",
626 .cache_put = rsc_put,
627 .cache_parse = rsc_parse,
631 gss_svc_searchbyctx(rawobj_t *handle)
636 rsci.handle = *handle;
637 found = rsc_lookup(&rsci, 0);
641 if (cache_check(&rsc_cache, &found->h, NULL))
647 struct gss_svc_data {
648 /* decoded gss client cred: */
649 struct rpc_gss_wire_cred clcred;
650 /* internal used status */
651 unsigned int is_init:1,
659 * again hacking: only try to give the svcgssd a chance to handle
662 struct cache_deferred_req* my_defer(struct cache_req *req)
667 static struct cache_req my_chandle = {my_defer};
669 /* Implements sequence number algorithm as specified in RFC 2203. */
671 gss_check_seq_num(struct gss_svc_seq_data *sd, __u32 seq_num)
675 spin_lock(&sd->sd_lock);
676 if (seq_num > sd->sd_max) {
677 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
678 memset(sd->sd_win, 0, sizeof(sd->sd_win));
679 sd->sd_max = seq_num;
681 while(sd->sd_max < seq_num) {
683 __clear_bit(sd->sd_max % GSS_SEQ_WIN,
687 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
689 } else if (seq_num + GSS_SEQ_WIN <= sd->sd_max) {
690 CERROR("seq %u too low: max %u, win %d\n",
691 seq_num, sd->sd_max, GSS_SEQ_WIN);
696 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win)) {
697 CERROR("seq %u is replay: max %u, win %d\n",
698 seq_num, sd->sd_max, GSS_SEQ_WIN);
702 spin_unlock(&sd->sd_lock);
707 gss_svc_verify_request(struct ptlrpc_request *req,
709 struct rpc_gss_wire_cred *gc,
710 __u32 *vp, __u32 vlen)
712 struct ptlrpcs_wire_hdr *sec_hdr;
713 struct gss_ctx *ctx = rsci->mechctx;
719 sec_hdr = (struct ptlrpcs_wire_hdr *) req->rq_reqbuf;
721 req->rq_reqmsg = (struct lustre_msg *) (req->rq_reqbuf + sizeof(*sec_hdr));
722 req->rq_reqlen = sec_hdr->msg_len;
724 msg.len = sec_hdr->msg_len;
725 msg.data = (__u8 *)req->rq_reqmsg;
727 mic.len = le32_to_cpu(*vp++);
728 mic.data = (unsigned char *)vp;
731 if (mic.len > vlen) {
732 CERROR("checksum len %d, while buffer len %d\n",
734 RETURN(GSS_S_CALL_BAD_STRUCTURE);
738 CERROR("invalid mic len %d\n", mic.len);
739 RETURN(GSS_S_CALL_BAD_STRUCTURE);
742 maj_stat = kgss_verify_mic(ctx, &msg, &mic, NULL);
743 if (maj_stat != GSS_S_COMPLETE) {
744 CERROR("MIC verification error: major %x\n", maj_stat);
748 if (gss_check_seq_num(&rsci->seqdata, gc->gc_seq)) {
749 CERROR("discard replayed request %p(o%u,x"LPU64",t"LPU64")\n",
750 req, req->rq_reqmsg->opc, req->rq_xid,
751 req->rq_reqmsg->transno);
752 RETURN(GSS_S_DUPLICATE_TOKEN);
755 RETURN(GSS_S_COMPLETE);
759 gss_svc_unseal_request(struct ptlrpc_request *req,
761 struct rpc_gss_wire_cred *gc,
762 __u32 *vp, __u32 vlen)
764 struct ptlrpcs_wire_hdr *sec_hdr;
765 struct gss_ctx *ctx = rsci->mechctx;
766 rawobj_t cipher_text, plain_text;
770 sec_hdr = (struct ptlrpcs_wire_hdr *) req->rq_reqbuf;
773 CERROR("vlen only %u\n", vlen);
774 RETURN(GSS_S_CALL_BAD_STRUCTURE);
777 cipher_text.len = le32_to_cpu(*vp++);
778 cipher_text.data = (__u8 *) vp;
781 if (cipher_text.len > vlen) {
782 CERROR("cipher claimed %u while buf only %u\n",
783 cipher_text.len, vlen);
784 RETURN(GSS_S_CALL_BAD_STRUCTURE);
787 plain_text = cipher_text;
789 major = kgss_unwrap(ctx, GSS_C_QOP_DEFAULT, &cipher_text, &plain_text);
791 CERROR("unwrap error 0x%x\n", major);
795 if (gss_check_seq_num(&rsci->seqdata, gc->gc_seq)) {
796 CERROR("discard replayed request %p(o%u,x"LPU64",t"LPU64")\n",
797 req, req->rq_reqmsg->opc, req->rq_xid,
798 req->rq_reqmsg->transno);
799 RETURN(GSS_S_DUPLICATE_TOKEN);
802 req->rq_reqmsg = (struct lustre_msg *) (vp);
803 req->rq_reqlen = plain_text.len;
805 CDEBUG(D_SEC, "msg len %d\n", req->rq_reqlen);
807 RETURN(GSS_S_COMPLETE);
811 gss_pack_err_notify(struct ptlrpc_request *req,
812 __u32 major, __u32 minor)
814 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
815 __u32 reslen, *resp, *reslenp;
816 char nidstr[PTL_NALFMT_SIZE];
817 const __u32 secdata_len = 7 * 4;
821 OBD_FAIL_RETURN(OBD_FAIL_SVCGSS_ERR_NOTIFY|OBD_FAIL_ONCE, -EINVAL);
824 svcdata->is_err_notify = 1;
825 svcdata->reserve_len = 7 * 4;
827 rc = lustre_pack_reply(req, 0, NULL, NULL);
829 CERROR("could not pack reply, err %d\n", rc);
833 LASSERT(req->rq_reply_state);
834 LASSERT(req->rq_reply_state->rs_repbuf);
835 LASSERT(req->rq_reply_state->rs_repbuf_len >= secdata_len);
836 resp = (__u32 *) req->rq_reply_state->rs_repbuf;
839 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS);
840 *resp++ = cpu_to_le32(PTLRPC_SEC_TYPE_NONE);
841 *resp++ = cpu_to_le32(req->rq_replen);
844 /* skip lustre msg */
845 resp += req->rq_replen / 4;
846 reslen = svcdata->reserve_len;
849 * version, subflavor, notify, major, minor,
850 * obj1(fake), obj2(fake)
852 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
853 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
854 *resp++ = cpu_to_le32(PTLRPC_GSS_PROC_ERR);
855 *resp++ = cpu_to_le32(major);
856 *resp++ = cpu_to_le32(minor);
860 /* the actual sec data length */
861 *reslenp = cpu_to_le32(secdata_len);
863 req->rq_reply_state->rs_repdata_len += (secdata_len);
864 CDEBUG(D_SEC, "prepare gss error notify(0x%x/0x%x) to %s\n",
866 portals_nid2str(req->rq_peer.peer_ni->pni_number,
867 req->rq_peer.peer_id.nid, nidstr));
871 static void dump_cache_head(struct cache_head *h)
873 CWARN("ref %d, fl %lx, n %p, t %ld, %ld\n",
874 atomic_read(&h->refcnt), h->flags, h->next,
875 h->expiry_time, h->last_refresh);
877 static void dump_rsi(struct rsi *rsi)
879 CWARN("dump rsi %p\n", rsi);
880 dump_cache_head(&rsi->h);
881 CWARN("%x,%x,%llx\n", rsi->naltype, rsi->netid, rsi->nid);
882 CWARN("len %d, d %p\n", rsi->in_handle.len, rsi->in_handle.data);
883 CWARN("len %d, d %p\n", rsi->in_token.len, rsi->in_token.data);
884 CWARN("len %d, d %p\n", rsi->out_handle.len, rsi->out_handle.data);
885 CWARN("len %d, d %p\n", rsi->out_token.len, rsi->out_token.data);
889 gss_svcsec_handle_init(struct ptlrpc_request *req,
890 struct rpc_gss_wire_cred *gc,
891 __u32 *secdata, __u32 seclen,
892 enum ptlrpcs_error *res)
894 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
896 struct rsi *rsikey, *rsip;
898 __u32 reslen, *resp, *reslenp;
899 char nidstr[PTL_NALFMT_SIZE];
905 CDEBUG(D_SEC, "processing gss init(%d) request from %s\n", gc->gc_proc,
906 portals_nid2str(req->rq_peer.peer_ni->pni_number,
907 req->rq_peer.peer_id.nid, nidstr));
909 *res = PTLRPCS_BADCRED;
910 OBD_FAIL_RETURN(OBD_FAIL_SVCGSS_INIT_REQ|OBD_FAIL_ONCE, SVC_DROP);
912 if (gc->gc_proc == RPC_GSS_PROC_INIT &&
913 gc->gc_ctx.len != 0) {
914 CERROR("proc %d, ctx_len %d: not really init?\n",
915 gc->gc_proc == RPC_GSS_PROC_INIT, gc->gc_ctx.len);
919 OBD_ALLOC(rsikey, sizeof(*rsikey));
921 CERROR("out of memory\n");
924 cache_init(&rsikey->h);
926 if (rawobj_dup(&rsikey->in_handle, &gc->gc_ctx)) {
927 CERROR("fail to dup context handle\n");
928 GOTO(out_rsikey, rc = SVC_DROP);
930 *res = PTLRPCS_BADVERF;
931 if (rawobj_extract(&tmpobj, &secdata, &seclen)) {
932 CERROR("can't extract token\n");
933 GOTO(out_rsikey, rc = SVC_DROP);
935 if (rawobj_dup(&rsikey->in_token, &tmpobj)) {
936 CERROR("can't duplicate token\n");
937 GOTO(out_rsikey, rc = SVC_DROP);
940 rsikey->naltype = (__u32) req->rq_peer.peer_ni->pni_number;
942 rsikey->nid = (__u64) req->rq_peer.peer_id.nid;
944 rsip = gssd_upcall(rsikey, &my_chandle);
946 CERROR("error in gssd_upcall.\n");
949 if (gss_pack_err_notify(req, GSS_S_FAILURE, 0))
952 GOTO(out_rsikey, rc);
955 rsci = gss_svc_searchbyctx(&rsip->out_handle);
957 CERROR("rsci still not mature yet?\n");
960 if (gss_pack_err_notify(req, GSS_S_FAILURE, 0))
965 CDEBUG(D_SEC, "svcsec create gss context %p(%u@%s)\n",
966 rsci, rsci->cred.vc_uid,
967 portals_nid2str(req->rq_peer.peer_ni->pni_number,
968 req->rq_peer.peer_id.nid, nidstr));
970 svcdata->is_init = 1;
971 svcdata->reserve_len = 6 * 4 +
972 size_round4(rsip->out_handle.len) +
973 size_round4(rsip->out_token.len);
975 rc = lustre_pack_reply(req, 0, NULL, NULL);
977 CERROR("failed to pack reply, rc = %d\n", rc);
978 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
979 GOTO(out, rc = SVC_DROP);
983 resp = (__u32 *) req->rq_reply_state->rs_repbuf;
984 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS);
985 *resp++ = cpu_to_le32(PTLRPC_SEC_TYPE_NONE);
986 *resp++ = cpu_to_le32(req->rq_replen);
989 resp += req->rq_replen / 4;
990 reslen = svcdata->reserve_len;
993 * status, major, minor, seq, out_handle, out_token
995 *resp++ = cpu_to_le32(PTLRPCS_OK);
996 *resp++ = cpu_to_le32(rsip->major_status);
997 *resp++ = cpu_to_le32(rsip->minor_status);
998 *resp++ = cpu_to_le32(GSS_SEQ_WIN);
1000 if (rawobj_serialize(&rsip->out_handle,
1006 if (rawobj_serialize(&rsip->out_token,
1012 /* the actual sec data length */
1013 *reslenp = cpu_to_le32(svcdata->reserve_len - reslen);
1015 req->rq_reply_state->rs_repdata_len += le32_to_cpu(*reslenp);
1016 CDEBUG(D_SEC, "req %p: msgsize %d, authsize %d, "
1017 "total size %d\n", req, req->rq_replen,
1018 le32_to_cpu(*reslenp),
1019 req->rq_reply_state->rs_repdata_len);
1023 req->rq_auth_uid = rsci->cred.vc_uid;
1024 req->rq_remote_realm = rsci->remote_realm;
1025 req->rq_mapped_uid = rsci->mapped_uid;
1027 /* This is simplified since right now we doesn't support
1028 * INIT_CONTINUE yet.
1030 if (gc->gc_proc == RPC_GSS_PROC_INIT) {
1031 struct ptlrpcs_wire_hdr *hdr;
1033 hdr = buf_to_sec_hdr(req->rq_reqbuf);
1034 req->rq_reqmsg = buf_to_lustre_msg(req->rq_reqbuf);
1035 req->rq_reqlen = hdr->msg_len;
1042 rsc_put(&rsci->h, &rsc_cache);
1044 rsi_put(&rsip->h, &rsi_cache);
1046 rsi_put(&rsikey->h, &rsi_cache);
1052 gss_svcsec_handle_data(struct ptlrpc_request *req,
1053 struct rpc_gss_wire_cred *gc,
1054 __u32 *secdata, __u32 seclen,
1055 enum ptlrpcs_error *res)
1058 char nidstr[PTL_NALFMT_SIZE];
1063 *res = PTLRPCS_GSS_CREDPROBLEM;
1065 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1067 CWARN("Invalid gss context handle from %s\n",
1068 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1069 req->rq_peer.peer_id.nid, nidstr));
1070 major = GSS_S_NO_CONTEXT;
1074 switch (gc->gc_svc) {
1075 case PTLRPC_GSS_SVC_INTEGRITY:
1076 major = gss_svc_verify_request(req, rsci, gc, secdata, seclen);
1077 if (major == GSS_S_COMPLETE)
1080 CWARN("fail in verify:0x%x: ctx %p@%s\n", major, rsci,
1081 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1082 req->rq_peer.peer_id.nid, nidstr));
1084 case PTLRPC_GSS_SVC_PRIVACY:
1085 major = gss_svc_unseal_request(req, rsci, gc, secdata, seclen);
1086 if (major == GSS_S_COMPLETE)
1089 CWARN("fail in decrypt:0x%x: ctx %p@%s\n", major, rsci,
1090 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1091 req->rq_peer.peer_id.nid, nidstr));
1094 CERROR("unsupported gss service %d\n", gc->gc_svc);
1095 GOTO(out, rc = SVC_DROP);
1098 req->rq_auth_uid = rsci->cred.vc_uid;
1099 req->rq_remote_realm = rsci->remote_realm;
1100 req->rq_mapped_uid = rsci->mapped_uid;
1103 GOTO(out, rc = SVC_OK);
1106 if (gss_pack_err_notify(req, major, 0))
1112 rsc_put(&rsci->h, &rsc_cache);
1117 gss_svcsec_handle_destroy(struct ptlrpc_request *req,
1118 struct rpc_gss_wire_cred *gc,
1119 __u32 *secdata, __u32 seclen,
1120 enum ptlrpcs_error *res)
1122 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
1124 char nidstr[PTL_NALFMT_SIZE];
1129 *res = PTLRPCS_GSS_CREDPROBLEM;
1131 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1133 CWARN("invalid gss context handle for destroy.\n");
1137 if (gc->gc_svc != PTLRPC_GSS_SVC_INTEGRITY) {
1138 CERROR("service %d is not supported in destroy.\n",
1140 GOTO(out, rc = SVC_DROP);
1143 *res = gss_svc_verify_request(req, rsci, gc, secdata, seclen);
1145 GOTO(out, rc = SVC_DROP);
1147 /* compose reply, which is actually nothing */
1148 svcdata->is_fini = 1;
1149 if (lustre_pack_reply(req, 0, NULL, NULL))
1150 GOTO(out, rc = SVC_DROP);
1152 CDEBUG(D_SEC, "svcsec destroy gss context %p(%u@%s)\n",
1153 rsci, rsci->cred.vc_uid,
1154 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1155 req->rq_peer.peer_id.nid, nidstr));
1157 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1161 rsc_put(&rsci->h, &rsc_cache);
1166 * let incomming request go through security check:
1167 * o context establishment: invoke user space helper
1168 * o data exchange: verify/decrypt
1169 * o context destruction: mark context invalid
1171 * in most cases, error will result to drop the packet silently.
1174 gss_svcsec_accept(struct ptlrpc_request *req, enum ptlrpcs_error *res)
1176 struct gss_svc_data *svcdata;
1177 struct rpc_gss_wire_cred *gc;
1178 struct ptlrpcs_wire_hdr *sec_hdr;
1179 __u32 seclen, *secdata, version, subflavor;
1183 CDEBUG(D_SEC, "request %p\n", req);
1184 LASSERT(req->rq_reqbuf);
1185 LASSERT(req->rq_reqbuf_len);
1187 *res = PTLRPCS_BADCRED;
1189 sec_hdr = buf_to_sec_hdr(req->rq_reqbuf);
1190 LASSERT(sec_hdr->flavor == PTLRPC_SEC_GSS);
1192 seclen = req->rq_reqbuf_len - sizeof(*sec_hdr) - sec_hdr->msg_len;
1193 secdata = (__u32 *) buf_to_sec_data(req->rq_reqbuf);
1195 if (sec_hdr->sec_len > seclen) {
1196 CERROR("seclen %d, while max buf %d\n",
1197 sec_hdr->sec_len, seclen);
1201 if (seclen < 6 * 4) {
1202 CERROR("sec size %d too small\n", seclen);
1206 LASSERT(!req->rq_sec_svcdata);
1207 OBD_ALLOC(svcdata, sizeof(*svcdata));
1209 CERROR("fail to alloc svcdata\n");
1212 req->rq_sec_svcdata = svcdata;
1213 gc = &svcdata->clcred;
1215 /* Now secdata/seclen is what we want to parse
1217 version = le32_to_cpu(*secdata++); /* version */
1218 subflavor = le32_to_cpu(*secdata++); /* subflavor */
1219 gc->gc_proc = le32_to_cpu(*secdata++); /* proc */
1220 gc->gc_seq = le32_to_cpu(*secdata++); /* seq */
1221 gc->gc_svc = le32_to_cpu(*secdata++); /* service */
1224 CDEBUG(D_SEC, "wire gss_hdr: %u/%u/%u/%u/%u\n",
1225 version, subflavor, gc->gc_proc, gc->gc_seq, gc->gc_svc);
1227 if (version != PTLRPC_SEC_GSS_VERSION) {
1228 CERROR("gss version mismatch: %d - %d\n",
1229 version, PTLRPC_SEC_GSS_VERSION);
1230 GOTO(err_free, rc = SVC_DROP);
1233 if (rawobj_extract(&gc->gc_ctx, &secdata, &seclen)) {
1234 CERROR("fail to obtain gss context handle\n");
1235 GOTO(err_free, rc = SVC_DROP);
1238 *res = PTLRPCS_BADVERF;
1239 switch(gc->gc_proc) {
1240 case RPC_GSS_PROC_INIT:
1241 case RPC_GSS_PROC_CONTINUE_INIT:
1242 rc = gss_svcsec_handle_init(req, gc, secdata, seclen, res);
1244 case RPC_GSS_PROC_DATA:
1245 rc = gss_svcsec_handle_data(req, gc, secdata, seclen, res);
1247 case RPC_GSS_PROC_DESTROY:
1248 rc = gss_svcsec_handle_destroy(req, gc, secdata, seclen, res);
1256 if (rc == SVC_DROP && req->rq_sec_svcdata) {
1257 OBD_FREE(req->rq_sec_svcdata, sizeof(struct gss_svc_data));
1258 req->rq_sec_svcdata = NULL;
1265 gss_svcsec_authorize(struct ptlrpc_request *req)
1267 struct ptlrpc_reply_state *rs = req->rq_reply_state;
1268 struct gss_svc_data *gsd = (struct gss_svc_data *)req->rq_sec_svcdata;
1269 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1271 struct ptlrpcs_wire_hdr *sec_hdr;
1272 rawobj_buf_t msg_buf;
1273 rawobj_t cipher_buf;
1274 __u32 *vp, *vpsave, major, vlen, seclen;
1280 LASSERT(rs->rs_repbuf);
1283 if (gsd->is_init || gsd->is_init_continue ||
1284 gsd->is_err_notify || gsd->is_fini) {
1285 /* nothing to do in these cases */
1286 CDEBUG(D_SEC, "req %p: init/fini/err\n", req);
1290 if (gc->gc_proc != RPC_GSS_PROC_DATA) {
1291 CERROR("proc %d not support\n", gc->gc_proc);
1295 rscp = gss_svc_searchbyctx(&gc->gc_ctx);
1297 CERROR("ctx disapeared under us?\n");
1301 sec_hdr = (struct ptlrpcs_wire_hdr *) rs->rs_repbuf;
1302 switch (gc->gc_svc) {
1303 case PTLRPC_GSS_SVC_INTEGRITY:
1304 /* prepare various pointers */
1305 lmsg.len = req->rq_replen;
1306 lmsg.data = (__u8 *) (rs->rs_repbuf + sizeof(*sec_hdr));
1307 vp = (__u32 *) (lmsg.data + lmsg.len);
1308 vlen = rs->rs_repbuf_len - sizeof(*sec_hdr) - lmsg.len;
1311 sec_hdr->flavor = cpu_to_le32(PTLRPC_SEC_GSS);
1312 sec_hdr->sectype = cpu_to_le32(PTLRPC_SEC_TYPE_AUTH);
1313 sec_hdr->msg_len = cpu_to_le32(req->rq_replen);
1315 /* standard gss hdr */
1316 LASSERT(vlen >= 7 * 4);
1317 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
1318 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
1319 *vp++ = cpu_to_le32(RPC_GSS_PROC_DATA);
1320 *vp++ = cpu_to_le32(gc->gc_seq);
1321 *vp++ = cpu_to_le32(PTLRPC_GSS_SVC_INTEGRITY);
1322 *vp++ = 0; /* fake ctx handle */
1323 vpsave = vp++; /* reserve size */
1327 mic.data = (unsigned char *)vp;
1329 major = kgss_get_mic(rscp->mechctx, 0, &lmsg, &mic);
1331 CERROR("fail to get MIC: 0x%x\n", major);
1332 GOTO(out, ret = -EINVAL);
1334 *vpsave = cpu_to_le32(mic.len);
1335 seclen = seclen - vlen + mic.len;
1336 sec_hdr->sec_len = cpu_to_le32(seclen);
1337 rs->rs_repdata_len += size_round(seclen);
1339 case PTLRPC_GSS_SVC_PRIVACY:
1340 vp = (__u32 *) (rs->rs_repbuf + sizeof(*sec_hdr));
1341 vlen = rs->rs_repbuf_len - sizeof(*sec_hdr);
1344 sec_hdr->flavor = cpu_to_le32(PTLRPC_SEC_GSS);
1345 sec_hdr->sectype = cpu_to_le32(PTLRPC_SEC_TYPE_PRIV);
1346 sec_hdr->msg_len = cpu_to_le32(0);
1348 /* standard gss hdr */
1349 LASSERT(vlen >= 7 * 4);
1350 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
1351 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
1352 *vp++ = cpu_to_le32(RPC_GSS_PROC_DATA);
1353 *vp++ = cpu_to_le32(gc->gc_seq);
1354 *vp++ = cpu_to_le32(PTLRPC_GSS_SVC_PRIVACY);
1355 *vp++ = 0; /* fake ctx handle */
1356 vpsave = vp++; /* reserve size */
1359 msg_buf.buf = (__u8 *) rs->rs_msg - GSS_PRIVBUF_PREFIX_LEN;
1360 msg_buf.buflen = req->rq_replen + GSS_PRIVBUF_PREFIX_LEN +
1361 GSS_PRIVBUF_SUFFIX_LEN;
1362 msg_buf.dataoff = GSS_PRIVBUF_PREFIX_LEN;
1363 msg_buf.datalen = req->rq_replen;
1365 cipher_buf.data = (__u8 *) vp;
1366 cipher_buf.len = vlen;
1368 major = kgss_wrap(rscp->mechctx, GSS_C_QOP_DEFAULT,
1369 &msg_buf, &cipher_buf);
1371 CERROR("failed to wrap: 0x%x\n", major);
1372 GOTO(out, ret = -EINVAL);
1375 *vpsave = cpu_to_le32(cipher_buf.len);
1376 seclen = seclen - vlen + cipher_buf.len;
1377 sec_hdr->sec_len = cpu_to_le32(seclen);
1378 rs->rs_repdata_len += size_round(seclen);
1381 CERROR("Unknown service %d\n", gc->gc_svc);
1382 GOTO(out, ret = -EINVAL);
1386 rsc_put(&rscp->h, &rsc_cache);
1392 void gss_svcsec_cleanup_req(struct ptlrpc_svcsec *svcsec,
1393 struct ptlrpc_request *req)
1395 struct gss_svc_data *gsd = (struct gss_svc_data *) req->rq_sec_svcdata;
1398 CDEBUG(D_SEC, "no svc_data present. do nothing\n");
1402 /* gsd->clclred.gc_ctx is NOT allocated, just set pointer
1403 * to the incoming packet buffer, so don't need free it
1405 OBD_FREE(gsd, sizeof(*gsd));
1406 req->rq_sec_svcdata = NULL;
1411 int gss_svcsec_est_payload(struct ptlrpc_svcsec *svcsec,
1412 struct ptlrpc_request *req,
1415 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
1418 /* just return the pre-set reserve_len for init/fini/err cases.
1421 if (svcdata->is_init) {
1422 CDEBUG(D_SEC, "is_init, reserver size %d(%d)\n",
1423 size_round(svcdata->reserve_len),
1424 svcdata->reserve_len);
1425 LASSERT(svcdata->reserve_len);
1426 LASSERT(svcdata->reserve_len % 4 == 0);
1427 RETURN(size_round(svcdata->reserve_len));
1428 } else if (svcdata->is_err_notify) {
1429 CDEBUG(D_SEC, "is_err_notify, reserver size %d(%d)\n",
1430 size_round(svcdata->reserve_len),
1431 svcdata->reserve_len);
1432 RETURN(size_round(svcdata->reserve_len));
1433 } else if (svcdata->is_fini) {
1434 CDEBUG(D_SEC, "is_fini, reserver size 0\n");
1437 if (svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_NONE ||
1438 svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_INTEGRITY)
1439 RETURN(size_round(GSS_MAX_AUTH_PAYLOAD));
1440 else if (svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_PRIVACY)
1441 RETURN(size_round16(GSS_MAX_AUTH_PAYLOAD + msgsize +
1442 GSS_PRIVBUF_PREFIX_LEN +
1443 GSS_PRIVBUF_SUFFIX_LEN));
1445 CERROR("unknown gss svc %u\n", svcdata->clcred.gc_svc);
1453 int gss_svcsec_alloc_repbuf(struct ptlrpc_svcsec *svcsec,
1454 struct ptlrpc_request *req,
1457 struct gss_svc_data *gsd = (struct gss_svc_data *) req->rq_sec_svcdata;
1458 struct ptlrpc_reply_state *rs;
1459 int msg_payload, sec_payload;
1463 /* determine the security type: none/auth or priv, we have
1464 * different pack scheme for them.
1465 * init/fini/err will always be treated as none/auth.
1468 if (!gsd->is_init && !gsd->is_init_continue &&
1469 !gsd->is_fini && !gsd->is_err_notify &&
1470 gsd->clcred.gc_svc == PTLRPC_GSS_SVC_PRIVACY)
1475 msg_payload = privacy ? 0 : msgsize;
1476 sec_payload = gss_svcsec_est_payload(svcsec, req, msgsize);
1478 rc = svcsec_alloc_reply_state(req, msg_payload, sec_payload);
1482 rs = req->rq_reply_state;
1484 rs->rs_msg_len = msgsize;
1487 /* we can choose to let msg simply point to the rear of the
1488 * buffer, which lead to buffer overlap when doing encryption.
1489 * usually it's ok and it indeed passed all existing tests.
1490 * but not sure if there will be subtle problems in the future.
1491 * so right now we choose to alloc another new buffer. we'll
1495 rs->rs_msg = (struct lustre_msg *)
1496 (rs->rs_repbuf + rs->rs_repbuf_len -
1497 msgsize - GSS_PRIVBUF_SUFFIX_LEN);
1501 msgsize += GSS_PRIVBUF_PREFIX_LEN + GSS_PRIVBUF_SUFFIX_LEN;
1502 OBD_ALLOC(msgbuf, msgsize);
1504 CERROR("can't alloc %d\n", msgsize);
1505 svcsec_free_reply_state(rs);
1506 req->rq_reply_state = NULL;
1509 rs->rs_msg = (struct lustre_msg *)
1510 (msgbuf + GSS_PRIVBUF_PREFIX_LEN);
1513 req->rq_repmsg = rs->rs_msg;
1519 void gss_svcsec_free_repbuf(struct ptlrpc_svcsec *svcsec,
1520 struct ptlrpc_reply_state *rs)
1522 unsigned long p1 = (unsigned long) rs->rs_msg;
1523 unsigned long p2 = (unsigned long) rs->rs_buf;
1525 LASSERT(rs->rs_buf);
1526 LASSERT(rs->rs_msg);
1527 LASSERT(rs->rs_msg_len);
1529 if (p1 < p2 || p1 >= p2 + rs->rs_buf_len) {
1530 char *start = (char*) rs->rs_msg - GSS_PRIVBUF_PREFIX_LEN;
1531 int size = rs->rs_msg_len + GSS_PRIVBUF_PREFIX_LEN +
1532 GSS_PRIVBUF_SUFFIX_LEN;
1533 OBD_FREE(start, size);
1536 svcsec_free_reply_state(rs);
1539 struct ptlrpc_svcsec svcsec_gss = {
1540 .pss_owner = THIS_MODULE,
1541 .pss_name = "GSS_SVCSEC",
1542 .pss_flavor = {PTLRPC_SEC_GSS, 0},
1543 .accept = gss_svcsec_accept,
1544 .authorize = gss_svcsec_authorize,
1545 .alloc_repbuf = gss_svcsec_alloc_repbuf,
1546 .free_repbuf = gss_svcsec_free_repbuf,
1547 .cleanup_req = gss_svcsec_cleanup_req,
1551 void lgss_svc_cache_purge_all(void)
1553 cache_purge(&rsi_cache);
1554 cache_purge(&rsc_cache);
1556 EXPORT_SYMBOL(lgss_svc_cache_purge_all);
1558 void lgss_svc_cache_flush(__u32 uid)
1562 EXPORT_SYMBOL(lgss_svc_cache_flush);
1564 int gss_svc_init(void)
1568 rc = svcsec_register(&svcsec_gss);
1570 cache_register(&rsc_cache);
1571 cache_register(&rsi_cache);
1576 void gss_svc_exit(void)
1579 if ((rc = cache_unregister(&rsi_cache)))
1580 CERROR("unregister rsi cache: %d\n", rc);
1581 if ((rc = cache_unregister(&rsc_cache)))
1582 CERROR("unregister rsc cache: %d\n", rc);
1583 if ((rc = svcsec_unregister(&svcsec_gss)))
1584 CERROR("unregister svcsec_gss: %d\n", rc);