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>
44 #include <linux/user_namespace.h>
46 #include <linux/sunrpc/auth_gss.h>
47 #include <linux/sunrpc/gss_err.h>
48 #include <linux/sunrpc/svcauth.h>
49 #include <linux/sunrpc/svcauth_gss.h>
50 #include <linux/sunrpc/cache.h>
55 # define RPCDBG_FACILITY RPCDBG_AUTH
58 /* The rpcsec_init cache is used for mapping RPCSEC_GSS_{,CONT_}INIT requests
61 * Key is context handle (\x if empty) and gss_token.
62 * Content is major_status minor_status (integers) context_handle, reply_token.
66 static int netobj_equal(struct xdr_netobj *a, struct xdr_netobj *b)
68 return a->len == b->len && 0 == memcmp(a->data, b->data, a->len);
71 #define RSI_HASHBITS 6
72 #define RSI_HASHMAX (1<<RSI_HASHBITS)
76 struct xdr_netobj in_handle, in_token;
77 struct xdr_netobj out_handle, out_token;
78 int major_status, minor_status;
81 static struct rsi *rsi_update(struct cache_detail *cd, struct rsi *new, struct rsi *old);
82 static struct rsi *rsi_lookup(struct cache_detail *cd, 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 ? kmemdup(src, len, GFP_KERNEL) : NULL);
117 if (len && !dst->data)
122 static inline int dup_netobj(struct xdr_netobj *dst, struct xdr_netobj *src)
124 return dup_to_netobj(dst, src->data, src->len);
127 static void rsi_init(struct cache_head *cnew, struct cache_head *citem)
129 struct rsi *new = container_of(cnew, struct rsi, h);
130 struct rsi *item = container_of(citem, struct rsi, h);
132 new->out_handle.data = NULL;
133 new->out_handle.len = 0;
134 new->out_token.data = NULL;
135 new->out_token.len = 0;
136 new->in_handle.len = item->in_handle.len;
137 item->in_handle.len = 0;
138 new->in_token.len = item->in_token.len;
139 item->in_token.len = 0;
140 new->in_handle.data = item->in_handle.data;
141 item->in_handle.data = NULL;
142 new->in_token.data = item->in_token.data;
143 item->in_token.data = NULL;
146 static void update_rsi(struct cache_head *cnew, struct cache_head *citem)
148 struct rsi *new = container_of(cnew, struct rsi, h);
149 struct rsi *item = container_of(citem, struct rsi, h);
151 BUG_ON(new->out_handle.data || new->out_token.data);
152 new->out_handle.len = item->out_handle.len;
153 item->out_handle.len = 0;
154 new->out_token.len = item->out_token.len;
155 item->out_token.len = 0;
156 new->out_handle.data = item->out_handle.data;
157 item->out_handle.data = NULL;
158 new->out_token.data = item->out_token.data;
159 item->out_token.data = NULL;
161 new->major_status = item->major_status;
162 new->minor_status = item->minor_status;
165 static struct cache_head *rsi_alloc(void)
167 struct rsi *rsii = kmalloc(sizeof(*rsii), GFP_KERNEL);
174 static void rsi_request(struct cache_detail *cd,
175 struct cache_head *h,
176 char **bpp, int *blen)
178 struct rsi *rsii = container_of(h, struct rsi, h);
180 qword_addhex(bpp, blen, rsii->in_handle.data, rsii->in_handle.len);
181 qword_addhex(bpp, blen, rsii->in_token.data, rsii->in_token.len);
185 static int rsi_parse(struct cache_detail *cd,
186 char *mesg, int mlen)
188 /* context token expiry major minor context token */
192 struct rsi rsii, *rsip = NULL;
194 int status = -EINVAL;
196 memset(&rsii, 0, sizeof(rsii));
198 len = qword_get(&mesg, buf, mlen);
202 if (dup_to_netobj(&rsii.in_handle, buf, len))
206 len = qword_get(&mesg, buf, mlen);
211 if (dup_to_netobj(&rsii.in_token, buf, len))
214 rsip = rsi_lookup(cd, &rsii);
220 expiry = get_expiry(&mesg);
226 len = qword_get(&mesg, buf, mlen);
229 rsii.major_status = simple_strtoul(buf, &ep, 10);
232 len = qword_get(&mesg, buf, mlen);
235 rsii.minor_status = simple_strtoul(buf, &ep, 10);
240 len = qword_get(&mesg, buf, mlen);
244 if (dup_to_netobj(&rsii.out_handle, buf, len))
248 len = qword_get(&mesg, buf, mlen);
253 if (dup_to_netobj(&rsii.out_token, buf, len))
255 rsii.h.expiry_time = expiry;
256 rsip = rsi_update(cd, &rsii, rsip);
261 cache_put(&rsip->h, cd);
267 static struct cache_detail rsi_cache_template = {
268 .owner = THIS_MODULE,
269 .hash_size = RSI_HASHMAX,
270 .name = "auth.rpcsec.init",
271 .cache_put = rsi_put,
272 .cache_request = rsi_request,
273 .cache_parse = rsi_parse,
276 .update = update_rsi,
280 static struct rsi *rsi_lookup(struct cache_detail *cd, struct rsi *item)
282 struct cache_head *ch;
283 int hash = rsi_hash(item);
285 ch = sunrpc_cache_lookup(cd, &item->h, hash);
287 return container_of(ch, struct rsi, h);
292 static struct rsi *rsi_update(struct cache_detail *cd, struct rsi *new, struct rsi *old)
294 struct cache_head *ch;
295 int hash = rsi_hash(new);
297 ch = sunrpc_cache_update(cd, &new->h,
300 return container_of(ch, struct rsi, h);
307 * The rpcsec_context cache is used to store a context that is
308 * used in data exchange.
309 * The key is a context handle. The content is:
310 * uid, gidlist, mechanism, service-set, mech-specific-data
313 #define RSC_HASHBITS 10
314 #define RSC_HASHMAX (1<<RSC_HASHBITS)
316 #define GSS_SEQ_WIN 128
318 struct gss_svc_seq_data {
319 /* highest seq number seen so far: */
321 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
322 * sd_win is nonzero iff sequence number i has been seen already: */
323 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
329 struct xdr_netobj handle;
330 struct svc_cred cred;
331 struct gss_svc_seq_data seqdata;
332 struct gss_ctx *mechctx;
335 static struct rsc *rsc_update(struct cache_detail *cd, struct rsc *new, struct rsc *old);
336 static struct rsc *rsc_lookup(struct cache_detail *cd, struct rsc *item);
338 static void rsc_free(struct rsc *rsci)
340 kfree(rsci->handle.data);
342 gss_delete_sec_context(&rsci->mechctx);
343 free_svc_cred(&rsci->cred);
346 static void rsc_put(struct kref *ref)
348 struct rsc *rsci = container_of(ref, struct rsc, h.ref);
355 rsc_hash(struct rsc *rsci)
357 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
361 rsc_match(struct cache_head *a, struct cache_head *b)
363 struct rsc *new = container_of(a, struct rsc, h);
364 struct rsc *tmp = container_of(b, struct rsc, h);
366 return netobj_equal(&new->handle, &tmp->handle);
370 rsc_init(struct cache_head *cnew, struct cache_head *ctmp)
372 struct rsc *new = container_of(cnew, struct rsc, h);
373 struct rsc *tmp = container_of(ctmp, struct rsc, h);
375 new->handle.len = tmp->handle.len;
377 new->handle.data = tmp->handle.data;
378 tmp->handle.data = NULL;
380 new->cred.cr_group_info = NULL;
381 new->cred.cr_principal = NULL;
385 update_rsc(struct cache_head *cnew, struct cache_head *ctmp)
387 struct rsc *new = container_of(cnew, struct rsc, h);
388 struct rsc *tmp = container_of(ctmp, struct rsc, h);
390 new->mechctx = tmp->mechctx;
392 memset(&new->seqdata, 0, sizeof(new->seqdata));
393 spin_lock_init(&new->seqdata.sd_lock);
394 new->cred = tmp->cred;
395 tmp->cred.cr_group_info = NULL;
396 new->cred.cr_principal = tmp->cred.cr_principal;
397 tmp->cred.cr_principal = NULL;
400 static struct cache_head *
403 struct rsc *rsci = kmalloc(sizeof(*rsci), GFP_KERNEL);
410 static int rsc_parse(struct cache_detail *cd,
411 char *mesg, int mlen)
413 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
417 struct rsc rsci, *rscp = NULL;
419 int status = -EINVAL;
420 struct gss_api_mech *gm = NULL;
422 memset(&rsci, 0, sizeof(rsci));
424 len = qword_get(&mesg, buf, mlen);
425 if (len < 0) goto out;
427 if (dup_to_netobj(&rsci.handle, buf, len))
432 expiry = get_expiry(&mesg);
437 rscp = rsc_lookup(cd, &rsci);
441 /* uid, or NEGATIVE */
442 rv = get_int(&mesg, &id);
446 set_bit(CACHE_NEGATIVE, &rsci.h.flags);
451 * NOTE: we skip uid_valid()/gid_valid() checks here:
452 * instead, * -1 id's are later mapped to the
453 * (export-specific) anonymous id by nfsd_setuser.
455 * (But supplementary gid's get no such special
456 * treatment so are checked for validity here.)
459 rsci.cred.cr_uid = make_kuid(&init_user_ns, id);
462 if (get_int(&mesg, &id))
464 rsci.cred.cr_gid = make_kgid(&init_user_ns, id);
466 /* number of additional gid's */
467 if (get_int(&mesg, &N))
470 rsci.cred.cr_group_info = groups_alloc(N);
471 if (rsci.cred.cr_group_info == NULL)
476 for (i=0; i<N; i++) {
478 if (get_int(&mesg, &id))
480 kgid = make_kgid(&init_user_ns, id);
481 if (!gid_valid(kgid))
483 GROUP_AT(rsci.cred.cr_group_info, i) = kgid;
487 len = qword_get(&mesg, buf, mlen);
490 gm = gss_mech_get_by_name(buf);
491 status = -EOPNOTSUPP;
496 /* mech-specific data: */
497 len = qword_get(&mesg, buf, mlen);
500 status = gss_import_sec_context(buf, len, gm, &rsci.mechctx, GFP_KERNEL);
504 /* get client name */
505 len = qword_get(&mesg, buf, mlen);
507 rsci.cred.cr_principal = kstrdup(buf, GFP_KERNEL);
508 if (!rsci.cred.cr_principal)
513 rsci.h.expiry_time = expiry;
514 rscp = rsc_update(cd, &rsci, rscp);
520 cache_put(&rscp->h, cd);
526 static struct cache_detail rsc_cache_template = {
527 .owner = THIS_MODULE,
528 .hash_size = RSC_HASHMAX,
529 .name = "auth.rpcsec.context",
530 .cache_put = rsc_put,
531 .cache_parse = rsc_parse,
534 .update = update_rsc,
538 static struct rsc *rsc_lookup(struct cache_detail *cd, struct rsc *item)
540 struct cache_head *ch;
541 int hash = rsc_hash(item);
543 ch = sunrpc_cache_lookup(cd, &item->h, hash);
545 return container_of(ch, struct rsc, h);
550 static struct rsc *rsc_update(struct cache_detail *cd, struct rsc *new, struct rsc *old)
552 struct cache_head *ch;
553 int hash = rsc_hash(new);
555 ch = sunrpc_cache_update(cd, &new->h,
558 return container_of(ch, struct rsc, h);
565 gss_svc_searchbyctx(struct cache_detail *cd, struct xdr_netobj *handle)
570 memset(&rsci, 0, sizeof(rsci));
571 if (dup_to_netobj(&rsci.handle, handle->data, handle->len))
573 found = rsc_lookup(cd, &rsci);
577 if (cache_check(cd, &found->h, NULL))
582 /* Implements sequence number algorithm as specified in RFC 2203. */
584 gss_check_seq_num(struct rsc *rsci, int seq_num)
586 struct gss_svc_seq_data *sd = &rsci->seqdata;
588 spin_lock(&sd->sd_lock);
589 if (seq_num > sd->sd_max) {
590 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
591 memset(sd->sd_win,0,sizeof(sd->sd_win));
592 sd->sd_max = seq_num;
593 } else while (sd->sd_max < seq_num) {
595 __clear_bit(sd->sd_max % GSS_SEQ_WIN, sd->sd_win);
597 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
599 } else if (seq_num <= sd->sd_max - GSS_SEQ_WIN) {
602 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
603 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win))
606 spin_unlock(&sd->sd_lock);
609 spin_unlock(&sd->sd_lock);
613 static inline u32 round_up_to_quad(u32 i)
615 return (i + 3 ) & ~3;
619 svc_safe_getnetobj(struct kvec *argv, struct xdr_netobj *o)
623 if (argv->iov_len < 4)
625 o->len = svc_getnl(argv);
626 l = round_up_to_quad(o->len);
627 if (argv->iov_len < l)
629 o->data = argv->iov_base;
636 svc_safe_putnetobj(struct kvec *resv, struct xdr_netobj *o)
640 if (resv->iov_len + 4 > PAGE_SIZE)
642 svc_putnl(resv, o->len);
643 p = resv->iov_base + resv->iov_len;
644 resv->iov_len += round_up_to_quad(o->len);
645 if (resv->iov_len > PAGE_SIZE)
647 memcpy(p, o->data, o->len);
648 memset(p + o->len, 0, round_up_to_quad(o->len) - o->len);
653 * Verify the checksum on the header and return SVC_OK on success.
654 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
655 * or return SVC_DENIED and indicate error in authp.
658 gss_verify_header(struct svc_rqst *rqstp, struct rsc *rsci,
659 __be32 *rpcstart, struct rpc_gss_wire_cred *gc, __be32 *authp)
661 struct gss_ctx *ctx_id = rsci->mechctx;
662 struct xdr_buf rpchdr;
663 struct xdr_netobj checksum;
665 struct kvec *argv = &rqstp->rq_arg.head[0];
668 /* data to compute the checksum over: */
669 iov.iov_base = rpcstart;
670 iov.iov_len = (u8 *)argv->iov_base - (u8 *)rpcstart;
671 xdr_buf_from_iov(&iov, &rpchdr);
673 *authp = rpc_autherr_badverf;
674 if (argv->iov_len < 4)
676 flavor = svc_getnl(argv);
677 if (flavor != RPC_AUTH_GSS)
679 if (svc_safe_getnetobj(argv, &checksum))
682 if (rqstp->rq_deferred) /* skip verification of revisited request */
684 if (gss_verify_mic(ctx_id, &rpchdr, &checksum) != GSS_S_COMPLETE) {
685 *authp = rpcsec_gsserr_credproblem;
689 if (gc->gc_seq > MAXSEQ) {
690 dprintk("RPC: svcauth_gss: discarding request with "
691 "large sequence number %d\n", gc->gc_seq);
692 *authp = rpcsec_gsserr_ctxproblem;
695 if (!gss_check_seq_num(rsci, gc->gc_seq)) {
696 dprintk("RPC: svcauth_gss: discarding request with "
697 "old sequence number %d\n", gc->gc_seq);
704 gss_write_null_verf(struct svc_rqst *rqstp)
708 svc_putnl(rqstp->rq_res.head, RPC_AUTH_NULL);
709 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
710 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
712 if (!xdr_ressize_check(rqstp, p))
718 gss_write_verf(struct svc_rqst *rqstp, struct gss_ctx *ctx_id, u32 seq)
722 struct xdr_buf verf_data;
723 struct xdr_netobj mic;
727 svc_putnl(rqstp->rq_res.head, RPC_AUTH_GSS);
728 xdr_seq = htonl(seq);
730 iov.iov_base = &xdr_seq;
731 iov.iov_len = sizeof(xdr_seq);
732 xdr_buf_from_iov(&iov, &verf_data);
733 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
734 mic.data = (u8 *)(p + 1);
735 maj_stat = gss_get_mic(ctx_id, &verf_data, &mic);
736 if (maj_stat != GSS_S_COMPLETE)
738 *p++ = htonl(mic.len);
739 memset((u8 *)p + mic.len, 0, round_up_to_quad(mic.len) - mic.len);
740 p += XDR_QUADLEN(mic.len);
741 if (!xdr_ressize_check(rqstp, p))
747 struct auth_domain h;
751 static struct auth_domain *
752 find_gss_auth_domain(struct gss_ctx *ctx, u32 svc)
756 name = gss_service_to_auth_domain_name(ctx->mech_type, svc);
759 return auth_domain_find(name);
762 static struct auth_ops svcauthops_gss;
764 u32 svcauth_gss_flavor(struct auth_domain *dom)
766 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
768 return gd->pseudoflavor;
771 EXPORT_SYMBOL_GPL(svcauth_gss_flavor);
774 svcauth_gss_register_pseudoflavor(u32 pseudoflavor, char * name)
776 struct gss_domain *new;
777 struct auth_domain *test;
780 new = kmalloc(sizeof(*new), GFP_KERNEL);
783 kref_init(&new->h.ref);
784 new->h.name = kstrdup(name, GFP_KERNEL);
787 new->h.flavour = &svcauthops_gss;
788 new->pseudoflavor = pseudoflavor;
791 test = auth_domain_lookup(name, &new->h);
792 if (test != &new->h) { /* Duplicate registration */
793 auth_domain_put(test);
805 EXPORT_SYMBOL_GPL(svcauth_gss_register_pseudoflavor);
808 read_u32_from_xdr_buf(struct xdr_buf *buf, int base, u32 *obj)
813 status = read_bytes_from_xdr_buf(buf, base, &raw, sizeof(*obj));
820 /* It would be nice if this bit of code could be shared with the client.
822 * The client shouldn't malloc(), would have to pass in own memory.
823 * The server uses base of head iovec as read pointer, while the
824 * client uses separate pointer. */
826 unwrap_integ_data(struct svc_rqst *rqstp, struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
829 u32 integ_len, maj_stat;
830 struct xdr_netobj mic;
831 struct xdr_buf integ_buf;
833 /* Did we already verify the signature on the original pass through? */
834 if (rqstp->rq_deferred)
837 integ_len = svc_getnl(&buf->head[0]);
840 if (integ_len > buf->len)
842 if (xdr_buf_subsegment(buf, &integ_buf, 0, integ_len))
844 /* copy out mic... */
845 if (read_u32_from_xdr_buf(buf, integ_len, &mic.len))
847 if (mic.len > RPC_MAX_AUTH_SIZE)
849 mic.data = kmalloc(mic.len, GFP_KERNEL);
852 if (read_bytes_from_xdr_buf(buf, integ_len + 4, mic.data, mic.len))
854 maj_stat = gss_verify_mic(ctx, &integ_buf, &mic);
855 if (maj_stat != GSS_S_COMPLETE)
857 if (svc_getnl(&buf->head[0]) != seq)
859 /* trim off the mic at the end before returning */
860 xdr_buf_trim(buf, mic.len + 4);
868 total_buf_len(struct xdr_buf *buf)
870 return buf->head[0].iov_len + buf->page_len + buf->tail[0].iov_len;
874 fix_priv_head(struct xdr_buf *buf, int pad)
876 if (buf->page_len == 0) {
877 /* We need to adjust head and buf->len in tandem in this
878 * case to make svc_defer() work--it finds the original
879 * buffer start using buf->len - buf->head[0].iov_len. */
880 buf->head[0].iov_len -= pad;
885 unwrap_priv_data(struct svc_rqst *rqstp, struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
887 u32 priv_len, maj_stat;
888 int pad, saved_len, remaining_len, offset;
890 rqstp->rq_splice_ok = 0;
892 priv_len = svc_getnl(&buf->head[0]);
893 if (rqstp->rq_deferred) {
894 /* Already decrypted last time through! The sequence number
895 * check at out_seq is unnecessary but harmless: */
898 /* buf->len is the number of bytes from the original start of the
899 * request to the end, where head[0].iov_len is just the bytes
900 * not yet read from the head, so these two values are different: */
901 remaining_len = total_buf_len(buf);
902 if (priv_len > remaining_len)
904 pad = remaining_len - priv_len;
906 fix_priv_head(buf, pad);
908 /* Maybe it would be better to give gss_unwrap a length parameter: */
909 saved_len = buf->len;
911 maj_stat = gss_unwrap(ctx, 0, buf);
912 pad = priv_len - buf->len;
913 buf->len = saved_len;
915 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
916 * In the krb5p case, at least, the data ends up offset, so we need to
918 /* XXX: This is very inefficient. It would be better to either do
919 * this while we encrypt, or maybe in the receive code, if we can peak
920 * ahead and work out the service and mechanism there. */
921 offset = buf->head[0].iov_len % 4;
923 buf->buflen = RPCSVC_MAXPAYLOAD;
924 xdr_shift_buf(buf, offset);
925 fix_priv_head(buf, pad);
927 if (maj_stat != GSS_S_COMPLETE)
930 if (svc_getnl(&buf->head[0]) != seq)
935 struct gss_svc_data {
936 /* decoded gss client cred: */
937 struct rpc_gss_wire_cred clcred;
938 /* save a pointer to the beginning of the encoded verifier,
939 * for use in encryption/checksumming in svcauth_gss_release: */
945 svcauth_gss_set_client(struct svc_rqst *rqstp)
947 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
948 struct rsc *rsci = svcdata->rsci;
949 struct rpc_gss_wire_cred *gc = &svcdata->clcred;
953 * A gss export can be specified either by:
954 * export *(sec=krb5,rw)
956 * export gss/krb5(rw)
957 * The latter is deprecated; but for backwards compatibility reasons
958 * the nfsd code will still fall back on trying it if the former
959 * doesn't work; so we try to make both available to nfsd, below.
961 rqstp->rq_gssclient = find_gss_auth_domain(rsci->mechctx, gc->gc_svc);
962 if (rqstp->rq_gssclient == NULL)
964 stat = svcauth_unix_set_client(rqstp);
965 if (stat == SVC_DROP || stat == SVC_CLOSE)
971 gss_write_init_verf(struct cache_detail *cd, struct svc_rqst *rqstp,
972 struct xdr_netobj *out_handle, int *major_status)
977 if (*major_status != GSS_S_COMPLETE)
978 return gss_write_null_verf(rqstp);
979 rsci = gss_svc_searchbyctx(cd, out_handle);
981 *major_status = GSS_S_NO_CONTEXT;
982 return gss_write_null_verf(rqstp);
984 rc = gss_write_verf(rqstp, rsci->mechctx, GSS_SEQ_WIN);
985 cache_put(&rsci->h, cd);
990 gss_read_verf(struct rpc_gss_wire_cred *gc,
991 struct kvec *argv, __be32 *authp,
992 struct xdr_netobj *in_handle,
993 struct xdr_netobj *in_token)
995 struct xdr_netobj tmpobj;
997 /* Read the verifier; should be NULL: */
998 *authp = rpc_autherr_badverf;
999 if (argv->iov_len < 2 * 4)
1001 if (svc_getnl(argv) != RPC_AUTH_NULL)
1003 if (svc_getnl(argv) != 0)
1005 /* Martial context handle and token for upcall: */
1006 *authp = rpc_autherr_badcred;
1007 if (gc->gc_proc == RPC_GSS_PROC_INIT && gc->gc_ctx.len != 0)
1009 if (dup_netobj(in_handle, &gc->gc_ctx))
1011 *authp = rpc_autherr_badverf;
1012 if (svc_safe_getnetobj(argv, &tmpobj)) {
1013 kfree(in_handle->data);
1016 if (dup_netobj(in_token, &tmpobj)) {
1017 kfree(in_handle->data);
1025 gss_write_resv(struct kvec *resv, size_t size_limit,
1026 struct xdr_netobj *out_handle, struct xdr_netobj *out_token,
1027 int major_status, int minor_status)
1029 if (resv->iov_len + 4 > size_limit)
1031 svc_putnl(resv, RPC_SUCCESS);
1032 if (svc_safe_putnetobj(resv, out_handle))
1034 if (resv->iov_len + 3 * 4 > size_limit)
1036 svc_putnl(resv, major_status);
1037 svc_putnl(resv, minor_status);
1038 svc_putnl(resv, GSS_SEQ_WIN);
1039 if (svc_safe_putnetobj(resv, out_token))
1045 * Having read the cred already and found we're in the context
1046 * initiation case, read the verifier and initiate (or check the results
1047 * of) upcalls to userspace for help with context initiation. If
1048 * the upcall results are available, write the verifier and result.
1049 * Otherwise, drop the request pending an answer to the upcall.
1051 static int svcauth_gss_handle_init(struct svc_rqst *rqstp,
1052 struct rpc_gss_wire_cred *gc, __be32 *authp)
1054 struct kvec *argv = &rqstp->rq_arg.head[0];
1055 struct kvec *resv = &rqstp->rq_res.head[0];
1056 struct rsi *rsip, rsikey;
1058 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1060 memset(&rsikey, 0, sizeof(rsikey));
1061 ret = gss_read_verf(gc, argv, authp,
1062 &rsikey.in_handle, &rsikey.in_token);
1066 /* Perform upcall, or find upcall result: */
1067 rsip = rsi_lookup(sn->rsi_cache, &rsikey);
1071 if (cache_check(sn->rsi_cache, &rsip->h, &rqstp->rq_chandle) < 0)
1072 /* No upcall result: */
1076 /* Got an answer to the upcall; use it: */
1077 if (gss_write_init_verf(sn->rsc_cache, rqstp,
1078 &rsip->out_handle, &rsip->major_status))
1080 if (gss_write_resv(resv, PAGE_SIZE,
1081 &rsip->out_handle, &rsip->out_token,
1082 rsip->major_status, rsip->minor_status))
1087 cache_put(&rsip->h, sn->rsi_cache);
1092 * Accept an rpcsec packet.
1093 * If context establishment, punt to user space
1094 * If data exchange, verify/decrypt
1095 * If context destruction, handle here
1096 * In the context establishment and destruction case we encode
1097 * response here and return SVC_COMPLETE.
1100 svcauth_gss_accept(struct svc_rqst *rqstp, __be32 *authp)
1102 struct kvec *argv = &rqstp->rq_arg.head[0];
1103 struct kvec *resv = &rqstp->rq_res.head[0];
1105 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
1106 struct rpc_gss_wire_cred *gc;
1107 struct rsc *rsci = NULL;
1109 __be32 *reject_stat = resv->iov_base + resv->iov_len;
1111 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1113 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
1116 *authp = rpc_autherr_badcred;
1118 svcdata = kmalloc(sizeof(*svcdata), GFP_KERNEL);
1121 rqstp->rq_auth_data = svcdata;
1122 svcdata->verf_start = NULL;
1123 svcdata->rsci = NULL;
1124 gc = &svcdata->clcred;
1126 /* start of rpc packet is 7 u32's back from here:
1127 * xid direction rpcversion prog vers proc flavour
1129 rpcstart = argv->iov_base;
1133 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1134 * at least 5 u32s, and is preceded by length, so that makes 6.
1137 if (argv->iov_len < 5 * 4)
1139 crlen = svc_getnl(argv);
1140 if (svc_getnl(argv) != RPC_GSS_VERSION)
1142 gc->gc_proc = svc_getnl(argv);
1143 gc->gc_seq = svc_getnl(argv);
1144 gc->gc_svc = svc_getnl(argv);
1145 if (svc_safe_getnetobj(argv, &gc->gc_ctx))
1147 if (crlen != round_up_to_quad(gc->gc_ctx.len) + 5 * 4)
1150 if ((gc->gc_proc != RPC_GSS_PROC_DATA) && (rqstp->rq_proc != 0))
1153 *authp = rpc_autherr_badverf;
1154 switch (gc->gc_proc) {
1155 case RPC_GSS_PROC_INIT:
1156 case RPC_GSS_PROC_CONTINUE_INIT:
1157 return svcauth_gss_handle_init(rqstp, gc, authp);
1158 case RPC_GSS_PROC_DATA:
1159 case RPC_GSS_PROC_DESTROY:
1160 /* Look up the context, and check the verifier: */
1161 *authp = rpcsec_gsserr_credproblem;
1162 rsci = gss_svc_searchbyctx(sn->rsc_cache, &gc->gc_ctx);
1165 switch (gss_verify_header(rqstp, rsci, rpcstart, gc, authp)) {
1175 *authp = rpc_autherr_rejectedcred;
1179 /* now act upon the command: */
1180 switch (gc->gc_proc) {
1181 case RPC_GSS_PROC_DESTROY:
1182 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1184 rsci->h.expiry_time = get_seconds();
1185 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1186 if (resv->iov_len + 4 > PAGE_SIZE)
1188 svc_putnl(resv, RPC_SUCCESS);
1190 case RPC_GSS_PROC_DATA:
1191 *authp = rpcsec_gsserr_ctxproblem;
1192 svcdata->verf_start = resv->iov_base + resv->iov_len;
1193 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1195 rqstp->rq_cred = rsci->cred;
1196 get_group_info(rsci->cred.cr_group_info);
1197 *authp = rpc_autherr_badcred;
1198 switch (gc->gc_svc) {
1199 case RPC_GSS_SVC_NONE:
1201 case RPC_GSS_SVC_INTEGRITY:
1202 /* placeholders for length and seq. number: */
1205 if (unwrap_integ_data(rqstp, &rqstp->rq_arg,
1206 gc->gc_seq, rsci->mechctx))
1209 case RPC_GSS_SVC_PRIVACY:
1210 /* placeholders for length and seq. number: */
1213 if (unwrap_priv_data(rqstp, &rqstp->rq_arg,
1214 gc->gc_seq, rsci->mechctx))
1220 svcdata->rsci = rsci;
1221 cache_get(&rsci->h);
1222 rqstp->rq_cred.cr_flavor = gss_svc_to_pseudoflavor(
1223 rsci->mechctx->mech_type, gc->gc_svc);
1231 /* Restore write pointer to its original value: */
1232 xdr_ressize_check(rqstp, reject_stat);
1242 cache_put(&rsci->h, sn->rsc_cache);
1247 svcauth_gss_prepare_to_wrap(struct xdr_buf *resbuf, struct gss_svc_data *gsd)
1252 p = gsd->verf_start;
1253 gsd->verf_start = NULL;
1255 /* If the reply stat is nonzero, don't wrap: */
1256 if (*(p-1) != rpc_success)
1258 /* Skip the verifier: */
1260 verf_len = ntohl(*p++);
1261 p += XDR_QUADLEN(verf_len);
1262 /* move accept_stat to right place: */
1263 memcpy(p, p + 2, 4);
1264 /* Also don't wrap if the accept stat is nonzero: */
1265 if (*p != rpc_success) {
1266 resbuf->head[0].iov_len -= 2 * 4;
1274 svcauth_gss_wrap_resp_integ(struct svc_rqst *rqstp)
1276 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1277 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1278 struct xdr_buf *resbuf = &rqstp->rq_res;
1279 struct xdr_buf integ_buf;
1280 struct xdr_netobj mic;
1283 int integ_offset, integ_len;
1286 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1289 integ_offset = (u8 *)(p + 1) - (u8 *)resbuf->head[0].iov_base;
1290 integ_len = resbuf->len - integ_offset;
1291 BUG_ON(integ_len % 4);
1292 *p++ = htonl(integ_len);
1293 *p++ = htonl(gc->gc_seq);
1294 if (xdr_buf_subsegment(resbuf, &integ_buf, integ_offset,
1297 if (resbuf->tail[0].iov_base == NULL) {
1298 if (resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1300 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1301 + resbuf->head[0].iov_len;
1302 resbuf->tail[0].iov_len = 0;
1303 resv = &resbuf->tail[0];
1305 resv = &resbuf->tail[0];
1307 mic.data = (u8 *)resv->iov_base + resv->iov_len + 4;
1308 if (gss_get_mic(gsd->rsci->mechctx, &integ_buf, &mic))
1310 svc_putnl(resv, mic.len);
1311 memset(mic.data + mic.len, 0,
1312 round_up_to_quad(mic.len) - mic.len);
1313 resv->iov_len += XDR_QUADLEN(mic.len) << 2;
1314 /* not strictly required: */
1315 resbuf->len += XDR_QUADLEN(mic.len) << 2;
1316 BUG_ON(resv->iov_len > PAGE_SIZE);
1324 svcauth_gss_wrap_resp_priv(struct svc_rqst *rqstp)
1326 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1327 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1328 struct xdr_buf *resbuf = &rqstp->rq_res;
1329 struct page **inpages = NULL;
1334 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1338 offset = (u8 *)p - (u8 *)resbuf->head[0].iov_base;
1339 *p++ = htonl(gc->gc_seq);
1340 inpages = resbuf->pages;
1341 /* XXX: Would be better to write some xdr helper functions for
1342 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1345 * If there is currently tail data, make sure there is
1346 * room for the head, tail, and 2 * RPC_MAX_AUTH_SIZE in
1347 * the page, and move the current tail data such that
1348 * there is RPC_MAX_AUTH_SIZE slack space available in
1349 * both the head and tail.
1351 if (resbuf->tail[0].iov_base) {
1352 BUG_ON(resbuf->tail[0].iov_base >= resbuf->head[0].iov_base
1354 BUG_ON(resbuf->tail[0].iov_base < resbuf->head[0].iov_base);
1355 if (resbuf->tail[0].iov_len + resbuf->head[0].iov_len
1356 + 2 * RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1358 memmove(resbuf->tail[0].iov_base + RPC_MAX_AUTH_SIZE,
1359 resbuf->tail[0].iov_base,
1360 resbuf->tail[0].iov_len);
1361 resbuf->tail[0].iov_base += RPC_MAX_AUTH_SIZE;
1364 * If there is no current tail data, make sure there is
1365 * room for the head data, and 2 * RPC_MAX_AUTH_SIZE in the
1366 * allotted page, and set up tail information such that there
1367 * is RPC_MAX_AUTH_SIZE slack space available in both the
1370 if (resbuf->tail[0].iov_base == NULL) {
1371 if (resbuf->head[0].iov_len + 2*RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1373 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1374 + resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE;
1375 resbuf->tail[0].iov_len = 0;
1377 if (gss_wrap(gsd->rsci->mechctx, offset, resbuf, inpages))
1379 *len = htonl(resbuf->len - offset);
1380 pad = 3 - ((resbuf->len - offset - 1)&3);
1381 p = (__be32 *)(resbuf->tail[0].iov_base + resbuf->tail[0].iov_len);
1383 resbuf->tail[0].iov_len += pad;
1389 svcauth_gss_release(struct svc_rqst *rqstp)
1391 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1392 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1393 struct xdr_buf *resbuf = &rqstp->rq_res;
1395 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1397 if (gc->gc_proc != RPC_GSS_PROC_DATA)
1399 /* Release can be called twice, but we only wrap once. */
1400 if (gsd->verf_start == NULL)
1402 /* normally not set till svc_send, but we need it here: */
1403 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1405 resbuf->len = total_buf_len(resbuf);
1406 switch (gc->gc_svc) {
1407 case RPC_GSS_SVC_NONE:
1409 case RPC_GSS_SVC_INTEGRITY:
1410 stat = svcauth_gss_wrap_resp_integ(rqstp);
1414 case RPC_GSS_SVC_PRIVACY:
1415 stat = svcauth_gss_wrap_resp_priv(rqstp);
1420 * For any other gc_svc value, svcauth_gss_accept() already set
1421 * the auth_error appropriately; just fall through:
1428 if (rqstp->rq_client)
1429 auth_domain_put(rqstp->rq_client);
1430 rqstp->rq_client = NULL;
1431 if (rqstp->rq_gssclient)
1432 auth_domain_put(rqstp->rq_gssclient);
1433 rqstp->rq_gssclient = NULL;
1434 if (rqstp->rq_cred.cr_group_info)
1435 put_group_info(rqstp->rq_cred.cr_group_info);
1436 rqstp->rq_cred.cr_group_info = NULL;
1438 cache_put(&gsd->rsci->h, sn->rsc_cache);
1445 svcauth_gss_domain_release(struct auth_domain *dom)
1447 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
1453 static struct auth_ops svcauthops_gss = {
1454 .name = "rpcsec_gss",
1455 .owner = THIS_MODULE,
1456 .flavour = RPC_AUTH_GSS,
1457 .accept = svcauth_gss_accept,
1458 .release = svcauth_gss_release,
1459 .domain_release = svcauth_gss_domain_release,
1460 .set_client = svcauth_gss_set_client,
1463 static int rsi_cache_create_net(struct net *net)
1465 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1466 struct cache_detail *cd;
1469 cd = cache_create_net(&rsi_cache_template, net);
1472 err = cache_register_net(cd, net);
1474 cache_destroy_net(cd, net);
1481 static void rsi_cache_destroy_net(struct net *net)
1483 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1484 struct cache_detail *cd = sn->rsi_cache;
1486 sn->rsi_cache = NULL;
1488 cache_unregister_net(cd, net);
1489 cache_destroy_net(cd, net);
1492 static int rsc_cache_create_net(struct net *net)
1494 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1495 struct cache_detail *cd;
1498 cd = cache_create_net(&rsc_cache_template, net);
1501 err = cache_register_net(cd, net);
1503 cache_destroy_net(cd, net);
1510 static void rsc_cache_destroy_net(struct net *net)
1512 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1513 struct cache_detail *cd = sn->rsc_cache;
1515 sn->rsc_cache = NULL;
1517 cache_unregister_net(cd, net);
1518 cache_destroy_net(cd, net);
1522 gss_svc_init_net(struct net *net)
1526 rv = rsc_cache_create_net(net);
1529 rv = rsi_cache_create_net(net);
1534 rsc_cache_destroy_net(net);
1539 gss_svc_shutdown_net(struct net *net)
1541 rsi_cache_destroy_net(net);
1542 rsc_cache_destroy_net(net);
1548 return svc_auth_register(RPC_AUTH_GSS, &svcauthops_gss);
1552 gss_svc_shutdown(void)
1554 svc_auth_unregister(RPC_AUTH_GSS);