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)
112 rawobj_t in_handle, in_token, in_srv_type;
113 rawobj_t out_handle, out_token;
114 int major_status, minor_status;
117 static struct cache_head *rsi_table[RSI_HASHMAX];
118 static struct cache_detail rsi_cache;
120 static void rsi_free(struct rsi *rsii)
122 rawobj_free(&rsii->in_handle);
123 rawobj_free(&rsii->in_token);
124 rawobj_free(&rsii->out_handle);
125 rawobj_free(&rsii->out_token);
128 static void rsi_put(struct cache_head *item, struct cache_detail *cd)
130 struct rsi *rsii = container_of(item, struct rsi, h);
131 LASSERT(atomic_read(&item->refcnt) > 0);
132 if (cache_put(item, cd)) {
133 LASSERT(item->next == NULL);
135 OBD_FREE(rsii, sizeof(*rsii));
139 static inline int rsi_hash(struct rsi *item)
141 return hash_mem((char *)item->in_handle.data, item->in_handle.len, RSI_HASHBITS)
142 ^ hash_mem((char *)item->in_token.data, item->in_token.len, RSI_HASHBITS);
145 static inline int rsi_match(struct rsi *item, struct rsi *tmp)
147 return (rawobj_equal(&item->in_handle, &tmp->in_handle) &&
148 rawobj_equal(&item->in_token, &tmp->in_token));
151 static void rsi_request(struct cache_detail *cd,
152 struct cache_head *h,
153 char **bpp, int *blen)
155 struct rsi *rsii = container_of(h, struct rsi, h);
157 qword_addhex(bpp, blen, (char *) &rsii->lustre_svc,
158 sizeof(rsii->lustre_svc));
159 qword_addhex(bpp, blen, (char *) &rsii->naltype, sizeof(rsii->naltype));
160 qword_addhex(bpp, blen, (char *) &rsii->netid, sizeof(rsii->netid));
161 qword_addhex(bpp, blen, (char *) &rsii->nid, sizeof(rsii->nid));
162 qword_addhex(bpp, blen, rsii->in_handle.data, rsii->in_handle.len);
163 qword_addhex(bpp, blen, rsii->in_token.data, rsii->in_token.len);
168 gssd_reply(struct rsi *item)
171 struct cache_head **hp, **head;
174 head = &rsi_cache.hash_table[rsi_hash(item)];
175 write_lock(&rsi_cache.hash_lock);
176 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
177 tmp = container_of(*hp, struct rsi, h);
178 if (rsi_match(tmp, item)) {
180 clear_bit(CACHE_HASHED, &tmp->h.flags);
184 if (test_bit(CACHE_VALID, &tmp->h.flags)) {
185 CERROR("rsi is valid\n");
186 write_unlock(&rsi_cache.hash_lock);
187 rsi_put(&tmp->h, &rsi_cache);
190 set_bit(CACHE_HASHED, &item->h.flags);
194 set_bit(CACHE_VALID, &item->h.flags);
195 item->h.last_refresh = get_seconds();
196 write_unlock(&rsi_cache.hash_lock);
197 cache_fresh(&rsi_cache, &tmp->h, 0);
198 rsi_put(&tmp->h, &rsi_cache);
202 write_unlock(&rsi_cache.hash_lock);
207 * here we just wait here for its completion or timedout. it's a
208 * hacking but works, and we'll comeup with real fix if we decided
209 * to still stick with NFS4 cache code
212 gssd_upcall(struct rsi *item, struct cache_req *chandle)
215 struct cache_head **hp, **head;
216 unsigned long starttime;
219 head = &rsi_cache.hash_table[rsi_hash(item)];
220 read_lock(&rsi_cache.hash_lock);
221 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
222 tmp = container_of(*hp, struct rsi, h);
223 if (rsi_match(tmp, item)) {
225 if (!test_bit(CACHE_VALID, &tmp->h.flags)) {
226 CERROR("found rsi without VALID\n");
227 read_unlock(&rsi_cache.hash_lock);
234 read_unlock(&rsi_cache.hash_lock);
239 //set_bit(CACHE_HASHED, &item->h.flags);
240 item->h.next = *head;
243 read_unlock(&rsi_cache.hash_lock);
244 //cache_get(&item->h);
246 cache_check(&rsi_cache, &item->h, chandle);
247 starttime = get_seconds();
249 set_current_state(TASK_UNINTERRUPTIBLE);
250 schedule_timeout(HZ/2);
251 read_lock(&rsi_cache.hash_lock);
252 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
253 tmp = container_of(*hp, struct rsi, h);
256 if (rsi_match(tmp, item)) {
257 if (!test_bit(CACHE_VALID, &tmp->h.flags)) {
258 read_unlock(&rsi_cache.hash_lock);
262 clear_bit(CACHE_HASHED, &tmp->h.flags);
266 read_unlock(&rsi_cache.hash_lock);
270 read_unlock(&rsi_cache.hash_lock);
271 } while ((get_seconds() - starttime) <= 15);
272 CERROR("15s timeout while waiting cache refill\n");
276 static int rsi_parse(struct cache_detail *cd,
277 char *mesg, int mlen)
279 /* context token expiry major minor context token */
285 int status = -EINVAL;
288 OBD_ALLOC(rsii, sizeof(*rsii));
291 cache_init(&rsii->h);
294 len = qword_get(&mesg, buf, mlen);
297 if (rawobj_alloc(&rsii->in_handle, buf, len)) {
303 len = qword_get(&mesg, buf, mlen);
306 if (rawobj_alloc(&rsii->in_token, buf, len)) {
312 expiry = get_expiry(&mesg);
317 len = qword_get(&mesg, buf, mlen);
320 rsii->major_status = simple_strtol(buf, &ep, 10);
325 len = qword_get(&mesg, buf, mlen);
328 rsii->minor_status = simple_strtol(buf, &ep, 10);
333 len = qword_get(&mesg, buf, mlen);
336 if (rawobj_alloc(&rsii->out_handle, buf, len)) {
342 len = qword_get(&mesg, buf, mlen);
345 if (rawobj_alloc(&rsii->out_token, buf, len)) {
350 rsii->h.expiry_time = expiry;
351 status = gssd_reply(rsii);
354 rsi_put(&rsii->h, &rsi_cache);
358 static struct cache_detail rsi_cache = {
359 .hash_size = RSI_HASHMAX,
360 .hash_table = rsi_table,
361 .name = "auth.ptlrpcs.init",
362 .cache_put = rsi_put,
363 .cache_request = rsi_request,
364 .cache_parse = rsi_parse,
368 * The rpcsec_context cache is used to store a context that is
369 * used in data exchange.
370 * The key is a context handle. The content is:
371 * uid, gidlist, mechanism, service-set, mech-specific-data
374 #define RSC_HASHBITS 10
375 #define RSC_HASHMAX (1<<RSC_HASHBITS)
376 #define RSC_HASHMASK (RSC_HASHMAX-1)
378 #define GSS_SEQ_WIN 512
380 struct gss_svc_seq_data {
381 /* highest seq number seen so far: */
383 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
384 * sd_win is nonzero iff sequence number i has been seen already: */
385 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
393 struct vfs_cred cred;
395 struct gss_svc_seq_data seqdata;
396 struct gss_ctx *mechctx;
399 static struct cache_head *rsc_table[RSC_HASHMAX];
400 static struct cache_detail rsc_cache;
402 static void rsc_free(struct rsc *rsci)
404 rawobj_free(&rsci->handle);
406 kgss_delete_sec_context(&rsci->mechctx);
408 if (rsci->cred.vc_ginfo)
409 put_group_info(rsci->cred.vc_ginfo);
413 static void rsc_put(struct cache_head *item, struct cache_detail *cd)
415 struct rsc *rsci = container_of(item, struct rsc, h);
417 LASSERT(atomic_read(&item->refcnt) > 0);
418 if (cache_put(item, cd)) {
419 LASSERT(item->next == NULL);
421 OBD_FREE(rsci, sizeof(*rsci));
426 rsc_hash(struct rsc *rsci)
428 return hash_mem((char *)rsci->handle.data,
429 rsci->handle.len, RSC_HASHBITS);
433 rsc_match(struct rsc *new, struct rsc *tmp)
435 return rawobj_equal(&new->handle, &tmp->handle);
438 static struct rsc *rsc_lookup(struct rsc *item, int set)
440 struct rsc *tmp = NULL;
441 struct cache_head **hp, **head;
442 head = &rsc_cache.hash_table[rsc_hash(item)];
446 write_lock(&rsc_cache.hash_lock);
448 read_lock(&rsc_cache.hash_lock);
449 for (hp = head; *hp != NULL; hp = &tmp->h.next) {
450 tmp = container_of(*hp, struct rsc, h);
451 if (!rsc_match(tmp, item))
458 clear_bit(CACHE_HASHED, &tmp->h.flags);
459 rsc_put(&tmp->h, &rsc_cache);
462 /* Didn't find anything */
467 set_bit(CACHE_HASHED, &item->h.flags);
468 item->h.next = *head;
470 write_unlock(&rsc_cache.hash_lock);
471 cache_fresh(&rsc_cache, &item->h, item->h.expiry_time);
477 read_unlock(&rsc_cache.hash_lock);
481 static int rsc_parse(struct cache_detail *cd,
482 char *mesg, int mlen)
484 /* contexthandle expiry [ uid gid N <n gids> mechname
485 * ...mechdata... ] */
488 struct rsc *rsci, *res = NULL;
490 int status = -EINVAL;
492 OBD_ALLOC(rsci, sizeof(*rsci));
494 CERROR("fail to alloc rsci\n");
497 cache_init(&rsci->h);
500 len = qword_get(&mesg, buf, mlen);
501 if (len < 0) goto out;
503 if (rawobj_alloc(&rsci->handle, buf, len))
507 expiry = get_expiry(&mesg);
513 rv = get_int(&mesg, (int *)&rsci->remote_realm);
515 CERROR("fail to get remote flag\n");
520 rv = get_int(&mesg, (int *)&rsci->mapped_uid);
522 CERROR("fail to get mapped uid\n");
526 /* uid, or NEGATIVE */
527 rv = get_int(&mesg, (int *)&rsci->cred.vc_uid);
531 CERROR("NOENT? set rsc entry negative\n");
532 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
534 struct gss_api_mech *gm;
539 if (get_int(&mesg, (int *)&rsci->cred.vc_gid))
543 len = qword_get(&mesg, buf, mlen);
546 gm = kgss_name_to_mech(buf);
547 status = -EOPNOTSUPP;
552 /* mech-specific data: */
553 len = qword_get(&mesg, buf, mlen);
559 tmp_buf.data = (unsigned char *)buf;
560 if (kgss_import_sec_context(&tmp_buf, gm, &rsci->mechctx)) {
565 /* currently the expiry time passed down from user-space
566 * is invalid, here we retrive it from mech.
568 if (kgss_inquire_context(rsci->mechctx, &ctx_expiry)) {
569 CERROR("unable to get expire time, drop it\n");
570 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
574 expiry = (time_t) ctx_expiry;
578 rsci->h.expiry_time = expiry;
579 spin_lock_init(&rsci->seqdata.sd_lock);
580 res = rsc_lookup(rsci, 1);
581 rsc_put(&res->h, &rsc_cache);
585 rsc_put(&rsci->h, &rsc_cache);
590 * flush all entries with @uid. @uid == -1 will match all.
591 * we only know the uid, maybe netid/nid in the future, in all cases
592 * we must search the whole cache
594 static void rsc_flush(uid_t uid)
596 struct cache_head **ch;
601 write_lock(&rsc_cache.hash_lock);
602 for (n = 0; n < RSC_HASHMAX; n++) {
603 for (ch = &rsc_cache.hash_table[n]; *ch;) {
604 rscp = container_of(*ch, struct rsc, h);
605 if (uid == -1 || rscp->cred.vc_uid == uid) {
606 /* it seems simply set NEGATIVE doesn't work */
610 set_bit(CACHE_NEGATIVE, &rscp->h.flags);
611 clear_bit(CACHE_HASHED, &rscp->h.flags);
612 CDEBUG(D_SEC, "flush rsc %p for uid %u\n",
613 rscp, rscp->cred.vc_uid);
614 rsc_put(&rscp->h, &rsc_cache);
621 write_unlock(&rsc_cache.hash_lock);
625 static struct cache_detail rsc_cache = {
626 .hash_size = RSC_HASHMAX,
627 .hash_table = rsc_table,
628 .name = "auth.ptlrpcs.context",
629 .cache_put = rsc_put,
630 .cache_parse = rsc_parse,
634 gss_svc_searchbyctx(rawobj_t *handle)
639 rsci.handle = *handle;
640 found = rsc_lookup(&rsci, 0);
644 if (cache_check(&rsc_cache, &found->h, NULL))
651 * again hacking: only try to give the svcgssd a chance to handle
654 struct cache_deferred_req* my_defer(struct cache_req *req)
659 static struct cache_req my_chandle = {my_defer};
661 /* Implements sequence number algorithm as specified in RFC 2203. */
663 gss_check_seq_num(struct gss_svc_seq_data *sd, __u32 seq_num)
667 spin_lock(&sd->sd_lock);
668 if (seq_num > sd->sd_max) {
669 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
670 memset(sd->sd_win, 0, sizeof(sd->sd_win));
671 sd->sd_max = seq_num;
673 while(sd->sd_max < seq_num) {
675 __clear_bit(sd->sd_max % GSS_SEQ_WIN,
679 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
681 } else if (seq_num + GSS_SEQ_WIN <= sd->sd_max) {
682 CERROR("seq %u too low: max %u, win %d\n",
683 seq_num, sd->sd_max, GSS_SEQ_WIN);
688 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win)) {
689 CERROR("seq %u is replay: max %u, win %d\n",
690 seq_num, sd->sd_max, GSS_SEQ_WIN);
694 spin_unlock(&sd->sd_lock);
699 gss_svc_verify_request(struct ptlrpc_request *req,
701 struct rpc_gss_wire_cred *gc,
702 __u32 *vp, __u32 vlen)
704 struct ptlrpcs_wire_hdr *sec_hdr;
705 struct gss_ctx *ctx = rsci->mechctx;
711 sec_hdr = (struct ptlrpcs_wire_hdr *) req->rq_reqbuf;
713 req->rq_reqmsg = (struct lustre_msg *) (req->rq_reqbuf + sizeof(*sec_hdr));
714 req->rq_reqlen = sec_hdr->msg_len;
716 msg.len = sec_hdr->msg_len;
717 msg.data = (__u8 *)req->rq_reqmsg;
719 mic.len = le32_to_cpu(*vp++);
720 mic.data = (unsigned char *)vp;
723 if (mic.len > vlen) {
724 CERROR("checksum len %d, while buffer len %d\n",
726 RETURN(GSS_S_CALL_BAD_STRUCTURE);
730 CERROR("invalid mic len %d\n", mic.len);
731 RETURN(GSS_S_CALL_BAD_STRUCTURE);
734 maj_stat = kgss_verify_mic(ctx, &msg, &mic, NULL);
735 if (maj_stat != GSS_S_COMPLETE) {
736 CERROR("MIC verification error: major %x\n", maj_stat);
740 if (gss_check_seq_num(&rsci->seqdata, gc->gc_seq)) {
741 CERROR("discard replayed request %p(o%u,x"LPU64",t"LPU64")\n",
742 req, req->rq_reqmsg->opc, req->rq_xid,
743 req->rq_reqmsg->transno);
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 replayed request %p(o%u,x"LPU64",t"LPU64")\n",
789 req, req->rq_reqmsg->opc, req->rq_xid,
790 req->rq_reqmsg->transno);
791 RETURN(GSS_S_DUPLICATE_TOKEN);
794 req->rq_reqmsg = (struct lustre_msg *) (vp);
795 req->rq_reqlen = plain_text.len;
797 CDEBUG(D_SEC, "msg len %d\n", req->rq_reqlen);
799 RETURN(GSS_S_COMPLETE);
803 gss_pack_err_notify(struct ptlrpc_request *req,
804 __u32 major, __u32 minor)
806 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
807 __u32 reslen, *resp, *reslenp;
808 char nidstr[PTL_NALFMT_SIZE];
809 const __u32 secdata_len = 7 * 4;
813 OBD_FAIL_RETURN(OBD_FAIL_SVCGSS_ERR_NOTIFY|OBD_FAIL_ONCE, -EINVAL);
816 svcdata->is_err_notify = 1;
817 svcdata->reserve_len = 7 * 4;
819 rc = lustre_pack_reply(req, 0, NULL, NULL);
821 CERROR("could not pack reply, err %d\n", rc);
825 LASSERT(req->rq_reply_state);
826 LASSERT(req->rq_reply_state->rs_repbuf);
827 LASSERT(req->rq_reply_state->rs_repbuf_len >= secdata_len);
828 resp = (__u32 *) req->rq_reply_state->rs_repbuf;
831 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS);
832 *resp++ = cpu_to_le32(PTLRPC_SEC_TYPE_NONE);
833 *resp++ = cpu_to_le32(req->rq_replen);
836 /* skip lustre msg */
837 resp += req->rq_replen / 4;
838 reslen = svcdata->reserve_len;
841 * version, subflavor, notify, major, minor,
842 * obj1(fake), obj2(fake)
844 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
845 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
846 *resp++ = cpu_to_le32(PTLRPC_GSS_PROC_ERR);
847 *resp++ = cpu_to_le32(major);
848 *resp++ = cpu_to_le32(minor);
852 /* the actual sec data length */
853 *reslenp = cpu_to_le32(secdata_len);
855 req->rq_reply_state->rs_repdata_len += (secdata_len);
856 CDEBUG(D_SEC, "prepare gss error notify(0x%x/0x%x) to %s\n",
858 portals_nid2str(req->rq_peer.peer_ni->pni_number,
859 req->rq_peer.peer_id.nid, nidstr));
863 static void dump_cache_head(struct cache_head *h)
865 CWARN("ref %d, fl %lx, n %p, t %ld, %ld\n",
866 atomic_read(&h->refcnt), h->flags, h->next,
867 h->expiry_time, h->last_refresh);
869 static void dump_rsi(struct rsi *rsi)
871 CWARN("dump rsi %p\n", rsi);
872 dump_cache_head(&rsi->h);
873 CWARN("%x,%x,%llx\n", rsi->naltype, rsi->netid, rsi->nid);
874 CWARN("len %d, d %p\n", rsi->in_handle.len, rsi->in_handle.data);
875 CWARN("len %d, d %p\n", rsi->in_token.len, rsi->in_token.data);
876 CWARN("len %d, d %p\n", rsi->out_handle.len, rsi->out_handle.data);
877 CWARN("len %d, d %p\n", rsi->out_token.len, rsi->out_token.data);
881 gss_svcsec_handle_init(struct ptlrpc_request *req,
882 struct rpc_gss_wire_cred *gc,
883 __u32 *secdata, __u32 seclen,
884 enum ptlrpcs_error *res)
886 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
888 struct rsi *rsikey, *rsip;
890 __u32 reslen, *resp, *reslenp;
891 char nidstr[PTL_NALFMT_SIZE];
897 CDEBUG(D_SEC, "processing gss init(%d) request from %s\n", gc->gc_proc,
898 portals_nid2str(req->rq_peer.peer_ni->pni_number,
899 req->rq_peer.peer_id.nid, nidstr));
901 *res = PTLRPCS_BADCRED;
902 OBD_FAIL_RETURN(OBD_FAIL_SVCGSS_INIT_REQ|OBD_FAIL_ONCE, SVC_DROP);
904 if (gc->gc_proc == RPC_GSS_PROC_INIT &&
905 gc->gc_ctx.len != 0) {
906 CERROR("proc %d, ctx_len %d: not really init?\n",
907 gc->gc_proc == RPC_GSS_PROC_INIT, gc->gc_ctx.len);
911 OBD_ALLOC(rsikey, sizeof(*rsikey));
913 CERROR("out of memory\n");
916 cache_init(&rsikey->h);
918 /* obtain lustre svc type */
920 CERROR("sec size %d too small\n", seclen);
921 GOTO(out_rsikey, rc = SVC_DROP);
923 rsikey->lustre_svc = le32_to_cpu(*secdata++);
926 /* duplicate context handle. currently always 0 */
927 if (rawobj_dup(&rsikey->in_handle, &gc->gc_ctx)) {
928 CERROR("fail to dup context handle\n");
929 GOTO(out_rsikey, rc = SVC_DROP);
933 *res = PTLRPCS_BADVERF;
934 if (rawobj_extract(&tmpobj, &secdata, &seclen)) {
935 CERROR("can't extract token\n");
936 GOTO(out_rsikey, rc = SVC_DROP);
938 if (rawobj_dup(&rsikey->in_token, &tmpobj)) {
939 CERROR("can't duplicate token\n");
940 GOTO(out_rsikey, rc = SVC_DROP);
943 rsikey->naltype = (__u32) req->rq_peer.peer_ni->pni_number;
945 rsikey->nid = (__u64) req->rq_peer.peer_id.nid;
947 rsip = gssd_upcall(rsikey, &my_chandle);
949 CERROR("error in gssd_upcall.\n");
952 if (gss_pack_err_notify(req, GSS_S_FAILURE, 0))
955 GOTO(out_rsikey, rc);
958 rsci = gss_svc_searchbyctx(&rsip->out_handle);
960 CERROR("rsci still not mature yet?\n");
963 if (gss_pack_err_notify(req, GSS_S_FAILURE, 0))
968 CDEBUG(D_SEC, "svcsec create gss context %p(%u@%s)\n",
969 rsci, rsci->cred.vc_uid,
970 portals_nid2str(req->rq_peer.peer_ni->pni_number,
971 req->rq_peer.peer_id.nid, nidstr));
973 svcdata->is_init = 1;
974 svcdata->reserve_len = 6 * 4 +
975 size_round4(rsip->out_handle.len) +
976 size_round4(rsip->out_token.len);
978 rc = lustre_pack_reply(req, 0, NULL, NULL);
980 CERROR("failed to pack reply, rc = %d\n", rc);
981 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
982 GOTO(out, rc = SVC_DROP);
986 resp = (__u32 *) req->rq_reply_state->rs_repbuf;
987 *resp++ = cpu_to_le32(PTLRPC_SEC_GSS);
988 *resp++ = cpu_to_le32(PTLRPC_SEC_TYPE_NONE);
989 *resp++ = cpu_to_le32(req->rq_replen);
992 resp += req->rq_replen / 4;
993 reslen = svcdata->reserve_len;
996 * status, major, minor, seq, out_handle, out_token
998 *resp++ = cpu_to_le32(PTLRPCS_OK);
999 *resp++ = cpu_to_le32(rsip->major_status);
1000 *resp++ = cpu_to_le32(rsip->minor_status);
1001 *resp++ = cpu_to_le32(GSS_SEQ_WIN);
1003 if (rawobj_serialize(&rsip->out_handle,
1009 if (rawobj_serialize(&rsip->out_token,
1015 /* the actual sec data length */
1016 *reslenp = cpu_to_le32(svcdata->reserve_len - reslen);
1018 req->rq_reply_state->rs_repdata_len += le32_to_cpu(*reslenp);
1019 CDEBUG(D_SEC, "req %p: msgsize %d, authsize %d, "
1020 "total size %d\n", req, req->rq_replen,
1021 le32_to_cpu(*reslenp),
1022 req->rq_reply_state->rs_repdata_len);
1026 req->rq_auth_uid = rsci->cred.vc_uid;
1027 req->rq_remote_realm = rsci->remote_realm;
1028 req->rq_mapped_uid = rsci->mapped_uid;
1030 /* This is simplified since right now we doesn't support
1031 * INIT_CONTINUE yet.
1033 if (gc->gc_proc == RPC_GSS_PROC_INIT) {
1034 struct ptlrpcs_wire_hdr *hdr;
1036 hdr = buf_to_sec_hdr(req->rq_reqbuf);
1037 req->rq_reqmsg = buf_to_lustre_msg(req->rq_reqbuf);
1038 req->rq_reqlen = hdr->msg_len;
1045 rsc_put(&rsci->h, &rsc_cache);
1047 rsi_put(&rsip->h, &rsi_cache);
1049 rsi_put(&rsikey->h, &rsi_cache);
1055 gss_svcsec_handle_data(struct ptlrpc_request *req,
1056 struct rpc_gss_wire_cred *gc,
1057 __u32 *secdata, __u32 seclen,
1058 enum ptlrpcs_error *res)
1061 char nidstr[PTL_NALFMT_SIZE];
1066 *res = PTLRPCS_GSS_CREDPROBLEM;
1068 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1070 CWARN("Invalid gss context handle from %s\n",
1071 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1072 req->rq_peer.peer_id.nid, nidstr));
1073 major = GSS_S_NO_CONTEXT;
1077 switch (gc->gc_svc) {
1078 case PTLRPC_GSS_SVC_INTEGRITY:
1079 major = gss_svc_verify_request(req, rsci, gc, secdata, seclen);
1080 if (major == GSS_S_COMPLETE)
1083 CWARN("fail in verify:0x%x: ctx %p@%s\n", major, rsci,
1084 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1085 req->rq_peer.peer_id.nid, nidstr));
1087 case PTLRPC_GSS_SVC_PRIVACY:
1088 major = gss_svc_unseal_request(req, rsci, gc, secdata, seclen);
1089 if (major == GSS_S_COMPLETE)
1092 CWARN("fail in decrypt:0x%x: ctx %p@%s\n", major, rsci,
1093 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1094 req->rq_peer.peer_id.nid, nidstr));
1097 CERROR("unsupported gss service %d\n", gc->gc_svc);
1098 GOTO(out, rc = SVC_DROP);
1101 req->rq_auth_uid = rsci->cred.vc_uid;
1102 req->rq_remote_realm = rsci->remote_realm;
1103 req->rq_mapped_uid = rsci->mapped_uid;
1106 GOTO(out, rc = SVC_OK);
1109 if (gss_pack_err_notify(req, major, 0))
1115 rsc_put(&rsci->h, &rsc_cache);
1120 gss_svcsec_handle_destroy(struct ptlrpc_request *req,
1121 struct rpc_gss_wire_cred *gc,
1122 __u32 *secdata, __u32 seclen,
1123 enum ptlrpcs_error *res)
1125 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
1127 char nidstr[PTL_NALFMT_SIZE];
1132 *res = PTLRPCS_GSS_CREDPROBLEM;
1134 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1136 CWARN("invalid gss context handle for destroy.\n");
1140 if (gc->gc_svc != PTLRPC_GSS_SVC_INTEGRITY) {
1141 CERROR("service %d is not supported in destroy.\n",
1143 GOTO(out, rc = SVC_DROP);
1146 *res = gss_svc_verify_request(req, rsci, gc, secdata, seclen);
1148 GOTO(out, rc = SVC_DROP);
1150 /* compose reply, which is actually nothing */
1151 svcdata->is_fini = 1;
1152 if (lustre_pack_reply(req, 0, NULL, NULL))
1153 GOTO(out, rc = SVC_DROP);
1155 CDEBUG(D_SEC, "svcsec destroy gss context %p(%u@%s)\n",
1156 rsci, rsci->cred.vc_uid,
1157 portals_nid2str(req->rq_peer.peer_ni->pni_number,
1158 req->rq_peer.peer_id.nid, nidstr));
1160 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1164 rsc_put(&rsci->h, &rsc_cache);
1169 * let incomming request go through security check:
1170 * o context establishment: invoke user space helper
1171 * o data exchange: verify/decrypt
1172 * o context destruction: mark context invalid
1174 * in most cases, error will result to drop the packet silently.
1177 gss_svcsec_accept(struct ptlrpc_request *req, enum ptlrpcs_error *res)
1179 struct gss_svc_data *svcdata;
1180 struct rpc_gss_wire_cred *gc;
1181 struct ptlrpcs_wire_hdr *sec_hdr;
1182 __u32 seclen, *secdata, version;
1186 CDEBUG(D_SEC, "request %p\n", req);
1187 LASSERT(req->rq_reqbuf);
1188 LASSERT(req->rq_reqbuf_len);
1190 *res = PTLRPCS_BADCRED;
1192 sec_hdr = buf_to_sec_hdr(req->rq_reqbuf);
1193 LASSERT(sec_hdr->flavor == PTLRPC_SEC_GSS);
1195 seclen = req->rq_reqbuf_len - sizeof(*sec_hdr) - sec_hdr->msg_len;
1196 secdata = (__u32 *) buf_to_sec_data(req->rq_reqbuf);
1198 if (sec_hdr->sec_len > seclen) {
1199 CERROR("seclen %d, while max buf %d\n",
1200 sec_hdr->sec_len, seclen);
1204 if (seclen < 6 * 4) {
1205 CERROR("sec size %d too small\n", seclen);
1209 LASSERT(!req->rq_sec_svcdata);
1210 OBD_ALLOC(svcdata, sizeof(*svcdata));
1212 CERROR("fail to alloc svcdata\n");
1215 req->rq_sec_svcdata = svcdata;
1216 gc = &svcdata->clcred;
1218 /* Now secdata/seclen is what we want to parse
1220 version = le32_to_cpu(*secdata++); /* version */
1221 svcdata->subflavor = le32_to_cpu(*secdata++); /* subflavor */
1222 gc->gc_proc = le32_to_cpu(*secdata++); /* proc */
1223 gc->gc_seq = le32_to_cpu(*secdata++); /* seq */
1224 gc->gc_svc = le32_to_cpu(*secdata++); /* service */
1227 CDEBUG(D_SEC, "wire gss_hdr: %u/%u/%u/%u/%u\n",
1228 version, svcdata->subflavor, gc->gc_proc,
1229 gc->gc_seq, gc->gc_svc);
1231 if (version != PTLRPC_SEC_GSS_VERSION) {
1232 CERROR("gss version mismatch: %d - %d\n",
1233 version, PTLRPC_SEC_GSS_VERSION);
1234 GOTO(err_free, rc = SVC_DROP);
1237 if (rawobj_extract(&gc->gc_ctx, &secdata, &seclen)) {
1238 CERROR("fail to obtain gss context handle\n");
1239 GOTO(err_free, rc = SVC_DROP);
1242 *res = PTLRPCS_BADVERF;
1243 switch(gc->gc_proc) {
1244 case RPC_GSS_PROC_INIT:
1245 case RPC_GSS_PROC_CONTINUE_INIT:
1246 rc = gss_svcsec_handle_init(req, gc, secdata, seclen, res);
1248 case RPC_GSS_PROC_DATA:
1249 rc = gss_svcsec_handle_data(req, gc, secdata, seclen, res);
1251 case RPC_GSS_PROC_DESTROY:
1252 rc = gss_svcsec_handle_destroy(req, gc, secdata, seclen, res);
1260 if (rc == SVC_DROP && req->rq_sec_svcdata) {
1261 OBD_FREE(req->rq_sec_svcdata, sizeof(struct gss_svc_data));
1262 req->rq_sec_svcdata = NULL;
1269 gss_svcsec_authorize(struct ptlrpc_request *req)
1271 struct ptlrpc_reply_state *rs = req->rq_reply_state;
1272 struct gss_svc_data *gsd = (struct gss_svc_data *)req->rq_sec_svcdata;
1273 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1275 struct ptlrpcs_wire_hdr *sec_hdr;
1276 rawobj_buf_t msg_buf;
1277 rawobj_t cipher_buf;
1278 __u32 *vp, *vpsave, major, vlen, seclen;
1284 LASSERT(rs->rs_repbuf);
1287 if (gsd->is_init || gsd->is_init_continue ||
1288 gsd->is_err_notify || gsd->is_fini) {
1289 /* nothing to do in these cases */
1290 CDEBUG(D_SEC, "req %p: init/fini/err\n", req);
1294 if (gc->gc_proc != RPC_GSS_PROC_DATA) {
1295 CERROR("proc %d not support\n", gc->gc_proc);
1299 rscp = gss_svc_searchbyctx(&gc->gc_ctx);
1301 CERROR("ctx disapeared under us?\n");
1305 sec_hdr = (struct ptlrpcs_wire_hdr *) rs->rs_repbuf;
1306 switch (gc->gc_svc) {
1307 case PTLRPC_GSS_SVC_INTEGRITY:
1308 /* prepare various pointers */
1309 lmsg.len = req->rq_replen;
1310 lmsg.data = (__u8 *) (rs->rs_repbuf + sizeof(*sec_hdr));
1311 vp = (__u32 *) (lmsg.data + lmsg.len);
1312 vlen = rs->rs_repbuf_len - sizeof(*sec_hdr) - lmsg.len;
1315 sec_hdr->flavor = cpu_to_le32(PTLRPC_SEC_GSS);
1316 sec_hdr->sectype = cpu_to_le32(PTLRPC_SEC_TYPE_AUTH);
1317 sec_hdr->msg_len = cpu_to_le32(req->rq_replen);
1319 /* standard gss hdr */
1320 LASSERT(vlen >= 7 * 4);
1321 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
1322 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
1323 *vp++ = cpu_to_le32(RPC_GSS_PROC_DATA);
1324 *vp++ = cpu_to_le32(gc->gc_seq);
1325 *vp++ = cpu_to_le32(PTLRPC_GSS_SVC_INTEGRITY);
1326 *vp++ = 0; /* fake ctx handle */
1327 vpsave = vp++; /* reserve size */
1331 mic.data = (unsigned char *)vp;
1333 major = kgss_get_mic(rscp->mechctx, 0, &lmsg, &mic);
1335 CERROR("fail to get MIC: 0x%x\n", major);
1336 GOTO(out, ret = -EINVAL);
1338 *vpsave = cpu_to_le32(mic.len);
1339 seclen = seclen - vlen + mic.len;
1340 sec_hdr->sec_len = cpu_to_le32(seclen);
1341 rs->rs_repdata_len += size_round(seclen);
1343 case PTLRPC_GSS_SVC_PRIVACY:
1344 vp = (__u32 *) (rs->rs_repbuf + sizeof(*sec_hdr));
1345 vlen = rs->rs_repbuf_len - sizeof(*sec_hdr);
1348 sec_hdr->flavor = cpu_to_le32(PTLRPC_SEC_GSS);
1349 sec_hdr->sectype = cpu_to_le32(PTLRPC_SEC_TYPE_PRIV);
1350 sec_hdr->msg_len = cpu_to_le32(0);
1352 /* standard gss hdr */
1353 LASSERT(vlen >= 7 * 4);
1354 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_VERSION);
1355 *vp++ = cpu_to_le32(PTLRPC_SEC_GSS_KRB5I);
1356 *vp++ = cpu_to_le32(RPC_GSS_PROC_DATA);
1357 *vp++ = cpu_to_le32(gc->gc_seq);
1358 *vp++ = cpu_to_le32(PTLRPC_GSS_SVC_PRIVACY);
1359 *vp++ = 0; /* fake ctx handle */
1360 vpsave = vp++; /* reserve size */
1363 msg_buf.buf = (__u8 *) rs->rs_msg - GSS_PRIVBUF_PREFIX_LEN;
1364 msg_buf.buflen = req->rq_replen + GSS_PRIVBUF_PREFIX_LEN +
1365 GSS_PRIVBUF_SUFFIX_LEN;
1366 msg_buf.dataoff = GSS_PRIVBUF_PREFIX_LEN;
1367 msg_buf.datalen = req->rq_replen;
1369 cipher_buf.data = (__u8 *) vp;
1370 cipher_buf.len = vlen;
1372 major = kgss_wrap(rscp->mechctx, GSS_C_QOP_DEFAULT,
1373 &msg_buf, &cipher_buf);
1375 CERROR("failed to wrap: 0x%x\n", major);
1376 GOTO(out, ret = -EINVAL);
1379 *vpsave = cpu_to_le32(cipher_buf.len);
1380 seclen = seclen - vlen + cipher_buf.len;
1381 sec_hdr->sec_len = cpu_to_le32(seclen);
1382 rs->rs_repdata_len += size_round(seclen);
1385 CERROR("Unknown service %d\n", gc->gc_svc);
1386 GOTO(out, ret = -EINVAL);
1390 rsc_put(&rscp->h, &rsc_cache);
1396 void gss_svcsec_cleanup_req(struct ptlrpc_svcsec *svcsec,
1397 struct ptlrpc_request *req)
1399 struct gss_svc_data *gsd = (struct gss_svc_data *) req->rq_sec_svcdata;
1402 CDEBUG(D_SEC, "no svc_data present. do nothing\n");
1406 /* gsd->clclred.gc_ctx is NOT allocated, just set pointer
1407 * to the incoming packet buffer, so don't need free it
1409 OBD_FREE(gsd, sizeof(*gsd));
1410 req->rq_sec_svcdata = NULL;
1415 int gss_svcsec_est_payload(struct ptlrpc_svcsec *svcsec,
1416 struct ptlrpc_request *req,
1419 struct gss_svc_data *svcdata = req->rq_sec_svcdata;
1422 /* just return the pre-set reserve_len for init/fini/err cases.
1425 if (svcdata->is_init) {
1426 CDEBUG(D_SEC, "is_init, reserver size %d(%d)\n",
1427 size_round(svcdata->reserve_len),
1428 svcdata->reserve_len);
1429 LASSERT(svcdata->reserve_len);
1430 LASSERT(svcdata->reserve_len % 4 == 0);
1431 RETURN(size_round(svcdata->reserve_len));
1432 } else if (svcdata->is_err_notify) {
1433 CDEBUG(D_SEC, "is_err_notify, reserver size %d(%d)\n",
1434 size_round(svcdata->reserve_len),
1435 svcdata->reserve_len);
1436 RETURN(size_round(svcdata->reserve_len));
1437 } else if (svcdata->is_fini) {
1438 CDEBUG(D_SEC, "is_fini, reserver size 0\n");
1441 if (svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_NONE ||
1442 svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_INTEGRITY)
1443 RETURN(size_round(GSS_MAX_AUTH_PAYLOAD));
1444 else if (svcdata->clcred.gc_svc == PTLRPC_GSS_SVC_PRIVACY)
1445 RETURN(size_round16(GSS_MAX_AUTH_PAYLOAD + msgsize +
1446 GSS_PRIVBUF_PREFIX_LEN +
1447 GSS_PRIVBUF_SUFFIX_LEN));
1449 CERROR("unknown gss svc %u\n", svcdata->clcred.gc_svc);
1457 int gss_svcsec_alloc_repbuf(struct ptlrpc_svcsec *svcsec,
1458 struct ptlrpc_request *req,
1461 struct gss_svc_data *gsd = (struct gss_svc_data *) req->rq_sec_svcdata;
1462 struct ptlrpc_reply_state *rs;
1463 int msg_payload, sec_payload;
1467 /* determine the security type: none/auth or priv, we have
1468 * different pack scheme for them.
1469 * init/fini/err will always be treated as none/auth.
1472 if (!gsd->is_init && !gsd->is_init_continue &&
1473 !gsd->is_fini && !gsd->is_err_notify &&
1474 gsd->clcred.gc_svc == PTLRPC_GSS_SVC_PRIVACY)
1479 msg_payload = privacy ? 0 : msgsize;
1480 sec_payload = gss_svcsec_est_payload(svcsec, req, msgsize);
1482 rc = svcsec_alloc_reply_state(req, msg_payload, sec_payload);
1486 rs = req->rq_reply_state;
1488 rs->rs_msg_len = msgsize;
1491 /* we can choose to let msg simply point to the rear of the
1492 * buffer, which lead to buffer overlap when doing encryption.
1493 * usually it's ok and it indeed passed all existing tests.
1494 * but not sure if there will be subtle problems in the future.
1495 * so right now we choose to alloc another new buffer. we'll
1499 rs->rs_msg = (struct lustre_msg *)
1500 (rs->rs_repbuf + rs->rs_repbuf_len -
1501 msgsize - GSS_PRIVBUF_SUFFIX_LEN);
1505 msgsize += GSS_PRIVBUF_PREFIX_LEN + GSS_PRIVBUF_SUFFIX_LEN;
1506 OBD_ALLOC(msgbuf, msgsize);
1508 CERROR("can't alloc %d\n", msgsize);
1509 svcsec_free_reply_state(rs);
1510 req->rq_reply_state = NULL;
1513 rs->rs_msg = (struct lustre_msg *)
1514 (msgbuf + GSS_PRIVBUF_PREFIX_LEN);
1517 req->rq_repmsg = rs->rs_msg;
1523 void gss_svcsec_free_repbuf(struct ptlrpc_svcsec *svcsec,
1524 struct ptlrpc_reply_state *rs)
1526 unsigned long p1 = (unsigned long) rs->rs_msg;
1527 unsigned long p2 = (unsigned long) rs->rs_buf;
1529 LASSERT(rs->rs_buf);
1530 LASSERT(rs->rs_msg);
1531 LASSERT(rs->rs_msg_len);
1533 if (p1 < p2 || p1 >= p2 + rs->rs_buf_len) {
1534 char *start = (char*) rs->rs_msg - GSS_PRIVBUF_PREFIX_LEN;
1535 int size = rs->rs_msg_len + GSS_PRIVBUF_PREFIX_LEN +
1536 GSS_PRIVBUF_SUFFIX_LEN;
1537 OBD_FREE(start, size);
1540 svcsec_free_reply_state(rs);
1543 struct ptlrpc_svcsec svcsec_gss = {
1544 .pss_owner = THIS_MODULE,
1545 .pss_name = "GSS_SVCSEC",
1546 .pss_flavor = {PTLRPC_SEC_GSS, 0},
1547 .accept = gss_svcsec_accept,
1548 .authorize = gss_svcsec_authorize,
1549 .alloc_repbuf = gss_svcsec_alloc_repbuf,
1550 .free_repbuf = gss_svcsec_free_repbuf,
1551 .cleanup_req = gss_svcsec_cleanup_req,
1555 void lgss_svc_cache_purge_all(void)
1557 cache_purge(&rsi_cache);
1558 cache_purge(&rsc_cache);
1560 EXPORT_SYMBOL(lgss_svc_cache_purge_all);
1562 void lgss_svc_cache_flush(__u32 uid)
1566 EXPORT_SYMBOL(lgss_svc_cache_flush);
1568 int gss_svc_init(void)
1572 rc = svcsec_register(&svcsec_gss);
1574 cache_register(&rsc_cache);
1575 cache_register(&rsi_cache);
1580 void gss_svc_exit(void)
1583 if ((rc = cache_unregister(&rsi_cache)))
1584 CERROR("unregister rsi cache: %d\n", rc);
1585 if ((rc = cache_unregister(&rsc_cache)))
1586 CERROR("unregister rsc cache: %d\n", rc);
1587 if ((rc = svcsec_unregister(&svcsec_gss)))
1588 CERROR("unregister svcsec_gss: %d\n", rc);