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/slab.h>
41 #include <linux/types.h>
42 #include <linux/module.h>
43 #include <linux/pagemap.h>
45 #include <linux/sunrpc/auth_gss.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>
54 # define RPCDBG_FACILITY RPCDBG_AUTH
57 /* The rpcsec_init cache is used for mapping RPCSEC_GSS_{,CONT_}INIT requests
60 * Key is context handle (\x if empty) and gss_token.
61 * Content is major_status minor_status (integers) context_handle, reply_token.
65 static int netobj_equal(struct xdr_netobj *a, struct xdr_netobj *b)
67 return a->len == b->len && 0 == memcmp(a->data, b->data, a->len);
70 #define RSI_HASHBITS 6
71 #define RSI_HASHMAX (1<<RSI_HASHBITS)
75 struct xdr_netobj in_handle, in_token;
76 struct xdr_netobj out_handle, out_token;
77 int major_status, minor_status;
80 static struct rsi *rsi_update(struct cache_detail *cd, struct rsi *new, struct rsi *old);
81 static struct rsi *rsi_lookup(struct cache_detail *cd, struct rsi *item);
83 static void rsi_free(struct rsi *rsii)
85 kfree(rsii->in_handle.data);
86 kfree(rsii->in_token.data);
87 kfree(rsii->out_handle.data);
88 kfree(rsii->out_token.data);
91 static void rsi_put(struct kref *ref)
93 struct rsi *rsii = container_of(ref, struct rsi, h.ref);
98 static inline int rsi_hash(struct rsi *item)
100 return hash_mem(item->in_handle.data, item->in_handle.len, RSI_HASHBITS)
101 ^ hash_mem(item->in_token.data, item->in_token.len, RSI_HASHBITS);
104 static int rsi_match(struct cache_head *a, struct cache_head *b)
106 struct rsi *item = container_of(a, struct rsi, h);
107 struct rsi *tmp = container_of(b, struct rsi, h);
108 return netobj_equal(&item->in_handle, &tmp->in_handle) &&
109 netobj_equal(&item->in_token, &tmp->in_token);
112 static int dup_to_netobj(struct xdr_netobj *dst, char *src, int len)
115 dst->data = (len ? kmemdup(src, len, GFP_KERNEL) : NULL);
116 if (len && !dst->data)
121 static inline int dup_netobj(struct xdr_netobj *dst, struct xdr_netobj *src)
123 return dup_to_netobj(dst, src->data, src->len);
126 static void rsi_init(struct cache_head *cnew, struct cache_head *citem)
128 struct rsi *new = container_of(cnew, struct rsi, h);
129 struct rsi *item = container_of(citem, struct rsi, h);
131 new->out_handle.data = NULL;
132 new->out_handle.len = 0;
133 new->out_token.data = NULL;
134 new->out_token.len = 0;
135 new->in_handle.len = item->in_handle.len;
136 item->in_handle.len = 0;
137 new->in_token.len = item->in_token.len;
138 item->in_token.len = 0;
139 new->in_handle.data = item->in_handle.data;
140 item->in_handle.data = NULL;
141 new->in_token.data = item->in_token.data;
142 item->in_token.data = NULL;
145 static void update_rsi(struct cache_head *cnew, struct cache_head *citem)
147 struct rsi *new = container_of(cnew, struct rsi, h);
148 struct rsi *item = container_of(citem, struct rsi, h);
150 BUG_ON(new->out_handle.data || new->out_token.data);
151 new->out_handle.len = item->out_handle.len;
152 item->out_handle.len = 0;
153 new->out_token.len = item->out_token.len;
154 item->out_token.len = 0;
155 new->out_handle.data = item->out_handle.data;
156 item->out_handle.data = NULL;
157 new->out_token.data = item->out_token.data;
158 item->out_token.data = NULL;
160 new->major_status = item->major_status;
161 new->minor_status = item->minor_status;
164 static struct cache_head *rsi_alloc(void)
166 struct rsi *rsii = kmalloc(sizeof(*rsii), GFP_KERNEL);
173 static void rsi_request(struct cache_detail *cd,
174 struct cache_head *h,
175 char **bpp, int *blen)
177 struct rsi *rsii = container_of(h, struct rsi, h);
179 qword_addhex(bpp, blen, rsii->in_handle.data, rsii->in_handle.len);
180 qword_addhex(bpp, blen, rsii->in_token.data, rsii->in_token.len);
184 static int rsi_upcall(struct cache_detail *cd, struct cache_head *h)
186 return sunrpc_cache_pipe_upcall(cd, h, rsi_request);
190 static int rsi_parse(struct cache_detail *cd,
191 char *mesg, int mlen)
193 /* context token expiry major minor context token */
197 struct rsi rsii, *rsip = NULL;
199 int status = -EINVAL;
201 memset(&rsii, 0, sizeof(rsii));
203 len = qword_get(&mesg, buf, mlen);
207 if (dup_to_netobj(&rsii.in_handle, buf, len))
211 len = qword_get(&mesg, buf, mlen);
216 if (dup_to_netobj(&rsii.in_token, buf, len))
219 rsip = rsi_lookup(cd, &rsii);
225 expiry = get_expiry(&mesg);
231 len = qword_get(&mesg, buf, mlen);
234 rsii.major_status = simple_strtoul(buf, &ep, 10);
237 len = qword_get(&mesg, buf, mlen);
240 rsii.minor_status = simple_strtoul(buf, &ep, 10);
245 len = qword_get(&mesg, buf, mlen);
249 if (dup_to_netobj(&rsii.out_handle, buf, len))
253 len = qword_get(&mesg, buf, mlen);
258 if (dup_to_netobj(&rsii.out_token, buf, len))
260 rsii.h.expiry_time = expiry;
261 rsip = rsi_update(cd, &rsii, rsip);
266 cache_put(&rsip->h, cd);
272 static struct cache_detail rsi_cache_template = {
273 .owner = THIS_MODULE,
274 .hash_size = RSI_HASHMAX,
275 .name = "auth.rpcsec.init",
276 .cache_put = rsi_put,
277 .cache_upcall = rsi_upcall,
278 .cache_parse = rsi_parse,
281 .update = update_rsi,
285 static struct rsi *rsi_lookup(struct cache_detail *cd, struct rsi *item)
287 struct cache_head *ch;
288 int hash = rsi_hash(item);
290 ch = sunrpc_cache_lookup(cd, &item->h, hash);
292 return container_of(ch, struct rsi, h);
297 static struct rsi *rsi_update(struct cache_detail *cd, struct rsi *new, struct rsi *old)
299 struct cache_head *ch;
300 int hash = rsi_hash(new);
302 ch = sunrpc_cache_update(cd, &new->h,
305 return container_of(ch, struct rsi, h);
312 * The rpcsec_context cache is used to store a context that is
313 * used in data exchange.
314 * The key is a context handle. The content is:
315 * uid, gidlist, mechanism, service-set, mech-specific-data
318 #define RSC_HASHBITS 10
319 #define RSC_HASHMAX (1<<RSC_HASHBITS)
321 #define GSS_SEQ_WIN 128
323 struct gss_svc_seq_data {
324 /* highest seq number seen so far: */
326 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
327 * sd_win is nonzero iff sequence number i has been seen already: */
328 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
334 struct xdr_netobj handle;
335 struct svc_cred cred;
336 struct gss_svc_seq_data seqdata;
337 struct gss_ctx *mechctx;
340 static struct rsc *rsc_update(struct cache_detail *cd, struct rsc *new, struct rsc *old);
341 static struct rsc *rsc_lookup(struct cache_detail *cd, struct rsc *item);
343 static void rsc_free(struct rsc *rsci)
345 kfree(rsci->handle.data);
347 gss_delete_sec_context(&rsci->mechctx);
348 free_svc_cred(&rsci->cred);
351 static void rsc_put(struct kref *ref)
353 struct rsc *rsci = container_of(ref, struct rsc, h.ref);
360 rsc_hash(struct rsc *rsci)
362 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
366 rsc_match(struct cache_head *a, struct cache_head *b)
368 struct rsc *new = container_of(a, struct rsc, h);
369 struct rsc *tmp = container_of(b, struct rsc, h);
371 return netobj_equal(&new->handle, &tmp->handle);
375 rsc_init(struct cache_head *cnew, struct cache_head *ctmp)
377 struct rsc *new = container_of(cnew, struct rsc, h);
378 struct rsc *tmp = container_of(ctmp, struct rsc, h);
380 new->handle.len = tmp->handle.len;
382 new->handle.data = tmp->handle.data;
383 tmp->handle.data = NULL;
385 new->cred.cr_group_info = NULL;
386 new->cred.cr_principal = NULL;
390 update_rsc(struct cache_head *cnew, struct cache_head *ctmp)
392 struct rsc *new = container_of(cnew, struct rsc, h);
393 struct rsc *tmp = container_of(ctmp, struct rsc, h);
395 new->mechctx = tmp->mechctx;
397 memset(&new->seqdata, 0, sizeof(new->seqdata));
398 spin_lock_init(&new->seqdata.sd_lock);
399 new->cred = tmp->cred;
400 tmp->cred.cr_group_info = NULL;
401 new->cred.cr_principal = tmp->cred.cr_principal;
402 tmp->cred.cr_principal = NULL;
405 static struct cache_head *
408 struct rsc *rsci = kmalloc(sizeof(*rsci), GFP_KERNEL);
415 static int rsc_parse(struct cache_detail *cd,
416 char *mesg, int mlen)
418 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
421 struct rsc rsci, *rscp = NULL;
423 int status = -EINVAL;
424 struct gss_api_mech *gm = NULL;
426 memset(&rsci, 0, sizeof(rsci));
428 len = qword_get(&mesg, buf, mlen);
429 if (len < 0) goto out;
431 if (dup_to_netobj(&rsci.handle, buf, len))
436 expiry = get_expiry(&mesg);
441 rscp = rsc_lookup(cd, &rsci);
445 /* uid, or NEGATIVE */
446 rv = get_int(&mesg, &rsci.cred.cr_uid);
450 set_bit(CACHE_NEGATIVE, &rsci.h.flags);
455 if (get_int(&mesg, &rsci.cred.cr_gid))
458 /* number of additional gid's */
459 if (get_int(&mesg, &N))
462 rsci.cred.cr_group_info = groups_alloc(N);
463 if (rsci.cred.cr_group_info == NULL)
468 for (i=0; i<N; i++) {
470 if (get_int(&mesg, &gid))
472 GROUP_AT(rsci.cred.cr_group_info, i) = gid;
476 len = qword_get(&mesg, buf, mlen);
479 gm = gss_mech_get_by_name(buf);
480 status = -EOPNOTSUPP;
485 /* mech-specific data: */
486 len = qword_get(&mesg, buf, mlen);
489 status = gss_import_sec_context(buf, len, gm, &rsci.mechctx, GFP_KERNEL);
493 /* get client name */
494 len = qword_get(&mesg, buf, mlen);
496 rsci.cred.cr_principal = kstrdup(buf, GFP_KERNEL);
497 if (!rsci.cred.cr_principal)
502 rsci.h.expiry_time = expiry;
503 rscp = rsc_update(cd, &rsci, rscp);
509 cache_put(&rscp->h, cd);
515 static struct cache_detail rsc_cache_template = {
516 .owner = THIS_MODULE,
517 .hash_size = RSC_HASHMAX,
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 cache_detail *cd, struct rsc *item)
529 struct cache_head *ch;
530 int hash = rsc_hash(item);
532 ch = sunrpc_cache_lookup(cd, &item->h, hash);
534 return container_of(ch, struct rsc, h);
539 static struct rsc *rsc_update(struct cache_detail *cd, struct rsc *new, struct rsc *old)
541 struct cache_head *ch;
542 int hash = rsc_hash(new);
544 ch = sunrpc_cache_update(cd, &new->h,
547 return container_of(ch, struct rsc, h);
554 gss_svc_searchbyctx(struct cache_detail *cd, 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(cd, &rsci);
566 if (cache_check(cd, &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 = svc_getnl(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_putnl(resv, 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(p + o->len, 0, round_up_to_quad(o->len) - o->len);
642 * Verify the checksum on the header and return SVC_OK on success.
643 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
644 * or return SVC_DENIED and indicate error in authp.
647 gss_verify_header(struct svc_rqst *rqstp, struct rsc *rsci,
648 __be32 *rpcstart, struct rpc_gss_wire_cred *gc, __be32 *authp)
650 struct gss_ctx *ctx_id = rsci->mechctx;
651 struct xdr_buf rpchdr;
652 struct xdr_netobj checksum;
654 struct kvec *argv = &rqstp->rq_arg.head[0];
657 /* data to compute the checksum over: */
658 iov.iov_base = rpcstart;
659 iov.iov_len = (u8 *)argv->iov_base - (u8 *)rpcstart;
660 xdr_buf_from_iov(&iov, &rpchdr);
662 *authp = rpc_autherr_badverf;
663 if (argv->iov_len < 4)
665 flavor = svc_getnl(argv);
666 if (flavor != RPC_AUTH_GSS)
668 if (svc_safe_getnetobj(argv, &checksum))
671 if (rqstp->rq_deferred) /* skip verification of revisited request */
673 if (gss_verify_mic(ctx_id, &rpchdr, &checksum) != GSS_S_COMPLETE) {
674 *authp = rpcsec_gsserr_credproblem;
678 if (gc->gc_seq > MAXSEQ) {
679 dprintk("RPC: svcauth_gss: discarding request with "
680 "large sequence number %d\n", gc->gc_seq);
681 *authp = rpcsec_gsserr_ctxproblem;
684 if (!gss_check_seq_num(rsci, gc->gc_seq)) {
685 dprintk("RPC: svcauth_gss: discarding request with "
686 "old sequence number %d\n", gc->gc_seq);
693 gss_write_null_verf(struct svc_rqst *rqstp)
697 svc_putnl(rqstp->rq_res.head, RPC_AUTH_NULL);
698 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
699 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
701 if (!xdr_ressize_check(rqstp, p))
707 gss_write_verf(struct svc_rqst *rqstp, struct gss_ctx *ctx_id, u32 seq)
711 struct xdr_buf verf_data;
712 struct xdr_netobj mic;
716 svc_putnl(rqstp->rq_res.head, RPC_AUTH_GSS);
717 xdr_seq = htonl(seq);
719 iov.iov_base = &xdr_seq;
720 iov.iov_len = sizeof(xdr_seq);
721 xdr_buf_from_iov(&iov, &verf_data);
722 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
723 mic.data = (u8 *)(p + 1);
724 maj_stat = gss_get_mic(ctx_id, &verf_data, &mic);
725 if (maj_stat != GSS_S_COMPLETE)
727 *p++ = htonl(mic.len);
728 memset((u8 *)p + mic.len, 0, round_up_to_quad(mic.len) - mic.len);
729 p += XDR_QUADLEN(mic.len);
730 if (!xdr_ressize_check(rqstp, p))
736 struct auth_domain h;
740 static struct auth_domain *
741 find_gss_auth_domain(struct gss_ctx *ctx, u32 svc)
745 name = gss_service_to_auth_domain_name(ctx->mech_type, svc);
748 return auth_domain_find(name);
751 static struct auth_ops svcauthops_gss;
753 u32 svcauth_gss_flavor(struct auth_domain *dom)
755 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
757 return gd->pseudoflavor;
760 EXPORT_SYMBOL_GPL(svcauth_gss_flavor);
763 svcauth_gss_register_pseudoflavor(u32 pseudoflavor, char * name)
765 struct gss_domain *new;
766 struct auth_domain *test;
769 new = kmalloc(sizeof(*new), GFP_KERNEL);
772 kref_init(&new->h.ref);
773 new->h.name = kstrdup(name, GFP_KERNEL);
776 new->h.flavour = &svcauthops_gss;
777 new->pseudoflavor = pseudoflavor;
780 test = auth_domain_lookup(name, &new->h);
781 if (test != &new->h) { /* Duplicate registration */
782 auth_domain_put(test);
794 EXPORT_SYMBOL_GPL(svcauth_gss_register_pseudoflavor);
797 read_u32_from_xdr_buf(struct xdr_buf *buf, int base, u32 *obj)
802 status = read_bytes_from_xdr_buf(buf, base, &raw, sizeof(*obj));
809 /* It would be nice if this bit of code could be shared with the client.
811 * The client shouldn't malloc(), would have to pass in own memory.
812 * The server uses base of head iovec as read pointer, while the
813 * client uses separate pointer. */
815 unwrap_integ_data(struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
818 u32 integ_len, maj_stat;
819 struct xdr_netobj mic;
820 struct xdr_buf integ_buf;
822 integ_len = svc_getnl(&buf->head[0]);
825 if (integ_len > buf->len)
827 if (xdr_buf_subsegment(buf, &integ_buf, 0, integ_len))
829 /* copy out mic... */
830 if (read_u32_from_xdr_buf(buf, integ_len, &mic.len))
832 if (mic.len > RPC_MAX_AUTH_SIZE)
834 mic.data = kmalloc(mic.len, GFP_KERNEL);
837 if (read_bytes_from_xdr_buf(buf, integ_len + 4, mic.data, mic.len))
839 maj_stat = gss_verify_mic(ctx, &integ_buf, &mic);
840 if (maj_stat != GSS_S_COMPLETE)
842 if (svc_getnl(&buf->head[0]) != seq)
851 total_buf_len(struct xdr_buf *buf)
853 return buf->head[0].iov_len + buf->page_len + buf->tail[0].iov_len;
857 fix_priv_head(struct xdr_buf *buf, int pad)
859 if (buf->page_len == 0) {
860 /* We need to adjust head and buf->len in tandem in this
861 * case to make svc_defer() work--it finds the original
862 * buffer start using buf->len - buf->head[0].iov_len. */
863 buf->head[0].iov_len -= pad;
868 unwrap_priv_data(struct svc_rqst *rqstp, struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
870 u32 priv_len, maj_stat;
871 int pad, saved_len, remaining_len, offset;
873 rqstp->rq_splice_ok = 0;
875 priv_len = svc_getnl(&buf->head[0]);
876 if (rqstp->rq_deferred) {
877 /* Already decrypted last time through! The sequence number
878 * check at out_seq is unnecessary but harmless: */
881 /* buf->len is the number of bytes from the original start of the
882 * request to the end, where head[0].iov_len is just the bytes
883 * not yet read from the head, so these two values are different: */
884 remaining_len = total_buf_len(buf);
885 if (priv_len > remaining_len)
887 pad = remaining_len - priv_len;
889 fix_priv_head(buf, pad);
891 /* Maybe it would be better to give gss_unwrap a length parameter: */
892 saved_len = buf->len;
894 maj_stat = gss_unwrap(ctx, 0, buf);
895 pad = priv_len - buf->len;
896 buf->len = saved_len;
898 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
899 * In the krb5p case, at least, the data ends up offset, so we need to
901 /* XXX: This is very inefficient. It would be better to either do
902 * this while we encrypt, or maybe in the receive code, if we can peak
903 * ahead and work out the service and mechanism there. */
904 offset = buf->head[0].iov_len % 4;
906 buf->buflen = RPCSVC_MAXPAYLOAD;
907 xdr_shift_buf(buf, offset);
908 fix_priv_head(buf, pad);
910 if (maj_stat != GSS_S_COMPLETE)
913 if (svc_getnl(&buf->head[0]) != seq)
918 struct gss_svc_data {
919 /* decoded gss client cred: */
920 struct rpc_gss_wire_cred clcred;
921 /* save a pointer to the beginning of the encoded verifier,
922 * for use in encryption/checksumming in svcauth_gss_release: */
928 svcauth_gss_set_client(struct svc_rqst *rqstp)
930 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
931 struct rsc *rsci = svcdata->rsci;
932 struct rpc_gss_wire_cred *gc = &svcdata->clcred;
936 * A gss export can be specified either by:
937 * export *(sec=krb5,rw)
939 * export gss/krb5(rw)
940 * The latter is deprecated; but for backwards compatibility reasons
941 * the nfsd code will still fall back on trying it if the former
942 * doesn't work; so we try to make both available to nfsd, below.
944 rqstp->rq_gssclient = find_gss_auth_domain(rsci->mechctx, gc->gc_svc);
945 if (rqstp->rq_gssclient == NULL)
947 stat = svcauth_unix_set_client(rqstp);
948 if (stat == SVC_DROP || stat == SVC_CLOSE)
954 gss_write_init_verf(struct cache_detail *cd, struct svc_rqst *rqstp,
955 struct xdr_netobj *out_handle, int *major_status)
960 if (*major_status != GSS_S_COMPLETE)
961 return gss_write_null_verf(rqstp);
962 rsci = gss_svc_searchbyctx(cd, out_handle);
964 *major_status = GSS_S_NO_CONTEXT;
965 return gss_write_null_verf(rqstp);
967 rc = gss_write_verf(rqstp, rsci->mechctx, GSS_SEQ_WIN);
968 cache_put(&rsci->h, cd);
973 gss_read_verf(struct rpc_gss_wire_cred *gc,
974 struct kvec *argv, __be32 *authp,
975 struct xdr_netobj *in_handle,
976 struct xdr_netobj *in_token)
978 struct xdr_netobj tmpobj;
980 /* Read the verifier; should be NULL: */
981 *authp = rpc_autherr_badverf;
982 if (argv->iov_len < 2 * 4)
984 if (svc_getnl(argv) != RPC_AUTH_NULL)
986 if (svc_getnl(argv) != 0)
988 /* Martial context handle and token for upcall: */
989 *authp = rpc_autherr_badcred;
990 if (gc->gc_proc == RPC_GSS_PROC_INIT && gc->gc_ctx.len != 0)
992 if (dup_netobj(in_handle, &gc->gc_ctx))
994 *authp = rpc_autherr_badverf;
995 if (svc_safe_getnetobj(argv, &tmpobj)) {
996 kfree(in_handle->data);
999 if (dup_netobj(in_token, &tmpobj)) {
1000 kfree(in_handle->data);
1008 gss_write_resv(struct kvec *resv, size_t size_limit,
1009 struct xdr_netobj *out_handle, struct xdr_netobj *out_token,
1010 int major_status, int minor_status)
1012 if (resv->iov_len + 4 > size_limit)
1014 svc_putnl(resv, RPC_SUCCESS);
1015 if (svc_safe_putnetobj(resv, out_handle))
1017 if (resv->iov_len + 3 * 4 > size_limit)
1019 svc_putnl(resv, major_status);
1020 svc_putnl(resv, minor_status);
1021 svc_putnl(resv, GSS_SEQ_WIN);
1022 if (svc_safe_putnetobj(resv, out_token))
1028 * Having read the cred already and found we're in the context
1029 * initiation case, read the verifier and initiate (or check the results
1030 * of) upcalls to userspace for help with context initiation. If
1031 * the upcall results are available, write the verifier and result.
1032 * Otherwise, drop the request pending an answer to the upcall.
1034 static int svcauth_gss_handle_init(struct svc_rqst *rqstp,
1035 struct rpc_gss_wire_cred *gc, __be32 *authp)
1037 struct kvec *argv = &rqstp->rq_arg.head[0];
1038 struct kvec *resv = &rqstp->rq_res.head[0];
1039 struct rsi *rsip, rsikey;
1041 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1043 memset(&rsikey, 0, sizeof(rsikey));
1044 ret = gss_read_verf(gc, argv, authp,
1045 &rsikey.in_handle, &rsikey.in_token);
1049 /* Perform upcall, or find upcall result: */
1050 rsip = rsi_lookup(sn->rsi_cache, &rsikey);
1054 if (cache_check(sn->rsi_cache, &rsip->h, &rqstp->rq_chandle) < 0)
1055 /* No upcall result: */
1059 /* Got an answer to the upcall; use it: */
1060 if (gss_write_init_verf(sn->rsc_cache, rqstp,
1061 &rsip->out_handle, &rsip->major_status))
1063 if (gss_write_resv(resv, PAGE_SIZE,
1064 &rsip->out_handle, &rsip->out_token,
1065 rsip->major_status, rsip->minor_status))
1070 cache_put(&rsip->h, sn->rsi_cache);
1075 * Accept an rpcsec packet.
1076 * If context establishment, punt to user space
1077 * If data exchange, verify/decrypt
1078 * If context destruction, handle here
1079 * In the context establishment and destruction case we encode
1080 * response here and return SVC_COMPLETE.
1083 svcauth_gss_accept(struct svc_rqst *rqstp, __be32 *authp)
1085 struct kvec *argv = &rqstp->rq_arg.head[0];
1086 struct kvec *resv = &rqstp->rq_res.head[0];
1088 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
1089 struct rpc_gss_wire_cred *gc;
1090 struct rsc *rsci = NULL;
1092 __be32 *reject_stat = resv->iov_base + resv->iov_len;
1094 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1096 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
1099 *authp = rpc_autherr_badcred;
1101 svcdata = kmalloc(sizeof(*svcdata), GFP_KERNEL);
1104 rqstp->rq_auth_data = svcdata;
1105 svcdata->verf_start = NULL;
1106 svcdata->rsci = NULL;
1107 gc = &svcdata->clcred;
1109 /* start of rpc packet is 7 u32's back from here:
1110 * xid direction rpcversion prog vers proc flavour
1112 rpcstart = argv->iov_base;
1116 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1117 * at least 5 u32s, and is preceded by length, so that makes 6.
1120 if (argv->iov_len < 5 * 4)
1122 crlen = svc_getnl(argv);
1123 if (svc_getnl(argv) != RPC_GSS_VERSION)
1125 gc->gc_proc = svc_getnl(argv);
1126 gc->gc_seq = svc_getnl(argv);
1127 gc->gc_svc = svc_getnl(argv);
1128 if (svc_safe_getnetobj(argv, &gc->gc_ctx))
1130 if (crlen != round_up_to_quad(gc->gc_ctx.len) + 5 * 4)
1133 if ((gc->gc_proc != RPC_GSS_PROC_DATA) && (rqstp->rq_proc != 0))
1136 *authp = rpc_autherr_badverf;
1137 switch (gc->gc_proc) {
1138 case RPC_GSS_PROC_INIT:
1139 case RPC_GSS_PROC_CONTINUE_INIT:
1140 return svcauth_gss_handle_init(rqstp, gc, authp);
1141 case RPC_GSS_PROC_DATA:
1142 case RPC_GSS_PROC_DESTROY:
1143 /* Look up the context, and check the verifier: */
1144 *authp = rpcsec_gsserr_credproblem;
1145 rsci = gss_svc_searchbyctx(sn->rsc_cache, &gc->gc_ctx);
1148 switch (gss_verify_header(rqstp, rsci, rpcstart, gc, authp)) {
1158 *authp = rpc_autherr_rejectedcred;
1162 /* now act upon the command: */
1163 switch (gc->gc_proc) {
1164 case RPC_GSS_PROC_DESTROY:
1165 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1167 rsci->h.expiry_time = get_seconds();
1168 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1169 if (resv->iov_len + 4 > PAGE_SIZE)
1171 svc_putnl(resv, RPC_SUCCESS);
1173 case RPC_GSS_PROC_DATA:
1174 *authp = rpcsec_gsserr_ctxproblem;
1175 svcdata->verf_start = resv->iov_base + resv->iov_len;
1176 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1178 rqstp->rq_cred = rsci->cred;
1179 get_group_info(rsci->cred.cr_group_info);
1180 *authp = rpc_autherr_badcred;
1181 switch (gc->gc_svc) {
1182 case RPC_GSS_SVC_NONE:
1184 case RPC_GSS_SVC_INTEGRITY:
1185 /* placeholders for length and seq. number: */
1188 if (unwrap_integ_data(&rqstp->rq_arg,
1189 gc->gc_seq, rsci->mechctx))
1192 case RPC_GSS_SVC_PRIVACY:
1193 /* placeholders for length and seq. number: */
1196 if (unwrap_priv_data(rqstp, &rqstp->rq_arg,
1197 gc->gc_seq, rsci->mechctx))
1203 svcdata->rsci = rsci;
1204 cache_get(&rsci->h);
1205 rqstp->rq_flavor = gss_svc_to_pseudoflavor(
1206 rsci->mechctx->mech_type, gc->gc_svc);
1214 /* Restore write pointer to its original value: */
1215 xdr_ressize_check(rqstp, reject_stat);
1225 cache_put(&rsci->h, sn->rsc_cache);
1230 svcauth_gss_prepare_to_wrap(struct xdr_buf *resbuf, struct gss_svc_data *gsd)
1235 p = gsd->verf_start;
1236 gsd->verf_start = NULL;
1238 /* If the reply stat is nonzero, don't wrap: */
1239 if (*(p-1) != rpc_success)
1241 /* Skip the verifier: */
1243 verf_len = ntohl(*p++);
1244 p += XDR_QUADLEN(verf_len);
1245 /* move accept_stat to right place: */
1246 memcpy(p, p + 2, 4);
1247 /* Also don't wrap if the accept stat is nonzero: */
1248 if (*p != rpc_success) {
1249 resbuf->head[0].iov_len -= 2 * 4;
1257 svcauth_gss_wrap_resp_integ(struct svc_rqst *rqstp)
1259 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1260 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1261 struct xdr_buf *resbuf = &rqstp->rq_res;
1262 struct xdr_buf integ_buf;
1263 struct xdr_netobj mic;
1266 int integ_offset, integ_len;
1269 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1272 integ_offset = (u8 *)(p + 1) - (u8 *)resbuf->head[0].iov_base;
1273 integ_len = resbuf->len - integ_offset;
1274 BUG_ON(integ_len % 4);
1275 *p++ = htonl(integ_len);
1276 *p++ = htonl(gc->gc_seq);
1277 if (xdr_buf_subsegment(resbuf, &integ_buf, integ_offset,
1280 if (resbuf->tail[0].iov_base == NULL) {
1281 if (resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1283 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1284 + resbuf->head[0].iov_len;
1285 resbuf->tail[0].iov_len = 0;
1286 resv = &resbuf->tail[0];
1288 resv = &resbuf->tail[0];
1290 mic.data = (u8 *)resv->iov_base + resv->iov_len + 4;
1291 if (gss_get_mic(gsd->rsci->mechctx, &integ_buf, &mic))
1293 svc_putnl(resv, mic.len);
1294 memset(mic.data + mic.len, 0,
1295 round_up_to_quad(mic.len) - mic.len);
1296 resv->iov_len += XDR_QUADLEN(mic.len) << 2;
1297 /* not strictly required: */
1298 resbuf->len += XDR_QUADLEN(mic.len) << 2;
1299 BUG_ON(resv->iov_len > PAGE_SIZE);
1307 svcauth_gss_wrap_resp_priv(struct svc_rqst *rqstp)
1309 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1310 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1311 struct xdr_buf *resbuf = &rqstp->rq_res;
1312 struct page **inpages = NULL;
1317 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1321 offset = (u8 *)p - (u8 *)resbuf->head[0].iov_base;
1322 *p++ = htonl(gc->gc_seq);
1323 inpages = resbuf->pages;
1324 /* XXX: Would be better to write some xdr helper functions for
1325 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1328 * If there is currently tail data, make sure there is
1329 * room for the head, tail, and 2 * RPC_MAX_AUTH_SIZE in
1330 * the page, and move the current tail data such that
1331 * there is RPC_MAX_AUTH_SIZE slack space available in
1332 * both the head and tail.
1334 if (resbuf->tail[0].iov_base) {
1335 BUG_ON(resbuf->tail[0].iov_base >= resbuf->head[0].iov_base
1337 BUG_ON(resbuf->tail[0].iov_base < resbuf->head[0].iov_base);
1338 if (resbuf->tail[0].iov_len + resbuf->head[0].iov_len
1339 + 2 * RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1341 memmove(resbuf->tail[0].iov_base + RPC_MAX_AUTH_SIZE,
1342 resbuf->tail[0].iov_base,
1343 resbuf->tail[0].iov_len);
1344 resbuf->tail[0].iov_base += RPC_MAX_AUTH_SIZE;
1347 * If there is no current tail data, make sure there is
1348 * room for the head data, and 2 * RPC_MAX_AUTH_SIZE in the
1349 * allotted page, and set up tail information such that there
1350 * is RPC_MAX_AUTH_SIZE slack space available in both the
1353 if (resbuf->tail[0].iov_base == NULL) {
1354 if (resbuf->head[0].iov_len + 2*RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1356 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1357 + resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE;
1358 resbuf->tail[0].iov_len = 0;
1360 if (gss_wrap(gsd->rsci->mechctx, offset, resbuf, inpages))
1362 *len = htonl(resbuf->len - offset);
1363 pad = 3 - ((resbuf->len - offset - 1)&3);
1364 p = (__be32 *)(resbuf->tail[0].iov_base + resbuf->tail[0].iov_len);
1366 resbuf->tail[0].iov_len += pad;
1372 svcauth_gss_release(struct svc_rqst *rqstp)
1374 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1375 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1376 struct xdr_buf *resbuf = &rqstp->rq_res;
1378 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1380 if (gc->gc_proc != RPC_GSS_PROC_DATA)
1382 /* Release can be called twice, but we only wrap once. */
1383 if (gsd->verf_start == NULL)
1385 /* normally not set till svc_send, but we need it here: */
1386 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1388 resbuf->len = total_buf_len(resbuf);
1389 switch (gc->gc_svc) {
1390 case RPC_GSS_SVC_NONE:
1392 case RPC_GSS_SVC_INTEGRITY:
1393 stat = svcauth_gss_wrap_resp_integ(rqstp);
1397 case RPC_GSS_SVC_PRIVACY:
1398 stat = svcauth_gss_wrap_resp_priv(rqstp);
1403 * For any other gc_svc value, svcauth_gss_accept() already set
1404 * the auth_error appropriately; just fall through:
1411 if (rqstp->rq_client)
1412 auth_domain_put(rqstp->rq_client);
1413 rqstp->rq_client = NULL;
1414 if (rqstp->rq_gssclient)
1415 auth_domain_put(rqstp->rq_gssclient);
1416 rqstp->rq_gssclient = NULL;
1417 if (rqstp->rq_cred.cr_group_info)
1418 put_group_info(rqstp->rq_cred.cr_group_info);
1419 rqstp->rq_cred.cr_group_info = NULL;
1421 cache_put(&gsd->rsci->h, sn->rsc_cache);
1428 svcauth_gss_domain_release(struct auth_domain *dom)
1430 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
1436 static struct auth_ops svcauthops_gss = {
1437 .name = "rpcsec_gss",
1438 .owner = THIS_MODULE,
1439 .flavour = RPC_AUTH_GSS,
1440 .accept = svcauth_gss_accept,
1441 .release = svcauth_gss_release,
1442 .domain_release = svcauth_gss_domain_release,
1443 .set_client = svcauth_gss_set_client,
1446 static int rsi_cache_create_net(struct net *net)
1448 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1449 struct cache_detail *cd;
1452 cd = cache_create_net(&rsi_cache_template, net);
1455 err = cache_register_net(cd, net);
1457 cache_destroy_net(cd, net);
1464 static void rsi_cache_destroy_net(struct net *net)
1466 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1467 struct cache_detail *cd = sn->rsi_cache;
1469 sn->rsi_cache = NULL;
1471 cache_unregister_net(cd, net);
1472 cache_destroy_net(cd, net);
1475 static int rsc_cache_create_net(struct net *net)
1477 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1478 struct cache_detail *cd;
1481 cd = cache_create_net(&rsc_cache_template, net);
1484 err = cache_register_net(cd, net);
1486 cache_destroy_net(cd, net);
1493 static void rsc_cache_destroy_net(struct net *net)
1495 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1496 struct cache_detail *cd = sn->rsc_cache;
1498 sn->rsc_cache = NULL;
1500 cache_unregister_net(cd, net);
1501 cache_destroy_net(cd, net);
1505 gss_svc_init_net(struct net *net)
1509 rv = rsc_cache_create_net(net);
1512 rv = rsi_cache_create_net(net);
1517 rsc_cache_destroy_net(net);
1522 gss_svc_shutdown_net(struct net *net)
1524 rsi_cache_destroy_net(net);
1525 rsc_cache_destroy_net(net);
1531 return svc_auth_register(RPC_AUTH_GSS, &svcauthops_gss);
1535 gss_svc_shutdown(void)
1537 svc_auth_unregister(RPC_AUTH_GSS);