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/slab.h>
41 #include <linux/types.h>
42 #include <linux/module.h>
43 #include <linux/pagemap.h>
45 #include <linux/sunrpc/auth_gss.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>
52 # define RPCDBG_FACILITY RPCDBG_AUTH
55 /* The rpcsec_init cache is used for mapping RPCSEC_GSS_{,CONT_}INIT requests
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)
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
);
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
)
116 dst
->data
= (len
? kmemdup(src
, len
, GFP_KERNEL
) : NULL
);
117 if (len
&& !dst
->data
)
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
);
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
);
185 static int rsi_upcall(struct cache_detail
*cd
, struct cache_head
*h
)
187 return sunrpc_cache_pipe_upcall(cd
, h
, rsi_request
);
191 static int rsi_parse(struct cache_detail
*cd
,
192 char *mesg
, int mlen
)
194 /* context token expiry major minor context token */
198 struct rsi rsii
, *rsip
= NULL
;
200 int status
= -EINVAL
;
202 memset(&rsii
, 0, sizeof(rsii
));
204 len
= qword_get(&mesg
, buf
, mlen
);
208 if (dup_to_netobj(&rsii
.in_handle
, buf
, len
))
212 len
= qword_get(&mesg
, buf
, mlen
);
217 if (dup_to_netobj(&rsii
.in_token
, buf
, len
))
220 rsip
= rsi_lookup(&rsii
);
226 expiry
= get_expiry(&mesg
);
232 len
= qword_get(&mesg
, buf
, mlen
);
235 rsii
.major_status
= simple_strtoul(buf
, &ep
, 10);
238 len
= qword_get(&mesg
, buf
, mlen
);
241 rsii
.minor_status
= simple_strtoul(buf
, &ep
, 10);
246 len
= qword_get(&mesg
, buf
, mlen
);
250 if (dup_to_netobj(&rsii
.out_handle
, buf
, len
))
254 len
= qword_get(&mesg
, buf
, mlen
);
259 if (dup_to_netobj(&rsii
.out_token
, buf
, len
))
261 rsii
.h
.expiry_time
= expiry
;
262 rsip
= rsi_update(&rsii
, rsip
);
267 cache_put(&rsip
->h
, &rsi_cache
);
273 static struct cache_detail rsi_cache
= {
274 .owner
= THIS_MODULE
,
275 .hash_size
= RSI_HASHMAX
,
276 .hash_table
= rsi_table
,
277 .name
= "auth.rpcsec.init",
278 .cache_put
= rsi_put
,
279 .cache_upcall
= rsi_upcall
,
280 .cache_parse
= rsi_parse
,
283 .update
= update_rsi
,
287 static struct rsi
*rsi_lookup(struct rsi
*item
)
289 struct cache_head
*ch
;
290 int hash
= rsi_hash(item
);
292 ch
= sunrpc_cache_lookup(&rsi_cache
, &item
->h
, hash
);
294 return container_of(ch
, struct rsi
, h
);
299 static struct rsi
*rsi_update(struct rsi
*new, struct rsi
*old
)
301 struct cache_head
*ch
;
302 int hash
= rsi_hash(new);
304 ch
= sunrpc_cache_update(&rsi_cache
, &new->h
,
307 return container_of(ch
, struct rsi
, h
);
314 * The rpcsec_context cache is used to store a context that is
315 * used in data exchange.
316 * The key is a context handle. The content is:
317 * uid, gidlist, mechanism, service-set, mech-specific-data
320 #define RSC_HASHBITS 10
321 #define RSC_HASHMAX (1<<RSC_HASHBITS)
322 #define RSC_HASHMASK (RSC_HASHMAX-1)
324 #define GSS_SEQ_WIN 128
326 struct gss_svc_seq_data
{
327 /* highest seq number seen so far: */
329 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
330 * sd_win is nonzero iff sequence number i has been seen already: */
331 unsigned long sd_win
[GSS_SEQ_WIN
/BITS_PER_LONG
];
337 struct xdr_netobj handle
;
338 struct svc_cred cred
;
339 struct gss_svc_seq_data seqdata
;
340 struct gss_ctx
*mechctx
;
344 static struct cache_head
*rsc_table
[RSC_HASHMAX
];
345 static struct cache_detail rsc_cache
;
346 static struct rsc
*rsc_update(struct rsc
*new, struct rsc
*old
);
347 static struct rsc
*rsc_lookup(struct rsc
*item
);
349 static void rsc_free(struct rsc
*rsci
)
351 kfree(rsci
->handle
.data
);
353 gss_delete_sec_context(&rsci
->mechctx
);
354 if (rsci
->cred
.cr_group_info
)
355 put_group_info(rsci
->cred
.cr_group_info
);
356 kfree(rsci
->client_name
);
359 static void rsc_put(struct kref
*ref
)
361 struct rsc
*rsci
= container_of(ref
, struct rsc
, h
.ref
);
368 rsc_hash(struct rsc
*rsci
)
370 return hash_mem(rsci
->handle
.data
, rsci
->handle
.len
, RSC_HASHBITS
);
374 rsc_match(struct cache_head
*a
, struct cache_head
*b
)
376 struct rsc
*new = container_of(a
, struct rsc
, h
);
377 struct rsc
*tmp
= container_of(b
, struct rsc
, h
);
379 return netobj_equal(&new->handle
, &tmp
->handle
);
383 rsc_init(struct cache_head
*cnew
, struct cache_head
*ctmp
)
385 struct rsc
*new = container_of(cnew
, struct rsc
, h
);
386 struct rsc
*tmp
= container_of(ctmp
, struct rsc
, h
);
388 new->handle
.len
= tmp
->handle
.len
;
390 new->handle
.data
= tmp
->handle
.data
;
391 tmp
->handle
.data
= NULL
;
393 new->cred
.cr_group_info
= NULL
;
394 new->client_name
= NULL
;
398 update_rsc(struct cache_head
*cnew
, struct cache_head
*ctmp
)
400 struct rsc
*new = container_of(cnew
, struct rsc
, h
);
401 struct rsc
*tmp
= container_of(ctmp
, struct rsc
, h
);
403 new->mechctx
= tmp
->mechctx
;
405 memset(&new->seqdata
, 0, sizeof(new->seqdata
));
406 spin_lock_init(&new->seqdata
.sd_lock
);
407 new->cred
= tmp
->cred
;
408 tmp
->cred
.cr_group_info
= NULL
;
409 new->client_name
= tmp
->client_name
;
410 tmp
->client_name
= NULL
;
413 static struct cache_head
*
416 struct rsc
*rsci
= kmalloc(sizeof(*rsci
), GFP_KERNEL
);
423 static int rsc_parse(struct cache_detail
*cd
,
424 char *mesg
, int mlen
)
426 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
429 struct rsc rsci
, *rscp
= NULL
;
431 int status
= -EINVAL
;
432 struct gss_api_mech
*gm
= NULL
;
434 memset(&rsci
, 0, sizeof(rsci
));
436 len
= qword_get(&mesg
, buf
, mlen
);
437 if (len
< 0) goto out
;
439 if (dup_to_netobj(&rsci
.handle
, buf
, len
))
444 expiry
= get_expiry(&mesg
);
449 rscp
= rsc_lookup(&rsci
);
453 /* uid, or NEGATIVE */
454 rv
= get_int(&mesg
, &rsci
.cred
.cr_uid
);
458 set_bit(CACHE_NEGATIVE
, &rsci
.h
.flags
);
463 if (get_int(&mesg
, &rsci
.cred
.cr_gid
))
466 /* number of additional gid's */
467 if (get_int(&mesg
, &N
))
470 rsci
.cred
.cr_group_info
= groups_alloc(N
);
471 if (rsci
.cred
.cr_group_info
== NULL
)
476 for (i
=0; i
<N
; i
++) {
478 if (get_int(&mesg
, &gid
))
480 GROUP_AT(rsci
.cred
.cr_group_info
, i
) = gid
;
484 len
= qword_get(&mesg
, buf
, mlen
);
487 gm
= gss_mech_get_by_name(buf
);
488 status
= -EOPNOTSUPP
;
493 /* mech-specific data: */
494 len
= qword_get(&mesg
, buf
, mlen
);
497 status
= gss_import_sec_context(buf
, len
, gm
, &rsci
.mechctx
, GFP_KERNEL
);
501 /* get client name */
502 len
= qword_get(&mesg
, buf
, mlen
);
504 rsci
.client_name
= kstrdup(buf
, GFP_KERNEL
);
505 if (!rsci
.client_name
)
510 rsci
.h
.expiry_time
= expiry
;
511 rscp
= rsc_update(&rsci
, rscp
);
517 cache_put(&rscp
->h
, &rsc_cache
);
523 static struct cache_detail rsc_cache
= {
524 .owner
= THIS_MODULE
,
525 .hash_size
= RSC_HASHMAX
,
526 .hash_table
= rsc_table
,
527 .name
= "auth.rpcsec.context",
528 .cache_put
= rsc_put
,
529 .cache_parse
= rsc_parse
,
532 .update
= update_rsc
,
536 static struct rsc
*rsc_lookup(struct rsc
*item
)
538 struct cache_head
*ch
;
539 int hash
= rsc_hash(item
);
541 ch
= sunrpc_cache_lookup(&rsc_cache
, &item
->h
, hash
);
543 return container_of(ch
, struct rsc
, h
);
548 static struct rsc
*rsc_update(struct rsc
*new, struct rsc
*old
)
550 struct cache_head
*ch
;
551 int hash
= rsc_hash(new);
553 ch
= sunrpc_cache_update(&rsc_cache
, &new->h
,
556 return container_of(ch
, struct rsc
, h
);
563 gss_svc_searchbyctx(struct xdr_netobj
*handle
)
568 memset(&rsci
, 0, sizeof(rsci
));
569 if (dup_to_netobj(&rsci
.handle
, handle
->data
, handle
->len
))
571 found
= rsc_lookup(&rsci
);
575 if (cache_check(&rsc_cache
, &found
->h
, NULL
))
580 /* Implements sequence number algorithm as specified in RFC 2203. */
582 gss_check_seq_num(struct rsc
*rsci
, int seq_num
)
584 struct gss_svc_seq_data
*sd
= &rsci
->seqdata
;
586 spin_lock(&sd
->sd_lock
);
587 if (seq_num
> sd
->sd_max
) {
588 if (seq_num
>= sd
->sd_max
+ GSS_SEQ_WIN
) {
589 memset(sd
->sd_win
,0,sizeof(sd
->sd_win
));
590 sd
->sd_max
= seq_num
;
591 } else while (sd
->sd_max
< seq_num
) {
593 __clear_bit(sd
->sd_max
% GSS_SEQ_WIN
, sd
->sd_win
);
595 __set_bit(seq_num
% GSS_SEQ_WIN
, sd
->sd_win
);
597 } else if (seq_num
<= sd
->sd_max
- GSS_SEQ_WIN
) {
600 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
601 if (__test_and_set_bit(seq_num
% GSS_SEQ_WIN
, sd
->sd_win
))
604 spin_unlock(&sd
->sd_lock
);
607 spin_unlock(&sd
->sd_lock
);
611 static inline u32
round_up_to_quad(u32 i
)
613 return (i
+ 3 ) & ~3;
617 svc_safe_getnetobj(struct kvec
*argv
, struct xdr_netobj
*o
)
621 if (argv
->iov_len
< 4)
623 o
->len
= svc_getnl(argv
);
624 l
= round_up_to_quad(o
->len
);
625 if (argv
->iov_len
< l
)
627 o
->data
= argv
->iov_base
;
634 svc_safe_putnetobj(struct kvec
*resv
, struct xdr_netobj
*o
)
638 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
640 svc_putnl(resv
, o
->len
);
641 p
= resv
->iov_base
+ resv
->iov_len
;
642 resv
->iov_len
+= round_up_to_quad(o
->len
);
643 if (resv
->iov_len
> PAGE_SIZE
)
645 memcpy(p
, o
->data
, o
->len
);
646 memset(p
+ o
->len
, 0, round_up_to_quad(o
->len
) - o
->len
);
651 * Verify the checksum on the header and return SVC_OK on success.
652 * Otherwise, return SVC_DROP (in the case of a bad sequence number)
653 * or return SVC_DENIED and indicate error in authp.
656 gss_verify_header(struct svc_rqst
*rqstp
, struct rsc
*rsci
,
657 __be32
*rpcstart
, struct rpc_gss_wire_cred
*gc
, __be32
*authp
)
659 struct gss_ctx
*ctx_id
= rsci
->mechctx
;
660 struct xdr_buf rpchdr
;
661 struct xdr_netobj checksum
;
663 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
666 /* data to compute the checksum over: */
667 iov
.iov_base
= rpcstart
;
668 iov
.iov_len
= (u8
*)argv
->iov_base
- (u8
*)rpcstart
;
669 xdr_buf_from_iov(&iov
, &rpchdr
);
671 *authp
= rpc_autherr_badverf
;
672 if (argv
->iov_len
< 4)
674 flavor
= svc_getnl(argv
);
675 if (flavor
!= RPC_AUTH_GSS
)
677 if (svc_safe_getnetobj(argv
, &checksum
))
680 if (rqstp
->rq_deferred
) /* skip verification of revisited request */
682 if (gss_verify_mic(ctx_id
, &rpchdr
, &checksum
) != GSS_S_COMPLETE
) {
683 *authp
= rpcsec_gsserr_credproblem
;
687 if (gc
->gc_seq
> MAXSEQ
) {
688 dprintk("RPC: svcauth_gss: discarding request with "
689 "large sequence number %d\n", gc
->gc_seq
);
690 *authp
= rpcsec_gsserr_ctxproblem
;
693 if (!gss_check_seq_num(rsci
, gc
->gc_seq
)) {
694 dprintk("RPC: svcauth_gss: discarding request with "
695 "old sequence number %d\n", gc
->gc_seq
);
702 gss_write_null_verf(struct svc_rqst
*rqstp
)
706 svc_putnl(rqstp
->rq_res
.head
, RPC_AUTH_NULL
);
707 p
= rqstp
->rq_res
.head
->iov_base
+ rqstp
->rq_res
.head
->iov_len
;
708 /* don't really need to check if head->iov_len > PAGE_SIZE ... */
710 if (!xdr_ressize_check(rqstp
, p
))
716 gss_write_verf(struct svc_rqst
*rqstp
, struct gss_ctx
*ctx_id
, u32 seq
)
720 struct xdr_buf verf_data
;
721 struct xdr_netobj mic
;
725 svc_putnl(rqstp
->rq_res
.head
, RPC_AUTH_GSS
);
726 xdr_seq
= htonl(seq
);
728 iov
.iov_base
= &xdr_seq
;
729 iov
.iov_len
= sizeof(xdr_seq
);
730 xdr_buf_from_iov(&iov
, &verf_data
);
731 p
= rqstp
->rq_res
.head
->iov_base
+ rqstp
->rq_res
.head
->iov_len
;
732 mic
.data
= (u8
*)(p
+ 1);
733 maj_stat
= gss_get_mic(ctx_id
, &verf_data
, &mic
);
734 if (maj_stat
!= GSS_S_COMPLETE
)
736 *p
++ = htonl(mic
.len
);
737 memset((u8
*)p
+ mic
.len
, 0, round_up_to_quad(mic
.len
) - mic
.len
);
738 p
+= XDR_QUADLEN(mic
.len
);
739 if (!xdr_ressize_check(rqstp
, p
))
745 struct auth_domain h
;
749 static struct auth_domain
*
750 find_gss_auth_domain(struct gss_ctx
*ctx
, u32 svc
)
754 name
= gss_service_to_auth_domain_name(ctx
->mech_type
, svc
);
757 return auth_domain_find(name
);
760 static struct auth_ops svcauthops_gss
;
762 u32
svcauth_gss_flavor(struct auth_domain
*dom
)
764 struct gss_domain
*gd
= container_of(dom
, struct gss_domain
, h
);
766 return gd
->pseudoflavor
;
769 EXPORT_SYMBOL_GPL(svcauth_gss_flavor
);
772 svcauth_gss_register_pseudoflavor(u32 pseudoflavor
, char * name
)
774 struct gss_domain
*new;
775 struct auth_domain
*test
;
778 new = kmalloc(sizeof(*new), GFP_KERNEL
);
781 kref_init(&new->h
.ref
);
782 new->h
.name
= kstrdup(name
, GFP_KERNEL
);
785 new->h
.flavour
= &svcauthops_gss
;
786 new->pseudoflavor
= pseudoflavor
;
789 test
= auth_domain_lookup(name
, &new->h
);
790 if (test
!= &new->h
) { /* Duplicate registration */
791 auth_domain_put(test
);
803 EXPORT_SYMBOL_GPL(svcauth_gss_register_pseudoflavor
);
806 read_u32_from_xdr_buf(struct xdr_buf
*buf
, int base
, u32
*obj
)
811 status
= read_bytes_from_xdr_buf(buf
, base
, &raw
, sizeof(*obj
));
818 /* It would be nice if this bit of code could be shared with the client.
820 * The client shouldn't malloc(), would have to pass in own memory.
821 * The server uses base of head iovec as read pointer, while the
822 * client uses separate pointer. */
824 unwrap_integ_data(struct xdr_buf
*buf
, u32 seq
, struct gss_ctx
*ctx
)
827 u32 integ_len
, maj_stat
;
828 struct xdr_netobj mic
;
829 struct xdr_buf integ_buf
;
831 integ_len
= svc_getnl(&buf
->head
[0]);
834 if (integ_len
> buf
->len
)
836 if (xdr_buf_subsegment(buf
, &integ_buf
, 0, integ_len
))
838 /* copy out mic... */
839 if (read_u32_from_xdr_buf(buf
, integ_len
, &mic
.len
))
841 if (mic
.len
> RPC_MAX_AUTH_SIZE
)
843 mic
.data
= kmalloc(mic
.len
, GFP_KERNEL
);
846 if (read_bytes_from_xdr_buf(buf
, integ_len
+ 4, mic
.data
, mic
.len
))
848 maj_stat
= gss_verify_mic(ctx
, &integ_buf
, &mic
);
849 if (maj_stat
!= GSS_S_COMPLETE
)
851 if (svc_getnl(&buf
->head
[0]) != seq
)
860 total_buf_len(struct xdr_buf
*buf
)
862 return buf
->head
[0].iov_len
+ buf
->page_len
+ buf
->tail
[0].iov_len
;
866 fix_priv_head(struct xdr_buf
*buf
, int pad
)
868 if (buf
->page_len
== 0) {
869 /* We need to adjust head and buf->len in tandem in this
870 * case to make svc_defer() work--it finds the original
871 * buffer start using buf->len - buf->head[0].iov_len. */
872 buf
->head
[0].iov_len
-= pad
;
877 unwrap_priv_data(struct svc_rqst
*rqstp
, struct xdr_buf
*buf
, u32 seq
, struct gss_ctx
*ctx
)
879 u32 priv_len
, maj_stat
;
880 int pad
, saved_len
, remaining_len
, offset
;
882 rqstp
->rq_splice_ok
= 0;
884 priv_len
= svc_getnl(&buf
->head
[0]);
885 if (rqstp
->rq_deferred
) {
886 /* Already decrypted last time through! The sequence number
887 * check at out_seq is unnecessary but harmless: */
890 /* buf->len is the number of bytes from the original start of the
891 * request to the end, where head[0].iov_len is just the bytes
892 * not yet read from the head, so these two values are different: */
893 remaining_len
= total_buf_len(buf
);
894 if (priv_len
> remaining_len
)
896 pad
= remaining_len
- priv_len
;
898 fix_priv_head(buf
, pad
);
900 /* Maybe it would be better to give gss_unwrap a length parameter: */
901 saved_len
= buf
->len
;
903 maj_stat
= gss_unwrap(ctx
, 0, buf
);
904 pad
= priv_len
- buf
->len
;
905 buf
->len
= saved_len
;
907 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
908 * In the krb5p case, at least, the data ends up offset, so we need to
910 /* XXX: This is very inefficient. It would be better to either do
911 * this while we encrypt, or maybe in the receive code, if we can peak
912 * ahead and work out the service and mechanism there. */
913 offset
= buf
->head
[0].iov_len
% 4;
915 buf
->buflen
= RPCSVC_MAXPAYLOAD
;
916 xdr_shift_buf(buf
, offset
);
917 fix_priv_head(buf
, pad
);
919 if (maj_stat
!= GSS_S_COMPLETE
)
922 if (svc_getnl(&buf
->head
[0]) != seq
)
927 struct gss_svc_data
{
928 /* decoded gss client cred: */
929 struct rpc_gss_wire_cred clcred
;
930 /* save a pointer to the beginning of the encoded verifier,
931 * for use in encryption/checksumming in svcauth_gss_release: */
936 char *svc_gss_principal(struct svc_rqst
*rqstp
)
938 struct gss_svc_data
*gd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
941 return gd
->rsci
->client_name
;
944 EXPORT_SYMBOL_GPL(svc_gss_principal
);
947 svcauth_gss_set_client(struct svc_rqst
*rqstp
)
949 struct gss_svc_data
*svcdata
= rqstp
->rq_auth_data
;
950 struct rsc
*rsci
= svcdata
->rsci
;
951 struct rpc_gss_wire_cred
*gc
= &svcdata
->clcred
;
955 * A gss export can be specified either by:
956 * export *(sec=krb5,rw)
958 * export gss/krb5(rw)
959 * The latter is deprecated; but for backwards compatibility reasons
960 * the nfsd code will still fall back on trying it if the former
961 * doesn't work; so we try to make both available to nfsd, below.
963 rqstp
->rq_gssclient
= find_gss_auth_domain(rsci
->mechctx
, gc
->gc_svc
);
964 if (rqstp
->rq_gssclient
== NULL
)
966 stat
= svcauth_unix_set_client(rqstp
);
967 if (stat
== SVC_DROP
)
973 gss_write_init_verf(struct svc_rqst
*rqstp
, struct rsi
*rsip
)
978 if (rsip
->major_status
!= GSS_S_COMPLETE
)
979 return gss_write_null_verf(rqstp
);
980 rsci
= gss_svc_searchbyctx(&rsip
->out_handle
);
982 rsip
->major_status
= GSS_S_NO_CONTEXT
;
983 return gss_write_null_verf(rqstp
);
985 rc
= gss_write_verf(rqstp
, rsci
->mechctx
, GSS_SEQ_WIN
);
986 cache_put(&rsci
->h
, &rsc_cache
);
991 * Having read the cred already and found we're in the context
992 * initiation case, read the verifier and initiate (or check the results
993 * of) upcalls to userspace for help with context initiation. If
994 * the upcall results are available, write the verifier and result.
995 * Otherwise, drop the request pending an answer to the upcall.
997 static int svcauth_gss_handle_init(struct svc_rqst
*rqstp
,
998 struct rpc_gss_wire_cred
*gc
, __be32
*authp
)
1000 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
1001 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
1002 struct xdr_netobj tmpobj
;
1003 struct rsi
*rsip
, rsikey
;
1006 /* Read the verifier; should be NULL: */
1007 *authp
= rpc_autherr_badverf
;
1008 if (argv
->iov_len
< 2 * 4)
1010 if (svc_getnl(argv
) != RPC_AUTH_NULL
)
1012 if (svc_getnl(argv
) != 0)
1015 /* Martial context handle and token for upcall: */
1016 *authp
= rpc_autherr_badcred
;
1017 if (gc
->gc_proc
== RPC_GSS_PROC_INIT
&& gc
->gc_ctx
.len
!= 0)
1019 memset(&rsikey
, 0, sizeof(rsikey
));
1020 if (dup_netobj(&rsikey
.in_handle
, &gc
->gc_ctx
))
1022 *authp
= rpc_autherr_badverf
;
1023 if (svc_safe_getnetobj(argv
, &tmpobj
)) {
1024 kfree(rsikey
.in_handle
.data
);
1027 if (dup_netobj(&rsikey
.in_token
, &tmpobj
)) {
1028 kfree(rsikey
.in_handle
.data
);
1032 /* Perform upcall, or find upcall result: */
1033 rsip
= rsi_lookup(&rsikey
);
1037 switch (cache_check(&rsi_cache
, &rsip
->h
, &rqstp
->rq_chandle
)) {
1041 /* No upcall result: */
1045 /* Got an answer to the upcall; use it: */
1046 if (gss_write_init_verf(rqstp
, rsip
))
1048 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
1050 svc_putnl(resv
, RPC_SUCCESS
);
1051 if (svc_safe_putnetobj(resv
, &rsip
->out_handle
))
1053 if (resv
->iov_len
+ 3 * 4 > PAGE_SIZE
)
1055 svc_putnl(resv
, rsip
->major_status
);
1056 svc_putnl(resv
, rsip
->minor_status
);
1057 svc_putnl(resv
, GSS_SEQ_WIN
);
1058 if (svc_safe_putnetobj(resv
, &rsip
->out_token
))
1063 cache_put(&rsip
->h
, &rsi_cache
);
1068 * Accept an rpcsec packet.
1069 * If context establishment, punt to user space
1070 * If data exchange, verify/decrypt
1071 * If context destruction, handle here
1072 * In the context establishment and destruction case we encode
1073 * response here and return SVC_COMPLETE.
1076 svcauth_gss_accept(struct svc_rqst
*rqstp
, __be32
*authp
)
1078 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
1079 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
1081 struct gss_svc_data
*svcdata
= rqstp
->rq_auth_data
;
1082 struct rpc_gss_wire_cred
*gc
;
1083 struct rsc
*rsci
= NULL
;
1085 __be32
*reject_stat
= resv
->iov_base
+ resv
->iov_len
;
1088 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",
1091 *authp
= rpc_autherr_badcred
;
1093 svcdata
= kmalloc(sizeof(*svcdata
), GFP_KERNEL
);
1096 rqstp
->rq_auth_data
= svcdata
;
1097 svcdata
->verf_start
= NULL
;
1098 svcdata
->rsci
= NULL
;
1099 gc
= &svcdata
->clcred
;
1101 /* start of rpc packet is 7 u32's back from here:
1102 * xid direction rpcversion prog vers proc flavour
1104 rpcstart
= argv
->iov_base
;
1108 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
1109 * at least 5 u32s, and is preceeded by length, so that makes 6.
1112 if (argv
->iov_len
< 5 * 4)
1114 crlen
= svc_getnl(argv
);
1115 if (svc_getnl(argv
) != RPC_GSS_VERSION
)
1117 gc
->gc_proc
= svc_getnl(argv
);
1118 gc
->gc_seq
= svc_getnl(argv
);
1119 gc
->gc_svc
= svc_getnl(argv
);
1120 if (svc_safe_getnetobj(argv
, &gc
->gc_ctx
))
1122 if (crlen
!= round_up_to_quad(gc
->gc_ctx
.len
) + 5 * 4)
1125 if ((gc
->gc_proc
!= RPC_GSS_PROC_DATA
) && (rqstp
->rq_proc
!= 0))
1128 *authp
= rpc_autherr_badverf
;
1129 switch (gc
->gc_proc
) {
1130 case RPC_GSS_PROC_INIT
:
1131 case RPC_GSS_PROC_CONTINUE_INIT
:
1132 return svcauth_gss_handle_init(rqstp
, gc
, authp
);
1133 case RPC_GSS_PROC_DATA
:
1134 case RPC_GSS_PROC_DESTROY
:
1135 /* Look up the context, and check the verifier: */
1136 *authp
= rpcsec_gsserr_credproblem
;
1137 rsci
= gss_svc_searchbyctx(&gc
->gc_ctx
);
1140 switch (gss_verify_header(rqstp
, rsci
, rpcstart
, gc
, authp
)) {
1150 *authp
= rpc_autherr_rejectedcred
;
1154 /* now act upon the command: */
1155 switch (gc
->gc_proc
) {
1156 case RPC_GSS_PROC_DESTROY
:
1157 if (gss_write_verf(rqstp
, rsci
->mechctx
, gc
->gc_seq
))
1159 rsci
->h
.expiry_time
= get_seconds();
1160 set_bit(CACHE_NEGATIVE
, &rsci
->h
.flags
);
1161 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
1163 svc_putnl(resv
, RPC_SUCCESS
);
1165 case RPC_GSS_PROC_DATA
:
1166 *authp
= rpcsec_gsserr_ctxproblem
;
1167 svcdata
->verf_start
= resv
->iov_base
+ resv
->iov_len
;
1168 if (gss_write_verf(rqstp
, rsci
->mechctx
, gc
->gc_seq
))
1170 rqstp
->rq_cred
= rsci
->cred
;
1171 get_group_info(rsci
->cred
.cr_group_info
);
1172 *authp
= rpc_autherr_badcred
;
1173 switch (gc
->gc_svc
) {
1174 case RPC_GSS_SVC_NONE
:
1176 case RPC_GSS_SVC_INTEGRITY
:
1177 /* placeholders for length and seq. number: */
1180 if (unwrap_integ_data(&rqstp
->rq_arg
,
1181 gc
->gc_seq
, rsci
->mechctx
))
1184 case RPC_GSS_SVC_PRIVACY
:
1185 /* placeholders for length and seq. number: */
1188 if (unwrap_priv_data(rqstp
, &rqstp
->rq_arg
,
1189 gc
->gc_seq
, rsci
->mechctx
))
1195 svcdata
->rsci
= rsci
;
1196 cache_get(&rsci
->h
);
1197 rqstp
->rq_flavor
= gss_svc_to_pseudoflavor(
1198 rsci
->mechctx
->mech_type
, gc
->gc_svc
);
1206 /* Restore write pointer to its original value: */
1207 xdr_ressize_check(rqstp
, reject_stat
);
1217 cache_put(&rsci
->h
, &rsc_cache
);
1222 svcauth_gss_prepare_to_wrap(struct xdr_buf
*resbuf
, struct gss_svc_data
*gsd
)
1227 p
= gsd
->verf_start
;
1228 gsd
->verf_start
= NULL
;
1230 /* If the reply stat is nonzero, don't wrap: */
1231 if (*(p
-1) != rpc_success
)
1233 /* Skip the verifier: */
1235 verf_len
= ntohl(*p
++);
1236 p
+= XDR_QUADLEN(verf_len
);
1237 /* move accept_stat to right place: */
1238 memcpy(p
, p
+ 2, 4);
1239 /* Also don't wrap if the accept stat is nonzero: */
1240 if (*p
!= rpc_success
) {
1241 resbuf
->head
[0].iov_len
-= 2 * 4;
1249 svcauth_gss_wrap_resp_integ(struct svc_rqst
*rqstp
)
1251 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1252 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1253 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1254 struct xdr_buf integ_buf
;
1255 struct xdr_netobj mic
;
1258 int integ_offset
, integ_len
;
1261 p
= svcauth_gss_prepare_to_wrap(resbuf
, gsd
);
1264 integ_offset
= (u8
*)(p
+ 1) - (u8
*)resbuf
->head
[0].iov_base
;
1265 integ_len
= resbuf
->len
- integ_offset
;
1266 BUG_ON(integ_len
% 4);
1267 *p
++ = htonl(integ_len
);
1268 *p
++ = htonl(gc
->gc_seq
);
1269 if (xdr_buf_subsegment(resbuf
, &integ_buf
, integ_offset
,
1272 if (resbuf
->tail
[0].iov_base
== NULL
) {
1273 if (resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1275 resbuf
->tail
[0].iov_base
= resbuf
->head
[0].iov_base
1276 + resbuf
->head
[0].iov_len
;
1277 resbuf
->tail
[0].iov_len
= 0;
1278 resv
= &resbuf
->tail
[0];
1280 resv
= &resbuf
->tail
[0];
1282 mic
.data
= (u8
*)resv
->iov_base
+ resv
->iov_len
+ 4;
1283 if (gss_get_mic(gsd
->rsci
->mechctx
, &integ_buf
, &mic
))
1285 svc_putnl(resv
, mic
.len
);
1286 memset(mic
.data
+ mic
.len
, 0,
1287 round_up_to_quad(mic
.len
) - mic
.len
);
1288 resv
->iov_len
+= XDR_QUADLEN(mic
.len
) << 2;
1289 /* not strictly required: */
1290 resbuf
->len
+= XDR_QUADLEN(mic
.len
) << 2;
1291 BUG_ON(resv
->iov_len
> PAGE_SIZE
);
1299 svcauth_gss_wrap_resp_priv(struct svc_rqst
*rqstp
)
1301 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1302 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1303 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1304 struct page
**inpages
= NULL
;
1309 p
= svcauth_gss_prepare_to_wrap(resbuf
, gsd
);
1313 offset
= (u8
*)p
- (u8
*)resbuf
->head
[0].iov_base
;
1314 *p
++ = htonl(gc
->gc_seq
);
1315 inpages
= resbuf
->pages
;
1316 /* XXX: Would be better to write some xdr helper functions for
1317 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1320 * If there is currently tail data, make sure there is
1321 * room for the head, tail, and 2 * RPC_MAX_AUTH_SIZE in
1322 * the page, and move the current tail data such that
1323 * there is RPC_MAX_AUTH_SIZE slack space available in
1324 * both the head and tail.
1326 if (resbuf
->tail
[0].iov_base
) {
1327 BUG_ON(resbuf
->tail
[0].iov_base
>= resbuf
->head
[0].iov_base
1329 BUG_ON(resbuf
->tail
[0].iov_base
< resbuf
->head
[0].iov_base
);
1330 if (resbuf
->tail
[0].iov_len
+ resbuf
->head
[0].iov_len
1331 + 2 * RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1333 memmove(resbuf
->tail
[0].iov_base
+ RPC_MAX_AUTH_SIZE
,
1334 resbuf
->tail
[0].iov_base
,
1335 resbuf
->tail
[0].iov_len
);
1336 resbuf
->tail
[0].iov_base
+= RPC_MAX_AUTH_SIZE
;
1339 * If there is no current tail data, make sure there is
1340 * room for the head data, and 2 * RPC_MAX_AUTH_SIZE in the
1341 * allotted page, and set up tail information such that there
1342 * is RPC_MAX_AUTH_SIZE slack space available in both the
1345 if (resbuf
->tail
[0].iov_base
== NULL
) {
1346 if (resbuf
->head
[0].iov_len
+ 2*RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1348 resbuf
->tail
[0].iov_base
= resbuf
->head
[0].iov_base
1349 + resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
;
1350 resbuf
->tail
[0].iov_len
= 0;
1352 if (gss_wrap(gsd
->rsci
->mechctx
, offset
, resbuf
, inpages
))
1354 *len
= htonl(resbuf
->len
- offset
);
1355 pad
= 3 - ((resbuf
->len
- offset
- 1)&3);
1356 p
= (__be32
*)(resbuf
->tail
[0].iov_base
+ resbuf
->tail
[0].iov_len
);
1358 resbuf
->tail
[0].iov_len
+= pad
;
1364 svcauth_gss_release(struct svc_rqst
*rqstp
)
1366 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1367 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1368 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1371 if (gc
->gc_proc
!= RPC_GSS_PROC_DATA
)
1373 /* Release can be called twice, but we only wrap once. */
1374 if (gsd
->verf_start
== NULL
)
1376 /* normally not set till svc_send, but we need it here: */
1377 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1379 resbuf
->len
= total_buf_len(resbuf
);
1380 switch (gc
->gc_svc
) {
1381 case RPC_GSS_SVC_NONE
:
1383 case RPC_GSS_SVC_INTEGRITY
:
1384 stat
= svcauth_gss_wrap_resp_integ(rqstp
);
1388 case RPC_GSS_SVC_PRIVACY
:
1389 stat
= svcauth_gss_wrap_resp_priv(rqstp
);
1394 * For any other gc_svc value, svcauth_gss_accept() already set
1395 * the auth_error appropriately; just fall through:
1402 if (rqstp
->rq_client
)
1403 auth_domain_put(rqstp
->rq_client
);
1404 rqstp
->rq_client
= NULL
;
1405 if (rqstp
->rq_gssclient
)
1406 auth_domain_put(rqstp
->rq_gssclient
);
1407 rqstp
->rq_gssclient
= NULL
;
1408 if (rqstp
->rq_cred
.cr_group_info
)
1409 put_group_info(rqstp
->rq_cred
.cr_group_info
);
1410 rqstp
->rq_cred
.cr_group_info
= NULL
;
1412 cache_put(&gsd
->rsci
->h
, &rsc_cache
);
1419 svcauth_gss_domain_release(struct auth_domain
*dom
)
1421 struct gss_domain
*gd
= container_of(dom
, struct gss_domain
, h
);
1427 static struct auth_ops svcauthops_gss
= {
1428 .name
= "rpcsec_gss",
1429 .owner
= THIS_MODULE
,
1430 .flavour
= RPC_AUTH_GSS
,
1431 .accept
= svcauth_gss_accept
,
1432 .release
= svcauth_gss_release
,
1433 .domain_release
= svcauth_gss_domain_release
,
1434 .set_client
= svcauth_gss_set_client
,
1440 int rv
= svc_auth_register(RPC_AUTH_GSS
, &svcauthops_gss
);
1443 rv
= cache_register(&rsc_cache
);
1446 rv
= cache_register(&rsi_cache
);
1451 cache_unregister(&rsc_cache
);
1453 svc_auth_unregister(RPC_AUTH_GSS
);
1458 gss_svc_shutdown(void)
1460 cache_unregister(&rsc_cache
);
1461 cache_unregister(&rsi_cache
);
1462 svc_auth_unregister(RPC_AUTH_GSS
);