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
);
232 rsii
.major_status
= simple_strtoul(buf
, &ep
, 10);
235 len
= qword_get(&mesg
, buf
, mlen
);
238 rsii
.minor_status
= simple_strtoul(buf
, &ep
, 10);
243 len
= qword_get(&mesg
, buf
, mlen
);
247 if (dup_to_netobj(&rsii
.out_handle
, buf
, len
))
251 len
= qword_get(&mesg
, buf
, mlen
);
256 if (dup_to_netobj(&rsii
.out_token
, buf
, len
))
259 rsii
.h
.expiry_time
= expiry
;
260 rsip
= rsi_update(&rsii
, rsip
);
265 cache_put(&rsip
->h
, &rsi_cache
);
271 static struct cache_detail rsi_cache
= {
272 .owner
= THIS_MODULE
,
273 .hash_size
= RSI_HASHMAX
,
274 .hash_table
= rsi_table
,
275 .name
= "auth.rpcsec.init",
276 .cache_put
= rsi_put
,
277 .cache_request
= rsi_request
,
278 .cache_parse
= rsi_parse
,
281 .update
= update_rsi
,
285 static struct rsi
*rsi_lookup(struct rsi
*item
)
287 struct cache_head
*ch
;
288 int hash
= rsi_hash(item
);
290 ch
= sunrpc_cache_lookup(&rsi_cache
, &item
->h
, hash
);
292 return container_of(ch
, struct rsi
, h
);
297 static struct rsi
*rsi_update(struct rsi
*new, struct rsi
*old
)
299 struct cache_head
*ch
;
300 int hash
= rsi_hash(new);
302 ch
= sunrpc_cache_update(&rsi_cache
, &new->h
,
305 return container_of(ch
, struct rsi
, h
);
312 * The rpcsec_context cache is used to store a context that is
313 * used in data exchange.
314 * The key is a context handle. The content is:
315 * uid, gidlist, mechanism, service-set, mech-specific-data
318 #define RSC_HASHBITS 10
319 #define RSC_HASHMAX (1<<RSC_HASHBITS)
320 #define RSC_HASHMASK (RSC_HASHMAX-1)
322 #define GSS_SEQ_WIN 128
324 struct gss_svc_seq_data
{
325 /* highest seq number seen so far: */
327 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
328 * sd_win is nonzero iff sequence number i has been seen already: */
329 unsigned long sd_win
[GSS_SEQ_WIN
/BITS_PER_LONG
];
335 struct xdr_netobj handle
;
336 struct svc_cred cred
;
337 struct gss_svc_seq_data seqdata
;
338 struct gss_ctx
*mechctx
;
341 static struct cache_head
*rsc_table
[RSC_HASHMAX
];
342 static struct cache_detail rsc_cache
;
343 static struct rsc
*rsc_update(struct rsc
*new, struct rsc
*old
);
344 static struct rsc
*rsc_lookup(struct rsc
*item
);
346 static void rsc_free(struct rsc
*rsci
)
348 kfree(rsci
->handle
.data
);
350 gss_delete_sec_context(&rsci
->mechctx
);
351 if (rsci
->cred
.cr_group_info
)
352 put_group_info(rsci
->cred
.cr_group_info
);
355 static void rsc_put(struct kref
*ref
)
357 struct rsc
*rsci
= container_of(ref
, struct rsc
, h
.ref
);
364 rsc_hash(struct rsc
*rsci
)
366 return hash_mem(rsci
->handle
.data
, rsci
->handle
.len
, RSC_HASHBITS
);
370 rsc_match(struct cache_head
*a
, struct cache_head
*b
)
372 struct rsc
*new = container_of(a
, struct rsc
, h
);
373 struct rsc
*tmp
= container_of(b
, struct rsc
, h
);
375 return netobj_equal(&new->handle
, &tmp
->handle
);
379 rsc_init(struct cache_head
*cnew
, struct cache_head
*ctmp
)
381 struct rsc
*new = container_of(cnew
, struct rsc
, h
);
382 struct rsc
*tmp
= container_of(ctmp
, struct rsc
, h
);
384 new->handle
.len
= tmp
->handle
.len
;
386 new->handle
.data
= tmp
->handle
.data
;
387 tmp
->handle
.data
= NULL
;
389 new->cred
.cr_group_info
= NULL
;
393 update_rsc(struct cache_head
*cnew
, struct cache_head
*ctmp
)
395 struct rsc
*new = container_of(cnew
, struct rsc
, h
);
396 struct rsc
*tmp
= container_of(ctmp
, struct rsc
, h
);
398 new->mechctx
= tmp
->mechctx
;
400 memset(&new->seqdata
, 0, sizeof(new->seqdata
));
401 spin_lock_init(&new->seqdata
.sd_lock
);
402 new->cred
= tmp
->cred
;
403 tmp
->cred
.cr_group_info
= NULL
;
406 static struct cache_head
*
409 struct rsc
*rsci
= kmalloc(sizeof(*rsci
), GFP_KERNEL
);
416 static int rsc_parse(struct cache_detail
*cd
,
417 char *mesg
, int mlen
)
419 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
422 struct rsc rsci
, *rscp
= NULL
;
424 int status
= -EINVAL
;
425 struct gss_api_mech
*gm
= NULL
;
427 memset(&rsci
, 0, sizeof(rsci
));
429 len
= qword_get(&mesg
, buf
, mlen
);
430 if (len
< 0) goto out
;
432 if (dup_to_netobj(&rsci
.handle
, buf
, len
))
437 expiry
= get_expiry(&mesg
);
442 rscp
= rsc_lookup(&rsci
);
446 /* uid, or NEGATIVE */
447 rv
= get_int(&mesg
, &rsci
.cred
.cr_uid
);
451 set_bit(CACHE_NEGATIVE
, &rsci
.h
.flags
);
456 if (get_int(&mesg
, &rsci
.cred
.cr_gid
))
459 /* number of additional gid's */
460 if (get_int(&mesg
, &N
))
463 rsci
.cred
.cr_group_info
= groups_alloc(N
);
464 if (rsci
.cred
.cr_group_info
== NULL
)
469 for (i
=0; i
<N
; i
++) {
471 if (get_int(&mesg
, &gid
))
473 GROUP_AT(rsci
.cred
.cr_group_info
, i
) = gid
;
477 len
= qword_get(&mesg
, buf
, mlen
);
480 gm
= gss_mech_get_by_name(buf
);
481 status
= -EOPNOTSUPP
;
486 /* mech-specific data: */
487 len
= qword_get(&mesg
, buf
, mlen
);
490 status
= gss_import_sec_context(buf
, len
, gm
, &rsci
.mechctx
);
494 rsci
.h
.expiry_time
= expiry
;
495 rscp
= rsc_update(&rsci
, rscp
);
501 cache_put(&rscp
->h
, &rsc_cache
);
507 static struct cache_detail rsc_cache
= {
508 .owner
= THIS_MODULE
,
509 .hash_size
= RSC_HASHMAX
,
510 .hash_table
= rsc_table
,
511 .name
= "auth.rpcsec.context",
512 .cache_put
= rsc_put
,
513 .cache_parse
= rsc_parse
,
516 .update
= update_rsc
,
520 static struct rsc
*rsc_lookup(struct rsc
*item
)
522 struct cache_head
*ch
;
523 int hash
= rsc_hash(item
);
525 ch
= sunrpc_cache_lookup(&rsc_cache
, &item
->h
, hash
);
527 return container_of(ch
, struct rsc
, h
);
532 static struct rsc
*rsc_update(struct rsc
*new, struct rsc
*old
)
534 struct cache_head
*ch
;
535 int hash
= rsc_hash(new);
537 ch
= sunrpc_cache_update(&rsc_cache
, &new->h
,
540 return container_of(ch
, struct rsc
, h
);
547 gss_svc_searchbyctx(struct xdr_netobj
*handle
)
552 memset(&rsci
, 0, sizeof(rsci
));
553 if (dup_to_netobj(&rsci
.handle
, handle
->data
, handle
->len
))
555 found
= rsc_lookup(&rsci
);
559 if (cache_check(&rsc_cache
, &found
->h
, NULL
))
564 /* Implements sequence number algorithm as specified in RFC 2203. */
566 gss_check_seq_num(struct rsc
*rsci
, int seq_num
)
568 struct gss_svc_seq_data
*sd
= &rsci
->seqdata
;
570 spin_lock(&sd
->sd_lock
);
571 if (seq_num
> sd
->sd_max
) {
572 if (seq_num
>= sd
->sd_max
+ GSS_SEQ_WIN
) {
573 memset(sd
->sd_win
,0,sizeof(sd
->sd_win
));
574 sd
->sd_max
= seq_num
;
575 } else while (sd
->sd_max
< seq_num
) {
577 __clear_bit(sd
->sd_max
% GSS_SEQ_WIN
, sd
->sd_win
);
579 __set_bit(seq_num
% GSS_SEQ_WIN
, sd
->sd_win
);
581 } else if (seq_num
<= sd
->sd_max
- GSS_SEQ_WIN
) {
584 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
585 if (__test_and_set_bit(seq_num
% GSS_SEQ_WIN
, sd
->sd_win
))
588 spin_unlock(&sd
->sd_lock
);
591 spin_unlock(&sd
->sd_lock
);
595 static inline u32
round_up_to_quad(u32 i
)
597 return (i
+ 3 ) & ~3;
601 svc_safe_getnetobj(struct kvec
*argv
, struct xdr_netobj
*o
)
605 if (argv
->iov_len
< 4)
607 o
->len
= svc_getnl(argv
);
608 l
= round_up_to_quad(o
->len
);
609 if (argv
->iov_len
< l
)
611 o
->data
= argv
->iov_base
;
618 svc_safe_putnetobj(struct kvec
*resv
, struct xdr_netobj
*o
)
622 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
624 svc_putnl(resv
, o
->len
);
625 p
= resv
->iov_base
+ resv
->iov_len
;
626 resv
->iov_len
+= round_up_to_quad(o
->len
);
627 if (resv
->iov_len
> PAGE_SIZE
)
629 memcpy(p
, o
->data
, o
->len
);
630 memset(p
+ o
->len
, 0, round_up_to_quad(o
->len
) - o
->len
);
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.
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
;
647 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
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)
658 flavor
= svc_getnl(argv
);
659 if (flavor
!= RPC_AUTH_GSS
)
661 if (svc_safe_getnetobj(argv
, &checksum
))
664 if (rqstp
->rq_deferred
) /* skip verification of revisited request */
666 if (gss_verify_mic(ctx_id
, &rpchdr
, &checksum
) != GSS_S_COMPLETE
) {
667 *authp
= rpcsec_gsserr_credproblem
;
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
;
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
);
686 gss_write_null_verf(struct svc_rqst
*rqstp
)
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 ... */
694 if (!xdr_ressize_check(rqstp
, p
))
700 gss_write_verf(struct svc_rqst
*rqstp
, struct gss_ctx
*ctx_id
, u32 seq
)
704 struct xdr_buf verf_data
;
705 struct xdr_netobj mic
;
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
)
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
))
729 struct auth_domain h
;
733 static struct auth_domain
*
734 find_gss_auth_domain(struct gss_ctx
*ctx
, u32 svc
)
738 name
= gss_service_to_auth_domain_name(ctx
->mech_type
, svc
);
741 return auth_domain_find(name
);
744 static struct auth_ops svcauthops_gss
;
746 u32
svcauth_gss_flavor(struct auth_domain
*dom
)
748 struct gss_domain
*gd
= container_of(dom
, struct gss_domain
, h
);
750 return gd
->pseudoflavor
;
753 EXPORT_SYMBOL(svcauth_gss_flavor
);
756 svcauth_gss_register_pseudoflavor(u32 pseudoflavor
, char * name
)
758 struct gss_domain
*new;
759 struct auth_domain
*test
;
762 new = kmalloc(sizeof(*new), GFP_KERNEL
);
765 kref_init(&new->h
.ref
);
766 new->h
.name
= kstrdup(name
, GFP_KERNEL
);
769 new->h
.flavour
= &svcauthops_gss
;
770 new->pseudoflavor
= pseudoflavor
;
773 test
= auth_domain_lookup(name
, &new->h
);
774 if (test
!= &new->h
) { /* Duplicate registration */
775 auth_domain_put(test
);
787 EXPORT_SYMBOL(svcauth_gss_register_pseudoflavor
);
790 read_u32_from_xdr_buf(struct xdr_buf
*buf
, int base
, u32
*obj
)
795 status
= read_bytes_from_xdr_buf(buf
, base
, &raw
, sizeof(*obj
));
802 /* It would be nice if this bit of code could be shared with the client.
804 * The client shouldn't malloc(), would have to pass in own memory.
805 * The server uses base of head iovec as read pointer, while the
806 * client uses separate pointer. */
808 unwrap_integ_data(struct xdr_buf
*buf
, u32 seq
, struct gss_ctx
*ctx
)
811 u32 integ_len
, maj_stat
;
812 struct xdr_netobj mic
;
813 struct xdr_buf integ_buf
;
815 integ_len
= svc_getnl(&buf
->head
[0]);
818 if (integ_len
> buf
->len
)
820 if (xdr_buf_subsegment(buf
, &integ_buf
, 0, integ_len
))
822 /* copy out mic... */
823 if (read_u32_from_xdr_buf(buf
, integ_len
, &mic
.len
))
825 if (mic
.len
> RPC_MAX_AUTH_SIZE
)
827 mic
.data
= kmalloc(mic
.len
, GFP_KERNEL
);
830 if (read_bytes_from_xdr_buf(buf
, integ_len
+ 4, mic
.data
, mic
.len
))
832 maj_stat
= gss_verify_mic(ctx
, &integ_buf
, &mic
);
833 if (maj_stat
!= GSS_S_COMPLETE
)
835 if (svc_getnl(&buf
->head
[0]) != seq
)
844 total_buf_len(struct xdr_buf
*buf
)
846 return buf
->head
[0].iov_len
+ buf
->page_len
+ buf
->tail
[0].iov_len
;
850 fix_priv_head(struct xdr_buf
*buf
, int pad
)
852 if (buf
->page_len
== 0) {
853 /* We need to adjust head and buf->len in tandem in this
854 * case to make svc_defer() work--it finds the original
855 * buffer start using buf->len - buf->head[0].iov_len. */
856 buf
->head
[0].iov_len
-= pad
;
861 unwrap_priv_data(struct svc_rqst
*rqstp
, struct xdr_buf
*buf
, u32 seq
, struct gss_ctx
*ctx
)
863 u32 priv_len
, maj_stat
;
864 int pad
, saved_len
, remaining_len
, offset
;
866 rqstp
->rq_splice_ok
= 0;
868 priv_len
= svc_getnl(&buf
->head
[0]);
869 if (rqstp
->rq_deferred
) {
870 /* Already decrypted last time through! The sequence number
871 * check at out_seq is unnecessary but harmless: */
874 /* buf->len is the number of bytes from the original start of the
875 * request to the end, where head[0].iov_len is just the bytes
876 * not yet read from the head, so these two values are different: */
877 remaining_len
= total_buf_len(buf
);
878 if (priv_len
> remaining_len
)
880 pad
= remaining_len
- priv_len
;
882 fix_priv_head(buf
, pad
);
884 /* Maybe it would be better to give gss_unwrap a length parameter: */
885 saved_len
= buf
->len
;
887 maj_stat
= gss_unwrap(ctx
, 0, buf
);
888 pad
= priv_len
- buf
->len
;
889 buf
->len
= saved_len
;
891 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
892 * In the krb5p case, at least, the data ends up offset, so we need to
894 /* XXX: This is very inefficient. It would be better to either do
895 * this while we encrypt, or maybe in the receive code, if we can peak
896 * ahead and work out the service and mechanism there. */
897 offset
= buf
->head
[0].iov_len
% 4;
899 buf
->buflen
= RPCSVC_MAXPAYLOAD
;
900 xdr_shift_buf(buf
, offset
);
901 fix_priv_head(buf
, pad
);
903 if (maj_stat
!= GSS_S_COMPLETE
)
906 if (svc_getnl(&buf
->head
[0]) != seq
)
911 struct gss_svc_data
{
912 /* decoded gss client cred: */
913 struct rpc_gss_wire_cred clcred
;
914 /* save a pointer to the beginning of the encoded verifier,
915 * for use in encryption/checksumming in svcauth_gss_release: */
921 svcauth_gss_set_client(struct svc_rqst
*rqstp
)
923 struct gss_svc_data
*svcdata
= rqstp
->rq_auth_data
;
924 struct rsc
*rsci
= svcdata
->rsci
;
925 struct rpc_gss_wire_cred
*gc
= &svcdata
->clcred
;
929 * A gss export can be specified either by:
930 * export *(sec=krb5,rw)
932 * export gss/krb5(rw)
933 * The latter is deprecated; but for backwards compatibility reasons
934 * the nfsd code will still fall back on trying it if the former
935 * doesn't work; so we try to make both available to nfsd, below.
937 rqstp
->rq_gssclient
= find_gss_auth_domain(rsci
->mechctx
, gc
->gc_svc
);
938 if (rqstp
->rq_gssclient
== NULL
)
940 stat
= svcauth_unix_set_client(rqstp
);
941 if (stat
== SVC_DROP
)
947 gss_write_init_verf(struct svc_rqst
*rqstp
, struct rsi
*rsip
)
952 if (rsip
->major_status
!= GSS_S_COMPLETE
)
953 return gss_write_null_verf(rqstp
);
954 rsci
= gss_svc_searchbyctx(&rsip
->out_handle
);
956 rsip
->major_status
= GSS_S_NO_CONTEXT
;
957 return gss_write_null_verf(rqstp
);
959 rc
= gss_write_verf(rqstp
, rsci
->mechctx
, GSS_SEQ_WIN
);
960 cache_put(&rsci
->h
, &rsc_cache
);
965 * Having read the cred already and found we're in the context
966 * initiation case, read the verifier and initiate (or check the results
967 * of) upcalls to userspace for help with context initiation. If
968 * the upcall results are available, write the verifier and result.
969 * Otherwise, drop the request pending an answer to the upcall.
971 static int svcauth_gss_handle_init(struct svc_rqst
*rqstp
,
972 struct rpc_gss_wire_cred
*gc
, __be32
*authp
)
974 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
975 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
976 struct xdr_netobj tmpobj
;
977 struct rsi
*rsip
, rsikey
;
979 /* Read the verifier; should be NULL: */
980 *authp
= rpc_autherr_badverf
;
981 if (argv
->iov_len
< 2 * 4)
983 if (svc_getnl(argv
) != RPC_AUTH_NULL
)
985 if (svc_getnl(argv
) != 0)
988 /* Martial context handle and token for upcall: */
989 *authp
= rpc_autherr_badcred
;
990 if (gc
->gc_proc
== RPC_GSS_PROC_INIT
&& gc
->gc_ctx
.len
!= 0)
992 memset(&rsikey
, 0, sizeof(rsikey
));
993 if (dup_netobj(&rsikey
.in_handle
, &gc
->gc_ctx
))
995 *authp
= rpc_autherr_badverf
;
996 if (svc_safe_getnetobj(argv
, &tmpobj
)) {
997 kfree(rsikey
.in_handle
.data
);
1000 if (dup_netobj(&rsikey
.in_token
, &tmpobj
)) {
1001 kfree(rsikey
.in_handle
.data
);
1005 /* Perform upcall, or find upcall result: */
1006 rsip
= rsi_lookup(&rsikey
);
1010 switch (cache_check(&rsi_cache
, &rsip
->h
, &rqstp
->rq_chandle
)) {
1014 /* No upcall result: */
1017 /* Got an answer to the upcall; use it: */
1018 if (gss_write_init_verf(rqstp
, rsip
))
1020 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
1022 svc_putnl(resv
, RPC_SUCCESS
);
1023 if (svc_safe_putnetobj(resv
, &rsip
->out_handle
))
1025 if (resv
->iov_len
+ 3 * 4 > PAGE_SIZE
)
1027 svc_putnl(resv
, rsip
->major_status
);
1028 svc_putnl(resv
, rsip
->minor_status
);
1029 svc_putnl(resv
, GSS_SEQ_WIN
);
1030 if (svc_safe_putnetobj(resv
, &rsip
->out_token
))
1033 return SVC_COMPLETE
;
1037 * Accept an rpcsec packet.
1038 * If context establishment, punt to user space
1039 * If data exchange, verify/decrypt
1040 * If context destruction, handle here
1041 * In the context establishment and destruction case we encode
1042 * response here and return SVC_COMPLETE.
1045 svcauth_gss_accept(struct svc_rqst
*rqstp
, __be32
*authp
)
1047 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
1048 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
1050 struct gss_svc_data
*svcdata
= rqstp
->rq_auth_data
;
1051 struct rpc_gss_wire_cred
*gc
;
1052 struct rsc
*rsci
= NULL
;
1054 __be32
*reject_stat
= resv
->iov_base
+ resv
->iov_len
;
1057 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
1060 *authp
= rpc_autherr_badcred
;
1062 svcdata
= kmalloc(sizeof(*svcdata
), GFP_KERNEL
);
1065 rqstp
->rq_auth_data
= svcdata
;
1066 svcdata
->verf_start
= NULL
;
1067 svcdata
->rsci
= NULL
;
1068 gc
= &svcdata
->clcred
;
1070 /* start of rpc packet is 7 u32's back from here:
1071 * xid direction rpcversion prog vers proc flavour
1073 rpcstart
= argv
->iov_base
;
1077 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1078 * at least 5 u32s, and is preceeded by length, so that makes 6.
1081 if (argv
->iov_len
< 5 * 4)
1083 crlen
= svc_getnl(argv
);
1084 if (svc_getnl(argv
) != RPC_GSS_VERSION
)
1086 gc
->gc_proc
= svc_getnl(argv
);
1087 gc
->gc_seq
= svc_getnl(argv
);
1088 gc
->gc_svc
= svc_getnl(argv
);
1089 if (svc_safe_getnetobj(argv
, &gc
->gc_ctx
))
1091 if (crlen
!= round_up_to_quad(gc
->gc_ctx
.len
) + 5 * 4)
1094 if ((gc
->gc_proc
!= RPC_GSS_PROC_DATA
) && (rqstp
->rq_proc
!= 0))
1097 *authp
= rpc_autherr_badverf
;
1098 switch (gc
->gc_proc
) {
1099 case RPC_GSS_PROC_INIT
:
1100 case RPC_GSS_PROC_CONTINUE_INIT
:
1101 return svcauth_gss_handle_init(rqstp
, gc
, authp
);
1102 case RPC_GSS_PROC_DATA
:
1103 case RPC_GSS_PROC_DESTROY
:
1104 /* Look up the context, and check the verifier: */
1105 *authp
= rpcsec_gsserr_credproblem
;
1106 rsci
= gss_svc_searchbyctx(&gc
->gc_ctx
);
1109 switch (gss_verify_header(rqstp
, rsci
, rpcstart
, gc
, authp
)) {
1119 *authp
= rpc_autherr_rejectedcred
;
1123 /* now act upon the command: */
1124 switch (gc
->gc_proc
) {
1125 case RPC_GSS_PROC_DESTROY
:
1126 if (gss_write_verf(rqstp
, rsci
->mechctx
, gc
->gc_seq
))
1128 set_bit(CACHE_NEGATIVE
, &rsci
->h
.flags
);
1129 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
1131 svc_putnl(resv
, RPC_SUCCESS
);
1133 case RPC_GSS_PROC_DATA
:
1134 *authp
= rpcsec_gsserr_ctxproblem
;
1135 svcdata
->verf_start
= resv
->iov_base
+ resv
->iov_len
;
1136 if (gss_write_verf(rqstp
, rsci
->mechctx
, gc
->gc_seq
))
1138 rqstp
->rq_cred
= rsci
->cred
;
1139 get_group_info(rsci
->cred
.cr_group_info
);
1140 *authp
= rpc_autherr_badcred
;
1141 switch (gc
->gc_svc
) {
1142 case RPC_GSS_SVC_NONE
:
1144 case RPC_GSS_SVC_INTEGRITY
:
1145 if (unwrap_integ_data(&rqstp
->rq_arg
,
1146 gc
->gc_seq
, rsci
->mechctx
))
1148 /* placeholders for length and seq. number: */
1152 case RPC_GSS_SVC_PRIVACY
:
1153 if (unwrap_priv_data(rqstp
, &rqstp
->rq_arg
,
1154 gc
->gc_seq
, rsci
->mechctx
))
1156 /* placeholders for length and seq. number: */
1163 svcdata
->rsci
= rsci
;
1164 cache_get(&rsci
->h
);
1165 rqstp
->rq_flavor
= gss_svc_to_pseudoflavor(
1166 rsci
->mechctx
->mech_type
, gc
->gc_svc
);
1171 /* Restore write pointer to its original value: */
1172 xdr_ressize_check(rqstp
, reject_stat
);
1182 cache_put(&rsci
->h
, &rsc_cache
);
1187 svcauth_gss_prepare_to_wrap(struct xdr_buf
*resbuf
, struct gss_svc_data
*gsd
)
1192 p
= gsd
->verf_start
;
1193 gsd
->verf_start
= NULL
;
1195 /* If the reply stat is nonzero, don't wrap: */
1196 if (*(p
-1) != rpc_success
)
1198 /* Skip the verifier: */
1200 verf_len
= ntohl(*p
++);
1201 p
+= XDR_QUADLEN(verf_len
);
1202 /* move accept_stat to right place: */
1203 memcpy(p
, p
+ 2, 4);
1204 /* Also don't wrap if the accept stat is nonzero: */
1205 if (*p
!= rpc_success
) {
1206 resbuf
->head
[0].iov_len
-= 2 * 4;
1214 svcauth_gss_wrap_resp_integ(struct svc_rqst
*rqstp
)
1216 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1217 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1218 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1219 struct xdr_buf integ_buf
;
1220 struct xdr_netobj mic
;
1223 int integ_offset
, integ_len
;
1226 p
= svcauth_gss_prepare_to_wrap(resbuf
, gsd
);
1229 integ_offset
= (u8
*)(p
+ 1) - (u8
*)resbuf
->head
[0].iov_base
;
1230 integ_len
= resbuf
->len
- integ_offset
;
1231 BUG_ON(integ_len
% 4);
1232 *p
++ = htonl(integ_len
);
1233 *p
++ = htonl(gc
->gc_seq
);
1234 if (xdr_buf_subsegment(resbuf
, &integ_buf
, integ_offset
,
1237 if (resbuf
->tail
[0].iov_base
== NULL
) {
1238 if (resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1240 resbuf
->tail
[0].iov_base
= resbuf
->head
[0].iov_base
1241 + resbuf
->head
[0].iov_len
;
1242 resbuf
->tail
[0].iov_len
= 0;
1243 resv
= &resbuf
->tail
[0];
1245 resv
= &resbuf
->tail
[0];
1247 mic
.data
= (u8
*)resv
->iov_base
+ resv
->iov_len
+ 4;
1248 if (gss_get_mic(gsd
->rsci
->mechctx
, &integ_buf
, &mic
))
1250 svc_putnl(resv
, mic
.len
);
1251 memset(mic
.data
+ mic
.len
, 0,
1252 round_up_to_quad(mic
.len
) - mic
.len
);
1253 resv
->iov_len
+= XDR_QUADLEN(mic
.len
) << 2;
1254 /* not strictly required: */
1255 resbuf
->len
+= XDR_QUADLEN(mic
.len
) << 2;
1256 BUG_ON(resv
->iov_len
> PAGE_SIZE
);
1264 svcauth_gss_wrap_resp_priv(struct svc_rqst
*rqstp
)
1266 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1267 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1268 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1269 struct page
**inpages
= NULL
;
1274 p
= svcauth_gss_prepare_to_wrap(resbuf
, gsd
);
1278 offset
= (u8
*)p
- (u8
*)resbuf
->head
[0].iov_base
;
1279 *p
++ = htonl(gc
->gc_seq
);
1280 inpages
= resbuf
->pages
;
1281 /* XXX: Would be better to write some xdr helper functions for
1282 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1283 if (resbuf
->tail
[0].iov_base
) {
1284 BUG_ON(resbuf
->tail
[0].iov_base
>= resbuf
->head
[0].iov_base
1286 BUG_ON(resbuf
->tail
[0].iov_base
< resbuf
->head
[0].iov_base
);
1287 if (resbuf
->tail
[0].iov_len
+ resbuf
->head
[0].iov_len
1288 + 2 * RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1290 memmove(resbuf
->tail
[0].iov_base
+ RPC_MAX_AUTH_SIZE
,
1291 resbuf
->tail
[0].iov_base
,
1292 resbuf
->tail
[0].iov_len
);
1293 resbuf
->tail
[0].iov_base
+= RPC_MAX_AUTH_SIZE
;
1295 if (resbuf
->tail
[0].iov_base
== NULL
) {
1296 if (resbuf
->head
[0].iov_len
+ 2*RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1298 resbuf
->tail
[0].iov_base
= resbuf
->head
[0].iov_base
1299 + resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
;
1300 resbuf
->tail
[0].iov_len
= 0;
1302 if (gss_wrap(gsd
->rsci
->mechctx
, offset
, resbuf
, inpages
))
1304 *len
= htonl(resbuf
->len
- offset
);
1305 pad
= 3 - ((resbuf
->len
- offset
- 1)&3);
1306 p
= (__be32
*)(resbuf
->tail
[0].iov_base
+ resbuf
->tail
[0].iov_len
);
1308 resbuf
->tail
[0].iov_len
+= pad
;
1314 svcauth_gss_release(struct svc_rqst
*rqstp
)
1316 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1317 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1318 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1321 if (gc
->gc_proc
!= RPC_GSS_PROC_DATA
)
1323 /* Release can be called twice, but we only wrap once. */
1324 if (gsd
->verf_start
== NULL
)
1326 /* normally not set till svc_send, but we need it here: */
1327 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1329 resbuf
->len
= total_buf_len(resbuf
);
1330 switch (gc
->gc_svc
) {
1331 case RPC_GSS_SVC_NONE
:
1333 case RPC_GSS_SVC_INTEGRITY
:
1334 stat
= svcauth_gss_wrap_resp_integ(rqstp
);
1338 case RPC_GSS_SVC_PRIVACY
:
1339 stat
= svcauth_gss_wrap_resp_priv(rqstp
);
1350 if (rqstp
->rq_client
)
1351 auth_domain_put(rqstp
->rq_client
);
1352 rqstp
->rq_client
= NULL
;
1353 if (rqstp
->rq_gssclient
)
1354 auth_domain_put(rqstp
->rq_gssclient
);
1355 rqstp
->rq_gssclient
= NULL
;
1356 if (rqstp
->rq_cred
.cr_group_info
)
1357 put_group_info(rqstp
->rq_cred
.cr_group_info
);
1358 rqstp
->rq_cred
.cr_group_info
= NULL
;
1360 cache_put(&gsd
->rsci
->h
, &rsc_cache
);
1367 svcauth_gss_domain_release(struct auth_domain
*dom
)
1369 struct gss_domain
*gd
= container_of(dom
, struct gss_domain
, h
);
1375 static struct auth_ops svcauthops_gss
= {
1376 .name
= "rpcsec_gss",
1377 .owner
= THIS_MODULE
,
1378 .flavour
= RPC_AUTH_GSS
,
1379 .accept
= svcauth_gss_accept
,
1380 .release
= svcauth_gss_release
,
1381 .domain_release
= svcauth_gss_domain_release
,
1382 .set_client
= svcauth_gss_set_client
,
1388 int rv
= svc_auth_register(RPC_AUTH_GSS
, &svcauthops_gss
);
1390 cache_register(&rsc_cache
);
1391 cache_register(&rsi_cache
);
1397 gss_svc_shutdown(void)
1399 if (cache_unregister(&rsc_cache
))
1400 printk(KERN_ERR
"auth_rpcgss: failed to unregister rsc cache\n");
1401 if (cache_unregister(&rsi_cache
))
1402 printk(KERN_ERR
"auth_rpcgss: failed to unregister rsi cache\n");
1403 svc_auth_unregister(RPC_AUTH_GSS
);