RT-AC66 3.0.0.4.374.130 core
[tomato.git] / release / src-rt-6.x / linux / linux-2.6 / net / sunrpc / auth_gss / svcauth_gss.c
blob2ccb9a4eef33c67f9a26f403e026bf1ca46b9fc3
1 /*
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
9 * (gssapi)
11 * The RPCSEC_GSS involves three stages:
12 * 1/ context creation
13 * 2/ data exchange
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
35 * mechanism type
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/svcauth.h>
46 #include <linux/sunrpc/gss_err.h>
47 #include <linux/sunrpc/svcauth.h>
48 #include <linux/sunrpc/svcauth_gss.h>
49 #include <linux/sunrpc/cache.h>
51 #ifdef RPC_DEBUG
52 # define RPCDBG_FACILITY RPCDBG_AUTH
53 #endif
55 /* The rpcsec_init cache is used for mapping RPCSEC_GSS_{,CONT_}INIT requests
56 * into replies.
58 * Key is context handle (\x if empty) and gss_token.
59 * Content is major_status minor_status (integers) context_handle, reply_token.
63 static int netobj_equal(struct xdr_netobj *a, struct xdr_netobj *b)
65 return a->len == b->len && 0 == memcmp(a->data, b->data, a->len);
68 #define RSI_HASHBITS 6
69 #define RSI_HASHMAX (1<<RSI_HASHBITS)
70 #define RSI_HASHMASK (RSI_HASHMAX-1)
72 struct rsi {
73 struct cache_head h;
74 struct xdr_netobj in_handle, in_token;
75 struct xdr_netobj out_handle, out_token;
76 int major_status, minor_status;
79 static struct cache_head *rsi_table[RSI_HASHMAX];
80 static struct cache_detail rsi_cache;
81 static struct rsi *rsi_update(struct rsi *new, struct rsi *old);
82 static struct rsi *rsi_lookup(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);
95 rsi_free(rsii);
96 kfree(rsii);
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)
115 dst->len = len;
116 dst->data = (len ? kmemdup(src, len, GFP_KERNEL) : NULL);
117 if (len && !dst->data)
118 return -ENOMEM;
119 return 0;
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);
168 if (rsii)
169 return &rsii->h;
170 else
171 return NULL;
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);
182 (*bpp)[-1] = '\n';
186 static int rsi_parse(struct cache_detail *cd,
187 char *mesg, int mlen)
189 /* context token expiry major minor context token */
190 char *buf = mesg;
191 char *ep;
192 int len;
193 struct rsi rsii, *rsip = NULL;
194 time_t expiry;
195 int status = -EINVAL;
197 memset(&rsii, 0, sizeof(rsii));
198 /* handle */
199 len = qword_get(&mesg, buf, mlen);
200 if (len < 0)
201 goto out;
202 status = -ENOMEM;
203 if (dup_to_netobj(&rsii.in_handle, buf, len))
204 goto out;
206 /* token */
207 len = qword_get(&mesg, buf, mlen);
208 status = -EINVAL;
209 if (len < 0)
210 goto out;
211 status = -ENOMEM;
212 if (dup_to_netobj(&rsii.in_token, buf, len))
213 goto out;
215 rsip = rsi_lookup(&rsii);
216 if (!rsip)
217 goto out;
219 rsii.h.flags = 0;
220 /* expiry */
221 expiry = get_expiry(&mesg);
222 status = -EINVAL;
223 if (expiry == 0)
224 goto out;
226 /* major/minor */
227 len = qword_get(&mesg, buf, mlen);
228 if (len < 0)
229 goto out;
230 if (len == 0) {
231 goto out;
232 } else {
233 rsii.major_status = simple_strtoul(buf, &ep, 10);
234 if (*ep)
235 goto out;
236 len = qword_get(&mesg, buf, mlen);
237 if (len <= 0)
238 goto out;
239 rsii.minor_status = simple_strtoul(buf, &ep, 10);
240 if (*ep)
241 goto out;
243 /* out_handle */
244 len = qword_get(&mesg, buf, mlen);
245 if (len < 0)
246 goto out;
247 status = -ENOMEM;
248 if (dup_to_netobj(&rsii.out_handle, buf, len))
249 goto out;
251 /* out_token */
252 len = qword_get(&mesg, buf, mlen);
253 status = -EINVAL;
254 if (len < 0)
255 goto out;
256 status = -ENOMEM;
257 if (dup_to_netobj(&rsii.out_token, buf, len))
258 goto out;
260 rsii.h.expiry_time = expiry;
261 rsip = rsi_update(&rsii, rsip);
262 status = 0;
263 out:
264 rsi_free(&rsii);
265 if (rsip)
266 cache_put(&rsip->h, &rsi_cache);
267 else
268 status = -ENOMEM;
269 return status;
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_request = rsi_request,
279 .cache_parse = rsi_parse,
280 .match = rsi_match,
281 .init = rsi_init,
282 .update = update_rsi,
283 .alloc = rsi_alloc,
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);
292 if (ch)
293 return container_of(ch, struct rsi, h);
294 else
295 return NULL;
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,
304 &old->h, hash);
305 if (ch)
306 return container_of(ch, struct rsi, h);
307 else
308 return NULL;
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: */
327 int sd_max;
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];
331 spinlock_t sd_lock;
334 struct rsc {
335 struct cache_head h;
336 struct xdr_netobj handle;
337 struct svc_cred cred;
338 struct gss_svc_seq_data seqdata;
339 struct gss_ctx *mechctx;
342 static struct cache_head *rsc_table[RSC_HASHMAX];
343 static struct cache_detail rsc_cache;
344 static struct rsc *rsc_update(struct rsc *new, struct rsc *old);
345 static struct rsc *rsc_lookup(struct rsc *item);
347 static void rsc_free(struct rsc *rsci)
349 kfree(rsci->handle.data);
350 if (rsci->mechctx)
351 gss_delete_sec_context(&rsci->mechctx);
352 if (rsci->cred.cr_group_info)
353 put_group_info(rsci->cred.cr_group_info);
356 static void rsc_put(struct kref *ref)
358 struct rsc *rsci = container_of(ref, struct rsc, h.ref);
360 rsc_free(rsci);
361 kfree(rsci);
364 static inline int
365 rsc_hash(struct rsc *rsci)
367 return hash_mem(rsci->handle.data, rsci->handle.len, RSC_HASHBITS);
370 static int
371 rsc_match(struct cache_head *a, struct cache_head *b)
373 struct rsc *new = container_of(a, struct rsc, h);
374 struct rsc *tmp = container_of(b, struct rsc, h);
376 return netobj_equal(&new->handle, &tmp->handle);
379 static void
380 rsc_init(struct cache_head *cnew, struct cache_head *ctmp)
382 struct rsc *new = container_of(cnew, struct rsc, h);
383 struct rsc *tmp = container_of(ctmp, struct rsc, h);
385 new->handle.len = tmp->handle.len;
386 tmp->handle.len = 0;
387 new->handle.data = tmp->handle.data;
388 tmp->handle.data = NULL;
389 new->mechctx = NULL;
390 new->cred.cr_group_info = NULL;
393 static void
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;
400 tmp->mechctx = NULL;
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;
407 static struct cache_head *
408 rsc_alloc(void)
410 struct rsc *rsci = kmalloc(sizeof(*rsci), GFP_KERNEL);
411 if (rsci)
412 return &rsci->h;
413 else
414 return NULL;
417 static int rsc_parse(struct cache_detail *cd,
418 char *mesg, int mlen)
420 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
421 char *buf = mesg;
422 int len, rv;
423 struct rsc rsci, *rscp = NULL;
424 time_t expiry;
425 int status = -EINVAL;
426 struct gss_api_mech *gm = NULL;
428 memset(&rsci, 0, sizeof(rsci));
429 /* context handle */
430 len = qword_get(&mesg, buf, mlen);
431 if (len < 0) goto out;
432 status = -ENOMEM;
433 if (dup_to_netobj(&rsci.handle, buf, len))
434 goto out;
436 rsci.h.flags = 0;
437 /* expiry */
438 expiry = get_expiry(&mesg);
439 status = -EINVAL;
440 if (expiry == 0)
441 goto out;
443 rscp = rsc_lookup(&rsci);
444 if (!rscp)
445 goto out;
447 /* uid, or NEGATIVE */
448 rv = get_int(&mesg, &rsci.cred.cr_uid);
449 if (rv == -EINVAL)
450 goto out;
451 if (rv == -ENOENT)
452 set_bit(CACHE_NEGATIVE, &rsci.h.flags);
453 else {
454 int N, i;
456 /* gid */
457 if (get_int(&mesg, &rsci.cred.cr_gid))
458 goto out;
460 /* number of additional gid's */
461 if (get_int(&mesg, &N))
462 goto out;
463 status = -ENOMEM;
464 rsci.cred.cr_group_info = groups_alloc(N);
465 if (rsci.cred.cr_group_info == NULL)
466 goto out;
468 /* gid's */
469 status = -EINVAL;
470 for (i=0; i<N; i++) {
471 gid_t gid;
472 if (get_int(&mesg, &gid))
473 goto out;
474 GROUP_AT(rsci.cred.cr_group_info, i) = gid;
477 /* mech name */
478 len = qword_get(&mesg, buf, mlen);
479 if (len < 0)
480 goto out;
481 gm = gss_mech_get_by_name(buf);
482 status = -EOPNOTSUPP;
483 if (!gm)
484 goto out;
486 status = -EINVAL;
487 /* mech-specific data: */
488 len = qword_get(&mesg, buf, mlen);
489 if (len < 0)
490 goto out;
491 status = gss_import_sec_context(buf, len, gm, &rsci.mechctx);
492 if (status)
493 goto out;
495 rsci.h.expiry_time = expiry;
496 rscp = rsc_update(&rsci, rscp);
497 status = 0;
498 out:
499 gss_mech_put(gm);
500 rsc_free(&rsci);
501 if (rscp)
502 cache_put(&rscp->h, &rsc_cache);
503 else
504 status = -ENOMEM;
505 return status;
508 static struct cache_detail rsc_cache = {
509 .owner = THIS_MODULE,
510 .hash_size = RSC_HASHMAX,
511 .hash_table = rsc_table,
512 .name = "auth.rpcsec.context",
513 .cache_put = rsc_put,
514 .cache_parse = rsc_parse,
515 .match = rsc_match,
516 .init = rsc_init,
517 .update = update_rsc,
518 .alloc = rsc_alloc,
521 static struct rsc *rsc_lookup(struct rsc *item)
523 struct cache_head *ch;
524 int hash = rsc_hash(item);
526 ch = sunrpc_cache_lookup(&rsc_cache, &item->h, hash);
527 if (ch)
528 return container_of(ch, struct rsc, h);
529 else
530 return NULL;
533 static struct rsc *rsc_update(struct rsc *new, struct rsc *old)
535 struct cache_head *ch;
536 int hash = rsc_hash(new);
538 ch = sunrpc_cache_update(&rsc_cache, &new->h,
539 &old->h, hash);
540 if (ch)
541 return container_of(ch, struct rsc, h);
542 else
543 return NULL;
547 static struct rsc *
548 gss_svc_searchbyctx(struct xdr_netobj *handle)
550 struct rsc rsci;
551 struct rsc *found;
553 memset(&rsci, 0, sizeof(rsci));
554 if (dup_to_netobj(&rsci.handle, handle->data, handle->len))
555 return NULL;
556 found = rsc_lookup(&rsci);
557 rsc_free(&rsci);
558 if (!found)
559 return NULL;
560 if (cache_check(&rsc_cache, &found->h, NULL))
561 return NULL;
562 return found;
565 /* Implements sequence number algorithm as specified in RFC 2203. */
566 static int
567 gss_check_seq_num(struct rsc *rsci, int seq_num)
569 struct gss_svc_seq_data *sd = &rsci->seqdata;
571 spin_lock(&sd->sd_lock);
572 if (seq_num > sd->sd_max) {
573 if (seq_num >= sd->sd_max + GSS_SEQ_WIN) {
574 memset(sd->sd_win,0,sizeof(sd->sd_win));
575 sd->sd_max = seq_num;
576 } else while (sd->sd_max < seq_num) {
577 sd->sd_max++;
578 __clear_bit(sd->sd_max % GSS_SEQ_WIN, sd->sd_win);
580 __set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win);
581 goto ok;
582 } else if (seq_num <= sd->sd_max - GSS_SEQ_WIN) {
583 goto drop;
585 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
586 if (__test_and_set_bit(seq_num % GSS_SEQ_WIN, sd->sd_win))
587 goto drop;
589 spin_unlock(&sd->sd_lock);
590 return 1;
591 drop:
592 spin_unlock(&sd->sd_lock);
593 return 0;
596 static inline u32 round_up_to_quad(u32 i)
598 return (i + 3 ) & ~3;
601 static inline int
602 svc_safe_getnetobj(struct kvec *argv, struct xdr_netobj *o)
604 int l;
606 if (argv->iov_len < 4)
607 return -1;
608 o->len = svc_getnl(argv);
609 l = round_up_to_quad(o->len);
610 if (argv->iov_len < l)
611 return -1;
612 o->data = argv->iov_base;
613 argv->iov_base += l;
614 argv->iov_len -= l;
615 return 0;
618 static inline int
619 svc_safe_putnetobj(struct kvec *resv, struct xdr_netobj *o)
621 u8 *p;
623 if (resv->iov_len + 4 > PAGE_SIZE)
624 return -1;
625 svc_putnl(resv, o->len);
626 p = resv->iov_base + resv->iov_len;
627 resv->iov_len += round_up_to_quad(o->len);
628 if (resv->iov_len > PAGE_SIZE)
629 return -1;
630 memcpy(p, o->data, o->len);
631 memset(p + o->len, 0, round_up_to_quad(o->len) - o->len);
632 return 0;
635 /* Verify the checksum on the header and return SVC_OK on success.
636 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
637 * or return SVC_DENIED and indicate error in authp.
639 static int
640 gss_verify_header(struct svc_rqst *rqstp, struct rsc *rsci,
641 __be32 *rpcstart, struct rpc_gss_wire_cred *gc, __be32 *authp)
643 struct gss_ctx *ctx_id = rsci->mechctx;
644 struct xdr_buf rpchdr;
645 struct xdr_netobj checksum;
646 u32 flavor = 0;
647 struct kvec *argv = &rqstp->rq_arg.head[0];
648 struct kvec iov;
650 /* data to compute the checksum over: */
651 iov.iov_base = rpcstart;
652 iov.iov_len = (u8 *)argv->iov_base - (u8 *)rpcstart;
653 xdr_buf_from_iov(&iov, &rpchdr);
655 *authp = rpc_autherr_badverf;
656 if (argv->iov_len < 4)
657 return SVC_DENIED;
658 flavor = svc_getnl(argv);
659 if (flavor != RPC_AUTH_GSS)
660 return SVC_DENIED;
661 if (svc_safe_getnetobj(argv, &checksum))
662 return SVC_DENIED;
664 if (rqstp->rq_deferred) /* skip verification of revisited request */
665 return SVC_OK;
666 if (gss_verify_mic(ctx_id, &rpchdr, &checksum) != GSS_S_COMPLETE) {
667 *authp = rpcsec_gsserr_credproblem;
668 return SVC_DENIED;
671 if (gc->gc_seq > MAXSEQ) {
672 dprintk("RPC: svcauth_gss: discarding request with "
673 "large sequence number %d\n", gc->gc_seq);
674 *authp = rpcsec_gsserr_ctxproblem;
675 return SVC_DENIED;
677 if (!gss_check_seq_num(rsci, gc->gc_seq)) {
678 dprintk("RPC: svcauth_gss: discarding request with "
679 "old sequence number %d\n", gc->gc_seq);
680 return SVC_DROP;
682 return SVC_OK;
685 static int
686 gss_write_null_verf(struct svc_rqst *rqstp)
688 __be32 *p;
690 svc_putnl(rqstp->rq_res.head, RPC_AUTH_NULL);
691 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
692 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
693 *p++ = 0;
694 if (!xdr_ressize_check(rqstp, p))
695 return -1;
696 return 0;
699 static int
700 gss_write_verf(struct svc_rqst *rqstp, struct gss_ctx *ctx_id, u32 seq)
702 __be32 xdr_seq;
703 u32 maj_stat;
704 struct xdr_buf verf_data;
705 struct xdr_netobj mic;
706 __be32 *p;
707 struct kvec iov;
709 svc_putnl(rqstp->rq_res.head, RPC_AUTH_GSS);
710 xdr_seq = htonl(seq);
712 iov.iov_base = &xdr_seq;
713 iov.iov_len = sizeof(xdr_seq);
714 xdr_buf_from_iov(&iov, &verf_data);
715 p = rqstp->rq_res.head->iov_base + rqstp->rq_res.head->iov_len;
716 mic.data = (u8 *)(p + 1);
717 maj_stat = gss_get_mic(ctx_id, &verf_data, &mic);
718 if (maj_stat != GSS_S_COMPLETE)
719 return -1;
720 *p++ = htonl(mic.len);
721 memset((u8 *)p + mic.len, 0, round_up_to_quad(mic.len) - mic.len);
722 p += XDR_QUADLEN(mic.len);
723 if (!xdr_ressize_check(rqstp, p))
724 return -1;
725 return 0;
728 struct gss_domain {
729 struct auth_domain h;
730 u32 pseudoflavor;
733 static struct auth_domain *
734 find_gss_auth_domain(struct gss_ctx *ctx, u32 svc)
736 char *name;
738 name = gss_service_to_auth_domain_name(ctx->mech_type, svc);
739 if (!name)
740 return NULL;
741 return auth_domain_find(name);
744 static struct auth_ops svcauthops_gss;
747 svcauth_gss_register_pseudoflavor(u32 pseudoflavor, char * name)
749 struct gss_domain *new;
750 struct auth_domain *test;
751 int stat = -ENOMEM;
753 new = kmalloc(sizeof(*new), GFP_KERNEL);
754 if (!new)
755 goto out;
756 kref_init(&new->h.ref);
757 new->h.name = kstrdup(name, GFP_KERNEL);
758 if (!new->h.name)
759 goto out_free_dom;
760 new->h.flavour = &svcauthops_gss;
761 new->pseudoflavor = pseudoflavor;
763 stat = 0;
764 test = auth_domain_lookup(name, &new->h);
765 if (test != &new->h) { /* Duplicate registration */
766 auth_domain_put(test);
767 kfree(new->h.name);
768 goto out_free_dom;
770 return 0;
772 out_free_dom:
773 kfree(new);
774 out:
775 return stat;
778 EXPORT_SYMBOL(svcauth_gss_register_pseudoflavor);
780 static inline int
781 read_u32_from_xdr_buf(struct xdr_buf *buf, int base, u32 *obj)
783 __be32 raw;
784 int status;
786 status = read_bytes_from_xdr_buf(buf, base, &raw, sizeof(*obj));
787 if (status)
788 return status;
789 *obj = ntohl(raw);
790 return 0;
793 /* It would be nice if this bit of code could be shared with the client.
794 * Obstacles:
795 * The client shouldn't malloc(), would have to pass in own memory.
796 * The server uses base of head iovec as read pointer, while the
797 * client uses separate pointer. */
798 static int
799 unwrap_integ_data(struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
801 int stat = -EINVAL;
802 u32 integ_len, maj_stat;
803 struct xdr_netobj mic;
804 struct xdr_buf integ_buf;
806 integ_len = svc_getnl(&buf->head[0]);
807 if (integ_len & 3)
808 return stat;
809 if (integ_len > buf->len)
810 return stat;
811 if (xdr_buf_subsegment(buf, &integ_buf, 0, integ_len))
812 BUG();
813 /* copy out mic... */
814 if (read_u32_from_xdr_buf(buf, integ_len, &mic.len))
815 BUG();
816 if (mic.len > RPC_MAX_AUTH_SIZE)
817 return stat;
818 mic.data = kmalloc(mic.len, GFP_KERNEL);
819 if (!mic.data)
820 return stat;
821 if (read_bytes_from_xdr_buf(buf, integ_len + 4, mic.data, mic.len))
822 goto out;
823 maj_stat = gss_verify_mic(ctx, &integ_buf, &mic);
824 if (maj_stat != GSS_S_COMPLETE)
825 goto out;
826 if (svc_getnl(&buf->head[0]) != seq)
827 goto out;
828 stat = 0;
829 out:
830 kfree(mic.data);
831 return stat;
834 static inline int
835 total_buf_len(struct xdr_buf *buf)
837 return buf->head[0].iov_len + buf->page_len + buf->tail[0].iov_len;
840 static void
841 fix_priv_head(struct xdr_buf *buf, int pad)
843 if (buf->page_len == 0) {
844 /* We need to adjust head and buf->len in tandem in this
845 * case to make svc_defer() work--it finds the original
846 * buffer start using buf->len - buf->head[0].iov_len. */
847 buf->head[0].iov_len -= pad;
851 static int
852 unwrap_priv_data(struct svc_rqst *rqstp, struct xdr_buf *buf, u32 seq, struct gss_ctx *ctx)
854 u32 priv_len, maj_stat;
855 int pad, saved_len, remaining_len, offset;
857 rqstp->rq_splice_ok = 0;
859 priv_len = svc_getnl(&buf->head[0]);
860 if (rqstp->rq_deferred) {
861 /* Already decrypted last time through! The sequence number
862 * check at out_seq is unnecessary but harmless: */
863 goto out_seq;
865 /* buf->len is the number of bytes from the original start of the
866 * request to the end, where head[0].iov_len is just the bytes
867 * not yet read from the head, so these two values are different: */
868 remaining_len = total_buf_len(buf);
869 if (priv_len > remaining_len)
870 return -EINVAL;
871 pad = remaining_len - priv_len;
872 buf->len -= pad;
873 fix_priv_head(buf, pad);
875 /* Maybe it would be better to give gss_unwrap a length parameter: */
876 saved_len = buf->len;
877 buf->len = priv_len;
878 maj_stat = gss_unwrap(ctx, 0, buf);
879 pad = priv_len - buf->len;
880 buf->len = saved_len;
881 buf->len -= pad;
882 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
883 * In the krb5p case, at least, the data ends up offset, so we need to
884 * move it around. */
885 /* XXX: This is very inefficient. It would be better to either do
886 * this while we encrypt, or maybe in the receive code, if we can peak
887 * ahead and work out the service and mechanism there. */
888 offset = buf->head[0].iov_len % 4;
889 if (offset) {
890 buf->buflen = RPCSVC_MAXPAYLOAD;
891 xdr_shift_buf(buf, offset);
892 fix_priv_head(buf, pad);
894 if (maj_stat != GSS_S_COMPLETE)
895 return -EINVAL;
896 out_seq:
897 if (svc_getnl(&buf->head[0]) != seq)
898 return -EINVAL;
899 return 0;
902 struct gss_svc_data {
903 /* decoded gss client cred: */
904 struct rpc_gss_wire_cred clcred;
905 /* save a pointer to the beginning of the encoded verifier,
906 * for use in encryption/checksumming in svcauth_gss_release: */
907 __be32 *verf_start;
908 struct rsc *rsci;
911 static int
912 svcauth_gss_set_client(struct svc_rqst *rqstp)
914 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
915 struct rsc *rsci = svcdata->rsci;
916 struct rpc_gss_wire_cred *gc = &svcdata->clcred;
917 int stat;
920 * A gss export can be specified either by:
921 * export *(sec=krb5,rw)
922 * or by
923 * export gss/krb5(rw)
924 * The latter is deprecated; but for backwards compatibility reasons
925 * the nfsd code will still fall back on trying it if the former
926 * doesn't work; so we try to make both available to nfsd, below.
928 rqstp->rq_gssclient = find_gss_auth_domain(rsci->mechctx, gc->gc_svc);
929 if (rqstp->rq_gssclient == NULL)
930 return SVC_DENIED;
931 stat = svcauth_unix_set_client(rqstp);
932 if (stat == SVC_DROP)
933 return stat;
934 return SVC_OK;
937 static inline int
938 gss_write_init_verf(struct svc_rqst *rqstp, struct rsi *rsip)
940 struct rsc *rsci;
941 int rc;
943 if (rsip->major_status != GSS_S_COMPLETE)
944 return gss_write_null_verf(rqstp);
945 rsci = gss_svc_searchbyctx(&rsip->out_handle);
946 if (rsci == NULL) {
947 rsip->major_status = GSS_S_NO_CONTEXT;
948 return gss_write_null_verf(rqstp);
950 rc = gss_write_verf(rqstp, rsci->mechctx, GSS_SEQ_WIN);
951 cache_put(&rsci->h, &rsc_cache);
952 return rc;
956 * Accept an rpcsec packet.
957 * If context establishment, punt to user space
958 * If data exchange, verify/decrypt
959 * If context destruction, handle here
960 * In the context establishment and destruction case we encode
961 * response here and return SVC_COMPLETE.
963 static int
964 svcauth_gss_accept(struct svc_rqst *rqstp, __be32 *authp)
966 struct kvec *argv = &rqstp->rq_arg.head[0];
967 struct kvec *resv = &rqstp->rq_res.head[0];
968 u32 crlen;
969 struct xdr_netobj tmpobj;
970 struct gss_svc_data *svcdata = rqstp->rq_auth_data;
971 struct rpc_gss_wire_cred *gc;
972 struct rsc *rsci = NULL;
973 struct rsi *rsip, rsikey;
974 __be32 *rpcstart;
975 __be32 *reject_stat = resv->iov_base + resv->iov_len;
976 int ret;
978 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
979 argv->iov_len);
981 *authp = rpc_autherr_badcred;
982 if (!svcdata)
983 svcdata = kmalloc(sizeof(*svcdata), GFP_KERNEL);
984 if (!svcdata)
985 goto auth_err;
986 rqstp->rq_auth_data = svcdata;
987 svcdata->verf_start = NULL;
988 svcdata->rsci = NULL;
989 gc = &svcdata->clcred;
991 /* start of rpc packet is 7 u32's back from here:
992 * xid direction rpcversion prog vers proc flavour
994 rpcstart = argv->iov_base;
995 rpcstart -= 7;
997 /* credential is:
998 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
999 * at least 5 u32s, and is preceeded by length, so that makes 6.
1002 if (argv->iov_len < 5 * 4)
1003 goto auth_err;
1004 crlen = svc_getnl(argv);
1005 if (svc_getnl(argv) != RPC_GSS_VERSION)
1006 goto auth_err;
1007 gc->gc_proc = svc_getnl(argv);
1008 gc->gc_seq = svc_getnl(argv);
1009 gc->gc_svc = svc_getnl(argv);
1010 if (svc_safe_getnetobj(argv, &gc->gc_ctx))
1011 goto auth_err;
1012 if (crlen != round_up_to_quad(gc->gc_ctx.len) + 5 * 4)
1013 goto auth_err;
1015 if ((gc->gc_proc != RPC_GSS_PROC_DATA) && (rqstp->rq_proc != 0))
1016 goto auth_err;
1019 * We've successfully parsed the credential. Let's check out the
1020 * verifier. An AUTH_NULL verifier is allowed (and required) for
1021 * INIT and CONTINUE_INIT requests. AUTH_RPCSEC_GSS is required for
1022 * PROC_DATA and PROC_DESTROY.
1024 * AUTH_NULL verifier is 0 (AUTH_NULL), 0 (length).
1025 * AUTH_RPCSEC_GSS verifier is:
1026 * 6 (AUTH_RPCSEC_GSS), length, checksum.
1027 * checksum is calculated over rpcheader from xid up to here.
1029 *authp = rpc_autherr_badverf;
1030 switch (gc->gc_proc) {
1031 case RPC_GSS_PROC_INIT:
1032 case RPC_GSS_PROC_CONTINUE_INIT:
1033 if (argv->iov_len < 2 * 4)
1034 goto auth_err;
1035 if (svc_getnl(argv) != RPC_AUTH_NULL)
1036 goto auth_err;
1037 if (svc_getnl(argv) != 0)
1038 goto auth_err;
1039 break;
1040 case RPC_GSS_PROC_DATA:
1041 case RPC_GSS_PROC_DESTROY:
1042 *authp = rpcsec_gsserr_credproblem;
1043 rsci = gss_svc_searchbyctx(&gc->gc_ctx);
1044 if (!rsci)
1045 goto auth_err;
1046 switch (gss_verify_header(rqstp, rsci, rpcstart, gc, authp)) {
1047 case SVC_OK:
1048 break;
1049 case SVC_DENIED:
1050 goto auth_err;
1051 case SVC_DROP:
1052 goto drop;
1054 break;
1055 default:
1056 *authp = rpc_autherr_rejectedcred;
1057 goto auth_err;
1060 /* now act upon the command: */
1061 switch (gc->gc_proc) {
1062 case RPC_GSS_PROC_INIT:
1063 case RPC_GSS_PROC_CONTINUE_INIT:
1064 *authp = rpc_autherr_badcred;
1065 if (gc->gc_proc == RPC_GSS_PROC_INIT && gc->gc_ctx.len != 0)
1066 goto auth_err;
1067 memset(&rsikey, 0, sizeof(rsikey));
1068 if (dup_netobj(&rsikey.in_handle, &gc->gc_ctx))
1069 goto drop;
1070 *authp = rpc_autherr_badverf;
1071 if (svc_safe_getnetobj(argv, &tmpobj)) {
1072 kfree(rsikey.in_handle.data);
1073 goto auth_err;
1075 if (dup_netobj(&rsikey.in_token, &tmpobj)) {
1076 kfree(rsikey.in_handle.data);
1077 goto drop;
1080 rsip = rsi_lookup(&rsikey);
1081 rsi_free(&rsikey);
1082 if (!rsip) {
1083 goto drop;
1085 switch(cache_check(&rsi_cache, &rsip->h, &rqstp->rq_chandle)) {
1086 case -EAGAIN:
1087 case -ETIMEDOUT:
1088 case -ENOENT:
1089 goto drop;
1090 case 0:
1091 if (gss_write_init_verf(rqstp, rsip))
1092 goto drop;
1093 if (resv->iov_len + 4 > PAGE_SIZE)
1094 goto drop;
1095 svc_putnl(resv, RPC_SUCCESS);
1096 if (svc_safe_putnetobj(resv, &rsip->out_handle))
1097 goto drop;
1098 if (resv->iov_len + 3 * 4 > PAGE_SIZE)
1099 goto drop;
1100 svc_putnl(resv, rsip->major_status);
1101 svc_putnl(resv, rsip->minor_status);
1102 svc_putnl(resv, GSS_SEQ_WIN);
1103 if (svc_safe_putnetobj(resv, &rsip->out_token))
1104 goto drop;
1106 goto complete;
1107 case RPC_GSS_PROC_DESTROY:
1108 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1109 goto auth_err;
1110 set_bit(CACHE_NEGATIVE, &rsci->h.flags);
1111 if (resv->iov_len + 4 > PAGE_SIZE)
1112 goto drop;
1113 svc_putnl(resv, RPC_SUCCESS);
1114 goto complete;
1115 case RPC_GSS_PROC_DATA:
1116 *authp = rpcsec_gsserr_ctxproblem;
1117 svcdata->verf_start = resv->iov_base + resv->iov_len;
1118 if (gss_write_verf(rqstp, rsci->mechctx, gc->gc_seq))
1119 goto auth_err;
1120 rqstp->rq_cred = rsci->cred;
1121 get_group_info(rsci->cred.cr_group_info);
1122 *authp = rpc_autherr_badcred;
1123 switch (gc->gc_svc) {
1124 case RPC_GSS_SVC_NONE:
1125 break;
1126 case RPC_GSS_SVC_INTEGRITY:
1127 if (unwrap_integ_data(&rqstp->rq_arg,
1128 gc->gc_seq, rsci->mechctx))
1129 goto auth_err;
1130 /* placeholders for length and seq. number: */
1131 svc_putnl(resv, 0);
1132 svc_putnl(resv, 0);
1133 break;
1134 case RPC_GSS_SVC_PRIVACY:
1135 if (unwrap_priv_data(rqstp, &rqstp->rq_arg,
1136 gc->gc_seq, rsci->mechctx))
1137 goto auth_err;
1138 /* placeholders for length and seq. number: */
1139 svc_putnl(resv, 0);
1140 svc_putnl(resv, 0);
1141 break;
1142 default:
1143 goto auth_err;
1145 svcdata->rsci = rsci;
1146 cache_get(&rsci->h);
1147 ret = SVC_OK;
1148 goto out;
1150 auth_err:
1151 /* Restore write pointer to original value: */
1152 xdr_ressize_check(rqstp, reject_stat);
1153 ret = SVC_DENIED;
1154 goto out;
1155 complete:
1156 ret = SVC_COMPLETE;
1157 goto out;
1158 drop:
1159 ret = SVC_DROP;
1160 out:
1161 if (rsci)
1162 cache_put(&rsci->h, &rsc_cache);
1163 return ret;
1166 static __be32 *
1167 svcauth_gss_prepare_to_wrap(struct xdr_buf *resbuf, struct gss_svc_data *gsd)
1169 __be32 *p;
1170 u32 verf_len;
1172 p = gsd->verf_start;
1173 gsd->verf_start = NULL;
1175 /* If the reply stat is nonzero, don't wrap: */
1176 if (*(p-1) != rpc_success)
1177 return NULL;
1178 /* Skip the verifier: */
1179 p += 1;
1180 verf_len = ntohl(*p++);
1181 p += XDR_QUADLEN(verf_len);
1182 /* move accept_stat to right place: */
1183 memcpy(p, p + 2, 4);
1184 /* Also don't wrap if the accept stat is nonzero: */
1185 if (*p != rpc_success) {
1186 resbuf->head[0].iov_len -= 2 * 4;
1187 return NULL;
1189 p++;
1190 return p;
1193 static inline int
1194 svcauth_gss_wrap_resp_integ(struct svc_rqst *rqstp)
1196 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1197 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1198 struct xdr_buf *resbuf = &rqstp->rq_res;
1199 struct xdr_buf integ_buf;
1200 struct xdr_netobj mic;
1201 struct kvec *resv;
1202 __be32 *p;
1203 int integ_offset, integ_len;
1204 int stat = -EINVAL;
1206 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1207 if (p == NULL)
1208 goto out;
1209 integ_offset = (u8 *)(p + 1) - (u8 *)resbuf->head[0].iov_base;
1210 integ_len = resbuf->len - integ_offset;
1211 BUG_ON(integ_len % 4);
1212 *p++ = htonl(integ_len);
1213 *p++ = htonl(gc->gc_seq);
1214 if (xdr_buf_subsegment(resbuf, &integ_buf, integ_offset,
1215 integ_len))
1216 BUG();
1217 if (resbuf->tail[0].iov_base == NULL) {
1218 if (resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1219 goto out_err;
1220 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1221 + resbuf->head[0].iov_len;
1222 resbuf->tail[0].iov_len = 0;
1223 resv = &resbuf->tail[0];
1224 } else {
1225 resv = &resbuf->tail[0];
1227 mic.data = (u8 *)resv->iov_base + resv->iov_len + 4;
1228 if (gss_get_mic(gsd->rsci->mechctx, &integ_buf, &mic))
1229 goto out_err;
1230 svc_putnl(resv, mic.len);
1231 memset(mic.data + mic.len, 0,
1232 round_up_to_quad(mic.len) - mic.len);
1233 resv->iov_len += XDR_QUADLEN(mic.len) << 2;
1234 /* not strictly required: */
1235 resbuf->len += XDR_QUADLEN(mic.len) << 2;
1236 BUG_ON(resv->iov_len > PAGE_SIZE);
1237 out:
1238 stat = 0;
1239 out_err:
1240 return stat;
1243 static inline int
1244 svcauth_gss_wrap_resp_priv(struct svc_rqst *rqstp)
1246 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1247 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1248 struct xdr_buf *resbuf = &rqstp->rq_res;
1249 struct page **inpages = NULL;
1250 __be32 *p, *len;
1251 int offset;
1252 int pad;
1254 p = svcauth_gss_prepare_to_wrap(resbuf, gsd);
1255 if (p == NULL)
1256 return 0;
1257 len = p++;
1258 offset = (u8 *)p - (u8 *)resbuf->head[0].iov_base;
1259 *p++ = htonl(gc->gc_seq);
1260 inpages = resbuf->pages;
1261 /* XXX: Would be better to write some xdr helper functions for
1262 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1263 if (resbuf->tail[0].iov_base) {
1264 BUG_ON(resbuf->tail[0].iov_base >= resbuf->head[0].iov_base
1265 + PAGE_SIZE);
1266 BUG_ON(resbuf->tail[0].iov_base < resbuf->head[0].iov_base);
1267 if (resbuf->tail[0].iov_len + resbuf->head[0].iov_len
1268 + 2 * RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1269 return -ENOMEM;
1270 memmove(resbuf->tail[0].iov_base + RPC_MAX_AUTH_SIZE,
1271 resbuf->tail[0].iov_base,
1272 resbuf->tail[0].iov_len);
1273 resbuf->tail[0].iov_base += RPC_MAX_AUTH_SIZE;
1275 if (resbuf->tail[0].iov_base == NULL) {
1276 if (resbuf->head[0].iov_len + 2*RPC_MAX_AUTH_SIZE > PAGE_SIZE)
1277 return -ENOMEM;
1278 resbuf->tail[0].iov_base = resbuf->head[0].iov_base
1279 + resbuf->head[0].iov_len + RPC_MAX_AUTH_SIZE;
1280 resbuf->tail[0].iov_len = 0;
1282 if (gss_wrap(gsd->rsci->mechctx, offset, resbuf, inpages))
1283 return -ENOMEM;
1284 *len = htonl(resbuf->len - offset);
1285 pad = 3 - ((resbuf->len - offset - 1)&3);
1286 p = (__be32 *)(resbuf->tail[0].iov_base + resbuf->tail[0].iov_len);
1287 memset(p, 0, pad);
1288 resbuf->tail[0].iov_len += pad;
1289 resbuf->len += pad;
1290 return 0;
1293 static int
1294 svcauth_gss_release(struct svc_rqst *rqstp)
1296 struct gss_svc_data *gsd = (struct gss_svc_data *)rqstp->rq_auth_data;
1297 struct rpc_gss_wire_cred *gc = &gsd->clcred;
1298 struct xdr_buf *resbuf = &rqstp->rq_res;
1299 int stat = -EINVAL;
1301 if (gc->gc_proc != RPC_GSS_PROC_DATA)
1302 goto out;
1303 /* Release can be called twice, but we only wrap once. */
1304 if (gsd->verf_start == NULL)
1305 goto out;
1306 /* normally not set till svc_send, but we need it here: */
1307 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1308 * or whatever? */
1309 resbuf->len = total_buf_len(resbuf);
1310 switch (gc->gc_svc) {
1311 case RPC_GSS_SVC_NONE:
1312 break;
1313 case RPC_GSS_SVC_INTEGRITY:
1314 stat = svcauth_gss_wrap_resp_integ(rqstp);
1315 if (stat)
1316 goto out_err;
1317 break;
1318 case RPC_GSS_SVC_PRIVACY:
1319 stat = svcauth_gss_wrap_resp_priv(rqstp);
1320 if (stat)
1321 goto out_err;
1322 break;
1323 default:
1324 goto out_err;
1327 out:
1328 stat = 0;
1329 out_err:
1330 if (rqstp->rq_client)
1331 auth_domain_put(rqstp->rq_client);
1332 rqstp->rq_client = NULL;
1333 if (rqstp->rq_gssclient)
1334 auth_domain_put(rqstp->rq_gssclient);
1335 rqstp->rq_gssclient = NULL;
1336 if (rqstp->rq_cred.cr_group_info)
1337 put_group_info(rqstp->rq_cred.cr_group_info);
1338 rqstp->rq_cred.cr_group_info = NULL;
1339 if (gsd->rsci)
1340 cache_put(&gsd->rsci->h, &rsc_cache);
1341 gsd->rsci = NULL;
1343 return stat;
1346 static void
1347 svcauth_gss_domain_release(struct auth_domain *dom)
1349 struct gss_domain *gd = container_of(dom, struct gss_domain, h);
1351 kfree(dom->name);
1352 kfree(gd);
1355 static struct auth_ops svcauthops_gss = {
1356 .name = "rpcsec_gss",
1357 .owner = THIS_MODULE,
1358 .flavour = RPC_AUTH_GSS,
1359 .accept = svcauth_gss_accept,
1360 .release = svcauth_gss_release,
1361 .domain_release = svcauth_gss_domain_release,
1362 .set_client = svcauth_gss_set_client,
1366 gss_svc_init(void)
1368 int rv = svc_auth_register(RPC_AUTH_GSS, &svcauthops_gss);
1369 if (rv == 0) {
1370 cache_register(&rsc_cache);
1371 cache_register(&rsi_cache);
1373 return rv;
1376 void
1377 gss_svc_shutdown(void)
1379 if (cache_unregister(&rsc_cache))
1380 printk(KERN_ERR "auth_rpcgss: failed to unregister rsc cache\n");
1381 if (cache_unregister(&rsi_cache))
1382 printk(KERN_ERR "auth_rpcgss: failed to unregister rsi cache\n");
1383 svc_auth_unregister(RPC_AUTH_GSS);