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;
342 static struct rsc *rsc_update(struct cache_detail *cd, struct rsc *new, struct rsc *old);
343 static struct rsc *rsc_lookup(struct cache_detail *cd, struct rsc *item);
345 static void rsc_free(struct rsc *rsci)
347 kfree(rsci->handle.data);
349 gss_delete_sec_context(&rsci->mechctx);
350 if (rsci->cred.cr_group_info)
351 put_group_info(rsci->cred.cr_group_info);
352 kfree(rsci->client_name);
355 static void rsc_put(struct kref *ref)
357 struct rsc *rsci = container_of(ref, struct rsc, h.ref);
364 rsc_hash(struct rsc *rsci)
366 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
370 rsc_match(struct cache_head *a, struct cache_head *b)
372 struct rsc *new = container_of(a, struct rsc, h);
373 struct rsc *tmp = container_of(b, struct rsc, h);
375 return netobj_equal(&new->handle, &tmp->handle);
379 rsc_init(struct cache_head *cnew, struct cache_head *ctmp)
381 struct rsc *new = container_of(cnew, struct rsc, h);
382 struct rsc *tmp = container_of(ctmp, struct rsc, h);
384 new->handle.len = tmp->handle.len;
386 new->handle.data = tmp->handle.data;
387 tmp->handle.data = NULL;
389 new->cred.cr_group_info = NULL;
390 new->client_name = NULL;
394 update_rsc(struct cache_head *cnew, struct cache_head *ctmp)
396 struct rsc *new = container_of(cnew, struct rsc, h);
397 struct rsc *tmp = container_of(ctmp, struct rsc, h);
399 new->mechctx = tmp->mechctx;
401 memset(&new->seqdata, 0, sizeof(new->seqdata));
402 spin_lock_init(&new->seqdata.sd_lock);
403 new->cred = tmp->cred;
404 tmp->cred.cr_group_info = NULL;
405 new->client_name = tmp->client_name;
406 tmp->client_name = NULL;
409 static struct cache_head *
412 struct rsc *rsci = kmalloc(sizeof(*rsci), GFP_KERNEL);
419 static int rsc_parse(struct cache_detail *cd,
420 char *mesg, int mlen)
422 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
425 struct rsc rsci, *rscp = NULL;
427 int status = -EINVAL;
428 struct gss_api_mech *gm = NULL;
430 memset(&rsci, 0, sizeof(rsci));
432 len = qword_get(&mesg, buf, mlen);
433 if (len < 0) goto out;
435 if (dup_to_netobj(&rsci.handle, buf, len))
440 expiry = get_expiry(&mesg);
445 rscp = rsc_lookup(cd, &rsci);
449 /* uid, or NEGATIVE */
450 rv = get_int(&mesg, &rsci.cred.cr_uid);
454 set_bit(CACHE_NEGATIVE, &rsci.h.flags);
459 if (get_int(&mesg, &rsci.cred.cr_gid))
462 /* number of additional gid's */
463 if (get_int(&mesg, &N))
466 rsci.cred.cr_group_info = groups_alloc(N);
467 if (rsci.cred.cr_group_info == NULL)
472 for (i=0; i<N; i++) {
475 if (get_int(&mesg, &gid))
477 kgid = make_kgid(&init_user_ns, gid);
478 if (!gid_valid(kgid))
480 GROUP_AT(rsci.cred.cr_group_info, i) = kgid;
484 len = qword_get(&mesg, buf, mlen);
487 gm = gss_mech_get_by_name(buf);
488 status = -EOPNOTSUPP;
493 /* mech-specific data: */
494 len = qword_get(&mesg, buf, mlen);
497 status = gss_import_sec_context(buf, len, gm, &rsci.mechctx, GFP_KERNEL);
501 /* get client name */
502 len = qword_get(&mesg, buf, mlen);
504 rsci.client_name = kstrdup(buf, GFP_KERNEL);
505 if (!rsci.client_name)
510 rsci.h.expiry_time = expiry;
511 rscp = rsc_update(cd, &rsci, rscp);
517 cache_put(&rscp->h, cd);
523 static struct cache_detail rsc_cache_template = {
524 .owner = THIS_MODULE,
525 .hash_size = RSC_HASHMAX,
526 .name = "auth.rpcsec.context",
527 .cache_put = rsc_put,
528 .cache_parse = rsc_parse,
531 .update = update_rsc,
535 static struct rsc *rsc_lookup(struct cache_detail *cd, struct rsc *item)
537 struct cache_head *ch;
538 int hash = rsc_hash(item);
540 ch = sunrpc_cache_lookup(cd, &item->h, hash);
542 return container_of(ch, struct rsc, h);
547 static struct rsc *rsc_update(struct cache_detail *cd, struct rsc *new, struct rsc *old)
549 struct cache_head *ch;
550 int hash = rsc_hash(new);
552 ch = sunrpc_cache_update(cd, &new->h,
555 return container_of(ch, struct rsc, h);
562 gss_svc_searchbyctx(struct cache_detail *cd, struct xdr_netobj *handle)
567 memset(&rsci, 0, sizeof(rsci));
568 if (dup_to_netobj(&rsci.handle, handle->data, handle->len))
570 found = rsc_lookup(cd, &rsci);
574 if (cache_check(cd, &found->h, NULL))
579 /* Implements sequence number algorithm as specified in RFC 2203. */
581 gss_check_seq_num(struct rsc *rsci, int seq_num)
583 struct gss_svc_seq_data *sd = &rsci->seqdata;
585 spin_lock(&sd->sd_lock);
586 if (seq_num > sd->sd_max) {
587 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
588 memset(sd->sd_win,0,sizeof(sd->sd_win));
589 sd->sd_max = seq_num;
590 } else while (sd->sd_max < seq_num) {
592 __clear_bit(sd->sd_max % GSS_SEQ_WIN, sd->sd_win);
594 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
596 } else if (seq_num <= sd->sd_max - GSS_SEQ_WIN) {
599 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
600 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win))
603 spin_unlock(&sd->sd_lock);
606 spin_unlock(&sd->sd_lock);
610 static inline u32 round_up_to_quad(u32 i)
612 return (i + 3 ) & ~3;
616 svc_safe_getnetobj(struct kvec *argv, struct xdr_netobj *o)
620 if (argv->iov_len < 4)
622 o->len = svc_getnl(argv);
623 l = round_up_to_quad(o->len);
624 if (argv->iov_len < l)
626 o->data = argv->iov_base;
633 svc_safe_putnetobj(struct kvec *resv, struct xdr_netobj *o)
637 if (resv->iov_len + 4 > PAGE_SIZE)
639 svc_putnl(resv, o->len);
640 p = resv->iov_base + resv->iov_len;
641 resv->iov_len += round_up_to_quad(o->len);
642 if (resv->iov_len > PAGE_SIZE)
644 memcpy(p, o->data, o->len);
645 memset(p + o->len, 0, round_up_to_quad(o->len) - o->len);
650 * Verify the checksum on the header and return SVC_OK on success.
651 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
652 * or return SVC_DENIED and indicate error in authp.
655 gss_verify_header(struct svc_rqst *rqstp, struct rsc *rsci,
656 __be32 *rpcstart, struct rpc_gss_wire_cred *gc, __be32 *authp)
658 struct gss_ctx *ctx_id = rsci->mechctx;
659 struct xdr_buf rpchdr;
660 struct xdr_netobj checksum;
662 struct kvec *argv = &rqstp->rq_arg.head[0];
665 /* data to compute the checksum over: */
666 iov.iov_base = rpcstart;
667 iov.iov_len = (u8 *)argv->iov_base - (u8 *)rpcstart;
668 xdr_buf_from_iov(&iov, &rpchdr);
670 *authp = rpc_autherr_badverf;
671 if (argv->iov_len < 4)
673 flavor = svc_getnl(argv);
674 if (flavor != RPC_AUTH_GSS)
676 if (svc_safe_getnetobj(argv, &checksum))
679 if (rqstp->rq_deferred) /* skip verification of revisited request */
681 if (gss_verify_mic(ctx_id, &rpchdr, &checksum) != GSS_S_COMPLETE) {
682 *authp = rpcsec_gsserr_credproblem;
686 if (gc->gc_seq > MAXSEQ) {
687 dprintk("RPC: svcauth_gss: discarding request with "
688 "large sequence number %d\n", gc->gc_seq);
689 *authp = rpcsec_gsserr_ctxproblem;
692 if (!gss_check_seq_num(rsci, gc->gc_seq)) {
693 dprintk("RPC: svcauth_gss: discarding request with "
694 "old sequence number %d\n", gc->gc_seq);
701 gss_write_null_verf(struct svc_rqst *rqstp)
705 svc_putnl(rqstp->rq_res.head, RPC_AUTH_NULL);
706 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
707 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
709 if (!xdr_ressize_check(rqstp, p))
715 gss_write_verf(struct svc_rqst *rqstp, struct gss_ctx *ctx_id, u32 seq)
719 struct xdr_buf verf_data;
720 struct xdr_netobj mic;
724 svc_putnl(rqstp->rq_res.head, RPC_AUTH_GSS);
725 xdr_seq = htonl(seq);
727 iov.iov_base = &xdr_seq;
728 iov.iov_len = sizeof(xdr_seq);
729 xdr_buf_from_iov(&iov, &verf_data);
730 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
731 mic.data = (u8 *)(p + 1);
732 maj_stat = gss_get_mic(ctx_id, &verf_data, &mic);
733 if (maj_stat != GSS_S_COMPLETE)
735 *p++ = htonl(mic.len);
736 memset((u8 *)p + mic.len, 0, round_up_to_quad(mic.len) - mic.len);
737 p += XDR_QUADLEN(mic.len);
738 if (!xdr_ressize_check(rqstp, p))
744 struct auth_domain h;
748 static struct auth_domain *
749 find_gss_auth_domain(struct gss_ctx *ctx, u32 svc)
753 name = gss_service_to_auth_domain_name(ctx->mech_type, svc);
756 return auth_domain_find(name);
759 static struct auth_ops svcauthops_gss;
761 u32 svcauth_gss_flavor(struct auth_domain *dom)
763 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
765 return gd->pseudoflavor;
768 EXPORT_SYMBOL_GPL(svcauth_gss_flavor);
771 svcauth_gss_register_pseudoflavor(u32 pseudoflavor, char * name)
773 struct gss_domain *new;
774 struct auth_domain *test;
777 new = kmalloc(sizeof(*new), GFP_KERNEL);
780 kref_init(&new->h.ref);
781 new->h.name = kstrdup(name, GFP_KERNEL);
784 new->h.flavour = &svcauthops_gss;
785 new->pseudoflavor = pseudoflavor;
788 test = auth_domain_lookup(name, &new->h);
789 if (test != &new->h) { /* Duplicate registration */
790 auth_domain_put(test);
802 EXPORT_SYMBOL_GPL(svcauth_gss_register_pseudoflavor);
805 read_u32_from_xdr_buf(struct xdr_buf *buf, int base, u32 *obj)
810 status = read_bytes_from_xdr_buf(buf, base, &raw, sizeof(*obj));
817 /* It would be nice if this bit of code could be shared with the client.
819 * The client shouldn't malloc(), would have to pass in own memory.
820 * The server uses base of head iovec as read pointer, while the
821 * client uses separate pointer. */
823 unwrap_integ_data(struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
826 u32 integ_len, maj_stat;
827 struct xdr_netobj mic;
828 struct xdr_buf integ_buf;
830 integ_len = svc_getnl(&buf->head[0]);
833 if (integ_len > buf->len)
835 if (xdr_buf_subsegment(buf, &integ_buf, 0, integ_len))
837 /* copy out mic... */
838 if (read_u32_from_xdr_buf(buf, integ_len, &mic.len))
840 if (mic.len > RPC_MAX_AUTH_SIZE)
842 mic.data = kmalloc(mic.len, GFP_KERNEL);
845 if (read_bytes_from_xdr_buf(buf, integ_len + 4, mic.data, mic.len))
847 maj_stat = gss_verify_mic(ctx, &integ_buf, &mic);
848 if (maj_stat != GSS_S_COMPLETE)
850 if (svc_getnl(&buf->head[0]) != seq)
859 total_buf_len(struct xdr_buf *buf)
861 return buf->head[0].iov_len + buf->page_len + buf->tail[0].iov_len;
865 fix_priv_head(struct xdr_buf *buf, int pad)
867 if (buf->page_len == 0) {
868 /* We need to adjust head and buf->len in tandem in this
869 * case to make svc_defer() work--it finds the original
870 * buffer start using buf->len - buf->head[0].iov_len. */
871 buf->head[0].iov_len -= pad;
876 unwrap_priv_data(struct svc_rqst *rqstp, struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
878 u32 priv_len, maj_stat;
879 int pad, saved_len, remaining_len, offset;
881 rqstp->rq_splice_ok = 0;
883 priv_len = svc_getnl(&buf->head[0]);
884 if (rqstp->rq_deferred) {
885 /* Already decrypted last time through! The sequence number
886 * check at out_seq is unnecessary but harmless: */
889 /* buf->len is the number of bytes from the original start of the
890 * request to the end, where head[0].iov_len is just the bytes
891 * not yet read from the head, so these two values are different: */
892 remaining_len = total_buf_len(buf);
893 if (priv_len > remaining_len)
895 pad = remaining_len - priv_len;
897 fix_priv_head(buf, pad);
899 /* Maybe it would be better to give gss_unwrap a length parameter: */
900 saved_len = buf->len;
902 maj_stat = gss_unwrap(ctx, 0, buf);
903 pad = priv_len - buf->len;
904 buf->len = saved_len;
906 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
907 * In the krb5p case, at least, the data ends up offset, so we need to
909 /* XXX: This is very inefficient. It would be better to either do
910 * this while we encrypt, or maybe in the receive code, if we can peak
911 * ahead and work out the service and mechanism there. */
912 offset = buf->head[0].iov_len % 4;
914 buf->buflen = RPCSVC_MAXPAYLOAD;
915 xdr_shift_buf(buf, offset);
916 fix_priv_head(buf, pad);
918 if (maj_stat != GSS_S_COMPLETE)
921 if (svc_getnl(&buf->head[0]) != seq)
926 struct gss_svc_data {
927 /* decoded gss client cred: */
928 struct rpc_gss_wire_cred clcred;
929 /* save a pointer to the beginning of the encoded verifier,
930 * for use in encryption/checksumming in svcauth_gss_release: */
935 char *svc_gss_principal(struct svc_rqst *rqstp)
937 struct gss_svc_data *gd = (struct gss_svc_data *)rqstp->rq_auth_data;
940 return gd->rsci->client_name;
943 EXPORT_SYMBOL_GPL(svc_gss_principal);
946 svcauth_gss_set_client(struct svc_rqst *rqstp)
948 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
949 struct rsc *rsci = svcdata->rsci;
950 struct rpc_gss_wire_cred *gc = &svcdata->clcred;
954 * A gss export can be specified either by:
955 * export *(sec=krb5,rw)
957 * export gss/krb5(rw)
958 * The latter is deprecated; but for backwards compatibility reasons
959 * the nfsd code will still fall back on trying it if the former
960 * doesn't work; so we try to make both available to nfsd, below.
962 rqstp->rq_gssclient = find_gss_auth_domain(rsci->mechctx, gc->gc_svc);
963 if (rqstp->rq_gssclient == NULL)
965 stat = svcauth_unix_set_client(rqstp);
966 if (stat == SVC_DROP || stat == SVC_CLOSE)
972 gss_write_init_verf(struct cache_detail *cd, struct svc_rqst *rqstp,
973 struct xdr_netobj *out_handle, int *major_status)
978 if (*major_status != GSS_S_COMPLETE)
979 return gss_write_null_verf(rqstp);
980 rsci = gss_svc_searchbyctx(cd, out_handle);
982 *major_status = GSS_S_NO_CONTEXT;
983 return gss_write_null_verf(rqstp);
985 rc = gss_write_verf(rqstp, rsci->mechctx, GSS_SEQ_WIN);
986 cache_put(&rsci->h, cd);
991 gss_read_verf(struct rpc_gss_wire_cred *gc,
992 struct kvec *argv, __be32 *authp,
993 struct xdr_netobj *in_handle,
994 struct xdr_netobj *in_token)
996 struct xdr_netobj tmpobj;
998 /* Read the verifier; should be NULL: */
999 *authp = rpc_autherr_badverf;
1000 if (argv->iov_len < 2 * 4)
1002 if (svc_getnl(argv) != RPC_AUTH_NULL)
1004 if (svc_getnl(argv) != 0)
1006 /* Martial context handle and token for upcall: */
1007 *authp = rpc_autherr_badcred;
1008 if (gc->gc_proc == RPC_GSS_PROC_INIT && gc->gc_ctx.len != 0)
1010 if (dup_netobj(in_handle, &gc->gc_ctx))
1012 *authp = rpc_autherr_badverf;
1013 if (svc_safe_getnetobj(argv, &tmpobj)) {
1014 kfree(in_handle->data);
1017 if (dup_netobj(in_token, &tmpobj)) {
1018 kfree(in_handle->data);
1026 gss_write_resv(struct kvec *resv, size_t size_limit,
1027 struct xdr_netobj *out_handle, struct xdr_netobj *out_token,
1028 int major_status, int minor_status)
1030 if (resv->iov_len + 4 > size_limit)
1032 svc_putnl(resv, RPC_SUCCESS);
1033 if (svc_safe_putnetobj(resv, out_handle))
1035 if (resv->iov_len + 3 * 4 > size_limit)
1037 svc_putnl(resv, major_status);
1038 svc_putnl(resv, minor_status);
1039 svc_putnl(resv, GSS_SEQ_WIN);
1040 if (svc_safe_putnetobj(resv, out_token))
1046 * Having read the cred already and found we're in the context
1047 * initiation case, read the verifier and initiate (or check the results
1048 * of) upcalls to userspace for help with context initiation. If
1049 * the upcall results are available, write the verifier and result.
1050 * Otherwise, drop the request pending an answer to the upcall.
1052 static int svcauth_gss_handle_init(struct svc_rqst *rqstp,
1053 struct rpc_gss_wire_cred *gc, __be32 *authp)
1055 struct kvec *argv = &rqstp->rq_arg.head[0];
1056 struct kvec *resv = &rqstp->rq_res.head[0];
1057 struct rsi *rsip, rsikey;
1059 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1061 memset(&rsikey, 0, sizeof(rsikey));
1062 ret = gss_read_verf(gc, argv, authp,
1063 &rsikey.in_handle, &rsikey.in_token);
1067 /* Perform upcall, or find upcall result: */
1068 rsip = rsi_lookup(sn->rsi_cache, &rsikey);
1072 if (cache_check(sn->rsi_cache, &rsip->h, &rqstp->rq_chandle) < 0)
1073 /* No upcall result: */
1077 /* Got an answer to the upcall; use it: */
1078 if (gss_write_init_verf(sn->rsc_cache, rqstp,
1079 &rsip->out_handle, &rsip->major_status))
1081 if (gss_write_resv(resv, PAGE_SIZE,
1082 &rsip->out_handle, &rsip->out_token,
1083 rsip->major_status, rsip->minor_status))
1088 cache_put(&rsip->h, sn->rsi_cache);
1093 * Accept an rpcsec packet.
1094 * If context establishment, punt to user space
1095 * If data exchange, verify/decrypt
1096 * If context destruction, handle here
1097 * In the context establishment and destruction case we encode
1098 * response here and return SVC_COMPLETE.
1101 svcauth_gss_accept(struct svc_rqst *rqstp, __be32 *authp)
1103 struct kvec *argv = &rqstp->rq_arg.head[0];
1104 struct kvec *resv = &rqstp->rq_res.head[0];
1106 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
1107 struct rpc_gss_wire_cred *gc;
1108 struct rsc *rsci = NULL;
1110 __be32 *reject_stat = resv->iov_base + resv->iov_len;
1112 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1114 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
1117 *authp = rpc_autherr_badcred;
1119 svcdata = kmalloc(sizeof(*svcdata), GFP_KERNEL);
1122 rqstp->rq_auth_data = svcdata;
1123 svcdata->verf_start = NULL;
1124 svcdata->rsci = NULL;
1125 gc = &svcdata->clcred;
1127 /* start of rpc packet is 7 u32's back from here:
1128 * xid direction rpcversion prog vers proc flavour
1130 rpcstart = argv->iov_base;
1134 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1135 * at least 5 u32s, and is preceded by length, so that makes 6.
1138 if (argv->iov_len < 5 * 4)
1140 crlen = svc_getnl(argv);
1141 if (svc_getnl(argv) != RPC_GSS_VERSION)
1143 gc->gc_proc = svc_getnl(argv);
1144 gc->gc_seq = svc_getnl(argv);
1145 gc->gc_svc = svc_getnl(argv);
1146 if (svc_safe_getnetobj(argv, &gc->gc_ctx))
1148 if (crlen != round_up_to_quad(gc->gc_ctx.len) + 5 * 4)
1151 if ((gc->gc_proc != RPC_GSS_PROC_DATA) && (rqstp->rq_proc != 0))
1154 *authp = rpc_autherr_badverf;
1155 switch (gc->gc_proc) {
1156 case RPC_GSS_PROC_INIT:
1157 case RPC_GSS_PROC_CONTINUE_INIT:
1158 return svcauth_gss_handle_init(rqstp, gc, authp);
1159 case RPC_GSS_PROC_DATA:
1160 case RPC_GSS_PROC_DESTROY:
1161 /* Look up the context, and check the verifier: */
1162 *authp = rpcsec_gsserr_credproblem;
1163 rsci = gss_svc_searchbyctx(sn->rsc_cache, &gc->gc_ctx);
1166 switch (gss_verify_header(rqstp, rsci, rpcstart, gc, authp)) {
1176 *authp = rpc_autherr_rejectedcred;
1180 /* now act upon the command: */
1181 switch (gc->gc_proc) {
1182 case RPC_GSS_PROC_DESTROY:
1183 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1185 rsci->h.expiry_time = get_seconds();
1186 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1187 if (resv->iov_len + 4 > PAGE_SIZE)
1189 svc_putnl(resv, RPC_SUCCESS);
1191 case RPC_GSS_PROC_DATA:
1192 *authp = rpcsec_gsserr_ctxproblem;
1193 svcdata->verf_start = resv->iov_base + resv->iov_len;
1194 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1196 rqstp->rq_cred = rsci->cred;
1197 get_group_info(rsci->cred.cr_group_info);
1198 *authp = rpc_autherr_badcred;
1199 switch (gc->gc_svc) {
1200 case RPC_GSS_SVC_NONE:
1202 case RPC_GSS_SVC_INTEGRITY:
1203 /* placeholders for length and seq. number: */
1206 if (unwrap_integ_data(&rqstp->rq_arg,
1207 gc->gc_seq, rsci->mechctx))
1210 case RPC_GSS_SVC_PRIVACY:
1211 /* placeholders for length and seq. number: */
1214 if (unwrap_priv_data(rqstp, &rqstp->rq_arg,
1215 gc->gc_seq, rsci->mechctx))
1221 svcdata->rsci = rsci;
1222 cache_get(&rsci->h);
1223 rqstp->rq_flavor = gss_svc_to_pseudoflavor(
1224 rsci->mechctx->mech_type, gc->gc_svc);
1232 /* Restore write pointer to its original value: */
1233 xdr_ressize_check(rqstp, reject_stat);
1243 cache_put(&rsci->h, sn->rsc_cache);
1248 svcauth_gss_prepare_to_wrap(struct xdr_buf *resbuf, struct gss_svc_data *gsd)
1253 p = gsd->verf_start;
1254 gsd->verf_start = NULL;
1256 /* If the reply stat is nonzero, don't wrap: */
1257 if (*(p-1) != rpc_success)
1259 /* Skip the verifier: */
1261 verf_len = ntohl(*p++);
1262 p += XDR_QUADLEN(verf_len);
1263 /* move accept_stat to right place: */
1264 memcpy(p, p + 2, 4);
1265 /* Also don't wrap if the accept stat is nonzero: */
1266 if (*p != rpc_success) {
1267 resbuf->head[0].iov_len -= 2 * 4;
1275 svcauth_gss_wrap_resp_integ(struct svc_rqst *rqstp)
1277 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1278 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1279 struct xdr_buf *resbuf = &rqstp->rq_res;
1280 struct xdr_buf integ_buf;
1281 struct xdr_netobj mic;
1284 int integ_offset, integ_len;
1287 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1290 integ_offset = (u8 *)(p + 1) - (u8 *)resbuf->head[0].iov_base;
1291 integ_len = resbuf->len - integ_offset;
1292 BUG_ON(integ_len % 4);
1293 *p++ = htonl(integ_len);
1294 *p++ = htonl(gc->gc_seq);
1295 if (xdr_buf_subsegment(resbuf, &integ_buf, integ_offset,
1298 if (resbuf->tail[0].iov_base == NULL) {
1299 if (resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1301 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1302 + resbuf->head[0].iov_len;
1303 resbuf->tail[0].iov_len = 0;
1304 resv = &resbuf->tail[0];
1306 resv = &resbuf->tail[0];
1308 mic.data = (u8 *)resv->iov_base + resv->iov_len + 4;
1309 if (gss_get_mic(gsd->rsci->mechctx, &integ_buf, &mic))
1311 svc_putnl(resv, mic.len);
1312 memset(mic.data + mic.len, 0,
1313 round_up_to_quad(mic.len) - mic.len);
1314 resv->iov_len += XDR_QUADLEN(mic.len) << 2;
1315 /* not strictly required: */
1316 resbuf->len += XDR_QUADLEN(mic.len) << 2;
1317 BUG_ON(resv->iov_len > PAGE_SIZE);
1325 svcauth_gss_wrap_resp_priv(struct svc_rqst *rqstp)
1327 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1328 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1329 struct xdr_buf *resbuf = &rqstp->rq_res;
1330 struct page **inpages = NULL;
1335 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1339 offset = (u8 *)p - (u8 *)resbuf->head[0].iov_base;
1340 *p++ = htonl(gc->gc_seq);
1341 inpages = resbuf->pages;
1342 /* XXX: Would be better to write some xdr helper functions for
1343 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1346 * If there is currently tail data, make sure there is
1347 * room for the head, tail, and 2 * RPC_MAX_AUTH_SIZE in
1348 * the page, and move the current tail data such that
1349 * there is RPC_MAX_AUTH_SIZE slack space available in
1350 * both the head and tail.
1352 if (resbuf->tail[0].iov_base) {
1353 BUG_ON(resbuf->tail[0].iov_base >= resbuf->head[0].iov_base
1355 BUG_ON(resbuf->tail[0].iov_base < resbuf->head[0].iov_base);
1356 if (resbuf->tail[0].iov_len + resbuf->head[0].iov_len
1357 + 2 * RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1359 memmove(resbuf->tail[0].iov_base + RPC_MAX_AUTH_SIZE,
1360 resbuf->tail[0].iov_base,
1361 resbuf->tail[0].iov_len);
1362 resbuf->tail[0].iov_base += RPC_MAX_AUTH_SIZE;
1365 * If there is no current tail data, make sure there is
1366 * room for the head data, and 2 * RPC_MAX_AUTH_SIZE in the
1367 * allotted page, and set up tail information such that there
1368 * is RPC_MAX_AUTH_SIZE slack space available in both the
1371 if (resbuf->tail[0].iov_base == NULL) {
1372 if (resbuf->head[0].iov_len + 2*RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1374 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1375 + resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE;
1376 resbuf->tail[0].iov_len = 0;
1378 if (gss_wrap(gsd->rsci->mechctx, offset, resbuf, inpages))
1380 *len = htonl(resbuf->len - offset);
1381 pad = 3 - ((resbuf->len - offset - 1)&3);
1382 p = (__be32 *)(resbuf->tail[0].iov_base + resbuf->tail[0].iov_len);
1384 resbuf->tail[0].iov_len += pad;
1390 svcauth_gss_release(struct svc_rqst *rqstp)
1392 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1393 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1394 struct xdr_buf *resbuf = &rqstp->rq_res;
1396 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net, sunrpc_net_id);
1398 if (gc->gc_proc != RPC_GSS_PROC_DATA)
1400 /* Release can be called twice, but we only wrap once. */
1401 if (gsd->verf_start == NULL)
1403 /* normally not set till svc_send, but we need it here: */
1404 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1406 resbuf->len = total_buf_len(resbuf);
1407 switch (gc->gc_svc) {
1408 case RPC_GSS_SVC_NONE:
1410 case RPC_GSS_SVC_INTEGRITY:
1411 stat = svcauth_gss_wrap_resp_integ(rqstp);
1415 case RPC_GSS_SVC_PRIVACY:
1416 stat = svcauth_gss_wrap_resp_priv(rqstp);
1421 * For any other gc_svc value, svcauth_gss_accept() already set
1422 * the auth_error appropriately; just fall through:
1429 if (rqstp->rq_client)
1430 auth_domain_put(rqstp->rq_client);
1431 rqstp->rq_client = NULL;
1432 if (rqstp->rq_gssclient)
1433 auth_domain_put(rqstp->rq_gssclient);
1434 rqstp->rq_gssclient = NULL;
1435 if (rqstp->rq_cred.cr_group_info)
1436 put_group_info(rqstp->rq_cred.cr_group_info);
1437 rqstp->rq_cred.cr_group_info = NULL;
1439 cache_put(&gsd->rsci->h, sn->rsc_cache);
1446 svcauth_gss_domain_release(struct auth_domain *dom)
1448 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
1454 static struct auth_ops svcauthops_gss = {
1455 .name = "rpcsec_gss",
1456 .owner = THIS_MODULE,
1457 .flavour = RPC_AUTH_GSS,
1458 .accept = svcauth_gss_accept,
1459 .release = svcauth_gss_release,
1460 .domain_release = svcauth_gss_domain_release,
1461 .set_client = svcauth_gss_set_client,
1464 static int rsi_cache_create_net(struct net *net)
1466 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1467 struct cache_detail *cd;
1470 cd = cache_create_net(&rsi_cache_template, net);
1473 err = cache_register_net(cd, net);
1475 cache_destroy_net(cd, net);
1482 static void rsi_cache_destroy_net(struct net *net)
1484 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1485 struct cache_detail *cd = sn->rsi_cache;
1487 sn->rsi_cache = NULL;
1489 cache_unregister_net(cd, net);
1490 cache_destroy_net(cd, net);
1493 static int rsc_cache_create_net(struct net *net)
1495 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1496 struct cache_detail *cd;
1499 cd = cache_create_net(&rsc_cache_template, net);
1502 err = cache_register_net(cd, net);
1504 cache_destroy_net(cd, net);
1511 static void rsc_cache_destroy_net(struct net *net)
1513 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1514 struct cache_detail *cd = sn->rsc_cache;
1516 sn->rsc_cache = NULL;
1518 cache_unregister_net(cd, net);
1519 cache_destroy_net(cd, net);
1523 gss_svc_init_net(struct net *net)
1527 rv = rsc_cache_create_net(net);
1530 rv = rsi_cache_create_net(net);
1535 rsc_cache_destroy_net(net);
1540 gss_svc_shutdown_net(struct net *net)
1542 rsi_cache_destroy_net(net);
1543 rsc_cache_destroy_net(net);
1549 return svc_auth_register(RPC_AUTH_GSS, &svcauthops_gss);
1553 gss_svc_shutdown(void)
1555 svc_auth_unregister(RPC_AUTH_GSS);