2 * Neil Brown <neilb@cse.unsw.edu.au>
3 * J. Bruce Fields <bfields@umich.edu>
4 * Andy Adamson <andros@umich.edu>
5 * Dug Song <dugsong@monkey.org>
7 * RPCSEC_GSS server authentication.
8 * This implements RPCSEC_GSS as defined in rfc2203 (rpcsec_gss) and rfc2078
11 * The RPCSEC_GSS involves three stages:
14 * 3/ context destruction
16 * Context creation is handled largely by upcalls to user-space.
17 * In particular, GSS_Accept_sec_context is handled by an upcall
18 * Data exchange is handled entirely within the kernel
19 * In particular, GSS_GetMIC, GSS_VerifyMIC, GSS_Seal, GSS_Unseal are in-kernel.
20 * Context destruction is handled in-kernel
21 * GSS_Delete_sec_context is in-kernel
23 * Context creation is initiated by a RPCSEC_GSS_INIT request arriving.
24 * The context handle and gss_token are used as a key into the rpcsec_init cache.
25 * The content of this cache includes some of the outputs of GSS_Accept_sec_context,
26 * being major_status, minor_status, context_handle, reply_token.
27 * These are sent back to the client.
28 * Sequence window management is handled by the kernel. The window size if currently
29 * a compile time constant.
31 * When user-space is happy that a context is established, it places an entry
32 * in the rpcsec_context cache. The key for this cache is the context_handle.
33 * The content includes:
34 * uid/gidlist - for determining access rights
36 * mechanism specific information, such as a key
40 #include <linux/types.h>
41 #include <linux/module.h>
42 #include <linux/pagemap.h>
44 #include <linux/sunrpc/auth_gss.h>
45 #include <linux/sunrpc/gss_err.h>
46 #include <linux/sunrpc/svcauth.h>
47 #include <linux/sunrpc/svcauth_gss.h>
48 #include <linux/sunrpc/cache.h>
51 # define RPCDBG_FACILITY RPCDBG_AUTH
54 /* The rpcsec_init cache is used for mapping RPCSEC_GSS_{,CONT_}INIT requests
57 * Key is context handle (\x if empty) and gss_token.
58 * Content is major_status minor_status (integers) context_handle, reply_token.
62 static int netobj_equal(struct xdr_netobj *a, struct xdr_netobj *b)
64 return a->len == b->len && 0 == memcmp(a->data, b->data, a->len);
67 #define RSI_HASHBITS 6
68 #define RSI_HASHMAX (1<<RSI_HASHBITS)
69 #define RSI_HASHMASK (RSI_HASHMAX-1)
73 struct xdr_netobj in_handle, in_token;
74 struct xdr_netobj out_handle, out_token;
75 int major_status, minor_status;
78 static struct cache_head *rsi_table[RSI_HASHMAX];
79 static struct cache_detail rsi_cache;
80 static struct rsi *rsi_update(struct rsi *new, struct rsi *old);
81 static struct rsi *rsi_lookup(struct rsi *item);
83 static void rsi_free(struct rsi *rsii)
85 kfree(rsii->in_handle.data);
86 kfree(rsii->in_token.data);
87 kfree(rsii->out_handle.data);
88 kfree(rsii->out_token.data);
91 static void rsi_put(struct kref *ref)
93 struct rsi *rsii = container_of(ref, struct rsi, h.ref);
98 static inline int rsi_hash(struct rsi *item)
100 return hash_mem(item->in_handle.data, item->in_handle.len, RSI_HASHBITS)
101 ^ hash_mem(item->in_token.data, item->in_token.len, RSI_HASHBITS);
104 static int rsi_match(struct cache_head *a, struct cache_head *b)
106 struct rsi *item = container_of(a, struct rsi, h);
107 struct rsi *tmp = container_of(b, struct rsi, h);
108 return netobj_equal(&item->in_handle, &tmp->in_handle)
109 && netobj_equal(&item->in_token, &tmp->in_token);
112 static int dup_to_netobj(struct xdr_netobj *dst, char *src, int len)
115 dst->data = (len ? kmemdup(src, len, GFP_KERNEL) : NULL);
116 if (len && !dst->data)
121 static inline int dup_netobj(struct xdr_netobj *dst, struct xdr_netobj *src)
123 return dup_to_netobj(dst, src->data, src->len);
126 static void rsi_init(struct cache_head *cnew, struct cache_head *citem)
128 struct rsi *new = container_of(cnew, struct rsi, h);
129 struct rsi *item = container_of(citem, struct rsi, h);
131 new->out_handle.data = NULL;
132 new->out_handle.len = 0;
133 new->out_token.data = NULL;
134 new->out_token.len = 0;
135 new->in_handle.len = item->in_handle.len;
136 item->in_handle.len = 0;
137 new->in_token.len = item->in_token.len;
138 item->in_token.len = 0;
139 new->in_handle.data = item->in_handle.data;
140 item->in_handle.data = NULL;
141 new->in_token.data = item->in_token.data;
142 item->in_token.data = NULL;
145 static void update_rsi(struct cache_head *cnew, struct cache_head *citem)
147 struct rsi *new = container_of(cnew, struct rsi, h);
148 struct rsi *item = container_of(citem, struct rsi, h);
150 BUG_ON(new->out_handle.data || new->out_token.data);
151 new->out_handle.len = item->out_handle.len;
152 item->out_handle.len = 0;
153 new->out_token.len = item->out_token.len;
154 item->out_token.len = 0;
155 new->out_handle.data = item->out_handle.data;
156 item->out_handle.data = NULL;
157 new->out_token.data = item->out_token.data;
158 item->out_token.data = NULL;
160 new->major_status = item->major_status;
161 new->minor_status = item->minor_status;
164 static struct cache_head *rsi_alloc(void)
166 struct rsi *rsii = kmalloc(sizeof(*rsii), GFP_KERNEL);
173 static void rsi_request(struct cache_detail *cd,
174 struct cache_head *h,
175 char **bpp, int *blen)
177 struct rsi *rsii = container_of(h, struct rsi, h);
179 qword_addhex(bpp, blen, rsii->in_handle.data, rsii->in_handle.len);
180 qword_addhex(bpp, blen, rsii->in_token.data, rsii->in_token.len);
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(&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(&rsii, rsip);
261 cache_put(&rsip->h, &rsi_cache);
267 static struct cache_detail rsi_cache = {
268 .owner = THIS_MODULE,
269 .hash_size = RSI_HASHMAX,
270 .hash_table = rsi_table,
271 .name = "auth.rpcsec.init",
272 .cache_put = rsi_put,
273 .cache_request = rsi_request,
274 .cache_parse = rsi_parse,
277 .update = update_rsi,
281 static struct rsi *rsi_lookup(struct rsi *item)
283 struct cache_head *ch;
284 int hash = rsi_hash(item);
286 ch = sunrpc_cache_lookup(&rsi_cache, &item->h, hash);
288 return container_of(ch, struct rsi, h);
293 static struct rsi *rsi_update(struct rsi *new, struct rsi *old)
295 struct cache_head *ch;
296 int hash = rsi_hash(new);
298 ch = sunrpc_cache_update(&rsi_cache, &new->h,
301 return container_of(ch, struct rsi, h);
308 * The rpcsec_context cache is used to store a context that is
309 * used in data exchange.
310 * The key is a context handle. The content is:
311 * uid, gidlist, mechanism, service-set, mech-specific-data
314 #define RSC_HASHBITS 10
315 #define RSC_HASHMAX (1<<RSC_HASHBITS)
316 #define RSC_HASHMASK (RSC_HASHMAX-1)
318 #define GSS_SEQ_WIN 128
320 struct gss_svc_seq_data {
321 /* highest seq number seen so far: */
323 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
324 * sd_win is nonzero iff sequence number i has been seen already: */
325 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
331 struct xdr_netobj handle;
332 struct svc_cred cred;
333 struct gss_svc_seq_data seqdata;
334 struct gss_ctx *mechctx;
338 static struct cache_head *rsc_table[RSC_HASHMAX];
339 static struct cache_detail rsc_cache;
340 static struct rsc *rsc_update(struct rsc *new, struct rsc *old);
341 static struct rsc *rsc_lookup(struct rsc *item);
343 static void rsc_free(struct rsc *rsci)
345 kfree(rsci->handle.data);
347 gss_delete_sec_context(&rsci->mechctx);
348 if (rsci->cred.cr_group_info)
349 put_group_info(rsci->cred.cr_group_info);
350 kfree(rsci->client_name);
353 static void rsc_put(struct kref *ref)
355 struct rsc *rsci = container_of(ref, struct rsc, h.ref);
362 rsc_hash(struct rsc *rsci)
364 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
368 rsc_match(struct cache_head *a, struct cache_head *b)
370 struct rsc *new = container_of(a, struct rsc, h);
371 struct rsc *tmp = container_of(b, struct rsc, h);
373 return netobj_equal(&new->handle, &tmp->handle);
377 rsc_init(struct cache_head *cnew, struct cache_head *ctmp)
379 struct rsc *new = container_of(cnew, struct rsc, h);
380 struct rsc *tmp = container_of(ctmp, struct rsc, h);
382 new->handle.len = tmp->handle.len;
384 new->handle.data = tmp->handle.data;
385 tmp->handle.data = NULL;
387 new->cred.cr_group_info = NULL;
388 new->client_name = NULL;
392 update_rsc(struct cache_head *cnew, struct cache_head *ctmp)
394 struct rsc *new = container_of(cnew, struct rsc, h);
395 struct rsc *tmp = container_of(ctmp, struct rsc, h);
397 new->mechctx = tmp->mechctx;
399 memset(&new->seqdata, 0, sizeof(new->seqdata));
400 spin_lock_init(&new->seqdata.sd_lock);
401 new->cred = tmp->cred;
402 tmp->cred.cr_group_info = NULL;
403 new->client_name = tmp->client_name;
404 tmp->client_name = NULL;
407 static struct cache_head *
410 struct rsc *rsci = kmalloc(sizeof(*rsci), GFP_KERNEL);
417 static int rsc_parse(struct cache_detail *cd,
418 char *mesg, int mlen)
420 /* 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(&rsci);
447 /* uid, or NEGATIVE */
448 rv = get_int(&mesg, &rsci.cred.cr_uid);
452 set_bit(CACHE_NEGATIVE, &rsci.h.flags);
457 if (get_int(&mesg, &rsci.cred.cr_gid))
460 /* number of additional gid's */
461 if (get_int(&mesg, &N))
464 rsci.cred.cr_group_info = groups_alloc(N);
465 if (rsci.cred.cr_group_info == NULL)
470 for (i=0; i<N; i++) {
472 if (get_int(&mesg, &gid))
474 GROUP_AT(rsci.cred.cr_group_info, i) = gid;
478 len = qword_get(&mesg, buf, mlen);
481 gm = gss_mech_get_by_name(buf);
482 status = -EOPNOTSUPP;
487 /* mech-specific data: */
488 len = qword_get(&mesg, buf, mlen);
491 status = gss_import_sec_context(buf, len, gm, &rsci.mechctx);
495 /* get client name */
496 len = qword_get(&mesg, buf, mlen);
498 rsci.client_name = kstrdup(buf, GFP_KERNEL);
499 if (!rsci.client_name)
504 rsci.h.expiry_time = expiry;
505 rscp = rsc_update(&rsci, rscp);
511 cache_put(&rscp->h, &rsc_cache);
517 static struct cache_detail rsc_cache = {
518 .owner = THIS_MODULE,
519 .hash_size = RSC_HASHMAX,
520 .hash_table = rsc_table,
521 .name = "auth.rpcsec.context",
522 .cache_put = rsc_put,
523 .cache_parse = rsc_parse,
526 .update = update_rsc,
530 static struct rsc *rsc_lookup(struct rsc *item)
532 struct cache_head *ch;
533 int hash = rsc_hash(item);
535 ch = sunrpc_cache_lookup(&rsc_cache, &item->h, hash);
537 return container_of(ch, struct rsc, h);
542 static struct rsc *rsc_update(struct rsc *new, struct rsc *old)
544 struct cache_head *ch;
545 int hash = rsc_hash(new);
547 ch = sunrpc_cache_update(&rsc_cache, &new->h,
550 return container_of(ch, struct rsc, h);
557 gss_svc_searchbyctx(struct xdr_netobj *handle)
562 memset(&rsci, 0, sizeof(rsci));
563 if (dup_to_netobj(&rsci.handle, handle->data, handle->len))
565 found = rsc_lookup(&rsci);
569 if (cache_check(&rsc_cache, &found->h, NULL))
574 /* Implements sequence number algorithm as specified in RFC 2203. */
576 gss_check_seq_num(struct rsc *rsci, int seq_num)
578 struct gss_svc_seq_data *sd = &rsci->seqdata;
580 spin_lock(&sd->sd_lock);
581 if (seq_num > sd->sd_max) {
582 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
583 memset(sd->sd_win,0,sizeof(sd->sd_win));
584 sd->sd_max = seq_num;
585 } else while (sd->sd_max < seq_num) {
587 __clear_bit(sd->sd_max % GSS_SEQ_WIN, sd->sd_win);
589 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
591 } else if (seq_num <= sd->sd_max - GSS_SEQ_WIN) {
594 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
595 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win))
598 spin_unlock(&sd->sd_lock);
601 spin_unlock(&sd->sd_lock);
605 static inline u32 round_up_to_quad(u32 i)
607 return (i + 3 ) & ~3;
611 svc_safe_getnetobj(struct kvec *argv, struct xdr_netobj *o)
615 if (argv->iov_len < 4)
617 o->len = svc_getnl(argv);
618 l = round_up_to_quad(o->len);
619 if (argv->iov_len < l)
621 o->data = argv->iov_base;
628 svc_safe_putnetobj(struct kvec *resv, struct xdr_netobj *o)
632 if (resv->iov_len + 4 > PAGE_SIZE)
634 svc_putnl(resv, o->len);
635 p = resv->iov_base + resv->iov_len;
636 resv->iov_len += round_up_to_quad(o->len);
637 if (resv->iov_len > PAGE_SIZE)
639 memcpy(p, o->data, o->len);
640 memset(p + o->len, 0, round_up_to_quad(o->len) - o->len);
645 * Verify the checksum on the header and return SVC_OK on success.
646 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
647 * or return SVC_DENIED and indicate error in authp.
650 gss_verify_header(struct svc_rqst *rqstp, struct rsc *rsci,
651 __be32 *rpcstart, struct rpc_gss_wire_cred *gc, __be32 *authp)
653 struct gss_ctx *ctx_id = rsci->mechctx;
654 struct xdr_buf rpchdr;
655 struct xdr_netobj checksum;
657 struct kvec *argv = &rqstp->rq_arg.head[0];
660 /* data to compute the checksum over: */
661 iov.iov_base = rpcstart;
662 iov.iov_len = (u8 *)argv->iov_base - (u8 *)rpcstart;
663 xdr_buf_from_iov(&iov, &rpchdr);
665 *authp = rpc_autherr_badverf;
666 if (argv->iov_len < 4)
668 flavor = svc_getnl(argv);
669 if (flavor != RPC_AUTH_GSS)
671 if (svc_safe_getnetobj(argv, &checksum))
674 if (rqstp->rq_deferred) /* skip verification of revisited request */
676 if (gss_verify_mic(ctx_id, &rpchdr, &checksum) != GSS_S_COMPLETE) {
677 *authp = rpcsec_gsserr_credproblem;
681 if (gc->gc_seq > MAXSEQ) {
682 dprintk("RPC: svcauth_gss: discarding request with "
683 "large sequence number %d\n", gc->gc_seq);
684 *authp = rpcsec_gsserr_ctxproblem;
687 if (!gss_check_seq_num(rsci, gc->gc_seq)) {
688 dprintk("RPC: svcauth_gss: discarding request with "
689 "old sequence number %d\n", gc->gc_seq);
696 gss_write_null_verf(struct svc_rqst *rqstp)
700 svc_putnl(rqstp->rq_res.head, RPC_AUTH_NULL);
701 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
702 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
704 if (!xdr_ressize_check(rqstp, p))
710 gss_write_verf(struct svc_rqst *rqstp, struct gss_ctx *ctx_id, u32 seq)
714 struct xdr_buf verf_data;
715 struct xdr_netobj mic;
719 svc_putnl(rqstp->rq_res.head, RPC_AUTH_GSS);
720 xdr_seq = htonl(seq);
722 iov.iov_base = &xdr_seq;
723 iov.iov_len = sizeof(xdr_seq);
724 xdr_buf_from_iov(&iov, &verf_data);
725 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
726 mic.data = (u8 *)(p + 1);
727 maj_stat = gss_get_mic(ctx_id, &verf_data, &mic);
728 if (maj_stat != GSS_S_COMPLETE)
730 *p++ = htonl(mic.len);
731 memset((u8 *)p + mic.len, 0, round_up_to_quad(mic.len) - mic.len);
732 p += XDR_QUADLEN(mic.len);
733 if (!xdr_ressize_check(rqstp, p))
739 struct auth_domain h;
743 static struct auth_domain *
744 find_gss_auth_domain(struct gss_ctx *ctx, u32 svc)
748 name = gss_service_to_auth_domain_name(ctx->mech_type, svc);
751 return auth_domain_find(name);
754 static struct auth_ops svcauthops_gss;
756 u32 svcauth_gss_flavor(struct auth_domain *dom)
758 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
760 return gd->pseudoflavor;
763 EXPORT_SYMBOL_GPL(svcauth_gss_flavor);
766 svcauth_gss_register_pseudoflavor(u32 pseudoflavor, char * name)
768 struct gss_domain *new;
769 struct auth_domain *test;
772 new = kmalloc(sizeof(*new), GFP_KERNEL);
775 kref_init(&new->h.ref);
776 new->h.name = kstrdup(name, GFP_KERNEL);
779 new->h.flavour = &svcauthops_gss;
780 new->pseudoflavor = pseudoflavor;
783 test = auth_domain_lookup(name, &new->h);
784 if (test != &new->h) { /* Duplicate registration */
785 auth_domain_put(test);
797 EXPORT_SYMBOL_GPL(svcauth_gss_register_pseudoflavor);
800 read_u32_from_xdr_buf(struct xdr_buf *buf, int base, u32 *obj)
805 status = read_bytes_from_xdr_buf(buf, base, &raw, sizeof(*obj));
812 /* It would be nice if this bit of code could be shared with the client.
814 * The client shouldn't malloc(), would have to pass in own memory.
815 * The server uses base of head iovec as read pointer, while the
816 * client uses separate pointer. */
818 unwrap_integ_data(struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
821 u32 integ_len, maj_stat;
822 struct xdr_netobj mic;
823 struct xdr_buf integ_buf;
825 integ_len = svc_getnl(&buf->head[0]);
828 if (integ_len > buf->len)
830 if (xdr_buf_subsegment(buf, &integ_buf, 0, integ_len))
832 /* copy out mic... */
833 if (read_u32_from_xdr_buf(buf, integ_len, &mic.len))
835 if (mic.len > RPC_MAX_AUTH_SIZE)
837 mic.data = kmalloc(mic.len, GFP_KERNEL);
840 if (read_bytes_from_xdr_buf(buf, integ_len + 4, mic.data, mic.len))
842 maj_stat = gss_verify_mic(ctx, &integ_buf, &mic);
843 if (maj_stat != GSS_S_COMPLETE)
845 if (svc_getnl(&buf->head[0]) != seq)
854 total_buf_len(struct xdr_buf *buf)
856 return buf->head[0].iov_len + buf->page_len + buf->tail[0].iov_len;
860 fix_priv_head(struct xdr_buf *buf, int pad)
862 if (buf->page_len == 0) {
863 /* We need to adjust head and buf->len in tandem in this
864 * case to make svc_defer() work--it finds the original
865 * buffer start using buf->len - buf->head[0].iov_len. */
866 buf->head[0].iov_len -= pad;
871 unwrap_priv_data(struct svc_rqst *rqstp, struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
873 u32 priv_len, maj_stat;
874 int pad, saved_len, remaining_len, offset;
876 rqstp->rq_splice_ok = 0;
878 priv_len = svc_getnl(&buf->head[0]);
879 if (rqstp->rq_deferred) {
880 /* Already decrypted last time through! The sequence number
881 * check at out_seq is unnecessary but harmless: */
884 /* buf->len is the number of bytes from the original start of the
885 * request to the end, where head[0].iov_len is just the bytes
886 * not yet read from the head, so these two values are different: */
887 remaining_len = total_buf_len(buf);
888 if (priv_len > remaining_len)
890 pad = remaining_len - priv_len;
892 fix_priv_head(buf, pad);
894 /* Maybe it would be better to give gss_unwrap a length parameter: */
895 saved_len = buf->len;
897 maj_stat = gss_unwrap(ctx, 0, buf);
898 pad = priv_len - buf->len;
899 buf->len = saved_len;
901 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
902 * In the krb5p case, at least, the data ends up offset, so we need to
904 /* XXX: This is very inefficient. It would be better to either do
905 * this while we encrypt, or maybe in the receive code, if we can peak
906 * ahead and work out the service and mechanism there. */
907 offset = buf->head[0].iov_len % 4;
909 buf->buflen = RPCSVC_MAXPAYLOAD;
910 xdr_shift_buf(buf, offset);
911 fix_priv_head(buf, pad);
913 if (maj_stat != GSS_S_COMPLETE)
916 if (svc_getnl(&buf->head[0]) != seq)
921 struct gss_svc_data {
922 /* decoded gss client cred: */
923 struct rpc_gss_wire_cred clcred;
924 /* save a pointer to the beginning of the encoded verifier,
925 * for use in encryption/checksumming in svcauth_gss_release: */
930 char *svc_gss_principal(struct svc_rqst *rqstp)
932 struct gss_svc_data *gd = (struct gss_svc_data *)rqstp->rq_auth_data;
935 return gd->rsci->client_name;
940 svcauth_gss_set_client(struct svc_rqst *rqstp)
942 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
943 struct rsc *rsci = svcdata->rsci;
944 struct rpc_gss_wire_cred *gc = &svcdata->clcred;
948 * A gss export can be specified either by:
949 * export *(sec=krb5,rw)
951 * export gss/krb5(rw)
952 * The latter is deprecated; but for backwards compatibility reasons
953 * the nfsd code will still fall back on trying it if the former
954 * doesn't work; so we try to make both available to nfsd, below.
956 rqstp->rq_gssclient = find_gss_auth_domain(rsci->mechctx, gc->gc_svc);
957 if (rqstp->rq_gssclient == NULL)
959 stat = svcauth_unix_set_client(rqstp);
960 if (stat == SVC_DROP)
966 gss_write_init_verf(struct svc_rqst *rqstp, struct rsi *rsip)
971 if (rsip->major_status != GSS_S_COMPLETE)
972 return gss_write_null_verf(rqstp);
973 rsci = gss_svc_searchbyctx(&rsip->out_handle);
975 rsip->major_status = GSS_S_NO_CONTEXT;
976 return gss_write_null_verf(rqstp);
978 rc = gss_write_verf(rqstp, rsci->mechctx, GSS_SEQ_WIN);
979 cache_put(&rsci->h, &rsc_cache);
984 * Having read the cred already and found we're in the context
985 * initiation case, read the verifier and initiate (or check the results
986 * of) upcalls to userspace for help with context initiation. If
987 * the upcall results are available, write the verifier and result.
988 * Otherwise, drop the request pending an answer to the upcall.
990 static int svcauth_gss_handle_init(struct svc_rqst *rqstp,
991 struct rpc_gss_wire_cred *gc, __be32 *authp)
993 struct kvec *argv = &rqstp->rq_arg.head[0];
994 struct kvec *resv = &rqstp->rq_res.head[0];
995 struct xdr_netobj tmpobj;
996 struct rsi *rsip, rsikey;
999 /* Read the verifier; should be NULL: */
1000 *authp = rpc_autherr_badverf;
1001 if (argv->iov_len < 2 * 4)
1003 if (svc_getnl(argv) != RPC_AUTH_NULL)
1005 if (svc_getnl(argv) != 0)
1008 /* Martial context handle and token for upcall: */
1009 *authp = rpc_autherr_badcred;
1010 if (gc->gc_proc == RPC_GSS_PROC_INIT && gc->gc_ctx.len != 0)
1012 memset(&rsikey, 0, sizeof(rsikey));
1013 if (dup_netobj(&rsikey.in_handle, &gc->gc_ctx))
1015 *authp = rpc_autherr_badverf;
1016 if (svc_safe_getnetobj(argv, &tmpobj)) {
1017 kfree(rsikey.in_handle.data);
1020 if (dup_netobj(&rsikey.in_token, &tmpobj)) {
1021 kfree(rsikey.in_handle.data);
1025 /* Perform upcall, or find upcall result: */
1026 rsip = rsi_lookup(&rsikey);
1030 switch (cache_check(&rsi_cache, &rsip->h, &rqstp->rq_chandle)) {
1034 /* No upcall result: */
1038 /* Got an answer to the upcall; use it: */
1039 if (gss_write_init_verf(rqstp, rsip))
1041 if (resv->iov_len + 4 > PAGE_SIZE)
1043 svc_putnl(resv, RPC_SUCCESS);
1044 if (svc_safe_putnetobj(resv, &rsip->out_handle))
1046 if (resv->iov_len + 3 * 4 > PAGE_SIZE)
1048 svc_putnl(resv, rsip->major_status);
1049 svc_putnl(resv, rsip->minor_status);
1050 svc_putnl(resv, GSS_SEQ_WIN);
1051 if (svc_safe_putnetobj(resv, &rsip->out_token))
1056 cache_put(&rsip->h, &rsi_cache);
1061 * Accept an rpcsec packet.
1062 * If context establishment, punt to user space
1063 * If data exchange, verify/decrypt
1064 * If context destruction, handle here
1065 * In the context establishment and destruction case we encode
1066 * response here and return SVC_COMPLETE.
1069 svcauth_gss_accept(struct svc_rqst *rqstp, __be32 *authp)
1071 struct kvec *argv = &rqstp->rq_arg.head[0];
1072 struct kvec *resv = &rqstp->rq_res.head[0];
1074 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
1075 struct rpc_gss_wire_cred *gc;
1076 struct rsc *rsci = NULL;
1078 __be32 *reject_stat = resv->iov_base + resv->iov_len;
1081 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
1084 *authp = rpc_autherr_badcred;
1086 svcdata = kmalloc(sizeof(*svcdata), GFP_KERNEL);
1089 rqstp->rq_auth_data = svcdata;
1090 svcdata->verf_start = NULL;
1091 svcdata->rsci = NULL;
1092 gc = &svcdata->clcred;
1094 /* start of rpc packet is 7 u32's back from here:
1095 * xid direction rpcversion prog vers proc flavour
1097 rpcstart = argv->iov_base;
1101 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1102 * at least 5 u32s, and is preceeded by length, so that makes 6.
1105 if (argv->iov_len < 5 * 4)
1107 crlen = svc_getnl(argv);
1108 if (svc_getnl(argv) != RPC_GSS_VERSION)
1110 gc->gc_proc = svc_getnl(argv);
1111 gc->gc_seq = svc_getnl(argv);
1112 gc->gc_svc = svc_getnl(argv);
1113 if (svc_safe_getnetobj(argv, &gc->gc_ctx))
1115 if (crlen != round_up_to_quad(gc->gc_ctx.len) + 5 * 4)
1118 if ((gc->gc_proc != RPC_GSS_PROC_DATA) && (rqstp->rq_proc != 0))
1121 *authp = rpc_autherr_badverf;
1122 switch (gc->gc_proc) {
1123 case RPC_GSS_PROC_INIT:
1124 case RPC_GSS_PROC_CONTINUE_INIT:
1125 return svcauth_gss_handle_init(rqstp, gc, authp);
1126 case RPC_GSS_PROC_DATA:
1127 case RPC_GSS_PROC_DESTROY:
1128 /* Look up the context, and check the verifier: */
1129 *authp = rpcsec_gsserr_credproblem;
1130 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1133 switch (gss_verify_header(rqstp, rsci, rpcstart, gc, authp)) {
1143 *authp = rpc_autherr_rejectedcred;
1147 /* now act upon the command: */
1148 switch (gc->gc_proc) {
1149 case RPC_GSS_PROC_DESTROY:
1150 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1152 rsci->h.expiry_time = get_seconds();
1153 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1154 if (resv->iov_len + 4 > PAGE_SIZE)
1156 svc_putnl(resv, RPC_SUCCESS);
1158 case RPC_GSS_PROC_DATA:
1159 *authp = rpcsec_gsserr_ctxproblem;
1160 svcdata->verf_start = resv->iov_base + resv->iov_len;
1161 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1163 rqstp->rq_cred = rsci->cred;
1164 get_group_info(rsci->cred.cr_group_info);
1165 *authp = rpc_autherr_badcred;
1166 switch (gc->gc_svc) {
1167 case RPC_GSS_SVC_NONE:
1169 case RPC_GSS_SVC_INTEGRITY:
1170 /* placeholders for length and seq. number: */
1173 if (unwrap_integ_data(&rqstp->rq_arg,
1174 gc->gc_seq, rsci->mechctx))
1177 case RPC_GSS_SVC_PRIVACY:
1178 /* placeholders for length and seq. number: */
1181 if (unwrap_priv_data(rqstp, &rqstp->rq_arg,
1182 gc->gc_seq, rsci->mechctx))
1188 svcdata->rsci = rsci;
1189 cache_get(&rsci->h);
1190 rqstp->rq_flavor = gss_svc_to_pseudoflavor(
1191 rsci->mechctx->mech_type, gc->gc_svc);
1199 /* Restore write pointer to its original value: */
1200 xdr_ressize_check(rqstp, reject_stat);
1210 cache_put(&rsci->h, &rsc_cache);
1215 svcauth_gss_prepare_to_wrap(struct xdr_buf *resbuf, struct gss_svc_data *gsd)
1220 p = gsd->verf_start;
1221 gsd->verf_start = NULL;
1223 /* If the reply stat is nonzero, don't wrap: */
1224 if (*(p-1) != rpc_success)
1226 /* Skip the verifier: */
1228 verf_len = ntohl(*p++);
1229 p += XDR_QUADLEN(verf_len);
1230 /* move accept_stat to right place: */
1231 memcpy(p, p + 2, 4);
1232 /* Also don't wrap if the accept stat is nonzero: */
1233 if (*p != rpc_success) {
1234 resbuf->head[0].iov_len -= 2 * 4;
1242 svcauth_gss_wrap_resp_integ(struct svc_rqst *rqstp)
1244 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1245 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1246 struct xdr_buf *resbuf = &rqstp->rq_res;
1247 struct xdr_buf integ_buf;
1248 struct xdr_netobj mic;
1251 int integ_offset, integ_len;
1254 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1257 integ_offset = (u8 *)(p + 1) - (u8 *)resbuf->head[0].iov_base;
1258 integ_len = resbuf->len - integ_offset;
1259 BUG_ON(integ_len % 4);
1260 *p++ = htonl(integ_len);
1261 *p++ = htonl(gc->gc_seq);
1262 if (xdr_buf_subsegment(resbuf, &integ_buf, integ_offset,
1265 if (resbuf->tail[0].iov_base == NULL) {
1266 if (resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1268 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1269 + resbuf->head[0].iov_len;
1270 resbuf->tail[0].iov_len = 0;
1271 resv = &resbuf->tail[0];
1273 resv = &resbuf->tail[0];
1275 mic.data = (u8 *)resv->iov_base + resv->iov_len + 4;
1276 if (gss_get_mic(gsd->rsci->mechctx, &integ_buf, &mic))
1278 svc_putnl(resv, mic.len);
1279 memset(mic.data + mic.len, 0,
1280 round_up_to_quad(mic.len) - mic.len);
1281 resv->iov_len += XDR_QUADLEN(mic.len) << 2;
1282 /* not strictly required: */
1283 resbuf->len += XDR_QUADLEN(mic.len) << 2;
1284 BUG_ON(resv->iov_len > PAGE_SIZE);
1292 svcauth_gss_wrap_resp_priv(struct svc_rqst *rqstp)
1294 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1295 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1296 struct xdr_buf *resbuf = &rqstp->rq_res;
1297 struct page **inpages = NULL;
1302 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1306 offset = (u8 *)p - (u8 *)resbuf->head[0].iov_base;
1307 *p++ = htonl(gc->gc_seq);
1308 inpages = resbuf->pages;
1309 /* XXX: Would be better to write some xdr helper functions for
1310 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1311 if (resbuf->tail[0].iov_base) {
1312 BUG_ON(resbuf->tail[0].iov_base >= resbuf->head[0].iov_base
1314 BUG_ON(resbuf->tail[0].iov_base < resbuf->head[0].iov_base);
1315 if (resbuf->tail[0].iov_len + resbuf->head[0].iov_len
1316 + 2 * RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1318 memmove(resbuf->tail[0].iov_base + RPC_MAX_AUTH_SIZE,
1319 resbuf->tail[0].iov_base,
1320 resbuf->tail[0].iov_len);
1321 resbuf->tail[0].iov_base += RPC_MAX_AUTH_SIZE;
1323 if (resbuf->tail[0].iov_base == NULL) {
1324 if (resbuf->head[0].iov_len + 2*RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1326 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1327 + resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE;
1328 resbuf->tail[0].iov_len = 0;
1330 if (gss_wrap(gsd->rsci->mechctx, offset, resbuf, inpages))
1332 *len = htonl(resbuf->len - offset);
1333 pad = 3 - ((resbuf->len - offset - 1)&3);
1334 p = (__be32 *)(resbuf->tail[0].iov_base + resbuf->tail[0].iov_len);
1336 resbuf->tail[0].iov_len += pad;
1342 svcauth_gss_release(struct svc_rqst *rqstp)
1344 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1345 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1346 struct xdr_buf *resbuf = &rqstp->rq_res;
1349 if (gc->gc_proc != RPC_GSS_PROC_DATA)
1351 /* Release can be called twice, but we only wrap once. */
1352 if (gsd->verf_start == NULL)
1354 /* normally not set till svc_send, but we need it here: */
1355 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1357 resbuf->len = total_buf_len(resbuf);
1358 switch (gc->gc_svc) {
1359 case RPC_GSS_SVC_NONE:
1361 case RPC_GSS_SVC_INTEGRITY:
1362 stat = svcauth_gss_wrap_resp_integ(rqstp);
1366 case RPC_GSS_SVC_PRIVACY:
1367 stat = svcauth_gss_wrap_resp_priv(rqstp);
1378 if (rqstp->rq_client)
1379 auth_domain_put(rqstp->rq_client);
1380 rqstp->rq_client = NULL;
1381 if (rqstp->rq_gssclient)
1382 auth_domain_put(rqstp->rq_gssclient);
1383 rqstp->rq_gssclient = NULL;
1384 if (rqstp->rq_cred.cr_group_info)
1385 put_group_info(rqstp->rq_cred.cr_group_info);
1386 rqstp->rq_cred.cr_group_info = NULL;
1388 cache_put(&gsd->rsci->h, &rsc_cache);
1395 svcauth_gss_domain_release(struct auth_domain *dom)
1397 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
1403 static struct auth_ops svcauthops_gss = {
1404 .name = "rpcsec_gss",
1405 .owner = THIS_MODULE,
1406 .flavour = RPC_AUTH_GSS,
1407 .accept = svcauth_gss_accept,
1408 .release = svcauth_gss_release,
1409 .domain_release = svcauth_gss_domain_release,
1410 .set_client = svcauth_gss_set_client,
1416 int rv = svc_auth_register(RPC_AUTH_GSS, &svcauthops_gss);
1419 rv = cache_register(&rsc_cache);
1422 rv = cache_register(&rsi_cache);
1427 cache_unregister(&rsc_cache);
1429 svc_auth_unregister(RPC_AUTH_GSS);
1434 gss_svc_shutdown(void)
1436 cache_unregister(&rsc_cache);
1437 cache_unregister(&rsi_cache);
1438 svc_auth_unregister(RPC_AUTH_GSS);