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);
184 static int rsi_upcall(struct cache_detail *cd, struct cache_head *h)
186 return sunrpc_cache_pipe_upcall(cd, h, rsi_request);
190 static int rsi_parse(struct cache_detail *cd,
191 char *mesg, int mlen)
193 /* context token expiry major minor context token */
197 struct rsi rsii, *rsip = NULL;
199 int status = -EINVAL;
201 memset(&rsii, 0, sizeof(rsii));
203 len = qword_get(&mesg, buf, mlen);
207 if (dup_to_netobj(&rsii.in_handle, buf, len))
211 len = qword_get(&mesg, buf, mlen);
216 if (dup_to_netobj(&rsii.in_token, buf, len))
219 rsip = rsi_lookup(&rsii);
225 expiry = get_expiry(&mesg);
231 len = qword_get(&mesg, buf, mlen);
234 rsii.major_status = simple_strtoul(buf, &ep, 10);
237 len = qword_get(&mesg, buf, mlen);
240 rsii.minor_status = simple_strtoul(buf, &ep, 10);
245 len = qword_get(&mesg, buf, mlen);
249 if (dup_to_netobj(&rsii.out_handle, buf, len))
253 len = qword_get(&mesg, buf, mlen);
258 if (dup_to_netobj(&rsii.out_token, buf, len))
260 rsii.h.expiry_time = expiry;
261 rsip = rsi_update(&rsii, rsip);
266 cache_put(&rsip->h, &rsi_cache);
272 static struct cache_detail rsi_cache = {
273 .owner = THIS_MODULE,
274 .hash_size = RSI_HASHMAX,
275 .hash_table = rsi_table,
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 rsi *item)
288 struct cache_head *ch;
289 int hash = rsi_hash(item);
291 ch = sunrpc_cache_lookup(&rsi_cache, &item->h, hash);
293 return container_of(ch, struct rsi, h);
298 static struct rsi *rsi_update(struct rsi *new, struct rsi *old)
300 struct cache_head *ch;
301 int hash = rsi_hash(new);
303 ch = sunrpc_cache_update(&rsi_cache, &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)
321 #define RSC_HASHMASK (RSC_HASHMAX-1)
323 #define GSS_SEQ_WIN 128
325 struct gss_svc_seq_data {
326 /* highest seq number seen so far: */
328 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
329 * sd_win is nonzero iff sequence number i has been seen already: */
330 unsigned long sd_win[GSS_SEQ_WIN/BITS_PER_LONG];
336 struct xdr_netobj handle;
337 struct svc_cred cred;
338 struct gss_svc_seq_data seqdata;
339 struct gss_ctx *mechctx;
343 static struct cache_head *rsc_table[RSC_HASHMAX];
344 static struct cache_detail rsc_cache;
345 static struct rsc *rsc_update(struct rsc *new, struct rsc *old);
346 static struct rsc *rsc_lookup(struct rsc *item);
348 static void rsc_free(struct rsc *rsci)
350 kfree(rsci->handle.data);
352 gss_delete_sec_context(&rsci->mechctx);
353 if (rsci->cred.cr_group_info)
354 put_group_info(rsci->cred.cr_group_info);
355 kfree(rsci->client_name);
358 static void rsc_put(struct kref *ref)
360 struct rsc *rsci = container_of(ref, struct rsc, h.ref);
367 rsc_hash(struct rsc *rsci)
369 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
373 rsc_match(struct cache_head *a, struct cache_head *b)
375 struct rsc *new = container_of(a, struct rsc, h);
376 struct rsc *tmp = container_of(b, struct rsc, h);
378 return netobj_equal(&new->handle, &tmp->handle);
382 rsc_init(struct cache_head *cnew, struct cache_head *ctmp)
384 struct rsc *new = container_of(cnew, struct rsc, h);
385 struct rsc *tmp = container_of(ctmp, struct rsc, h);
387 new->handle.len = tmp->handle.len;
389 new->handle.data = tmp->handle.data;
390 tmp->handle.data = NULL;
392 new->cred.cr_group_info = NULL;
393 new->client_name = NULL;
397 update_rsc(struct cache_head *cnew, struct cache_head *ctmp)
399 struct rsc *new = container_of(cnew, struct rsc, h);
400 struct rsc *tmp = container_of(ctmp, struct rsc, h);
402 new->mechctx = tmp->mechctx;
404 memset(&new->seqdata, 0, sizeof(new->seqdata));
405 spin_lock_init(&new->seqdata.sd_lock);
406 new->cred = tmp->cred;
407 tmp->cred.cr_group_info = NULL;
408 new->client_name = tmp->client_name;
409 tmp->client_name = NULL;
412 static struct cache_head *
415 struct rsc *rsci = kmalloc(sizeof(*rsci), GFP_KERNEL);
422 static int rsc_parse(struct cache_detail *cd,
423 char *mesg, int mlen)
425 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
428 struct rsc rsci, *rscp = NULL;
430 int status = -EINVAL;
431 struct gss_api_mech *gm = NULL;
433 memset(&rsci, 0, sizeof(rsci));
435 len = qword_get(&mesg, buf, mlen);
436 if (len < 0) goto out;
438 if (dup_to_netobj(&rsci.handle, buf, len))
443 expiry = get_expiry(&mesg);
448 rscp = rsc_lookup(&rsci);
452 /* uid, or NEGATIVE */
453 rv = get_int(&mesg, &rsci.cred.cr_uid);
457 set_bit(CACHE_NEGATIVE, &rsci.h.flags);
462 if (get_int(&mesg, &rsci.cred.cr_gid))
465 /* number of additional gid's */
466 if (get_int(&mesg, &N))
469 rsci.cred.cr_group_info = groups_alloc(N);
470 if (rsci.cred.cr_group_info == NULL)
475 for (i=0; i<N; i++) {
477 if (get_int(&mesg, &gid))
479 GROUP_AT(rsci.cred.cr_group_info, i) = gid;
483 len = qword_get(&mesg, buf, mlen);
486 gm = gss_mech_get_by_name(buf);
487 status = -EOPNOTSUPP;
492 /* mech-specific data: */
493 len = qword_get(&mesg, buf, mlen);
496 status = gss_import_sec_context(buf, len, gm, &rsci.mechctx);
500 /* get client name */
501 len = qword_get(&mesg, buf, mlen);
503 rsci.client_name = kstrdup(buf, GFP_KERNEL);
504 if (!rsci.client_name)
509 rsci.h.expiry_time = expiry;
510 rscp = rsc_update(&rsci, rscp);
516 cache_put(&rscp->h, &rsc_cache);
522 static struct cache_detail rsc_cache = {
523 .owner = THIS_MODULE,
524 .hash_size = RSC_HASHMAX,
525 .hash_table = rsc_table,
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 rsc *item)
537 struct cache_head *ch;
538 int hash = rsc_hash(item);
540 ch = sunrpc_cache_lookup(&rsc_cache, &item->h, hash);
542 return container_of(ch, struct rsc, h);
547 static struct rsc *rsc_update(struct rsc *new, struct rsc *old)
549 struct cache_head *ch;
550 int hash = rsc_hash(new);
552 ch = sunrpc_cache_update(&rsc_cache, &new->h,
555 return container_of(ch, struct rsc, h);
562 gss_svc_searchbyctx(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(&rsci);
574 if (cache_check(&rsc_cache, &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)
972 gss_write_init_verf(struct svc_rqst *rqstp, struct rsi *rsip)
977 if (rsip->major_status != GSS_S_COMPLETE)
978 return gss_write_null_verf(rqstp);
979 rsci = gss_svc_searchbyctx(&rsip->out_handle);
981 rsip->major_status = GSS_S_NO_CONTEXT;
982 return gss_write_null_verf(rqstp);
984 rc = gss_write_verf(rqstp, rsci->mechctx, GSS_SEQ_WIN);
985 cache_put(&rsci->h, &rsc_cache);
990 * Having read the cred already and found we're in the context
991 * initiation case, read the verifier and initiate (or check the results
992 * of) upcalls to userspace for help with context initiation. If
993 * the upcall results are available, write the verifier and result.
994 * Otherwise, drop the request pending an answer to the upcall.
996 static int svcauth_gss_handle_init(struct svc_rqst *rqstp,
997 struct rpc_gss_wire_cred *gc, __be32 *authp)
999 struct kvec *argv = &rqstp->rq_arg.head[0];
1000 struct kvec *resv = &rqstp->rq_res.head[0];
1001 struct xdr_netobj tmpobj;
1002 struct rsi *rsip, rsikey;
1005 /* Read the verifier; should be NULL: */
1006 *authp = rpc_autherr_badverf;
1007 if (argv->iov_len < 2 * 4)
1009 if (svc_getnl(argv) != RPC_AUTH_NULL)
1011 if (svc_getnl(argv) != 0)
1014 /* Martial context handle and token for upcall: */
1015 *authp = rpc_autherr_badcred;
1016 if (gc->gc_proc == RPC_GSS_PROC_INIT && gc->gc_ctx.len != 0)
1018 memset(&rsikey, 0, sizeof(rsikey));
1019 if (dup_netobj(&rsikey.in_handle, &gc->gc_ctx))
1021 *authp = rpc_autherr_badverf;
1022 if (svc_safe_getnetobj(argv, &tmpobj)) {
1023 kfree(rsikey.in_handle.data);
1026 if (dup_netobj(&rsikey.in_token, &tmpobj)) {
1027 kfree(rsikey.in_handle.data);
1031 /* Perform upcall, or find upcall result: */
1032 rsip = rsi_lookup(&rsikey);
1036 switch (cache_check(&rsi_cache, &rsip->h, &rqstp->rq_chandle)) {
1040 /* No upcall result: */
1044 /* Got an answer to the upcall; use it: */
1045 if (gss_write_init_verf(rqstp, rsip))
1047 if (resv->iov_len + 4 > PAGE_SIZE)
1049 svc_putnl(resv, RPC_SUCCESS);
1050 if (svc_safe_putnetobj(resv, &rsip->out_handle))
1052 if (resv->iov_len + 3 * 4 > PAGE_SIZE)
1054 svc_putnl(resv, rsip->major_status);
1055 svc_putnl(resv, rsip->minor_status);
1056 svc_putnl(resv, GSS_SEQ_WIN);
1057 if (svc_safe_putnetobj(resv, &rsip->out_token))
1062 cache_put(&rsip->h, &rsi_cache);
1067 * Accept an rpcsec packet.
1068 * If context establishment, punt to user space
1069 * If data exchange, verify/decrypt
1070 * If context destruction, handle here
1071 * In the context establishment and destruction case we encode
1072 * response here and return SVC_COMPLETE.
1075 svcauth_gss_accept(struct svc_rqst *rqstp, __be32 *authp)
1077 struct kvec *argv = &rqstp->rq_arg.head[0];
1078 struct kvec *resv = &rqstp->rq_res.head[0];
1080 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
1081 struct rpc_gss_wire_cred *gc;
1082 struct rsc *rsci = NULL;
1084 __be32 *reject_stat = resv->iov_base + resv->iov_len;
1087 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
1090 *authp = rpc_autherr_badcred;
1092 svcdata = kmalloc(sizeof(*svcdata), GFP_KERNEL);
1095 rqstp->rq_auth_data = svcdata;
1096 svcdata->verf_start = NULL;
1097 svcdata->rsci = NULL;
1098 gc = &svcdata->clcred;
1100 /* start of rpc packet is 7 u32's back from here:
1101 * xid direction rpcversion prog vers proc flavour
1103 rpcstart = argv->iov_base;
1107 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1108 * at least 5 u32s, and is preceeded by length, so that makes 6.
1111 if (argv->iov_len < 5 * 4)
1113 crlen = svc_getnl(argv);
1114 if (svc_getnl(argv) != RPC_GSS_VERSION)
1116 gc->gc_proc = svc_getnl(argv);
1117 gc->gc_seq = svc_getnl(argv);
1118 gc->gc_svc = svc_getnl(argv);
1119 if (svc_safe_getnetobj(argv, &gc->gc_ctx))
1121 if (crlen != round_up_to_quad(gc->gc_ctx.len) + 5 * 4)
1124 if ((gc->gc_proc != RPC_GSS_PROC_DATA) && (rqstp->rq_proc != 0))
1127 *authp = rpc_autherr_badverf;
1128 switch (gc->gc_proc) {
1129 case RPC_GSS_PROC_INIT:
1130 case RPC_GSS_PROC_CONTINUE_INIT:
1131 return svcauth_gss_handle_init(rqstp, gc, authp);
1132 case RPC_GSS_PROC_DATA:
1133 case RPC_GSS_PROC_DESTROY:
1134 /* Look up the context, and check the verifier: */
1135 *authp = rpcsec_gsserr_credproblem;
1136 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1139 switch (gss_verify_header(rqstp, rsci, rpcstart, gc, authp)) {
1149 *authp = rpc_autherr_rejectedcred;
1153 /* now act upon the command: */
1154 switch (gc->gc_proc) {
1155 case RPC_GSS_PROC_DESTROY:
1156 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1158 rsci->h.expiry_time = get_seconds();
1159 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1160 if (resv->iov_len + 4 > PAGE_SIZE)
1162 svc_putnl(resv, RPC_SUCCESS);
1164 case RPC_GSS_PROC_DATA:
1165 *authp = rpcsec_gsserr_ctxproblem;
1166 svcdata->verf_start = resv->iov_base + resv->iov_len;
1167 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1169 rqstp->rq_cred = rsci->cred;
1170 get_group_info(rsci->cred.cr_group_info);
1171 *authp = rpc_autherr_badcred;
1172 switch (gc->gc_svc) {
1173 case RPC_GSS_SVC_NONE:
1175 case RPC_GSS_SVC_INTEGRITY:
1176 /* placeholders for length and seq. number: */
1179 if (unwrap_integ_data(&rqstp->rq_arg,
1180 gc->gc_seq, rsci->mechctx))
1183 case RPC_GSS_SVC_PRIVACY:
1184 /* placeholders for length and seq. number: */
1187 if (unwrap_priv_data(rqstp, &rqstp->rq_arg,
1188 gc->gc_seq, rsci->mechctx))
1194 svcdata->rsci = rsci;
1195 cache_get(&rsci->h);
1196 rqstp->rq_flavor = gss_svc_to_pseudoflavor(
1197 rsci->mechctx->mech_type, gc->gc_svc);
1205 /* Restore write pointer to its original value: */
1206 xdr_ressize_check(rqstp, reject_stat);
1216 cache_put(&rsci->h, &rsc_cache);
1221 svcauth_gss_prepare_to_wrap(struct xdr_buf *resbuf, struct gss_svc_data *gsd)
1226 p = gsd->verf_start;
1227 gsd->verf_start = NULL;
1229 /* If the reply stat is nonzero, don't wrap: */
1230 if (*(p-1) != rpc_success)
1232 /* Skip the verifier: */
1234 verf_len = ntohl(*p++);
1235 p += XDR_QUADLEN(verf_len);
1236 /* move accept_stat to right place: */
1237 memcpy(p, p + 2, 4);
1238 /* Also don't wrap if the accept stat is nonzero: */
1239 if (*p != rpc_success) {
1240 resbuf->head[0].iov_len -= 2 * 4;
1248 svcauth_gss_wrap_resp_integ(struct svc_rqst *rqstp)
1250 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1251 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1252 struct xdr_buf *resbuf = &rqstp->rq_res;
1253 struct xdr_buf integ_buf;
1254 struct xdr_netobj mic;
1257 int integ_offset, integ_len;
1260 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1263 integ_offset = (u8 *)(p + 1) - (u8 *)resbuf->head[0].iov_base;
1264 integ_len = resbuf->len - integ_offset;
1265 BUG_ON(integ_len % 4);
1266 *p++ = htonl(integ_len);
1267 *p++ = htonl(gc->gc_seq);
1268 if (xdr_buf_subsegment(resbuf, &integ_buf, integ_offset,
1271 if (resbuf->tail[0].iov_base == NULL) {
1272 if (resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1274 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1275 + resbuf->head[0].iov_len;
1276 resbuf->tail[0].iov_len = 0;
1277 resv = &resbuf->tail[0];
1279 resv = &resbuf->tail[0];
1281 mic.data = (u8 *)resv->iov_base + resv->iov_len + 4;
1282 if (gss_get_mic(gsd->rsci->mechctx, &integ_buf, &mic))
1284 svc_putnl(resv, mic.len);
1285 memset(mic.data + mic.len, 0,
1286 round_up_to_quad(mic.len) - mic.len);
1287 resv->iov_len += XDR_QUADLEN(mic.len) << 2;
1288 /* not strictly required: */
1289 resbuf->len += XDR_QUADLEN(mic.len) << 2;
1290 BUG_ON(resv->iov_len > PAGE_SIZE);
1298 svcauth_gss_wrap_resp_priv(struct svc_rqst *rqstp)
1300 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1301 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1302 struct xdr_buf *resbuf = &rqstp->rq_res;
1303 struct page **inpages = NULL;
1308 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1312 offset = (u8 *)p - (u8 *)resbuf->head[0].iov_base;
1313 *p++ = htonl(gc->gc_seq);
1314 inpages = resbuf->pages;
1315 /* XXX: Would be better to write some xdr helper functions for
1316 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1317 if (resbuf->tail[0].iov_base) {
1318 BUG_ON(resbuf->tail[0].iov_base >= resbuf->head[0].iov_base
1320 BUG_ON(resbuf->tail[0].iov_base < resbuf->head[0].iov_base);
1321 if (resbuf->tail[0].iov_len + resbuf->head[0].iov_len
1322 + 2 * RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1324 memmove(resbuf->tail[0].iov_base + RPC_MAX_AUTH_SIZE,
1325 resbuf->tail[0].iov_base,
1326 resbuf->tail[0].iov_len);
1327 resbuf->tail[0].iov_base += RPC_MAX_AUTH_SIZE;
1329 if (resbuf->tail[0].iov_base == NULL) {
1330 if (resbuf->head[0].iov_len + 2*RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1332 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1333 + resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE;
1334 resbuf->tail[0].iov_len = 0;
1336 if (gss_wrap(gsd->rsci->mechctx, offset, resbuf, inpages))
1338 *len = htonl(resbuf->len - offset);
1339 pad = 3 - ((resbuf->len - offset - 1)&3);
1340 p = (__be32 *)(resbuf->tail[0].iov_base + resbuf->tail[0].iov_len);
1342 resbuf->tail[0].iov_len += pad;
1348 svcauth_gss_release(struct svc_rqst *rqstp)
1350 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1351 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1352 struct xdr_buf *resbuf = &rqstp->rq_res;
1355 if (gc->gc_proc != RPC_GSS_PROC_DATA)
1357 /* Release can be called twice, but we only wrap once. */
1358 if (gsd->verf_start == NULL)
1360 /* normally not set till svc_send, but we need it here: */
1361 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1363 resbuf->len = total_buf_len(resbuf);
1364 switch (gc->gc_svc) {
1365 case RPC_GSS_SVC_NONE:
1367 case RPC_GSS_SVC_INTEGRITY:
1368 stat = svcauth_gss_wrap_resp_integ(rqstp);
1372 case RPC_GSS_SVC_PRIVACY:
1373 stat = svcauth_gss_wrap_resp_priv(rqstp);
1378 * For any other gc_svc value, svcauth_gss_accept() already set
1379 * the auth_error appropriately; just fall through:
1386 if (rqstp->rq_client)
1387 auth_domain_put(rqstp->rq_client);
1388 rqstp->rq_client = NULL;
1389 if (rqstp->rq_gssclient)
1390 auth_domain_put(rqstp->rq_gssclient);
1391 rqstp->rq_gssclient = NULL;
1392 if (rqstp->rq_cred.cr_group_info)
1393 put_group_info(rqstp->rq_cred.cr_group_info);
1394 rqstp->rq_cred.cr_group_info = NULL;
1396 cache_put(&gsd->rsci->h, &rsc_cache);
1403 svcauth_gss_domain_release(struct auth_domain *dom)
1405 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
1411 static struct auth_ops svcauthops_gss = {
1412 .name = "rpcsec_gss",
1413 .owner = THIS_MODULE,
1414 .flavour = RPC_AUTH_GSS,
1415 .accept = svcauth_gss_accept,
1416 .release = svcauth_gss_release,
1417 .domain_release = svcauth_gss_domain_release,
1418 .set_client = svcauth_gss_set_client,
1424 int rv = svc_auth_register(RPC_AUTH_GSS, &svcauthops_gss);
1427 rv = cache_register(&rsc_cache);
1430 rv = cache_register(&rsi_cache);
1435 cache_unregister(&rsc_cache);
1437 svc_auth_unregister(RPC_AUTH_GSS);
1442 gss_svc_shutdown(void)
1444 cache_unregister(&rsc_cache);
1445 cache_unregister(&rsi_cache);
1446 svc_auth_unregister(RPC_AUTH_GSS);