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_upcall(struct cache_detail *cd, struct cache_head *h)
187 return sunrpc_cache_pipe_upcall(cd, h, rsi_request);
191 static int rsi_parse(struct cache_detail *cd,
192 char *mesg, int mlen)
194 /* context token expiry major minor context token */
198 struct rsi rsii, *rsip = NULL;
200 int status = -EINVAL;
202 memset(&rsii, 0, sizeof(rsii));
204 len = qword_get(&mesg, buf, mlen);
208 if (dup_to_netobj(&rsii.in_handle, buf, len))
212 len = qword_get(&mesg, buf, mlen);
217 if (dup_to_netobj(&rsii.in_token, buf, len))
220 rsip = rsi_lookup(cd, &rsii);
226 expiry = get_expiry(&mesg);
232 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))
261 rsii.h.expiry_time = expiry;
262 rsip = rsi_update(cd, &rsii, rsip);
267 cache_put(&rsip->h, cd);
273 static struct cache_detail rsi_cache_template = {
274 .owner = THIS_MODULE,
275 .hash_size = RSI_HASHMAX,
276 .name = "auth.rpcsec.init",
277 .cache_put = rsi_put,
278 .cache_upcall = rsi_upcall,
279 .cache_parse = rsi_parse,
282 .update = update_rsi,
286 static struct rsi *rsi_lookup(struct cache_detail *cd, struct rsi *item)
288 struct cache_head *ch;
289 int hash = rsi_hash(item);
291 ch = sunrpc_cache_lookup(cd, &item->h, hash);
293 return container_of(ch, struct rsi, h);
298 static struct rsi *rsi_update(struct cache_detail *cd, struct rsi *new, struct rsi *old)
300 struct cache_head *ch;
301 int hash = rsi_hash(new);
303 ch = sunrpc_cache_update(cd, &new->h,
306 return container_of(ch, struct rsi, h);
313 * The rpcsec_context cache is used to store a context that is
314 * used in data exchange.
315 * The key is a context handle. The content is:
316 * uid, gidlist, mechanism, service-set, mech-specific-data
319 #define RSC_HASHBITS 10
320 #define RSC_HASHMAX (1<<RSC_HASHBITS)
322 #define GSS_SEQ_WIN 128
324 struct gss_svc_seq_data {
325 /* highest seq number seen so far: */
327 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
328 * sd_win is nonzero iff sequence number i has been seen already: */
329 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
335 struct xdr_netobj handle;
336 struct svc_cred cred;
337 struct gss_svc_seq_data seqdata;
338 struct gss_ctx *mechctx;
341 static struct rsc *rsc_update(struct cache_detail *cd, struct rsc *new, struct rsc *old);
342 static struct rsc *rsc_lookup(struct cache_detail *cd, struct rsc *item);
344 static void rsc_free(struct rsc *rsci)
346 kfree(rsci->handle.data);
348 gss_delete_sec_context(&rsci->mechctx);
349 free_svc_cred(&rsci->cred);
352 static void rsc_put(struct kref *ref)
354 struct rsc *rsci = container_of(ref, struct rsc, h.ref);
361 rsc_hash(struct rsc *rsci)
363 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
367 rsc_match(struct cache_head *a, struct cache_head *b)
369 struct rsc *new = container_of(a, struct rsc, h);
370 struct rsc *tmp = container_of(b, struct rsc, h);
372 return netobj_equal(&new->handle, &tmp->handle);
376 rsc_init(struct cache_head *cnew, struct cache_head *ctmp)
378 struct rsc *new = container_of(cnew, struct rsc, h);
379 struct rsc *tmp = container_of(ctmp, struct rsc, h);
381 new->handle.len = tmp->handle.len;
383 new->handle.data = tmp->handle.data;
384 tmp->handle.data = NULL;
386 new->cred.cr_group_info = NULL;
387 new->cred.cr_principal = NULL;
391 update_rsc(struct cache_head *cnew, struct cache_head *ctmp)
393 struct rsc *new = container_of(cnew, struct rsc, h);
394 struct rsc *tmp = container_of(ctmp, struct rsc, h);
396 new->mechctx = tmp->mechctx;
398 memset(&new->seqdata, 0, sizeof(new->seqdata));
399 spin_lock_init(&new->seqdata.sd_lock);
400 new->cred = tmp->cred;
401 tmp->cred.cr_group_info = NULL;
402 new->cred.cr_principal = tmp->cred.cr_principal;
403 tmp->cred.cr_principal = NULL;
406 static struct cache_head *
409 struct rsc *rsci = kmalloc(sizeof(*rsci), GFP_KERNEL);
416 static int rsc_parse(struct cache_detail *cd,
417 char *mesg, int mlen)
419 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
423 struct rsc rsci, *rscp = NULL;
425 int status = -EINVAL;
426 struct gss_api_mech *gm = NULL;
428 memset(&rsci, 0, sizeof(rsci));
430 len = qword_get(&mesg, buf, mlen);
431 if (len < 0) goto out;
433 if (dup_to_netobj(&rsci.handle, buf, len))
438 expiry = get_expiry(&mesg);
443 rscp = rsc_lookup(cd, &rsci);
447 /* uid, or NEGATIVE */
448 rv = get_int(&mesg, &id);
452 set_bit(CACHE_NEGATIVE, &rsci.h.flags);
457 rsci.cred.cr_uid = make_kuid(&init_user_ns, id);
458 if (!uid_valid(rsci.cred.cr_uid))
462 if (get_int(&mesg, &id))
464 rsci.cred.cr_gid = make_kgid(&init_user_ns, id);
465 if (!gid_valid(rsci.cred.cr_gid))
468 /* number of additional gid's */
469 if (get_int(&mesg, &N))
472 rsci.cred.cr_group_info = groups_alloc(N);
473 if (rsci.cred.cr_group_info == NULL)
478 for (i=0; i<N; i++) {
480 if (get_int(&mesg, &id))
482 kgid = make_kgid(&init_user_ns, id);
483 if (!gid_valid(kgid))
485 GROUP_AT(rsci.cred.cr_group_info, i) = kgid;
489 len = qword_get(&mesg, buf, mlen);
492 gm = gss_mech_get_by_name(buf);
493 status = -EOPNOTSUPP;
498 /* mech-specific data: */
499 len = qword_get(&mesg, buf, mlen);
502 status = gss_import_sec_context(buf, len, gm, &rsci.mechctx, GFP_KERNEL);
506 /* get client name */
507 len = qword_get(&mesg, buf, mlen);
509 rsci.cred.cr_principal = kstrdup(buf, GFP_KERNEL);
510 if (!rsci.cred.cr_principal)
515 rsci.h.expiry_time = expiry;
516 rscp = rsc_update(cd, &rsci, rscp);
522 cache_put(&rscp->h, cd);
528 static struct cache_detail rsc_cache_template = {
529 .owner = THIS_MODULE,
530 .hash_size = RSC_HASHMAX,
531 .name = "auth.rpcsec.context",
532 .cache_put = rsc_put,
533 .cache_parse = rsc_parse,
536 .update = update_rsc,
540 static struct rsc *rsc_lookup(struct cache_detail *cd, struct rsc *item)
542 struct cache_head *ch;
543 int hash = rsc_hash(item);
545 ch = sunrpc_cache_lookup(cd, &item->h, hash);
547 return container_of(ch, struct rsc, h);
552 static struct rsc *rsc_update(struct cache_detail *cd, struct rsc *new, struct rsc *old)
554 struct cache_head *ch;
555 int hash = rsc_hash(new);
557 ch = sunrpc_cache_update(cd, &new->h,
560 return container_of(ch, struct rsc, h);
567 gss_svc_searchbyctx(struct cache_detail *cd, struct xdr_netobj *handle)
572 memset(&rsci, 0, sizeof(rsci));
573 if (dup_to_netobj(&rsci.handle, handle->data, handle->len))
575 found = rsc_lookup(cd, &rsci);
579 if (cache_check(cd, &found->h, NULL))
584 /* Implements sequence number algorithm as specified in RFC 2203. */
586 gss_check_seq_num(struct rsc *rsci, int seq_num)
588 struct gss_svc_seq_data *sd = &rsci->seqdata;
590 spin_lock(&sd->sd_lock);
591 if (seq_num > sd->sd_max) {
592 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
593 memset(sd->sd_win,0,sizeof(sd->sd_win));
594 sd->sd_max = seq_num;
595 } else while (sd->sd_max < seq_num) {
597 __clear_bit(sd->sd_max % GSS_SEQ_WIN, sd->sd_win);
599 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
601 } else if (seq_num <= sd->sd_max - GSS_SEQ_WIN) {
604 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
605 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win))
608 spin_unlock(&sd->sd_lock);
611 spin_unlock(&sd->sd_lock);
615 static inline u32 round_up_to_quad(u32 i)
617 return (i + 3 ) & ~3;
621 svc_safe_getnetobj(struct kvec *argv, struct xdr_netobj *o)
625 if (argv->iov_len < 4)
627 o->len = svc_getnl(argv);
628 l = round_up_to_quad(o->len);
629 if (argv->iov_len < l)
631 o->data = argv->iov_base;
638 svc_safe_putnetobj(struct kvec *resv, struct xdr_netobj *o)
642 if (resv->iov_len + 4 > PAGE_SIZE)
644 svc_putnl(resv, o->len);
645 p = resv->iov_base + resv->iov_len;
646 resv->iov_len += round_up_to_quad(o->len);
647 if (resv->iov_len > PAGE_SIZE)
649 memcpy(p, o->data, o->len);
650 memset(p + o->len, 0, round_up_to_quad(o->len) - o->len);
655 * Verify the checksum on the header and return SVC_OK on success.
656 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
657 * or return SVC_DENIED and indicate error in authp.
660 gss_verify_header(struct svc_rqst *rqstp, struct rsc *rsci,
661 __be32 *rpcstart, struct rpc_gss_wire_cred *gc, __be32 *authp)
663 struct gss_ctx *ctx_id = rsci->mechctx;
664 struct xdr_buf rpchdr;
665 struct xdr_netobj checksum;
667 struct kvec *argv = &rqstp->rq_arg.head[0];
670 /* data to compute the checksum over: */
671 iov.iov_base = rpcstart;
672 iov.iov_len = (u8 *)argv->iov_base - (u8 *)rpcstart;
673 xdr_buf_from_iov(&iov, &rpchdr);
675 *authp = rpc_autherr_badverf;
676 if (argv->iov_len < 4)
678 flavor = svc_getnl(argv);
679 if (flavor != RPC_AUTH_GSS)
681 if (svc_safe_getnetobj(argv, &checksum))
684 if (rqstp->rq_deferred) /* skip verification of revisited request */
686 if (gss_verify_mic(ctx_id, &rpchdr, &checksum) != GSS_S_COMPLETE) {
687 *authp = rpcsec_gsserr_credproblem;
691 if (gc->gc_seq > MAXSEQ) {
692 dprintk("RPC: svcauth_gss: discarding request with "
693 "large sequence number %d\n", gc->gc_seq);
694 *authp = rpcsec_gsserr_ctxproblem;
697 if (!gss_check_seq_num(rsci, gc->gc_seq)) {
698 dprintk("RPC: svcauth_gss: discarding request with "
699 "old sequence number %d\n", gc->gc_seq);
706 gss_write_null_verf(struct svc_rqst *rqstp)
710 svc_putnl(rqstp->rq_res.head, RPC_AUTH_NULL);
711 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
712 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
714 if (!xdr_ressize_check(rqstp, p))
720 gss_write_verf(struct svc_rqst *rqstp, struct gss_ctx *ctx_id, u32 seq)
724 struct xdr_buf verf_data;
725 struct xdr_netobj mic;
729 svc_putnl(rqstp->rq_res.head, RPC_AUTH_GSS);
730 xdr_seq = htonl(seq);
732 iov.iov_base = &xdr_seq;
733 iov.iov_len = sizeof(xdr_seq);
734 xdr_buf_from_iov(&iov, &verf_data);
735 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
736 mic.data = (u8 *)(p + 1);
737 maj_stat = gss_get_mic(ctx_id, &verf_data, &mic);
738 if (maj_stat != GSS_S_COMPLETE)
740 *p++ = htonl(mic.len);
741 memset((u8 *)p + mic.len, 0, round_up_to_quad(mic.len) - mic.len);
742 p += XDR_QUADLEN(mic.len);
743 if (!xdr_ressize_check(rqstp, p))
749 struct auth_domain h;
753 static struct auth_domain *
754 find_gss_auth_domain(struct gss_ctx *ctx, u32 svc)
758 name = gss_service_to_auth_domain_name(ctx->mech_type, svc);
761 return auth_domain_find(name);
764 static struct auth_ops svcauthops_gss;
766 u32 svcauth_gss_flavor(struct auth_domain *dom)
768 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
770 return gd->pseudoflavor;
773 EXPORT_SYMBOL_GPL(svcauth_gss_flavor);
776 svcauth_gss_register_pseudoflavor(u32 pseudoflavor, char * name)
778 struct gss_domain *new;
779 struct auth_domain *test;
782 new = kmalloc(sizeof(*new), GFP_KERNEL);
785 kref_init(&new->h.ref);
786 new->h.name = kstrdup(name, GFP_KERNEL);
789 new->h.flavour = &svcauthops_gss;
790 new->pseudoflavor = pseudoflavor;
793 test = auth_domain_lookup(name, &new->h);
794 if (test != &new->h) { /* Duplicate registration */
795 auth_domain_put(test);
807 EXPORT_SYMBOL_GPL(svcauth_gss_register_pseudoflavor);
810 read_u32_from_xdr_buf(struct xdr_buf *buf, int base, u32 *obj)
815 status = read_bytes_from_xdr_buf(buf, base, &raw, sizeof(*obj));
822 /* It would be nice if this bit of code could be shared with the client.
824 * The client shouldn't malloc(), would have to pass in own memory.
825 * The server uses base of head iovec as read pointer, while the
826 * client uses separate pointer. */
828 unwrap_integ_data(struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
831 u32 integ_len, maj_stat;
832 struct xdr_netobj mic;
833 struct xdr_buf integ_buf;
835 integ_len = svc_getnl(&buf->head[0]);
838 if (integ_len > buf->len)
840 if (xdr_buf_subsegment(buf, &integ_buf, 0, integ_len))
842 /* copy out mic... */
843 if (read_u32_from_xdr_buf(buf, integ_len, &mic.len))
845 if (mic.len > RPC_MAX_AUTH_SIZE)
847 mic.data = kmalloc(mic.len, GFP_KERNEL);
850 if (read_bytes_from_xdr_buf(buf, integ_len + 4, mic.data, mic.len))
852 maj_stat = gss_verify_mic(ctx, &integ_buf, &mic);
853 if (maj_stat != GSS_S_COMPLETE)
855 if (svc_getnl(&buf->head[0]) != seq)
864 total_buf_len(struct xdr_buf *buf)
866 return buf->head[0].iov_len + buf->page_len + buf->tail[0].iov_len;
870 fix_priv_head(struct xdr_buf *buf, int pad)
872 if (buf->page_len == 0) {
873 /* We need to adjust head and buf->len in tandem in this
874 * case to make svc_defer() work--it finds the original
875 * buffer start using buf->len - buf->head[0].iov_len. */
876 buf->head[0].iov_len -= pad;
881 unwrap_priv_data(struct svc_rqst *rqstp, struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
883 u32 priv_len, maj_stat;
884 int pad, saved_len, remaining_len, offset;
886 rqstp->rq_splice_ok = 0;
888 priv_len = svc_getnl(&buf->head[0]);
889 if (rqstp->rq_deferred) {
890 /* Already decrypted last time through! The sequence number
891 * check at out_seq is unnecessary but harmless: */
894 /* buf->len is the number of bytes from the original start of the
895 * request to the end, where head[0].iov_len is just the bytes
896 * not yet read from the head, so these two values are different: */
897 remaining_len = total_buf_len(buf);
898 if (priv_len > remaining_len)
900 pad = remaining_len - priv_len;
902 fix_priv_head(buf, pad);
904 /* Maybe it would be better to give gss_unwrap a length parameter: */
905 saved_len = buf->len;
907 maj_stat = gss_unwrap(ctx, 0, buf);
908 pad = priv_len - buf->len;
909 buf->len = saved_len;
911 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
912 * In the krb5p case, at least, the data ends up offset, so we need to
914 /* XXX: This is very inefficient. It would be better to either do
915 * this while we encrypt, or maybe in the receive code, if we can peak
916 * ahead and work out the service and mechanism there. */
917 offset = buf->head[0].iov_len % 4;
919 buf->buflen = RPCSVC_MAXPAYLOAD;
920 xdr_shift_buf(buf, offset);
921 fix_priv_head(buf, pad);
923 if (maj_stat != GSS_S_COMPLETE)
926 if (svc_getnl(&buf->head[0]) != seq)
931 struct gss_svc_data {
932 /* decoded gss client cred: */
933 struct rpc_gss_wire_cred clcred;
934 /* save a pointer to the beginning of the encoded verifier,
935 * for use in encryption/checksumming in svcauth_gss_release: */
941 svcauth_gss_set_client(struct svc_rqst *rqstp)
943 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
944 struct rsc *rsci = svcdata->rsci;
945 struct rpc_gss_wire_cred *gc = &svcdata->clcred;
949 * A gss export can be specified either by:
950 * export *(sec=krb5,rw)
952 * export gss/krb5(rw)
953 * The latter is deprecated; but for backwards compatibility reasons
954 * the nfsd code will still fall back on trying it if the former
955 * doesn't work; so we try to make both available to nfsd, below.
957 rqstp->rq_gssclient = find_gss_auth_domain(rsci->mechctx, gc->gc_svc);
958 if (rqstp->rq_gssclient == NULL)
960 stat = svcauth_unix_set_client(rqstp);
961 if (stat == SVC_DROP || stat == SVC_CLOSE)
967 gss_write_init_verf(struct cache_detail *cd, struct svc_rqst *rqstp,
968 struct xdr_netobj *out_handle, int *major_status)
973 if (*major_status != GSS_S_COMPLETE)
974 return gss_write_null_verf(rqstp);
975 rsci = gss_svc_searchbyctx(cd, out_handle);
977 *major_status = GSS_S_NO_CONTEXT;
978 return gss_write_null_verf(rqstp);
980 rc = gss_write_verf(rqstp, rsci->mechctx, GSS_SEQ_WIN);
981 cache_put(&rsci->h, cd);
986 gss_read_verf(struct rpc_gss_wire_cred *gc,
987 struct kvec *argv, __be32 *authp,
988 struct xdr_netobj *in_handle,
989 struct xdr_netobj *in_token)
991 struct xdr_netobj tmpobj;
993 /* Read the verifier; should be NULL: */
994 *authp = rpc_autherr_badverf;
995 if (argv->iov_len < 2 * 4)
997 if (svc_getnl(argv) != RPC_AUTH_NULL)
999 if (svc_getnl(argv) != 0)
1001 /* Martial context handle and token for upcall: */
1002 *authp = rpc_autherr_badcred;
1003 if (gc->gc_proc == RPC_GSS_PROC_INIT && gc->gc_ctx.len != 0)
1005 if (dup_netobj(in_handle, &gc->gc_ctx))
1007 *authp = rpc_autherr_badverf;
1008 if (svc_safe_getnetobj(argv, &tmpobj)) {
1009 kfree(in_handle->data);
1012 if (dup_netobj(in_token, &tmpobj)) {
1013 kfree(in_handle->data);
1021 gss_write_resv(struct kvec *resv, size_t size_limit,
1022 struct xdr_netobj *out_handle, struct xdr_netobj *out_token,
1023 int major_status, int minor_status)
1025 if (resv->iov_len + 4 > size_limit)
1027 svc_putnl(resv, RPC_SUCCESS);
1028 if (svc_safe_putnetobj(resv, out_handle))
1030 if (resv->iov_len + 3 * 4 > size_limit)
1032 svc_putnl(resv, major_status);
1033 svc_putnl(resv, minor_status);
1034 svc_putnl(resv, GSS_SEQ_WIN);
1035 if (svc_safe_putnetobj(resv, out_token))
1041 * Having read the cred already and found we're in the context
1042 * initiation case, read the verifier and initiate (or check the results
1043 * of) upcalls to userspace for help with context initiation. If
1044 * the upcall results are available, write the verifier and result.
1045 * Otherwise, drop the request pending an answer to the upcall.
1047 static int svcauth_gss_handle_init(struct svc_rqst *rqstp,
1048 struct rpc_gss_wire_cred *gc, __be32 *authp)
1050 struct kvec *argv = &rqstp->rq_arg.head[0];
1051 struct kvec *resv = &rqstp->rq_res.head[0];
1052 struct rsi *rsip, rsikey;
1054 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1056 memset(&rsikey, 0, sizeof(rsikey));
1057 ret = gss_read_verf(gc, argv, authp,
1058 &rsikey.in_handle, &rsikey.in_token);
1062 /* Perform upcall, or find upcall result: */
1063 rsip = rsi_lookup(sn->rsi_cache, &rsikey);
1067 if (cache_check(sn->rsi_cache, &rsip->h, &rqstp->rq_chandle) < 0)
1068 /* No upcall result: */
1072 /* Got an answer to the upcall; use it: */
1073 if (gss_write_init_verf(sn->rsc_cache, rqstp,
1074 &rsip->out_handle, &rsip->major_status))
1076 if (gss_write_resv(resv, PAGE_SIZE,
1077 &rsip->out_handle, &rsip->out_token,
1078 rsip->major_status, rsip->minor_status))
1083 cache_put(&rsip->h, sn->rsi_cache);
1088 * Accept an rpcsec packet.
1089 * If context establishment, punt to user space
1090 * If data exchange, verify/decrypt
1091 * If context destruction, handle here
1092 * In the context establishment and destruction case we encode
1093 * response here and return SVC_COMPLETE.
1096 svcauth_gss_accept(struct svc_rqst *rqstp, __be32 *authp)
1098 struct kvec *argv = &rqstp->rq_arg.head[0];
1099 struct kvec *resv = &rqstp->rq_res.head[0];
1101 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
1102 struct rpc_gss_wire_cred *gc;
1103 struct rsc *rsci = NULL;
1105 __be32 *reject_stat = resv->iov_base + resv->iov_len;
1107 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1109 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
1112 *authp = rpc_autherr_badcred;
1114 svcdata = kmalloc(sizeof(*svcdata), GFP_KERNEL);
1117 rqstp->rq_auth_data = svcdata;
1118 svcdata->verf_start = NULL;
1119 svcdata->rsci = NULL;
1120 gc = &svcdata->clcred;
1122 /* start of rpc packet is 7 u32's back from here:
1123 * xid direction rpcversion prog vers proc flavour
1125 rpcstart = argv->iov_base;
1129 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1130 * at least 5 u32s, and is preceded by length, so that makes 6.
1133 if (argv->iov_len < 5 * 4)
1135 crlen = svc_getnl(argv);
1136 if (svc_getnl(argv) != RPC_GSS_VERSION)
1138 gc->gc_proc = svc_getnl(argv);
1139 gc->gc_seq = svc_getnl(argv);
1140 gc->gc_svc = svc_getnl(argv);
1141 if (svc_safe_getnetobj(argv, &gc->gc_ctx))
1143 if (crlen != round_up_to_quad(gc->gc_ctx.len) + 5 * 4)
1146 if ((gc->gc_proc != RPC_GSS_PROC_DATA) && (rqstp->rq_proc != 0))
1149 *authp = rpc_autherr_badverf;
1150 switch (gc->gc_proc) {
1151 case RPC_GSS_PROC_INIT:
1152 case RPC_GSS_PROC_CONTINUE_INIT:
1153 return svcauth_gss_handle_init(rqstp, gc, authp);
1154 case RPC_GSS_PROC_DATA:
1155 case RPC_GSS_PROC_DESTROY:
1156 /* Look up the context, and check the verifier: */
1157 *authp = rpcsec_gsserr_credproblem;
1158 rsci = gss_svc_searchbyctx(sn->rsc_cache, &gc->gc_ctx);
1161 switch (gss_verify_header(rqstp, rsci, rpcstart, gc, authp)) {
1171 *authp = rpc_autherr_rejectedcred;
1175 /* now act upon the command: */
1176 switch (gc->gc_proc) {
1177 case RPC_GSS_PROC_DESTROY:
1178 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1180 rsci->h.expiry_time = get_seconds();
1181 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1182 if (resv->iov_len + 4 > PAGE_SIZE)
1184 svc_putnl(resv, RPC_SUCCESS);
1186 case RPC_GSS_PROC_DATA:
1187 *authp = rpcsec_gsserr_ctxproblem;
1188 svcdata->verf_start = resv->iov_base + resv->iov_len;
1189 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1191 rqstp->rq_cred = rsci->cred;
1192 get_group_info(rsci->cred.cr_group_info);
1193 *authp = rpc_autherr_badcred;
1194 switch (gc->gc_svc) {
1195 case RPC_GSS_SVC_NONE:
1197 case RPC_GSS_SVC_INTEGRITY:
1198 /* placeholders for length and seq. number: */
1201 if (unwrap_integ_data(&rqstp->rq_arg,
1202 gc->gc_seq, rsci->mechctx))
1205 case RPC_GSS_SVC_PRIVACY:
1206 /* placeholders for length and seq. number: */
1209 if (unwrap_priv_data(rqstp, &rqstp->rq_arg,
1210 gc->gc_seq, rsci->mechctx))
1216 svcdata->rsci = rsci;
1217 cache_get(&rsci->h);
1218 rqstp->rq_cred.cr_flavor = gss_svc_to_pseudoflavor(
1219 rsci->mechctx->mech_type, gc->gc_svc);
1227 /* Restore write pointer to its original value: */
1228 xdr_ressize_check(rqstp, reject_stat);
1238 cache_put(&rsci->h, sn->rsc_cache);
1243 svcauth_gss_prepare_to_wrap(struct xdr_buf *resbuf, struct gss_svc_data *gsd)
1248 p = gsd->verf_start;
1249 gsd->verf_start = NULL;
1251 /* If the reply stat is nonzero, don't wrap: */
1252 if (*(p-1) != rpc_success)
1254 /* Skip the verifier: */
1256 verf_len = ntohl(*p++);
1257 p += XDR_QUADLEN(verf_len);
1258 /* move accept_stat to right place: */
1259 memcpy(p, p + 2, 4);
1260 /* Also don't wrap if the accept stat is nonzero: */
1261 if (*p != rpc_success) {
1262 resbuf->head[0].iov_len -= 2 * 4;
1270 svcauth_gss_wrap_resp_integ(struct svc_rqst *rqstp)
1272 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1273 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1274 struct xdr_buf *resbuf = &rqstp->rq_res;
1275 struct xdr_buf integ_buf;
1276 struct xdr_netobj mic;
1279 int integ_offset, integ_len;
1282 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1285 integ_offset = (u8 *)(p + 1) - (u8 *)resbuf->head[0].iov_base;
1286 integ_len = resbuf->len - integ_offset;
1287 BUG_ON(integ_len % 4);
1288 *p++ = htonl(integ_len);
1289 *p++ = htonl(gc->gc_seq);
1290 if (xdr_buf_subsegment(resbuf, &integ_buf, integ_offset,
1293 if (resbuf->tail[0].iov_base == NULL) {
1294 if (resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1296 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1297 + resbuf->head[0].iov_len;
1298 resbuf->tail[0].iov_len = 0;
1299 resv = &resbuf->tail[0];
1301 resv = &resbuf->tail[0];
1303 mic.data = (u8 *)resv->iov_base + resv->iov_len + 4;
1304 if (gss_get_mic(gsd->rsci->mechctx, &integ_buf, &mic))
1306 svc_putnl(resv, mic.len);
1307 memset(mic.data + mic.len, 0,
1308 round_up_to_quad(mic.len) - mic.len);
1309 resv->iov_len += XDR_QUADLEN(mic.len) << 2;
1310 /* not strictly required: */
1311 resbuf->len += XDR_QUADLEN(mic.len) << 2;
1312 BUG_ON(resv->iov_len > PAGE_SIZE);
1320 svcauth_gss_wrap_resp_priv(struct svc_rqst *rqstp)
1322 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1323 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1324 struct xdr_buf *resbuf = &rqstp->rq_res;
1325 struct page **inpages = NULL;
1330 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1334 offset = (u8 *)p - (u8 *)resbuf->head[0].iov_base;
1335 *p++ = htonl(gc->gc_seq);
1336 inpages = resbuf->pages;
1337 /* XXX: Would be better to write some xdr helper functions for
1338 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1341 * If there is currently tail data, make sure there is
1342 * room for the head, tail, and 2 * RPC_MAX_AUTH_SIZE in
1343 * the page, and move the current tail data such that
1344 * there is RPC_MAX_AUTH_SIZE slack space available in
1345 * both the head and tail.
1347 if (resbuf->tail[0].iov_base) {
1348 BUG_ON(resbuf->tail[0].iov_base >= resbuf->head[0].iov_base
1350 BUG_ON(resbuf->tail[0].iov_base < resbuf->head[0].iov_base);
1351 if (resbuf->tail[0].iov_len + resbuf->head[0].iov_len
1352 + 2 * RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1354 memmove(resbuf->tail[0].iov_base + RPC_MAX_AUTH_SIZE,
1355 resbuf->tail[0].iov_base,
1356 resbuf->tail[0].iov_len);
1357 resbuf->tail[0].iov_base += RPC_MAX_AUTH_SIZE;
1360 * If there is no current tail data, make sure there is
1361 * room for the head data, and 2 * RPC_MAX_AUTH_SIZE in the
1362 * allotted page, and set up tail information such that there
1363 * is RPC_MAX_AUTH_SIZE slack space available in both the
1366 if (resbuf->tail[0].iov_base == NULL) {
1367 if (resbuf->head[0].iov_len + 2*RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1369 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1370 + resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE;
1371 resbuf->tail[0].iov_len = 0;
1373 if (gss_wrap(gsd->rsci->mechctx, offset, resbuf, inpages))
1375 *len = htonl(resbuf->len - offset);
1376 pad = 3 - ((resbuf->len - offset - 1)&3);
1377 p = (__be32 *)(resbuf->tail[0].iov_base + resbuf->tail[0].iov_len);
1379 resbuf->tail[0].iov_len += pad;
1385 svcauth_gss_release(struct svc_rqst *rqstp)
1387 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1388 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1389 struct xdr_buf *resbuf = &rqstp->rq_res;
1391 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1393 if (gc->gc_proc != RPC_GSS_PROC_DATA)
1395 /* Release can be called twice, but we only wrap once. */
1396 if (gsd->verf_start == NULL)
1398 /* normally not set till svc_send, but we need it here: */
1399 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1401 resbuf->len = total_buf_len(resbuf);
1402 switch (gc->gc_svc) {
1403 case RPC_GSS_SVC_NONE:
1405 case RPC_GSS_SVC_INTEGRITY:
1406 stat = svcauth_gss_wrap_resp_integ(rqstp);
1410 case RPC_GSS_SVC_PRIVACY:
1411 stat = svcauth_gss_wrap_resp_priv(rqstp);
1416 * For any other gc_svc value, svcauth_gss_accept() already set
1417 * the auth_error appropriately; just fall through:
1424 if (rqstp->rq_client)
1425 auth_domain_put(rqstp->rq_client);
1426 rqstp->rq_client = NULL;
1427 if (rqstp->rq_gssclient)
1428 auth_domain_put(rqstp->rq_gssclient);
1429 rqstp->rq_gssclient = NULL;
1430 if (rqstp->rq_cred.cr_group_info)
1431 put_group_info(rqstp->rq_cred.cr_group_info);
1432 rqstp->rq_cred.cr_group_info = NULL;
1434 cache_put(&gsd->rsci->h, sn->rsc_cache);
1441 svcauth_gss_domain_release(struct auth_domain *dom)
1443 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
1449 static struct auth_ops svcauthops_gss = {
1450 .name = "rpcsec_gss",
1451 .owner = THIS_MODULE,
1452 .flavour = RPC_AUTH_GSS,
1453 .accept = svcauth_gss_accept,
1454 .release = svcauth_gss_release,
1455 .domain_release = svcauth_gss_domain_release,
1456 .set_client = svcauth_gss_set_client,
1459 static int rsi_cache_create_net(struct net *net)
1461 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1462 struct cache_detail *cd;
1465 cd = cache_create_net(&rsi_cache_template, net);
1468 err = cache_register_net(cd, net);
1470 cache_destroy_net(cd, net);
1477 static void rsi_cache_destroy_net(struct net *net)
1479 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1480 struct cache_detail *cd = sn->rsi_cache;
1482 sn->rsi_cache = NULL;
1484 cache_unregister_net(cd, net);
1485 cache_destroy_net(cd, net);
1488 static int rsc_cache_create_net(struct net *net)
1490 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1491 struct cache_detail *cd;
1494 cd = cache_create_net(&rsc_cache_template, net);
1497 err = cache_register_net(cd, net);
1499 cache_destroy_net(cd, net);
1506 static void rsc_cache_destroy_net(struct net *net)
1508 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1509 struct cache_detail *cd = sn->rsc_cache;
1511 sn->rsc_cache = NULL;
1513 cache_unregister_net(cd, net);
1514 cache_destroy_net(cd, net);
1518 gss_svc_init_net(struct net *net)
1522 rv = rsc_cache_create_net(net);
1525 rv = rsi_cache_create_net(net);
1530 rsc_cache_destroy_net(net);
1535 gss_svc_shutdown_net(struct net *net)
1537 rsi_cache_destroy_net(net);
1538 rsc_cache_destroy_net(net);
1544 return svc_auth_register(RPC_AUTH_GSS, &svcauthops_gss);
1548 gss_svc_shutdown(void)
1550 svc_auth_unregister(RPC_AUTH_GSS);