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 if (cache_put(item, cd)) {
132 OBD_FREE(rsii, sizeof(*rsii));
136 static inline int rsi_hash(struct rsi *item)
138 return hash_mem(item->in_handle.data, item->in_handle.len, RSI_HASHBITS)
139 ^ hash_mem(item->in_token.data, item->in_token.len, RSI_HASHBITS);
142 static inline int rsi_match(struct rsi *item, struct rsi *tmp)
144 return (rawobj_equal(&item->in_handle, &tmp->in_handle) &&
145 rawobj_equal(&item->in_token, &tmp->in_token));
148 static void rsi_request(struct cache_detail *cd,
149 struct cache_head *h,
150 char **bpp, int *blen)
152 struct rsi *rsii = container_of(h, struct rsi, h);
154 qword_addhex(bpp, blen, (char *) &rsii->naltype, sizeof(rsii->naltype));
155 qword_addhex(bpp, blen, (char *) &rsii->netid, sizeof(rsii->netid));
156 qword_addhex(bpp, blen, (char *) &rsii->nid, sizeof(rsii->nid));
157 qword_addhex(bpp, blen, rsii->in_handle.data, rsii->in_handle.len);
158 qword_addhex(bpp, blen, rsii->in_token.data, rsii->in_token.len);
163 gssd_reply(struct rsi *item)
166 struct cache_head **hp, **head;
169 head = &rsi_cache.hash_table[rsi_hash(item)];
170 write_lock(&rsi_cache.hash_lock);
171 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
172 tmp = container_of(*hp, struct rsi, h);
173 if (rsi_match(tmp, item)) {
175 clear_bit(CACHE_HASHED, &tmp->h.flags);
179 if (test_bit(CACHE_VALID, &tmp->h.flags)) {
180 write_unlock(&rsi_cache.hash_lock);
181 rsi_put(&tmp->h, &rsi_cache);
184 set_bit(CACHE_HASHED, &item->h.flags);
188 set_bit(CACHE_VALID, &item->h.flags);
189 item->h.last_refresh = get_seconds();
190 write_unlock(&rsi_cache.hash_lock);
191 cache_fresh(&rsi_cache, &tmp->h, 0);
192 rsi_put(&tmp->h, &rsi_cache);
196 write_unlock(&rsi_cache.hash_lock);
201 * here we just wait here for its completion or timedout. it's a
202 * hacking but works, and we'll comeup with real fix if we decided
203 * to still stick with NFS4 cache code
206 gssd_upcall(struct rsi *item, struct cache_req *chandle)
209 struct cache_head **hp, **head;
210 unsigned long starttime;
213 head = &rsi_cache.hash_table[rsi_hash(item)];
214 read_lock(&rsi_cache.hash_lock);
215 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
216 tmp = container_of(*hp, struct rsi, h);
217 if (rsi_match(tmp, item)) {
219 if (!test_bit(CACHE_VALID, &tmp->h.flags)) {
220 CERROR("found rsi without VALID\n");
221 read_unlock(&rsi_cache.hash_lock);
228 read_unlock(&rsi_cache.hash_lock);
232 // cache_get(&item->h);
233 set_bit(CACHE_HASHED, &item->h.flags);
234 item->h.next = *head;
237 read_unlock(&rsi_cache.hash_lock);
240 cache_check(&rsi_cache, &item->h, chandle);
241 starttime = get_seconds();
244 read_lock(&rsi_cache.hash_lock);
245 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
246 tmp = container_of(*hp, struct rsi, h);
249 if (rsi_match(tmp, item)) {
250 if (!test_bit(CACHE_VALID, &tmp->h.flags)) {
251 read_unlock(&rsi_cache.hash_lock);
255 clear_bit(CACHE_HASHED, &tmp->h.flags);
259 read_unlock(&rsi_cache.hash_lock);
263 read_unlock(&rsi_cache.hash_lock);
264 } while ((get_seconds() - starttime) <= 5);
265 CERROR("5s timeout while waiting cache refill\n");
269 static int rsi_parse(struct cache_detail *cd,
270 char *mesg, int mlen)
272 /* context token expiry major minor context token */
278 int status = -EINVAL;
281 OBD_ALLOC(rsii, sizeof(*rsii));
283 CERROR("failed to alloc rsii\n");
286 cache_init(&rsii->h);
289 len = qword_get(&mesg, buf, mlen);
293 if (rawobj_alloc(&rsii->in_handle, buf, len))
297 len = qword_get(&mesg, buf, mlen);
302 if (rawobj_alloc(&rsii->in_token, buf, len))
306 expiry = get_expiry(&mesg);
312 len = qword_get(&mesg, buf, mlen);
318 rsii->major_status = simple_strtoul(buf, &ep, 10);
321 len = qword_get(&mesg, buf, mlen);
324 rsii->minor_status = simple_strtoul(buf, &ep, 10);
329 len = qword_get(&mesg, buf, mlen);
333 if (rawobj_alloc(&rsii->out_handle, buf, len))
337 len = qword_get(&mesg, buf, mlen);
342 if (rawobj_alloc(&rsii->out_token, buf, len))
345 rsii->h.expiry_time = expiry;
346 status = gssd_reply(rsii);
349 rsi_put(&rsii->h, &rsi_cache);
353 static struct cache_detail rsi_cache = {
354 .hash_size = RSI_HASHMAX,
355 .hash_table = rsi_table,
356 .name = "auth.ptlrpcs.init",
357 .cache_put = rsi_put,
358 .cache_request = rsi_request,
359 .cache_parse = rsi_parse,
363 * The rpcsec_context cache is used to store a context that is
364 * used in data exchange.
365 * The key is a context handle. The content is:
366 * uid, gidlist, mechanism, service-set, mech-specific-data
369 #define RSC_HASHBITS 10
370 #define RSC_HASHMAX (1<<RSC_HASHBITS)
371 #define RSC_HASHMASK (RSC_HASHMAX-1)
373 #define GSS_SEQ_WIN 512
375 struct gss_svc_seq_data {
376 /* highest seq number seen so far: */
378 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
379 * sd_win is nonzero iff sequence number i has been seen already: */
380 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
388 struct vfs_cred cred;
390 struct gss_svc_seq_data seqdata;
391 struct gss_ctx *mechctx;
394 static struct cache_head *rsc_table[RSC_HASHMAX];
395 static struct cache_detail rsc_cache;
397 static void rsc_free(struct rsc *rsci)
399 rawobj_free(&rsci->handle);
401 kgss_delete_sec_context(&rsci->mechctx);
403 if (rsci->cred.vc_ginfo)
404 put_group_info(rsci->cred.vc_ginfo);
408 static void rsc_put(struct cache_head *item, struct cache_detail *cd)
410 struct rsc *rsci = container_of(item, struct rsc, h);
412 if (cache_put(item, cd)) {
414 OBD_FREE(rsci, sizeof(*rsci));
419 rsc_hash(struct rsc *rsci)
421 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
425 rsc_match(struct rsc *new, struct rsc *tmp)
427 return rawobj_equal(&new->handle, &tmp->handle);
430 static struct rsc *rsc_lookup(struct rsc *item, int set)
432 struct rsc *tmp = NULL;
433 struct cache_head **hp, **head;
434 head = &rsc_cache.hash_table[rsc_hash(item)];
438 write_lock(&rsc_cache.hash_lock);
440 read_lock(&rsc_cache.hash_lock);
441 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
442 tmp = container_of(*hp, struct rsc, h);
443 if (!rsc_match(tmp, item))
451 clear_bit(CACHE_HASHED, &tmp->h.flags);
452 rsc_put(&tmp->h, &rsc_cache);
455 /* Didn't find anything */
460 set_bit(CACHE_HASHED, &item->h.flags);
461 item->h.next = *head;
463 write_unlock(&rsc_cache.hash_lock);
464 cache_fresh(&rsc_cache, &item->h, item->h.expiry_time);
468 read_unlock(&rsc_cache.hash_lock);
472 static int rsc_parse(struct cache_detail *cd,
473 char *mesg, int mlen)
475 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
478 struct rsc *rsci, *res = NULL;
480 int status = -EINVAL;
482 OBD_ALLOC(rsci, sizeof(*rsci));
484 CERROR("fail to alloc rsci\n");
487 cache_init(&rsci->h);
490 len = qword_get(&mesg, buf, mlen);
491 if (len < 0) goto out;
493 if (rawobj_alloc(&rsci->handle, buf, len))
497 expiry = get_expiry(&mesg);
503 rv = get_int(&mesg, &rsci->remote_realm);
505 CERROR("fail to get remote flag\n");
510 rv = get_int(&mesg, &rsci->mapped_uid);
512 CERROR("fail to get mapped uid\n");
516 /* uid, or NEGATIVE */
517 rv = get_int(&mesg, &rsci->cred.vc_uid);
521 CERROR("NOENT? set rsc entry negative\n");
522 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
524 struct gss_api_mech *gm;
529 if (get_int(&mesg, &rsci->cred.vc_gid))
533 len = qword_get(&mesg, buf, mlen);
536 gm = kgss_name_to_mech(buf);
537 status = -EOPNOTSUPP;
542 /* mech-specific data: */
543 len = qword_get(&mesg, buf, mlen);
550 if (kgss_import_sec_context(&tmp_buf, gm, &rsci->mechctx)) {
555 /* currently the expiry time passed down from user-space
556 * is invalid, here we retrive it from mech.
558 if (kgss_inquire_context(rsci->mechctx, &ctx_expiry)) {
559 CERROR("unable to get expire time, drop it\n");
560 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
564 expiry = (time_t) ctx_expiry;
568 rsci->h.expiry_time = expiry;
569 spin_lock_init(&rsci->seqdata.sd_lock);
570 res = rsc_lookup(rsci, 1);
571 rsc_put(&res->h, &rsc_cache);
575 rsc_put(&rsci->h, &rsc_cache);
580 * flush all entries with @uid. @uid == -1 will match all.
581 * we only know the uid, maybe netid/nid in the future, in all cases
582 * we must search the whole cache
584 static void rsc_flush(uid_t uid)
586 struct cache_head **ch;
591 write_lock(&rsc_cache.hash_lock);
592 for (n = 0; n < RSC_HASHMAX; n++) {
593 for (ch = &rsc_cache.hash_table[n]; *ch;) {
594 rscp = container_of(*ch, struct rsc, h);
595 if (uid == -1 || rscp->cred.vc_uid == uid) {
596 /* it seems simply set NEGATIVE doesn't work */
600 set_bit(CACHE_NEGATIVE, &rscp->h.flags);
601 clear_bit(CACHE_HASHED, &rscp->h.flags);
602 CWARN("flush rsc %p for uid %u\n",
603 rscp, rscp->cred.vc_uid);
604 rsc_put(&rscp->h, &rsc_cache);
611 write_unlock(&rsc_cache.hash_lock);
615 static struct cache_detail rsc_cache = {
616 .hash_size = RSC_HASHMAX,
617 .hash_table = rsc_table,
618 .name = "auth.ptlrpcs.context",
619 .cache_put = rsc_put,
620 .cache_parse = rsc_parse,
624 gss_svc_searchbyctx(rawobj_t *handle)
629 rsci.handle = *handle;
630 found = rsc_lookup(&rsci, 0);
634 if (cache_check(&rsc_cache, &found->h, NULL))
640 struct gss_svc_data {
641 /* decoded gss client cred: */
642 struct rpc_gss_wire_cred clcred;
643 /* internal used status */
644 unsigned int is_init:1,
652 * again hacking: only try to give the svcgssd a chance to handle
655 struct cache_deferred_req* my_defer(struct cache_req *req)
660 static struct cache_req my_chandle = {my_defer};
662 /* Implements sequence number algorithm as specified in RFC 2203. */
664 gss_check_seq_num(struct gss_svc_seq_data *sd, __u32 seq_num)
668 spin_lock(&sd->sd_lock);
669 if (seq_num > sd->sd_max) {
670 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
671 memset(sd->sd_win, 0, sizeof(sd->sd_win));
672 sd->sd_max = seq_num;
674 while(sd->sd_max < seq_num) {
676 __clear_bit(sd->sd_max % GSS_SEQ_WIN,
680 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
682 } else if (seq_num + GSS_SEQ_WIN <= sd->sd_max) {
683 CERROR("seq %u too low: max %u, win %d\n",
684 seq_num, sd->sd_max, GSS_SEQ_WIN);
689 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win)) {
690 CERROR("seq %u is replay: max %u, win %d\n",
691 seq_num, sd->sd_max, GSS_SEQ_WIN);
695 spin_unlock(&sd->sd_lock);
700 gss_svc_verify_request(struct ptlrpc_request *req,
702 struct rpc_gss_wire_cred *gc,
703 __u32 *vp, __u32 vlen)
705 struct ptlrpcs_wire_hdr *sec_hdr;
706 struct gss_ctx *ctx = rsci->mechctx;
712 sec_hdr = (struct ptlrpcs_wire_hdr *) req->rq_reqbuf;
714 req->rq_reqmsg = (struct lustre_msg *) (req->rq_reqbuf + sizeof(*sec_hdr));
715 req->rq_reqlen = sec_hdr->msg_len;
717 msg.len = sec_hdr->msg_len;
718 msg.data = (__u8 *)req->rq_reqmsg;
720 mic.len = le32_to_cpu(*vp++);
721 mic.data = (char *) vp;
724 if (mic.len > vlen) {
725 CERROR("checksum len %d, while buffer len %d\n",
727 RETURN(GSS_S_CALL_BAD_STRUCTURE);
731 CERROR("invalid mic len %d\n", mic.len);
732 RETURN(GSS_S_CALL_BAD_STRUCTURE);
735 maj_stat = kgss_verify_mic(ctx, &msg, &mic, NULL);
736 if (maj_stat != GSS_S_COMPLETE) {
737 CERROR("MIC verification error: major %x\n", maj_stat);
741 if (gss_check_seq_num(&rsci->seqdata, gc->gc_seq)) {
742 CERROR("discard request %p with old seq_num %u\n",
744 RETURN(GSS_S_DUPLICATE_TOKEN);
747 RETURN(GSS_S_COMPLETE);
751 gss_svc_unseal_request(struct ptlrpc_request *req,
753 struct rpc_gss_wire_cred *gc,
754 __u32 *vp, __u32 vlen)
756 struct ptlrpcs_wire_hdr *sec_hdr;
757 struct gss_ctx *ctx = rsci->mechctx;
758 rawobj_t cipher_text, plain_text;
762 sec_hdr = (struct ptlrpcs_wire_hdr *) req->rq_reqbuf;
765 CERROR("vlen only %u\n", vlen);
766 RETURN(GSS_S_CALL_BAD_STRUCTURE);
769 cipher_text.len = le32_to_cpu(*vp++);
770 cipher_text.data = (__u8 *) vp;
773 if (cipher_text.len > vlen) {
774 CERROR("cipher claimed %u while buf only %u\n",
775 cipher_text.len, vlen);
776 RETURN(GSS_S_CALL_BAD_STRUCTURE);
779 plain_text = cipher_text;
781 major = kgss_unwrap(ctx, GSS_C_QOP_DEFAULT, &cipher_text, &plain_text);
783 CERROR("unwrap error 0x%x\n", major);
787 if (gss_check_seq_num(&rsci->seqdata, gc->gc_seq)) {
788 CERROR("discard request %p with old seq_num %u\n",
790 RETURN(GSS_S_DUPLICATE_TOKEN);
793 req->rq_reqmsg = (struct lustre_msg *) (vp);
794 req->rq_reqlen = plain_text.len;
796 CDEBUG(D_SEC, "msg len %d\n", req->rq_reqlen);
798 RETURN(GSS_S_COMPLETE);
802 gss_pack_err_notify(struct ptlrpc_request *req,
803 __u32 major, __u32 minor)
805 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
806 __u32 reslen, *resp, *reslenp;
807 char nidstr[PTL_NALFMT_SIZE];
808 const __u32 secdata_len = 7 * 4;
812 OBD_FAIL_RETURN(OBD_FAIL_SVCGSS_ERR_NOTIFY|OBD_FAIL_ONCE, -EINVAL);
815 svcdata->is_err_notify = 1;
816 svcdata->reserve_len = 7 * 4;
818 rc = lustre_pack_reply(req, 0, NULL, NULL);
820 CERROR("could not pack reply, err %d\n", rc);
824 LASSERT(req->rq_reply_state);
825 LASSERT(req->rq_reply_state->rs_repbuf);
826 LASSERT(req->rq_reply_state->rs_repbuf_len >= secdata_len);
827 resp = (__u32 *) req->rq_reply_state->rs_repbuf;
830 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS);
831 *resp++ = cpu_to_le32(PTLRPC_SEC_TYPE_NONE);
832 *resp++ = cpu_to_le32(req->rq_replen);
835 /* skip lustre msg */
836 resp += req->rq_replen / 4;
837 reslen = svcdata->reserve_len;
840 * version, subflavor, notify, major, minor,
841 * obj1(fake), obj2(fake)
843 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
844 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
845 *resp++ = cpu_to_le32(PTLRPC_GSS_PROC_ERR);
846 *resp++ = cpu_to_le32(major);
847 *resp++ = cpu_to_le32(minor);
851 /* the actual sec data length */
852 *reslenp = cpu_to_le32(secdata_len);
854 req->rq_reply_state->rs_repdata_len += (secdata_len);
855 CWARN("prepare gss error notify(0x%x/0x%x) to %s\n", major, minor,
856 portals_nid2str(req->rq_peer.peer_ni->pni_number,
857 req->rq_peer.peer_id.nid, nidstr));
862 gss_svcsec_handle_init(struct ptlrpc_request *req,
863 struct rpc_gss_wire_cred *gc,
864 __u32 *secdata, __u32 seclen,
865 enum ptlrpcs_error *res)
867 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
869 struct rsi *rsikey, *rsip;
871 __u32 reslen, *resp, *reslenp;
872 char nidstr[PTL_NALFMT_SIZE];
878 CWARN("processing gss init(%d) request from %s\n", gc->gc_proc,
879 portals_nid2str(req->rq_peer.peer_ni->pni_number,
880 req->rq_peer.peer_id.nid, nidstr));
882 *res = PTLRPCS_BADCRED;
883 OBD_FAIL_RETURN(OBD_FAIL_SVCGSS_INIT_REQ|OBD_FAIL_ONCE, SVC_DROP);
885 if (gc->gc_proc == RPC_GSS_PROC_INIT &&
886 gc->gc_ctx.len != 0) {
887 CERROR("proc %d, ctx_len %d: not really init?\n",
888 gc->gc_proc == RPC_GSS_PROC_INIT, gc->gc_ctx.len);
892 OBD_ALLOC(rsikey, sizeof(*rsikey));
894 CERROR("out of memory\n");
897 cache_init(&rsikey->h);
899 if (rawobj_dup(&rsikey->in_handle, &gc->gc_ctx)) {
900 CERROR("fail to dup context handle\n");
901 GOTO(out_rsikey, rc = SVC_DROP);
903 *res = PTLRPCS_BADVERF;
904 if (rawobj_extract(&tmpobj, &secdata, &seclen)) {
905 CERROR("can't extract token\n");
906 GOTO(out_rsikey, rc = SVC_DROP);
908 if (rawobj_dup(&rsikey->in_token, &tmpobj)) {
909 CERROR("can't duplicate token\n");
910 GOTO(out_rsikey, rc = SVC_DROP);
913 rsikey->naltype = (__u32) req->rq_peer.peer_ni->pni_number;
915 rsikey->nid = (__u64) req->rq_peer.peer_id.nid;
917 rsip = gssd_upcall(rsikey, &my_chandle);
919 CERROR("error in gssd_upcall.\n");
920 GOTO(out_rsikey, rc = SVC_DROP);
923 rsci = gss_svc_searchbyctx(&rsip->out_handle);
925 CERROR("rsci still not mature yet?\n");
927 if (gss_pack_err_notify(req, GSS_S_FAILURE, 0))
934 CWARN("svcsec create gss context %p(%u@%s)\n",
935 rsci, rsci->cred.vc_uid,
936 portals_nid2str(req->rq_peer.peer_ni->pni_number,
937 req->rq_peer.peer_id.nid, nidstr));
939 svcdata->is_init = 1;
940 svcdata->reserve_len = 6 * 4 +
941 size_round4(rsip->out_handle.len) +
942 size_round4(rsip->out_token.len);
944 rc = lustre_pack_reply(req, 0, NULL, NULL);
946 CERROR("failed to pack reply, rc = %d\n", rc);
947 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
948 GOTO(out, rc = SVC_DROP);
952 resp = (__u32 *) req->rq_reply_state->rs_repbuf;
953 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS);
954 *resp++ = cpu_to_le32(PTLRPC_SEC_TYPE_NONE);
955 *resp++ = cpu_to_le32(req->rq_replen);
958 resp += req->rq_replen / 4;
959 reslen = svcdata->reserve_len;
962 * status, major, minor, seq, out_handle, out_token
964 *resp++ = cpu_to_le32(PTLRPCS_OK);
965 *resp++ = cpu_to_le32(rsip->major_status);
966 *resp++ = cpu_to_le32(rsip->minor_status);
967 *resp++ = cpu_to_le32(GSS_SEQ_WIN);
969 if (rawobj_serialize(&rsip->out_handle,
972 if (rawobj_serialize(&rsip->out_token,
975 /* the actual sec data length */
976 *reslenp = cpu_to_le32(svcdata->reserve_len - reslen);
978 req->rq_reply_state->rs_repdata_len += le32_to_cpu(*reslenp);
979 CDEBUG(D_SEC, "req %p: msgsize %d, authsize %d, "
980 "total size %d\n", req, req->rq_replen,
981 le32_to_cpu(*reslenp),
982 req->rq_reply_state->rs_repdata_len);
986 req->rq_auth_uid = rsci->cred.vc_uid;
987 req->rq_remote_realm = rsci->remote_realm;
988 req->rq_mapped_uid = rsci->mapped_uid;
990 /* This is simplified since right now we doesn't support
993 if (gc->gc_proc == RPC_GSS_PROC_INIT) {
994 struct ptlrpcs_wire_hdr *hdr;
996 hdr = buf_to_sec_hdr(req->rq_reqbuf);
997 req->rq_reqmsg = buf_to_lustre_msg(req->rq_reqbuf);
998 req->rq_reqlen = hdr->msg_len;
1005 rsc_put(&rsci->h, &rsc_cache);
1007 rsi_put(&rsip->h, &rsi_cache);
1009 rsi_put(&rsikey->h, &rsi_cache);
1015 gss_svcsec_handle_data(struct ptlrpc_request *req,
1016 struct rpc_gss_wire_cred *gc,
1017 __u32 *secdata, __u32 seclen,
1018 enum ptlrpcs_error *res)
1021 char nidstr[PTL_NALFMT_SIZE];
1026 *res = PTLRPCS_GSS_CREDPROBLEM;
1028 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1030 CWARN("Invalid gss context handle from %s\n",
1031 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1032 req->rq_peer.peer_id.nid, nidstr));
1033 major = GSS_S_NO_CONTEXT;
1037 switch (gc->gc_svc) {
1038 case PTLRPC_GSS_SVC_INTEGRITY:
1039 major = gss_svc_verify_request(req, rsci, gc, secdata, seclen);
1040 if (major == GSS_S_COMPLETE)
1043 CWARN("fail in verify:0x%x: ctx %p@%s\n", major, rsci,
1044 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1045 req->rq_peer.peer_id.nid, nidstr));
1047 case PTLRPC_GSS_SVC_PRIVACY:
1048 major = gss_svc_unseal_request(req, rsci, gc, secdata, seclen);
1049 if (major == GSS_S_COMPLETE)
1052 CWARN("fail in decrypt:0x%x: ctx %p@%s\n", major, rsci,
1053 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1054 req->rq_peer.peer_id.nid, nidstr));
1057 CERROR("unsupported gss service %d\n", gc->gc_svc);
1058 GOTO(out, rc = SVC_DROP);
1061 req->rq_auth_uid = rsci->cred.vc_uid;
1062 req->rq_remote_realm = rsci->remote_realm;
1063 req->rq_mapped_uid = rsci->mapped_uid;
1066 GOTO(out, rc = SVC_OK);
1069 if (gss_pack_err_notify(req, major, 0))
1075 rsc_put(&rsci->h, &rsc_cache);
1080 gss_svcsec_handle_destroy(struct ptlrpc_request *req,
1081 struct rpc_gss_wire_cred *gc,
1082 __u32 *secdata, __u32 seclen,
1083 enum ptlrpcs_error *res)
1085 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
1087 char nidstr[PTL_NALFMT_SIZE];
1092 *res = PTLRPCS_GSS_CREDPROBLEM;
1094 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1096 CWARN("invalid gss context handle for destroy.\n");
1100 if (gc->gc_svc != PTLRPC_GSS_SVC_INTEGRITY) {
1101 CERROR("service %d is not supported in destroy.\n",
1103 GOTO(out, rc = SVC_DROP);
1106 *res = gss_svc_verify_request(req, rsci, gc, secdata, seclen);
1108 GOTO(out, rc = SVC_DROP);
1110 /* compose reply, which is actually nothing */
1111 svcdata->is_fini = 1;
1112 if (lustre_pack_reply(req, 0, NULL, NULL))
1113 GOTO(out, rc = SVC_DROP);
1115 CWARN("svcsec destroy gss context %p(%u@%s)\n",
1116 rsci, rsci->cred.vc_uid,
1117 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1118 req->rq_peer.peer_id.nid, nidstr));
1120 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1124 rsc_put(&rsci->h, &rsc_cache);
1129 * let incomming request go through security check:
1130 * o context establishment: invoke user space helper
1131 * o data exchange: verify/decrypt
1132 * o context destruction: mark context invalid
1134 * in most cases, error will result to drop the packet silently.
1137 gss_svcsec_accept(struct ptlrpc_request *req, enum ptlrpcs_error *res)
1139 struct gss_svc_data *svcdata;
1140 struct rpc_gss_wire_cred *gc;
1141 struct ptlrpcs_wire_hdr *sec_hdr;
1142 __u32 seclen, *secdata, version, subflavor;
1146 CDEBUG(D_SEC, "request %p\n", req);
1147 LASSERT(req->rq_reqbuf);
1148 LASSERT(req->rq_reqbuf_len);
1150 *res = PTLRPCS_BADCRED;
1152 sec_hdr = buf_to_sec_hdr(req->rq_reqbuf);
1153 LASSERT(sec_hdr->flavor == PTLRPC_SEC_GSS);
1155 seclen = req->rq_reqbuf_len - sizeof(*sec_hdr) - sec_hdr->msg_len;
1156 secdata = (__u32 *) buf_to_sec_data(req->rq_reqbuf);
1158 if (sec_hdr->sec_len > seclen) {
1159 CERROR("seclen %d, while max buf %d\n",
1160 sec_hdr->sec_len, seclen);
1164 if (seclen < 6 * 4) {
1165 CERROR("sec size %d too small\n", seclen);
1169 LASSERT(!req->rq_sec_svcdata);
1170 OBD_ALLOC(svcdata, sizeof(*svcdata));
1172 CERROR("fail to alloc svcdata\n");
1175 req->rq_sec_svcdata = svcdata;
1176 gc = &svcdata->clcred;
1178 /* Now secdata/seclen is what we want to parse
1180 version = le32_to_cpu(*secdata++); /* version */
1181 subflavor = le32_to_cpu(*secdata++); /* subflavor */
1182 gc->gc_proc = le32_to_cpu(*secdata++); /* proc */
1183 gc->gc_seq = le32_to_cpu(*secdata++); /* seq */
1184 gc->gc_svc = le32_to_cpu(*secdata++); /* service */
1187 CDEBUG(D_SEC, "wire gss_hdr: %u/%u/%u/%u/%u\n",
1188 version, subflavor, gc->gc_proc, gc->gc_seq, gc->gc_svc);
1190 if (version != PTLRPC_SEC_GSS_VERSION) {
1191 CERROR("gss version mismatch: %d - %d\n",
1192 version, PTLRPC_SEC_GSS_VERSION);
1193 GOTO(err_free, rc = SVC_DROP);
1196 if (rawobj_extract(&gc->gc_ctx, &secdata, &seclen)) {
1197 CERROR("fail to obtain gss context handle\n");
1198 GOTO(err_free, rc = SVC_DROP);
1201 *res = PTLRPCS_BADVERF;
1202 switch(gc->gc_proc) {
1203 case RPC_GSS_PROC_INIT:
1204 case RPC_GSS_PROC_CONTINUE_INIT:
1205 rc = gss_svcsec_handle_init(req, gc, secdata, seclen, res);
1207 case RPC_GSS_PROC_DATA:
1208 rc = gss_svcsec_handle_data(req, gc, secdata, seclen, res);
1210 case RPC_GSS_PROC_DESTROY:
1211 rc = gss_svcsec_handle_destroy(req, gc, secdata, seclen, res);
1219 if (rc == SVC_DROP && req->rq_sec_svcdata) {
1220 OBD_FREE(req->rq_sec_svcdata, sizeof(struct gss_svc_data));
1221 req->rq_sec_svcdata = NULL;
1228 gss_svcsec_authorize(struct ptlrpc_request *req)
1230 struct ptlrpc_reply_state *rs = req->rq_reply_state;
1231 struct gss_svc_data *gsd = (struct gss_svc_data *)req->rq_sec_svcdata;
1232 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1234 struct ptlrpcs_wire_hdr *sec_hdr;
1235 rawobj_buf_t msg_buf;
1236 rawobj_t cipher_buf;
1237 __u32 *vp, *vpsave, major, vlen, seclen;
1243 LASSERT(rs->rs_repbuf);
1246 if (gsd->is_init || gsd->is_init_continue ||
1247 gsd->is_err_notify || gsd->is_fini) {
1248 /* nothing to do in these cases */
1249 CDEBUG(D_SEC, "req %p: init/fini/err\n", req);
1253 if (gc->gc_proc != RPC_GSS_PROC_DATA) {
1254 CERROR("proc %d not support\n", gc->gc_proc);
1258 rscp = gss_svc_searchbyctx(&gc->gc_ctx);
1260 CERROR("ctx disapeared under us?\n");
1264 sec_hdr = (struct ptlrpcs_wire_hdr *) rs->rs_repbuf;
1265 switch (gc->gc_svc) {
1266 case PTLRPC_GSS_SVC_INTEGRITY:
1267 /* prepare various pointers */
1268 lmsg.len = req->rq_replen;
1269 lmsg.data = (__u8 *) (rs->rs_repbuf + sizeof(*sec_hdr));
1270 vp = (__u32 *) (lmsg.data + lmsg.len);
1271 vlen = rs->rs_repbuf_len - sizeof(*sec_hdr) - lmsg.len;
1274 sec_hdr->flavor = cpu_to_le32(PTLRPC_SEC_GSS);
1275 sec_hdr->sectype = cpu_to_le32(PTLRPC_SEC_TYPE_AUTH);
1276 sec_hdr->msg_len = cpu_to_le32(req->rq_replen);
1278 /* standard gss hdr */
1279 LASSERT(vlen >= 7 * 4);
1280 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
1281 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
1282 *vp++ = cpu_to_le32(RPC_GSS_PROC_DATA);
1283 *vp++ = cpu_to_le32(gc->gc_seq);
1284 *vp++ = cpu_to_le32(PTLRPC_GSS_SVC_INTEGRITY);
1285 *vp++ = 0; /* fake ctx handle */
1286 vpsave = vp++; /* reserve size */
1290 mic.data = (char *) vp;
1292 major = kgss_get_mic(rscp->mechctx, 0, &lmsg, &mic);
1294 CERROR("fail to get MIC: 0x%x\n", major);
1295 GOTO(out, ret = -EINVAL);
1297 *vpsave = cpu_to_le32(mic.len);
1298 seclen = seclen - vlen + mic.len;
1299 sec_hdr->sec_len = cpu_to_le32(seclen);
1300 rs->rs_repdata_len += size_round(seclen);
1302 case PTLRPC_GSS_SVC_PRIVACY:
1303 vp = (__u32 *) (rs->rs_repbuf + sizeof(*sec_hdr));
1304 vlen = rs->rs_repbuf_len - sizeof(*sec_hdr);
1307 sec_hdr->flavor = cpu_to_le32(PTLRPC_SEC_GSS);
1308 sec_hdr->sectype = cpu_to_le32(PTLRPC_SEC_TYPE_PRIV);
1309 sec_hdr->msg_len = cpu_to_le32(0);
1311 /* standard gss hdr */
1312 LASSERT(vlen >= 7 * 4);
1313 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
1314 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
1315 *vp++ = cpu_to_le32(RPC_GSS_PROC_DATA);
1316 *vp++ = cpu_to_le32(gc->gc_seq);
1317 *vp++ = cpu_to_le32(PTLRPC_GSS_SVC_PRIVACY);
1318 *vp++ = 0; /* fake ctx handle */
1319 vpsave = vp++; /* reserve size */
1322 msg_buf.buf = (__u8 *) rs->rs_msg - GSS_PRIVBUF_PREFIX_LEN;
1323 msg_buf.buflen = req->rq_replen + GSS_PRIVBUF_PREFIX_LEN +
1324 GSS_PRIVBUF_SUFFIX_LEN;
1325 msg_buf.dataoff = GSS_PRIVBUF_PREFIX_LEN;
1326 msg_buf.datalen = req->rq_replen;
1328 cipher_buf.data = (__u8 *) vp;
1329 cipher_buf.len = vlen;
1331 major = kgss_wrap(rscp->mechctx, GSS_C_QOP_DEFAULT,
1332 &msg_buf, &cipher_buf);
1334 CERROR("failed to wrap: 0x%x\n", major);
1335 GOTO(out, ret = -EINVAL);
1338 *vpsave = cpu_to_le32(cipher_buf.len);
1339 seclen = seclen - vlen + cipher_buf.len;
1340 sec_hdr->sec_len = cpu_to_le32(seclen);
1341 rs->rs_repdata_len += size_round(seclen);
1344 CERROR("Unknown service %d\n", gc->gc_svc);
1345 GOTO(out, ret = -EINVAL);
1349 rsc_put(&rscp->h, &rsc_cache);
1355 void gss_svcsec_cleanup_req(struct ptlrpc_svcsec *svcsec,
1356 struct ptlrpc_request *req)
1358 struct gss_svc_data *gsd = (struct gss_svc_data *) req->rq_sec_svcdata;
1361 CDEBUG(D_SEC, "no svc_data present. do nothing\n");
1365 /* gsd->clclred.gc_ctx is NOT allocated, just set pointer
1366 * to the incoming packet buffer, so don't need free it
1368 OBD_FREE(gsd, sizeof(*gsd));
1369 req->rq_sec_svcdata = NULL;
1374 int gss_svcsec_est_payload(struct ptlrpc_svcsec *svcsec,
1375 struct ptlrpc_request *req,
1378 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
1381 /* just return the pre-set reserve_len for init/fini/err cases.
1384 if (svcdata->is_init) {
1385 CDEBUG(D_SEC, "is_init, reserver size %d(%d)\n",
1386 size_round(svcdata->reserve_len),
1387 svcdata->reserve_len);
1388 LASSERT(svcdata->reserve_len);
1389 LASSERT(svcdata->reserve_len % 4 == 0);
1390 RETURN(size_round(svcdata->reserve_len));
1391 } else if (svcdata->is_err_notify) {
1392 CDEBUG(D_SEC, "is_err_notify, reserver size %d(%d)\n",
1393 size_round(svcdata->reserve_len),
1394 svcdata->reserve_len);
1395 RETURN(size_round(svcdata->reserve_len));
1396 } else if (svcdata->is_fini) {
1397 CDEBUG(D_SEC, "is_fini, reserver size 0\n");
1400 if (svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_NONE ||
1401 svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_INTEGRITY)
1402 RETURN(size_round(GSS_MAX_AUTH_PAYLOAD));
1403 else if (svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_PRIVACY)
1404 RETURN(size_round16(GSS_MAX_AUTH_PAYLOAD + msgsize +
1405 GSS_PRIVBUF_PREFIX_LEN +
1406 GSS_PRIVBUF_SUFFIX_LEN));
1408 CERROR("unknown gss svc %u\n", svcdata->clcred.gc_svc);
1416 int gss_svcsec_alloc_repbuf(struct ptlrpc_svcsec *svcsec,
1417 struct ptlrpc_request *req,
1420 struct gss_svc_data *gsd = (struct gss_svc_data *) req->rq_sec_svcdata;
1421 struct ptlrpc_reply_state *rs;
1422 int msg_payload, sec_payload;
1426 /* determine the security type: none/auth or priv, we have
1427 * different pack scheme for them.
1428 * init/fini/err will always be treated as none/auth.
1431 if (!gsd->is_init && !gsd->is_init_continue &&
1432 !gsd->is_fini && !gsd->is_err_notify &&
1433 gsd->clcred.gc_svc == PTLRPC_GSS_SVC_PRIVACY)
1438 msg_payload = privacy ? 0 : msgsize;
1439 sec_payload = gss_svcsec_est_payload(svcsec, req, msgsize);
1441 rc = svcsec_alloc_reply_state(req, msg_payload, sec_payload);
1445 rs = req->rq_reply_state;
1447 rs->rs_msg_len = msgsize;
1450 /* we can choose to let msg simply point to the rear of the
1451 * buffer, which lead to buffer overlap when doing encryption.
1452 * usually it's ok and it indeed passed all existing tests.
1453 * but not sure if there will be subtle problems in the future.
1454 * so right now we choose to alloc another new buffer. we'll
1458 rs->rs_msg = (struct lustre_msg *)
1459 (rs->rs_repbuf + rs->rs_repbuf_len -
1460 msgsize - GSS_PRIVBUF_SUFFIX_LEN);
1464 msgsize += GSS_PRIVBUF_PREFIX_LEN + GSS_PRIVBUF_SUFFIX_LEN;
1465 OBD_ALLOC(msgbuf, msgsize);
1467 CERROR("can't alloc %d\n", msgsize);
1468 svcsec_free_reply_state(rs);
1469 req->rq_reply_state = NULL;
1472 rs->rs_msg = (struct lustre_msg *)
1473 (msgbuf + GSS_PRIVBUF_PREFIX_LEN);
1476 req->rq_repmsg = rs->rs_msg;
1482 void gss_svcsec_free_repbuf(struct ptlrpc_svcsec *svcsec,
1483 struct ptlrpc_reply_state *rs)
1485 unsigned long p1 = (unsigned long) rs->rs_msg;
1486 unsigned long p2 = (unsigned long) rs->rs_buf;
1488 LASSERT(rs->rs_buf);
1489 LASSERT(rs->rs_msg);
1490 LASSERT(rs->rs_msg_len);
1492 if (p1 < p2 || p1 >= p2 + rs->rs_buf_len) {
1493 char *start = (char*) rs->rs_msg - GSS_PRIVBUF_PREFIX_LEN;
1494 int size = rs->rs_msg_len + GSS_PRIVBUF_PREFIX_LEN +
1495 GSS_PRIVBUF_SUFFIX_LEN;
1496 OBD_FREE(start, size);
1499 svcsec_free_reply_state(rs);
1502 struct ptlrpc_svcsec svcsec_gss = {
1503 .pss_owner = THIS_MODULE,
1504 .pss_name = "GSS_SVCSEC",
1505 .pss_flavor = {PTLRPC_SEC_GSS, 0},
1506 .accept = gss_svcsec_accept,
1507 .authorize = gss_svcsec_authorize,
1508 .alloc_repbuf = gss_svcsec_alloc_repbuf,
1509 .free_repbuf = gss_svcsec_free_repbuf,
1510 .cleanup_req = gss_svcsec_cleanup_req,
1514 void lgss_svc_cache_purge_all(void)
1516 cache_purge(&rsi_cache);
1517 cache_purge(&rsc_cache);
1519 EXPORT_SYMBOL(lgss_svc_cache_purge_all);
1521 void lgss_svc_cache_flush(__u32 uid)
1525 EXPORT_SYMBOL(lgss_svc_cache_flush);
1527 int gss_svc_init(void)
1531 rc = svcsec_register(&svcsec_gss);
1533 cache_register(&rsc_cache);
1534 cache_register(&rsi_cache);
1539 void gss_svc_exit(void)
1542 if ((rc = cache_unregister(&rsi_cache)))
1543 CERROR("unregister rsi cache: %d\n", rc);
1544 if ((rc = cache_unregister(&rsc_cache)))
1545 CERROR("unregister rsc cache: %d\n", rc);
1546 if ((rc = svcsec_unregister(&svcsec_gss)))
1547 CERROR("unregister svcsec_gss: %d\n", rc);