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
);
634 /* Verify the checksum on the header and return SVC_OK on success.
635 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
636 * or return SVC_DENIED and indicate error in authp.
639 gss_verify_header(struct svc_rqst
*rqstp
, struct rsc
*rsci
,
640 __be32
*rpcstart
, struct rpc_gss_wire_cred
*gc
, __be32
*authp
)
642 struct gss_ctx
*ctx_id
= rsci
->mechctx
;
643 struct xdr_buf rpchdr
;
644 struct xdr_netobj checksum
;
646 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
649 /* data to compute the checksum over: */
650 iov
.iov_base
= rpcstart
;
651 iov
.iov_len
= (u8
*)argv
->iov_base
- (u8
*)rpcstart
;
652 xdr_buf_from_iov(&iov
, &rpchdr
);
654 *authp
= rpc_autherr_badverf
;
655 if (argv
->iov_len
< 4)
657 flavor
= svc_getnl(argv
);
658 if (flavor
!= RPC_AUTH_GSS
)
660 if (svc_safe_getnetobj(argv
, &checksum
))
663 if (rqstp
->rq_deferred
) /* skip verification of revisited request */
665 if (gss_verify_mic(ctx_id
, &rpchdr
, &checksum
) != GSS_S_COMPLETE
) {
666 *authp
= rpcsec_gsserr_credproblem
;
670 if (gc
->gc_seq
> MAXSEQ
) {
671 dprintk("RPC: svcauth_gss: discarding request with "
672 "large sequence number %d\n", gc
->gc_seq
);
673 *authp
= rpcsec_gsserr_ctxproblem
;
676 if (!gss_check_seq_num(rsci
, gc
->gc_seq
)) {
677 dprintk("RPC: svcauth_gss: discarding request with "
678 "old sequence number %d\n", gc
->gc_seq
);
685 gss_write_null_verf(struct svc_rqst
*rqstp
)
689 svc_putnl(rqstp
->rq_res
.head
, RPC_AUTH_NULL
);
690 p
= rqstp
->rq_res
.head
->iov_base
+ rqstp
->rq_res
.head
->iov_len
;
691 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
693 if (!xdr_ressize_check(rqstp
, p
))
699 gss_write_verf(struct svc_rqst
*rqstp
, struct gss_ctx
*ctx_id
, u32 seq
)
703 struct xdr_buf verf_data
;
704 struct xdr_netobj mic
;
708 svc_putnl(rqstp
->rq_res
.head
, RPC_AUTH_GSS
);
709 xdr_seq
= htonl(seq
);
711 iov
.iov_base
= &xdr_seq
;
712 iov
.iov_len
= sizeof(xdr_seq
);
713 xdr_buf_from_iov(&iov
, &verf_data
);
714 p
= rqstp
->rq_res
.head
->iov_base
+ rqstp
->rq_res
.head
->iov_len
;
715 mic
.data
= (u8
*)(p
+ 1);
716 maj_stat
= gss_get_mic(ctx_id
, &verf_data
, &mic
);
717 if (maj_stat
!= GSS_S_COMPLETE
)
719 *p
++ = htonl(mic
.len
);
720 memset((u8
*)p
+ mic
.len
, 0, round_up_to_quad(mic
.len
) - mic
.len
);
721 p
+= XDR_QUADLEN(mic
.len
);
722 if (!xdr_ressize_check(rqstp
, p
))
728 struct auth_domain h
;
732 static struct auth_domain
*
733 find_gss_auth_domain(struct gss_ctx
*ctx
, u32 svc
)
737 name
= gss_service_to_auth_domain_name(ctx
->mech_type
, svc
);
740 return auth_domain_find(name
);
743 static struct auth_ops svcauthops_gss
;
745 u32
svcauth_gss_flavor(struct auth_domain
*dom
)
747 struct gss_domain
*gd
= container_of(dom
, struct gss_domain
, h
);
749 return gd
->pseudoflavor
;
752 EXPORT_SYMBOL(svcauth_gss_flavor
);
755 svcauth_gss_register_pseudoflavor(u32 pseudoflavor
, char * name
)
757 struct gss_domain
*new;
758 struct auth_domain
*test
;
761 new = kmalloc(sizeof(*new), GFP_KERNEL
);
764 kref_init(&new->h
.ref
);
765 new->h
.name
= kstrdup(name
, GFP_KERNEL
);
768 new->h
.flavour
= &svcauthops_gss
;
769 new->pseudoflavor
= pseudoflavor
;
772 test
= auth_domain_lookup(name
, &new->h
);
773 if (test
!= &new->h
) { /* Duplicate registration */
774 auth_domain_put(test
);
786 EXPORT_SYMBOL(svcauth_gss_register_pseudoflavor
);
789 read_u32_from_xdr_buf(struct xdr_buf
*buf
, int base
, u32
*obj
)
794 status
= read_bytes_from_xdr_buf(buf
, base
, &raw
, sizeof(*obj
));
801 /* It would be nice if this bit of code could be shared with the client.
803 * The client shouldn't malloc(), would have to pass in own memory.
804 * The server uses base of head iovec as read pointer, while the
805 * client uses separate pointer. */
807 unwrap_integ_data(struct xdr_buf
*buf
, u32 seq
, struct gss_ctx
*ctx
)
810 u32 integ_len
, maj_stat
;
811 struct xdr_netobj mic
;
812 struct xdr_buf integ_buf
;
814 integ_len
= svc_getnl(&buf
->head
[0]);
817 if (integ_len
> buf
->len
)
819 if (xdr_buf_subsegment(buf
, &integ_buf
, 0, integ_len
))
821 /* copy out mic... */
822 if (read_u32_from_xdr_buf(buf
, integ_len
, &mic
.len
))
824 if (mic
.len
> RPC_MAX_AUTH_SIZE
)
826 mic
.data
= kmalloc(mic
.len
, GFP_KERNEL
);
829 if (read_bytes_from_xdr_buf(buf
, integ_len
+ 4, mic
.data
, mic
.len
))
831 maj_stat
= gss_verify_mic(ctx
, &integ_buf
, &mic
);
832 if (maj_stat
!= GSS_S_COMPLETE
)
834 if (svc_getnl(&buf
->head
[0]) != seq
)
843 total_buf_len(struct xdr_buf
*buf
)
845 return buf
->head
[0].iov_len
+ buf
->page_len
+ buf
->tail
[0].iov_len
;
849 fix_priv_head(struct xdr_buf
*buf
, int pad
)
851 if (buf
->page_len
== 0) {
852 /* We need to adjust head and buf->len in tandem in this
853 * case to make svc_defer() work--it finds the original
854 * buffer start using buf->len - buf->head[0].iov_len. */
855 buf
->head
[0].iov_len
-= pad
;
860 unwrap_priv_data(struct svc_rqst
*rqstp
, struct xdr_buf
*buf
, u32 seq
, struct gss_ctx
*ctx
)
862 u32 priv_len
, maj_stat
;
863 int pad
, saved_len
, remaining_len
, offset
;
865 rqstp
->rq_splice_ok
= 0;
867 priv_len
= svc_getnl(&buf
->head
[0]);
868 if (rqstp
->rq_deferred
) {
869 /* Already decrypted last time through! The sequence number
870 * check at out_seq is unnecessary but harmless: */
873 /* buf->len is the number of bytes from the original start of the
874 * request to the end, where head[0].iov_len is just the bytes
875 * not yet read from the head, so these two values are different: */
876 remaining_len
= total_buf_len(buf
);
877 if (priv_len
> remaining_len
)
879 pad
= remaining_len
- priv_len
;
881 fix_priv_head(buf
, pad
);
883 /* Maybe it would be better to give gss_unwrap a length parameter: */
884 saved_len
= buf
->len
;
886 maj_stat
= gss_unwrap(ctx
, 0, buf
);
887 pad
= priv_len
- buf
->len
;
888 buf
->len
= saved_len
;
890 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
891 * In the krb5p case, at least, the data ends up offset, so we need to
893 /* XXX: This is very inefficient. It would be better to either do
894 * this while we encrypt, or maybe in the receive code, if we can peak
895 * ahead and work out the service and mechanism there. */
896 offset
= buf
->head
[0].iov_len
% 4;
898 buf
->buflen
= RPCSVC_MAXPAYLOAD
;
899 xdr_shift_buf(buf
, offset
);
900 fix_priv_head(buf
, pad
);
902 if (maj_stat
!= GSS_S_COMPLETE
)
905 if (svc_getnl(&buf
->head
[0]) != seq
)
910 struct gss_svc_data
{
911 /* decoded gss client cred: */
912 struct rpc_gss_wire_cred clcred
;
913 /* save a pointer to the beginning of the encoded verifier,
914 * for use in encryption/checksumming in svcauth_gss_release: */
920 svcauth_gss_set_client(struct svc_rqst
*rqstp
)
922 struct gss_svc_data
*svcdata
= rqstp
->rq_auth_data
;
923 struct rsc
*rsci
= svcdata
->rsci
;
924 struct rpc_gss_wire_cred
*gc
= &svcdata
->clcred
;
928 * A gss export can be specified either by:
929 * export *(sec=krb5,rw)
931 * export gss/krb5(rw)
932 * The latter is deprecated; but for backwards compatibility reasons
933 * the nfsd code will still fall back on trying it if the former
934 * doesn't work; so we try to make both available to nfsd, below.
936 rqstp
->rq_gssclient
= find_gss_auth_domain(rsci
->mechctx
, gc
->gc_svc
);
937 if (rqstp
->rq_gssclient
== NULL
)
939 stat
= svcauth_unix_set_client(rqstp
);
940 if (stat
== SVC_DROP
)
946 gss_write_init_verf(struct svc_rqst
*rqstp
, struct rsi
*rsip
)
951 if (rsip
->major_status
!= GSS_S_COMPLETE
)
952 return gss_write_null_verf(rqstp
);
953 rsci
= gss_svc_searchbyctx(&rsip
->out_handle
);
955 rsip
->major_status
= GSS_S_NO_CONTEXT
;
956 return gss_write_null_verf(rqstp
);
958 rc
= gss_write_verf(rqstp
, rsci
->mechctx
, GSS_SEQ_WIN
);
959 cache_put(&rsci
->h
, &rsc_cache
);
964 * Accept an rpcsec packet.
965 * If context establishment, punt to user space
966 * If data exchange, verify/decrypt
967 * If context destruction, handle here
968 * In the context establishment and destruction case we encode
969 * response here and return SVC_COMPLETE.
972 svcauth_gss_accept(struct svc_rqst
*rqstp
, __be32
*authp
)
974 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
975 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
977 struct xdr_netobj tmpobj
;
978 struct gss_svc_data
*svcdata
= rqstp
->rq_auth_data
;
979 struct rpc_gss_wire_cred
*gc
;
980 struct rsc
*rsci
= NULL
;
981 struct rsi
*rsip
, rsikey
;
983 __be32
*reject_stat
= resv
->iov_base
+ resv
->iov_len
;
986 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
989 *authp
= rpc_autherr_badcred
;
991 svcdata
= kmalloc(sizeof(*svcdata
), GFP_KERNEL
);
994 rqstp
->rq_auth_data
= svcdata
;
995 svcdata
->verf_start
= NULL
;
996 svcdata
->rsci
= NULL
;
997 gc
= &svcdata
->clcred
;
999 /* start of rpc packet is 7 u32's back from here:
1000 * xid direction rpcversion prog vers proc flavour
1002 rpcstart
= argv
->iov_base
;
1006 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1007 * at least 5 u32s, and is preceeded by length, so that makes 6.
1010 if (argv
->iov_len
< 5 * 4)
1012 crlen
= svc_getnl(argv
);
1013 if (svc_getnl(argv
) != RPC_GSS_VERSION
)
1015 gc
->gc_proc
= svc_getnl(argv
);
1016 gc
->gc_seq
= svc_getnl(argv
);
1017 gc
->gc_svc
= svc_getnl(argv
);
1018 if (svc_safe_getnetobj(argv
, &gc
->gc_ctx
))
1020 if (crlen
!= round_up_to_quad(gc
->gc_ctx
.len
) + 5 * 4)
1023 if ((gc
->gc_proc
!= RPC_GSS_PROC_DATA
) && (rqstp
->rq_proc
!= 0))
1027 * We've successfully parsed the credential. Let's check out the
1028 * verifier. An AUTH_NULL verifier is allowed (and required) for
1029 * INIT and CONTINUE_INIT requests. AUTH_RPCSEC_GSS is required for
1030 * PROC_DATA and PROC_DESTROY.
1032 * AUTH_NULL verifier is 0 (AUTH_NULL), 0 (length).
1033 * AUTH_RPCSEC_GSS verifier is:
1034 * 6 (AUTH_RPCSEC_GSS), length, checksum.
1035 * checksum is calculated over rpcheader from xid up to here.
1037 *authp
= rpc_autherr_badverf
;
1038 switch (gc
->gc_proc
) {
1039 case RPC_GSS_PROC_INIT
:
1040 case RPC_GSS_PROC_CONTINUE_INIT
:
1041 if (argv
->iov_len
< 2 * 4)
1043 if (svc_getnl(argv
) != RPC_AUTH_NULL
)
1045 if (svc_getnl(argv
) != 0)
1048 case RPC_GSS_PROC_DATA
:
1049 case RPC_GSS_PROC_DESTROY
:
1050 *authp
= rpcsec_gsserr_credproblem
;
1051 rsci
= gss_svc_searchbyctx(&gc
->gc_ctx
);
1054 switch (gss_verify_header(rqstp
, rsci
, rpcstart
, gc
, authp
)) {
1064 *authp
= rpc_autherr_rejectedcred
;
1068 /* now act upon the command: */
1069 switch (gc
->gc_proc
) {
1070 case RPC_GSS_PROC_INIT
:
1071 case RPC_GSS_PROC_CONTINUE_INIT
:
1072 *authp
= rpc_autherr_badcred
;
1073 if (gc
->gc_proc
== RPC_GSS_PROC_INIT
&& gc
->gc_ctx
.len
!= 0)
1075 memset(&rsikey
, 0, sizeof(rsikey
));
1076 if (dup_netobj(&rsikey
.in_handle
, &gc
->gc_ctx
))
1078 *authp
= rpc_autherr_badverf
;
1079 if (svc_safe_getnetobj(argv
, &tmpobj
)) {
1080 kfree(rsikey
.in_handle
.data
);
1083 if (dup_netobj(&rsikey
.in_token
, &tmpobj
)) {
1084 kfree(rsikey
.in_handle
.data
);
1088 rsip
= rsi_lookup(&rsikey
);
1093 switch(cache_check(&rsi_cache
, &rsip
->h
, &rqstp
->rq_chandle
)) {
1099 if (gss_write_init_verf(rqstp
, rsip
))
1101 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
1103 svc_putnl(resv
, RPC_SUCCESS
);
1104 if (svc_safe_putnetobj(resv
, &rsip
->out_handle
))
1106 if (resv
->iov_len
+ 3 * 4 > PAGE_SIZE
)
1108 svc_putnl(resv
, rsip
->major_status
);
1109 svc_putnl(resv
, rsip
->minor_status
);
1110 svc_putnl(resv
, GSS_SEQ_WIN
);
1111 if (svc_safe_putnetobj(resv
, &rsip
->out_token
))
1115 case RPC_GSS_PROC_DESTROY
:
1116 if (gss_write_verf(rqstp
, rsci
->mechctx
, gc
->gc_seq
))
1118 set_bit(CACHE_NEGATIVE
, &rsci
->h
.flags
);
1119 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
1121 svc_putnl(resv
, RPC_SUCCESS
);
1123 case RPC_GSS_PROC_DATA
:
1124 *authp
= rpcsec_gsserr_ctxproblem
;
1125 svcdata
->verf_start
= resv
->iov_base
+ resv
->iov_len
;
1126 if (gss_write_verf(rqstp
, rsci
->mechctx
, gc
->gc_seq
))
1128 rqstp
->rq_cred
= rsci
->cred
;
1129 get_group_info(rsci
->cred
.cr_group_info
);
1130 *authp
= rpc_autherr_badcred
;
1131 switch (gc
->gc_svc
) {
1132 case RPC_GSS_SVC_NONE
:
1134 case RPC_GSS_SVC_INTEGRITY
:
1135 if (unwrap_integ_data(&rqstp
->rq_arg
,
1136 gc
->gc_seq
, rsci
->mechctx
))
1138 /* placeholders for length and seq. number: */
1142 case RPC_GSS_SVC_PRIVACY
:
1143 if (unwrap_priv_data(rqstp
, &rqstp
->rq_arg
,
1144 gc
->gc_seq
, rsci
->mechctx
))
1146 /* placeholders for length and seq. number: */
1153 svcdata
->rsci
= rsci
;
1154 cache_get(&rsci
->h
);
1155 rqstp
->rq_flavor
= gss_svc_to_pseudoflavor(
1156 rsci
->mechctx
->mech_type
, gc
->gc_svc
);
1161 /* Restore write pointer to original value: */
1162 xdr_ressize_check(rqstp
, reject_stat
);
1172 cache_put(&rsci
->h
, &rsc_cache
);
1177 svcauth_gss_prepare_to_wrap(struct xdr_buf
*resbuf
, struct gss_svc_data
*gsd
)
1182 p
= gsd
->verf_start
;
1183 gsd
->verf_start
= NULL
;
1185 /* If the reply stat is nonzero, don't wrap: */
1186 if (*(p
-1) != rpc_success
)
1188 /* Skip the verifier: */
1190 verf_len
= ntohl(*p
++);
1191 p
+= XDR_QUADLEN(verf_len
);
1192 /* move accept_stat to right place: */
1193 memcpy(p
, p
+ 2, 4);
1194 /* Also don't wrap if the accept stat is nonzero: */
1195 if (*p
!= rpc_success
) {
1196 resbuf
->head
[0].iov_len
-= 2 * 4;
1204 svcauth_gss_wrap_resp_integ(struct svc_rqst
*rqstp
)
1206 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1207 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1208 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1209 struct xdr_buf integ_buf
;
1210 struct xdr_netobj mic
;
1213 int integ_offset
, integ_len
;
1216 p
= svcauth_gss_prepare_to_wrap(resbuf
, gsd
);
1219 integ_offset
= (u8
*)(p
+ 1) - (u8
*)resbuf
->head
[0].iov_base
;
1220 integ_len
= resbuf
->len
- integ_offset
;
1221 BUG_ON(integ_len
% 4);
1222 *p
++ = htonl(integ_len
);
1223 *p
++ = htonl(gc
->gc_seq
);
1224 if (xdr_buf_subsegment(resbuf
, &integ_buf
, integ_offset
,
1227 if (resbuf
->tail
[0].iov_base
== NULL
) {
1228 if (resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1230 resbuf
->tail
[0].iov_base
= resbuf
->head
[0].iov_base
1231 + resbuf
->head
[0].iov_len
;
1232 resbuf
->tail
[0].iov_len
= 0;
1233 resv
= &resbuf
->tail
[0];
1235 resv
= &resbuf
->tail
[0];
1237 mic
.data
= (u8
*)resv
->iov_base
+ resv
->iov_len
+ 4;
1238 if (gss_get_mic(gsd
->rsci
->mechctx
, &integ_buf
, &mic
))
1240 svc_putnl(resv
, mic
.len
);
1241 memset(mic
.data
+ mic
.len
, 0,
1242 round_up_to_quad(mic
.len
) - mic
.len
);
1243 resv
->iov_len
+= XDR_QUADLEN(mic
.len
) << 2;
1244 /* not strictly required: */
1245 resbuf
->len
+= XDR_QUADLEN(mic
.len
) << 2;
1246 BUG_ON(resv
->iov_len
> PAGE_SIZE
);
1254 svcauth_gss_wrap_resp_priv(struct svc_rqst
*rqstp
)
1256 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1257 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1258 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1259 struct page
**inpages
= NULL
;
1264 p
= svcauth_gss_prepare_to_wrap(resbuf
, gsd
);
1268 offset
= (u8
*)p
- (u8
*)resbuf
->head
[0].iov_base
;
1269 *p
++ = htonl(gc
->gc_seq
);
1270 inpages
= resbuf
->pages
;
1271 /* XXX: Would be better to write some xdr helper functions for
1272 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1273 if (resbuf
->tail
[0].iov_base
) {
1274 BUG_ON(resbuf
->tail
[0].iov_base
>= resbuf
->head
[0].iov_base
1276 BUG_ON(resbuf
->tail
[0].iov_base
< resbuf
->head
[0].iov_base
);
1277 if (resbuf
->tail
[0].iov_len
+ resbuf
->head
[0].iov_len
1278 + 2 * RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1280 memmove(resbuf
->tail
[0].iov_base
+ RPC_MAX_AUTH_SIZE
,
1281 resbuf
->tail
[0].iov_base
,
1282 resbuf
->tail
[0].iov_len
);
1283 resbuf
->tail
[0].iov_base
+= RPC_MAX_AUTH_SIZE
;
1285 if (resbuf
->tail
[0].iov_base
== NULL
) {
1286 if (resbuf
->head
[0].iov_len
+ 2*RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1288 resbuf
->tail
[0].iov_base
= resbuf
->head
[0].iov_base
1289 + resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
;
1290 resbuf
->tail
[0].iov_len
= 0;
1292 if (gss_wrap(gsd
->rsci
->mechctx
, offset
, resbuf
, inpages
))
1294 *len
= htonl(resbuf
->len
- offset
);
1295 pad
= 3 - ((resbuf
->len
- offset
- 1)&3);
1296 p
= (__be32
*)(resbuf
->tail
[0].iov_base
+ resbuf
->tail
[0].iov_len
);
1298 resbuf
->tail
[0].iov_len
+= pad
;
1304 svcauth_gss_release(struct svc_rqst
*rqstp
)
1306 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1307 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1308 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1311 if (gc
->gc_proc
!= RPC_GSS_PROC_DATA
)
1313 /* Release can be called twice, but we only wrap once. */
1314 if (gsd
->verf_start
== NULL
)
1316 /* normally not set till svc_send, but we need it here: */
1317 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1319 resbuf
->len
= total_buf_len(resbuf
);
1320 switch (gc
->gc_svc
) {
1321 case RPC_GSS_SVC_NONE
:
1323 case RPC_GSS_SVC_INTEGRITY
:
1324 stat
= svcauth_gss_wrap_resp_integ(rqstp
);
1328 case RPC_GSS_SVC_PRIVACY
:
1329 stat
= svcauth_gss_wrap_resp_priv(rqstp
);
1340 if (rqstp
->rq_client
)
1341 auth_domain_put(rqstp
->rq_client
);
1342 rqstp
->rq_client
= NULL
;
1343 if (rqstp
->rq_gssclient
)
1344 auth_domain_put(rqstp
->rq_gssclient
);
1345 rqstp
->rq_gssclient
= NULL
;
1346 if (rqstp
->rq_cred
.cr_group_info
)
1347 put_group_info(rqstp
->rq_cred
.cr_group_info
);
1348 rqstp
->rq_cred
.cr_group_info
= NULL
;
1350 cache_put(&gsd
->rsci
->h
, &rsc_cache
);
1357 svcauth_gss_domain_release(struct auth_domain
*dom
)
1359 struct gss_domain
*gd
= container_of(dom
, struct gss_domain
, h
);
1365 static struct auth_ops svcauthops_gss
= {
1366 .name
= "rpcsec_gss",
1367 .owner
= THIS_MODULE
,
1368 .flavour
= RPC_AUTH_GSS
,
1369 .accept
= svcauth_gss_accept
,
1370 .release
= svcauth_gss_release
,
1371 .domain_release
= svcauth_gss_domain_release
,
1372 .set_client
= svcauth_gss_set_client
,
1378 int rv
= svc_auth_register(RPC_AUTH_GSS
, &svcauthops_gss
);
1380 cache_register(&rsc_cache
);
1381 cache_register(&rsi_cache
);
1387 gss_svc_shutdown(void)
1389 if (cache_unregister(&rsc_cache
))
1390 printk(KERN_ERR
"auth_rpcgss: failed to unregister rsc cache\n");
1391 if (cache_unregister(&rsi_cache
))
1392 printk(KERN_ERR
"auth_rpcgss: failed to unregister rsi cache\n");
1393 svc_auth_unregister(RPC_AUTH_GSS
);