2 * Neil Brown <neilb@cse.unsw.edu.au>
3 * J. Bruce Fields <bfields@umich.edu>
4 * Andy Adamson <andros@umich.edu>
5 * Dug Song <dugsong@monkey.org>
7 * RPCSEC_GSS server authentication.
8 * This implements RPCSEC_GSS as defined in rfc2203 (rpcsec_gss) and rfc2078
11 * The RPCSEC_GSS involves three stages:
14 * 3/ context destruction
16 * Context creation is handled largely by upcalls to user-space.
17 * In particular, GSS_Accept_sec_context is handled by an upcall
18 * Data exchange is handled entirely within the kernel
19 * In particular, GSS_GetMIC, GSS_VerifyMIC, GSS_Seal, GSS_Unseal are in-kernel.
20 * Context destruction is handled in-kernel
21 * GSS_Delete_sec_context is in-kernel
23 * Context creation is initiated by a RPCSEC_GSS_INIT request arriving.
24 * The context handle and gss_token are used as a key into the rpcsec_init cache.
25 * The content of this cache includes some of the outputs of GSS_Accept_sec_context,
26 * being major_status, minor_status, context_handle, reply_token.
27 * These are sent back to the client.
28 * Sequence window management is handled by the kernel. The window size if currently
29 * a compile time constant.
31 * When user-space is happy that a context is established, it places an entry
32 * in the rpcsec_context cache. The key for this cache is the context_handle.
33 * The content includes:
34 * uid/gidlist - for determining access rights
36 * mechanism specific information, such as a key
40 #include <linux/types.h>
41 #include <linux/module.h>
42 #include <linux/pagemap.h>
44 #include <linux/sunrpc/auth_gss.h>
45 #include <linux/sunrpc/svcauth.h>
46 #include <linux/sunrpc/gss_err.h>
47 #include <linux/sunrpc/svcauth.h>
48 #include <linux/sunrpc/svcauth_gss.h>
49 #include <linux/sunrpc/cache.h>
52 # define RPCDBG_FACILITY RPCDBG_AUTH
55 /* The rpcsec_init cache is used for mapping RPCSEC_GSS_{,CONT_}INIT requests
58 * Key is context handle (\x if empty) and gss_token.
59 * Content is major_status minor_status (integers) context_handle, reply_token.
63 static int netobj_equal(struct xdr_netobj *a, struct xdr_netobj *b)
65 return a->len == b->len && 0 == memcmp(a->data, b->data, a->len);
68 #define RSI_HASHBITS 6
69 #define RSI_HASHMAX (1<<RSI_HASHBITS)
70 #define RSI_HASHMASK (RSI_HASHMAX-1)
74 struct xdr_netobj in_handle, in_token;
75 struct xdr_netobj out_handle, out_token;
76 int major_status, minor_status;
79 static struct cache_head *rsi_table[RSI_HASHMAX];
80 static struct cache_detail rsi_cache;
81 static struct rsi *rsi_update(struct rsi *new, struct rsi *old);
82 static struct rsi *rsi_lookup(struct rsi *item);
84 static void rsi_free(struct rsi *rsii)
86 kfree(rsii->in_handle.data);
87 kfree(rsii->in_token.data);
88 kfree(rsii->out_handle.data);
89 kfree(rsii->out_token.data);
92 static void rsi_put(struct kref *ref)
94 struct rsi *rsii = container_of(ref, struct rsi, h.ref);
99 static inline int rsi_hash(struct rsi *item)
101 return hash_mem(item->in_handle.data, item->in_handle.len, RSI_HASHBITS)
102 ^ hash_mem(item->in_token.data, item->in_token.len, RSI_HASHBITS);
105 static int rsi_match(struct cache_head *a, struct cache_head *b)
107 struct rsi *item = container_of(a, struct rsi, h);
108 struct rsi *tmp = container_of(b, struct rsi, h);
109 return netobj_equal(&item->in_handle, &tmp->in_handle)
110 && netobj_equal(&item->in_token, &tmp->in_token);
113 static int dup_to_netobj(struct xdr_netobj *dst, char *src, int len)
116 dst->data = (len ? kmalloc(len, GFP_KERNEL) : NULL);
118 memcpy(dst->data, src, len);
119 if (len && !dst->data)
124 static inline int dup_netobj(struct xdr_netobj *dst, struct xdr_netobj *src)
126 return dup_to_netobj(dst, src->data, src->len);
129 static void rsi_init(struct cache_head *cnew, struct cache_head *citem)
131 struct rsi *new = container_of(cnew, struct rsi, h);
132 struct rsi *item = container_of(citem, struct rsi, h);
134 new->out_handle.data = NULL;
135 new->out_handle.len = 0;
136 new->out_token.data = NULL;
137 new->out_token.len = 0;
138 new->in_handle.len = item->in_handle.len;
139 item->in_handle.len = 0;
140 new->in_token.len = item->in_token.len;
141 item->in_token.len = 0;
142 new->in_handle.data = item->in_handle.data;
143 item->in_handle.data = NULL;
144 new->in_token.data = item->in_token.data;
145 item->in_token.data = NULL;
148 static void update_rsi(struct cache_head *cnew, struct cache_head *citem)
150 struct rsi *new = container_of(cnew, struct rsi, h);
151 struct rsi *item = container_of(citem, struct rsi, h);
153 BUG_ON(new->out_handle.data || new->out_token.data);
154 new->out_handle.len = item->out_handle.len;
155 item->out_handle.len = 0;
156 new->out_token.len = item->out_token.len;
157 item->out_token.len = 0;
158 new->out_handle.data = item->out_handle.data;
159 item->out_handle.data = NULL;
160 new->out_token.data = item->out_token.data;
161 item->out_token.data = NULL;
163 new->major_status = item->major_status;
164 new->minor_status = item->minor_status;
167 static struct cache_head *rsi_alloc(void)
169 struct rsi *rsii = kmalloc(sizeof(*rsii), GFP_KERNEL);
176 static void rsi_request(struct cache_detail *cd,
177 struct cache_head *h,
178 char **bpp, int *blen)
180 struct rsi *rsii = container_of(h, struct rsi, h);
182 qword_addhex(bpp, blen, rsii->in_handle.data, rsii->in_handle.len);
183 qword_addhex(bpp, blen, rsii->in_token.data, rsii->in_token.len);
188 static int rsi_parse(struct cache_detail *cd,
189 char *mesg, int mlen)
191 /* context token expiry major minor context token */
195 struct rsi rsii, *rsip = NULL;
197 int status = -EINVAL;
199 memset(&rsii, 0, sizeof(rsii));
201 len = qword_get(&mesg, buf, mlen);
205 if (dup_to_netobj(&rsii.in_handle, buf, len))
209 len = qword_get(&mesg, buf, mlen);
214 if (dup_to_netobj(&rsii.in_token, buf, len))
217 rsip = rsi_lookup(&rsii);
223 expiry = get_expiry(&mesg);
229 len = qword_get(&mesg, buf, mlen);
235 rsii.major_status = simple_strtoul(buf, &ep, 10);
238 len = qword_get(&mesg, buf, mlen);
241 rsii.minor_status = simple_strtoul(buf, &ep, 10);
246 len = qword_get(&mesg, buf, mlen);
250 if (dup_to_netobj(&rsii.out_handle, buf, len))
254 len = qword_get(&mesg, buf, mlen);
259 if (dup_to_netobj(&rsii.out_token, buf, len))
262 rsii.h.expiry_time = expiry;
263 rsip = rsi_update(&rsii, rsip);
268 cache_put(&rsip->h, &rsi_cache);
274 static struct cache_detail rsi_cache = {
275 .owner = THIS_MODULE,
276 .hash_size = RSI_HASHMAX,
277 .hash_table = rsi_table,
278 .name = "auth.rpcsec.init",
279 .cache_put = rsi_put,
280 .cache_request = rsi_request,
281 .cache_parse = rsi_parse,
284 .update = update_rsi,
288 static struct rsi *rsi_lookup(struct rsi *item)
290 struct cache_head *ch;
291 int hash = rsi_hash(item);
293 ch = sunrpc_cache_lookup(&rsi_cache, &item->h, hash);
295 return container_of(ch, struct rsi, h);
300 static struct rsi *rsi_update(struct rsi *new, struct rsi *old)
302 struct cache_head *ch;
303 int hash = rsi_hash(new);
305 ch = sunrpc_cache_update(&rsi_cache, &new->h,
308 return container_of(ch, struct rsi, h);
315 * The rpcsec_context cache is used to store a context that is
316 * used in data exchange.
317 * The key is a context handle. The content is:
318 * uid, gidlist, mechanism, service-set, mech-specific-data
321 #define RSC_HASHBITS 10
322 #define RSC_HASHMAX (1<<RSC_HASHBITS)
323 #define RSC_HASHMASK (RSC_HASHMAX-1)
325 #define GSS_SEQ_WIN 128
327 struct gss_svc_seq_data {
328 /* highest seq number seen so far: */
330 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
331 * sd_win is nonzero iff sequence number i has been seen already: */
332 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
338 struct xdr_netobj handle;
339 struct svc_cred cred;
340 struct gss_svc_seq_data seqdata;
341 struct gss_ctx *mechctx;
344 static struct cache_head *rsc_table[RSC_HASHMAX];
345 static struct cache_detail rsc_cache;
346 static struct rsc *rsc_update(struct rsc *new, struct rsc *old);
347 static struct rsc *rsc_lookup(struct rsc *item);
349 static void rsc_free(struct rsc *rsci)
351 kfree(rsci->handle.data);
353 gss_delete_sec_context(&rsci->mechctx);
354 if (rsci->cred.cr_group_info)
355 put_group_info(rsci->cred.cr_group_info);
358 static void rsc_put(struct kref *ref)
360 struct rsc *rsci = container_of(ref, struct rsc, h.ref);
367 rsc_hash(struct rsc *rsci)
369 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
373 rsc_match(struct cache_head *a, struct cache_head *b)
375 struct rsc *new = container_of(a, struct rsc, h);
376 struct rsc *tmp = container_of(b, struct rsc, h);
378 return netobj_equal(&new->handle, &tmp->handle);
382 rsc_init(struct cache_head *cnew, struct cache_head *ctmp)
384 struct rsc *new = container_of(cnew, struct rsc, h);
385 struct rsc *tmp = container_of(ctmp, struct rsc, h);
387 new->handle.len = tmp->handle.len;
389 new->handle.data = tmp->handle.data;
390 tmp->handle.data = NULL;
392 new->cred.cr_group_info = NULL;
396 update_rsc(struct cache_head *cnew, struct cache_head *ctmp)
398 struct rsc *new = container_of(cnew, struct rsc, h);
399 struct rsc *tmp = container_of(ctmp, struct rsc, h);
401 new->mechctx = tmp->mechctx;
403 memset(&new->seqdata, 0, sizeof(new->seqdata));
404 spin_lock_init(&new->seqdata.sd_lock);
405 new->cred = tmp->cred;
406 tmp->cred.cr_group_info = NULL;
409 static struct cache_head *
412 struct rsc *rsci = kmalloc(sizeof(*rsci), GFP_KERNEL);
419 static int rsc_parse(struct cache_detail *cd,
420 char *mesg, int mlen)
422 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
425 struct rsc rsci, *rscp = NULL;
427 int status = -EINVAL;
429 memset(&rsci, 0, sizeof(rsci));
431 len = qword_get(&mesg, buf, mlen);
432 if (len < 0) goto out;
434 if (dup_to_netobj(&rsci.handle, buf, len))
439 expiry = get_expiry(&mesg);
444 rscp = rsc_lookup(&rsci);
448 /* uid, or NEGATIVE */
449 rv = get_int(&mesg, &rsci.cred.cr_uid);
453 set_bit(CACHE_NEGATIVE, &rsci.h.flags);
456 struct gss_api_mech *gm;
459 if (get_int(&mesg, &rsci.cred.cr_gid))
462 /* number of additional gid's */
463 if (get_int(&mesg, &N))
466 rsci.cred.cr_group_info = groups_alloc(N);
467 if (rsci.cred.cr_group_info == NULL)
472 for (i=0; i<N; i++) {
474 if (get_int(&mesg, &gid))
476 GROUP_AT(rsci.cred.cr_group_info, i) = gid;
480 len = qword_get(&mesg, buf, mlen);
483 gm = gss_mech_get_by_name(buf);
484 status = -EOPNOTSUPP;
489 /* mech-specific data: */
490 len = qword_get(&mesg, buf, mlen);
495 status = gss_import_sec_context(buf, len, gm, &rsci.mechctx);
502 rsci.h.expiry_time = expiry;
503 rscp = rsc_update(&rsci, rscp);
508 cache_put(&rscp->h, &rsc_cache);
514 static struct cache_detail rsc_cache = {
515 .owner = THIS_MODULE,
516 .hash_size = RSC_HASHMAX,
517 .hash_table = rsc_table,
518 .name = "auth.rpcsec.context",
519 .cache_put = rsc_put,
520 .cache_parse = rsc_parse,
523 .update = update_rsc,
527 static struct rsc *rsc_lookup(struct rsc *item)
529 struct cache_head *ch;
530 int hash = rsc_hash(item);
532 ch = sunrpc_cache_lookup(&rsc_cache, &item->h, hash);
534 return container_of(ch, struct rsc, h);
539 static struct rsc *rsc_update(struct rsc *new, struct rsc *old)
541 struct cache_head *ch;
542 int hash = rsc_hash(new);
544 ch = sunrpc_cache_update(&rsc_cache, &new->h,
547 return container_of(ch, struct rsc, h);
554 gss_svc_searchbyctx(struct xdr_netobj *handle)
559 memset(&rsci, 0, sizeof(rsci));
560 if (dup_to_netobj(&rsci.handle, handle->data, handle->len))
562 found = rsc_lookup(&rsci);
566 if (cache_check(&rsc_cache, &found->h, NULL))
571 /* Implements sequence number algorithm as specified in RFC 2203. */
573 gss_check_seq_num(struct rsc *rsci, int seq_num)
575 struct gss_svc_seq_data *sd = &rsci->seqdata;
577 spin_lock(&sd->sd_lock);
578 if (seq_num > sd->sd_max) {
579 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
580 memset(sd->sd_win,0,sizeof(sd->sd_win));
581 sd->sd_max = seq_num;
582 } else while (sd->sd_max < seq_num) {
584 __clear_bit(sd->sd_max % GSS_SEQ_WIN, sd->sd_win);
586 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
588 } else if (seq_num <= sd->sd_max - GSS_SEQ_WIN) {
591 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
592 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win))
595 spin_unlock(&sd->sd_lock);
598 spin_unlock(&sd->sd_lock);
602 static inline u32 round_up_to_quad(u32 i)
604 return (i + 3 ) & ~3;
608 svc_safe_getnetobj(struct kvec *argv, struct xdr_netobj *o)
612 if (argv->iov_len < 4)
614 o->len = ntohl(svc_getu32(argv));
615 l = round_up_to_quad(o->len);
616 if (argv->iov_len < l)
618 o->data = argv->iov_base;
625 svc_safe_putnetobj(struct kvec *resv, struct xdr_netobj *o)
629 if (resv->iov_len + 4 > PAGE_SIZE)
631 svc_putu32(resv, htonl(o->len));
632 p = resv->iov_base + resv->iov_len;
633 resv->iov_len += round_up_to_quad(o->len);
634 if (resv->iov_len > PAGE_SIZE)
636 memcpy(p, o->data, o->len);
637 memset((u8 *)p + o->len, 0, round_up_to_quad(o->len) - o->len);
641 /* Verify the checksum on the header and return SVC_OK on success.
642 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
643 * or return SVC_DENIED and indicate error in authp.
646 gss_verify_header(struct svc_rqst *rqstp, struct rsc *rsci,
647 u32 *rpcstart, struct rpc_gss_wire_cred *gc, u32 *authp)
649 struct gss_ctx *ctx_id = rsci->mechctx;
650 struct xdr_buf rpchdr;
651 struct xdr_netobj checksum;
653 struct kvec *argv = &rqstp->rq_arg.head[0];
656 /* data to compute the checksum over: */
657 iov.iov_base = rpcstart;
658 iov.iov_len = (u8 *)argv->iov_base - (u8 *)rpcstart;
659 xdr_buf_from_iov(&iov, &rpchdr);
661 *authp = rpc_autherr_badverf;
662 if (argv->iov_len < 4)
664 flavor = ntohl(svc_getu32(argv));
665 if (flavor != RPC_AUTH_GSS)
667 if (svc_safe_getnetobj(argv, &checksum))
670 if (rqstp->rq_deferred) /* skip verification of revisited request */
672 if (gss_verify_mic(ctx_id, &rpchdr, &checksum) != GSS_S_COMPLETE) {
673 *authp = rpcsec_gsserr_credproblem;
677 if (gc->gc_seq > MAXSEQ) {
678 dprintk("RPC: svcauth_gss: discarding request with large sequence number %d\n",
680 *authp = rpcsec_gsserr_ctxproblem;
683 if (!gss_check_seq_num(rsci, gc->gc_seq)) {
684 dprintk("RPC: svcauth_gss: discarding request with old sequence number %d\n",
692 gss_write_null_verf(struct svc_rqst *rqstp)
696 svc_putu32(rqstp->rq_res.head, htonl(RPC_AUTH_NULL));
697 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
698 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
700 if (!xdr_ressize_check(rqstp, p))
706 gss_write_verf(struct svc_rqst *rqstp, struct gss_ctx *ctx_id, u32 seq)
710 struct xdr_buf verf_data;
711 struct xdr_netobj mic;
715 svc_putu32(rqstp->rq_res.head, htonl(RPC_AUTH_GSS));
716 xdr_seq = htonl(seq);
718 iov.iov_base = &xdr_seq;
719 iov.iov_len = sizeof(xdr_seq);
720 xdr_buf_from_iov(&iov, &verf_data);
721 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
722 mic.data = (u8 *)(p + 1);
723 maj_stat = gss_get_mic(ctx_id, &verf_data, &mic);
724 if (maj_stat != GSS_S_COMPLETE)
726 *p++ = htonl(mic.len);
727 memset((u8 *)p + mic.len, 0, round_up_to_quad(mic.len) - mic.len);
728 p += XDR_QUADLEN(mic.len);
729 if (!xdr_ressize_check(rqstp, p))
735 struct auth_domain h;
739 static struct auth_domain *
740 find_gss_auth_domain(struct gss_ctx *ctx, u32 svc)
744 name = gss_service_to_auth_domain_name(ctx->mech_type, svc);
747 return auth_domain_find(name);
750 static struct auth_ops svcauthops_gss;
753 svcauth_gss_register_pseudoflavor(u32 pseudoflavor, char * name)
755 struct gss_domain *new;
756 struct auth_domain *test;
759 new = kmalloc(sizeof(*new), GFP_KERNEL);
762 kref_init(&new->h.ref);
763 new->h.name = kmalloc(strlen(name) + 1, GFP_KERNEL);
766 strcpy(new->h.name, name);
767 new->h.flavour = &svcauthops_gss;
768 new->pseudoflavor = pseudoflavor;
770 test = auth_domain_lookup(name, &new->h);
771 if (test != &new->h) { /* XXX Duplicate registration? */
772 auth_domain_put(&new->h);
773 /* dangling ref-count... */
784 EXPORT_SYMBOL(svcauth_gss_register_pseudoflavor);
787 read_u32_from_xdr_buf(struct xdr_buf *buf, int base, u32 *obj)
792 status = read_bytes_from_xdr_buf(buf, base, &raw, sizeof(*obj));
799 /* It would be nice if this bit of code could be shared with the client.
801 * The client shouldn't malloc(), would have to pass in own memory.
802 * The server uses base of head iovec as read pointer, while the
803 * client uses separate pointer. */
805 unwrap_integ_data(struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
808 u32 integ_len, maj_stat;
809 struct xdr_netobj mic;
810 struct xdr_buf integ_buf;
812 integ_len = ntohl(svc_getu32(&buf->head[0]));
815 if (integ_len > buf->len)
817 if (xdr_buf_subsegment(buf, &integ_buf, 0, integ_len))
819 /* copy out mic... */
820 if (read_u32_from_xdr_buf(buf, integ_len, &mic.len))
822 if (mic.len > RPC_MAX_AUTH_SIZE)
824 mic.data = kmalloc(mic.len, GFP_KERNEL);
827 if (read_bytes_from_xdr_buf(buf, integ_len + 4, mic.data, mic.len))
829 maj_stat = gss_verify_mic(ctx, &integ_buf, &mic);
830 if (maj_stat != GSS_S_COMPLETE)
832 if (ntohl(svc_getu32(&buf->head[0])) != seq)
839 struct gss_svc_data {
840 /* decoded gss client cred: */
841 struct rpc_gss_wire_cred clcred;
842 /* pointer to the beginning of the procedure-specific results,
843 * which may be encrypted/checksummed in svcauth_gss_release: */
849 svcauth_gss_set_client(struct svc_rqst *rqstp)
851 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
852 struct rsc *rsci = svcdata->rsci;
853 struct rpc_gss_wire_cred *gc = &svcdata->clcred;
855 rqstp->rq_client = find_gss_auth_domain(rsci->mechctx, gc->gc_svc);
856 if (rqstp->rq_client == NULL)
862 gss_write_init_verf(struct svc_rqst *rqstp, struct rsi *rsip)
866 if (rsip->major_status != GSS_S_COMPLETE)
867 return gss_write_null_verf(rqstp);
868 rsci = gss_svc_searchbyctx(&rsip->out_handle);
870 rsip->major_status = GSS_S_NO_CONTEXT;
871 return gss_write_null_verf(rqstp);
873 return gss_write_verf(rqstp, rsci->mechctx, GSS_SEQ_WIN);
877 * Accept an rpcsec packet.
878 * If context establishment, punt to user space
879 * If data exchange, verify/decrypt
880 * If context destruction, handle here
881 * In the context establishment and destruction case we encode
882 * response here and return SVC_COMPLETE.
885 svcauth_gss_accept(struct svc_rqst *rqstp, u32 *authp)
887 struct kvec *argv = &rqstp->rq_arg.head[0];
888 struct kvec *resv = &rqstp->rq_res.head[0];
890 struct xdr_netobj tmpobj;
891 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
892 struct rpc_gss_wire_cred *gc;
893 struct rsc *rsci = NULL;
894 struct rsi *rsip, rsikey;
896 u32 *reject_stat = resv->iov_base + resv->iov_len;
899 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",argv->iov_len);
901 *authp = rpc_autherr_badcred;
903 svcdata = kmalloc(sizeof(*svcdata), GFP_KERNEL);
906 rqstp->rq_auth_data = svcdata;
907 svcdata->body_start = NULL;
908 svcdata->rsci = NULL;
909 gc = &svcdata->clcred;
911 /* start of rpc packet is 7 u32's back from here:
912 * xid direction rpcversion prog vers proc flavour
914 rpcstart = argv->iov_base;
918 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
919 * at least 5 u32s, and is preceeded by length, so that makes 6.
922 if (argv->iov_len < 5 * 4)
924 crlen = ntohl(svc_getu32(argv));
925 if (ntohl(svc_getu32(argv)) != RPC_GSS_VERSION)
927 gc->gc_proc = ntohl(svc_getu32(argv));
928 gc->gc_seq = ntohl(svc_getu32(argv));
929 gc->gc_svc = ntohl(svc_getu32(argv));
930 if (svc_safe_getnetobj(argv, &gc->gc_ctx))
932 if (crlen != round_up_to_quad(gc->gc_ctx.len) + 5 * 4)
935 if ((gc->gc_proc != RPC_GSS_PROC_DATA) && (rqstp->rq_proc != 0))
939 * We've successfully parsed the credential. Let's check out the
940 * verifier. An AUTH_NULL verifier is allowed (and required) for
941 * INIT and CONTINUE_INIT requests. AUTH_RPCSEC_GSS is required for
942 * PROC_DATA and PROC_DESTROY.
944 * AUTH_NULL verifier is 0 (AUTH_NULL), 0 (length).
945 * AUTH_RPCSEC_GSS verifier is:
946 * 6 (AUTH_RPCSEC_GSS), length, checksum.
947 * checksum is calculated over rpcheader from xid up to here.
949 *authp = rpc_autherr_badverf;
950 switch (gc->gc_proc) {
951 case RPC_GSS_PROC_INIT:
952 case RPC_GSS_PROC_CONTINUE_INIT:
953 if (argv->iov_len < 2 * 4)
955 if (ntohl(svc_getu32(argv)) != RPC_AUTH_NULL)
957 if (ntohl(svc_getu32(argv)) != 0)
960 case RPC_GSS_PROC_DATA:
961 case RPC_GSS_PROC_DESTROY:
962 *authp = rpcsec_gsserr_credproblem;
963 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
966 switch (gss_verify_header(rqstp, rsci, rpcstart, gc, authp)) {
976 *authp = rpc_autherr_rejectedcred;
980 /* now act upon the command: */
981 switch (gc->gc_proc) {
982 case RPC_GSS_PROC_INIT:
983 case RPC_GSS_PROC_CONTINUE_INIT:
984 *authp = rpc_autherr_badcred;
985 if (gc->gc_proc == RPC_GSS_PROC_INIT && gc->gc_ctx.len != 0)
987 memset(&rsikey, 0, sizeof(rsikey));
988 if (dup_netobj(&rsikey.in_handle, &gc->gc_ctx))
990 *authp = rpc_autherr_badverf;
991 if (svc_safe_getnetobj(argv, &tmpobj)) {
992 kfree(rsikey.in_handle.data);
995 if (dup_netobj(&rsikey.in_token, &tmpobj)) {
996 kfree(rsikey.in_handle.data);
1000 rsip = rsi_lookup(&rsikey);
1005 switch(cache_check(&rsi_cache, &rsip->h, &rqstp->rq_chandle)) {
1011 if (gss_write_init_verf(rqstp, rsip))
1013 if (resv->iov_len + 4 > PAGE_SIZE)
1015 svc_putu32(resv, rpc_success);
1016 if (svc_safe_putnetobj(resv, &rsip->out_handle))
1018 if (resv->iov_len + 3 * 4 > PAGE_SIZE)
1020 svc_putu32(resv, htonl(rsip->major_status));
1021 svc_putu32(resv, htonl(rsip->minor_status));
1022 svc_putu32(resv, htonl(GSS_SEQ_WIN));
1023 if (svc_safe_putnetobj(resv, &rsip->out_token))
1025 rqstp->rq_client = NULL;
1028 case RPC_GSS_PROC_DESTROY:
1029 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1030 if (resv->iov_len + 4 > PAGE_SIZE)
1032 svc_putu32(resv, rpc_success);
1034 case RPC_GSS_PROC_DATA:
1035 *authp = rpcsec_gsserr_ctxproblem;
1036 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1038 rqstp->rq_cred = rsci->cred;
1039 get_group_info(rsci->cred.cr_group_info);
1040 *authp = rpc_autherr_badcred;
1041 switch (gc->gc_svc) {
1042 case RPC_GSS_SVC_NONE:
1044 case RPC_GSS_SVC_INTEGRITY:
1045 if (unwrap_integ_data(&rqstp->rq_arg,
1046 gc->gc_seq, rsci->mechctx))
1048 /* placeholders for length and seq. number: */
1049 svcdata->body_start = resv->iov_base + resv->iov_len;
1050 svc_putu32(resv, 0);
1051 svc_putu32(resv, 0);
1053 case RPC_GSS_SVC_PRIVACY:
1054 /* currently unsupported */
1058 svcdata->rsci = rsci;
1059 cache_get(&rsci->h);
1064 /* Restore write pointer to original value: */
1065 xdr_ressize_check(rqstp, reject_stat);
1075 cache_put(&rsci->h, &rsc_cache);
1080 svcauth_gss_release(struct svc_rqst *rqstp)
1082 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1083 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1084 struct xdr_buf *resbuf = &rqstp->rq_res;
1085 struct xdr_buf integ_buf;
1086 struct xdr_netobj mic;
1089 int integ_offset, integ_len;
1092 if (gc->gc_proc != RPC_GSS_PROC_DATA)
1094 /* Release can be called twice, but we only wrap once. */
1095 if (gsd->body_start == NULL)
1097 /* normally not set till svc_send, but we need it here: */
1098 resbuf->len = resbuf->head[0].iov_len
1099 + resbuf->page_len + resbuf->tail[0].iov_len;
1100 switch (gc->gc_svc) {
1101 case RPC_GSS_SVC_NONE:
1103 case RPC_GSS_SVC_INTEGRITY:
1104 p = gsd->body_start;
1105 gsd->body_start = NULL;
1106 /* move accept_stat to right place: */
1107 memcpy(p, p + 2, 4);
1108 /* don't wrap in failure case: */
1109 /* Note: counting on not getting here if call was not even
1111 if (*p != rpc_success) {
1112 resbuf->head[0].iov_len -= 2 * 4;
1116 integ_offset = (u8 *)(p + 1) - (u8 *)resbuf->head[0].iov_base;
1117 integ_len = resbuf->len - integ_offset;
1118 BUG_ON(integ_len % 4);
1119 *p++ = htonl(integ_len);
1120 *p++ = htonl(gc->gc_seq);
1121 if (xdr_buf_subsegment(resbuf, &integ_buf, integ_offset,
1124 if (resbuf->page_len == 0
1125 && resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE
1127 BUG_ON(resbuf->tail[0].iov_len);
1128 /* Use head for everything */
1129 resv = &resbuf->head[0];
1130 } else if (resbuf->tail[0].iov_base == NULL) {
1131 if (resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE
1134 resbuf->tail[0].iov_base =
1135 resbuf->head[0].iov_base
1136 + resbuf->head[0].iov_len;
1137 resbuf->tail[0].iov_len = 0;
1138 rqstp->rq_restailpage = 0;
1139 resv = &resbuf->tail[0];
1141 resv = &resbuf->tail[0];
1143 mic.data = (u8 *)resv->iov_base + resv->iov_len + 4;
1144 if (gss_get_mic(gsd->rsci->mechctx, &integ_buf, &mic))
1146 svc_putu32(resv, htonl(mic.len));
1147 memset(mic.data + mic.len, 0,
1148 round_up_to_quad(mic.len) - mic.len);
1149 resv->iov_len += XDR_QUADLEN(mic.len) << 2;
1150 /* not strictly required: */
1151 resbuf->len += XDR_QUADLEN(mic.len) << 2;
1152 BUG_ON(resv->iov_len > PAGE_SIZE);
1154 case RPC_GSS_SVC_PRIVACY:
1162 if (rqstp->rq_client)
1163 auth_domain_put(rqstp->rq_client);
1164 rqstp->rq_client = NULL;
1165 if (rqstp->rq_cred.cr_group_info)
1166 put_group_info(rqstp->rq_cred.cr_group_info);
1167 rqstp->rq_cred.cr_group_info = NULL;
1169 cache_put(&gsd->rsci->h, &rsc_cache);
1176 svcauth_gss_domain_release(struct auth_domain *dom)
1178 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
1184 static struct auth_ops svcauthops_gss = {
1185 .name = "rpcsec_gss",
1186 .owner = THIS_MODULE,
1187 .flavour = RPC_AUTH_GSS,
1188 .accept = svcauth_gss_accept,
1189 .release = svcauth_gss_release,
1190 .domain_release = svcauth_gss_domain_release,
1191 .set_client = svcauth_gss_set_client,
1197 int rv = svc_auth_register(RPC_AUTH_GSS, &svcauthops_gss);
1199 cache_register(&rsc_cache);
1200 cache_register(&rsi_cache);
1206 gss_svc_shutdown(void)
1208 if (cache_unregister(&rsc_cache))
1209 printk(KERN_ERR "auth_rpcgss: failed to unregister rsc cache\n");
1210 if (cache_unregister(&rsi_cache))
1211 printk(KERN_ERR "auth_rpcgss: failed to unregister rsi cache\n");
1212 svc_auth_unregister(RPC_AUTH_GSS);