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/svcauth.h>
46 #include <linux/sunrpc/gss_err.h>
47 #include <linux/sunrpc/svcauth.h>
48 #include <linux/sunrpc/svcauth_gss.h>
49 #include <linux/sunrpc/cache.h>
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
);
186 static int rsi_parse(struct cache_detail
*cd
,
187 char *mesg
, int mlen
)
189 /* context token expiry major minor context token */
193 struct rsi rsii
, *rsip
= NULL
;
195 int status
= -EINVAL
;
197 memset(&rsii
, 0, sizeof(rsii
));
199 len
= qword_get(&mesg
, buf
, mlen
);
203 if (dup_to_netobj(&rsii
.in_handle
, buf
, len
))
207 len
= qword_get(&mesg
, buf
, mlen
);
212 if (dup_to_netobj(&rsii
.in_token
, buf
, len
))
215 rsip
= rsi_lookup(&rsii
);
221 expiry
= get_expiry(&mesg
);
227 len
= qword_get(&mesg
, buf
, mlen
);
233 rsii
.major_status
= simple_strtoul(buf
, &ep
, 10);
236 len
= qword_get(&mesg
, buf
, mlen
);
239 rsii
.minor_status
= simple_strtoul(buf
, &ep
, 10);
244 len
= qword_get(&mesg
, buf
, mlen
);
248 if (dup_to_netobj(&rsii
.out_handle
, buf
, len
))
252 len
= qword_get(&mesg
, buf
, mlen
);
257 if (dup_to_netobj(&rsii
.out_token
, buf
, len
))
260 rsii
.h
.expiry_time
= expiry
;
261 rsip
= rsi_update(&rsii
, rsip
);
266 cache_put(&rsip
->h
, &rsi_cache
);
272 static struct cache_detail rsi_cache
= {
273 .owner
= THIS_MODULE
,
274 .hash_size
= RSI_HASHMAX
,
275 .hash_table
= rsi_table
,
276 .name
= "auth.rpcsec.init",
277 .cache_put
= rsi_put
,
278 .cache_request
= rsi_request
,
279 .cache_parse
= rsi_parse
,
282 .update
= update_rsi
,
286 static struct rsi
*rsi_lookup(struct rsi
*item
)
288 struct cache_head
*ch
;
289 int hash
= rsi_hash(item
);
291 ch
= sunrpc_cache_lookup(&rsi_cache
, &item
->h
, hash
);
293 return container_of(ch
, struct rsi
, h
);
298 static struct rsi
*rsi_update(struct rsi
*new, struct rsi
*old
)
300 struct cache_head
*ch
;
301 int hash
= rsi_hash(new);
303 ch
= sunrpc_cache_update(&rsi_cache
, &new->h
,
306 return container_of(ch
, struct rsi
, h
);
313 * The rpcsec_context cache is used to store a context that is
314 * used in data exchange.
315 * The key is a context handle. The content is:
316 * uid, gidlist, mechanism, service-set, mech-specific-data
319 #define RSC_HASHBITS 10
320 #define RSC_HASHMAX (1<<RSC_HASHBITS)
321 #define RSC_HASHMASK (RSC_HASHMAX-1)
323 #define GSS_SEQ_WIN 128
325 struct gss_svc_seq_data
{
326 /* highest seq number seen so far: */
328 /* for i such that sd_max-GSS_SEQ_WIN < i <= sd_max, the i-th bit of
329 * sd_win is nonzero iff sequence number i has been seen already: */
330 unsigned long sd_win
[GSS_SEQ_WIN
/BITS_PER_LONG
];
336 struct xdr_netobj handle
;
337 struct svc_cred cred
;
338 struct gss_svc_seq_data seqdata
;
339 struct gss_ctx
*mechctx
;
342 static struct cache_head
*rsc_table
[RSC_HASHMAX
];
343 static struct cache_detail rsc_cache
;
344 static struct rsc
*rsc_update(struct rsc
*new, struct rsc
*old
);
345 static struct rsc
*rsc_lookup(struct rsc
*item
);
347 static void rsc_free(struct rsc
*rsci
)
349 kfree(rsci
->handle
.data
);
351 gss_delete_sec_context(&rsci
->mechctx
);
352 if (rsci
->cred
.cr_group_info
)
353 put_group_info(rsci
->cred
.cr_group_info
);
356 static void rsc_put(struct kref
*ref
)
358 struct rsc
*rsci
= container_of(ref
, struct rsc
, h
.ref
);
365 rsc_hash(struct rsc
*rsci
)
367 return hash_mem(rsci
->handle
.data
, rsci
->handle
.len
, RSC_HASHBITS
);
371 rsc_match(struct cache_head
*a
, struct cache_head
*b
)
373 struct rsc
*new = container_of(a
, struct rsc
, h
);
374 struct rsc
*tmp
= container_of(b
, struct rsc
, h
);
376 return netobj_equal(&new->handle
, &tmp
->handle
);
380 rsc_init(struct cache_head
*cnew
, struct cache_head
*ctmp
)
382 struct rsc
*new = container_of(cnew
, struct rsc
, h
);
383 struct rsc
*tmp
= container_of(ctmp
, struct rsc
, h
);
385 new->handle
.len
= tmp
->handle
.len
;
387 new->handle
.data
= tmp
->handle
.data
;
388 tmp
->handle
.data
= NULL
;
390 new->cred
.cr_group_info
= NULL
;
394 update_rsc(struct cache_head
*cnew
, struct cache_head
*ctmp
)
396 struct rsc
*new = container_of(cnew
, struct rsc
, h
);
397 struct rsc
*tmp
= container_of(ctmp
, struct rsc
, h
);
399 new->mechctx
= tmp
->mechctx
;
401 memset(&new->seqdata
, 0, sizeof(new->seqdata
));
402 spin_lock_init(&new->seqdata
.sd_lock
);
403 new->cred
= tmp
->cred
;
404 tmp
->cred
.cr_group_info
= NULL
;
407 static struct cache_head
*
410 struct rsc
*rsci
= kmalloc(sizeof(*rsci
), GFP_KERNEL
);
417 static int rsc_parse(struct cache_detail
*cd
,
418 char *mesg
, int mlen
)
420 /* contexthandle expiry [ uid gid N <n gids> mechname ...mechdata... ] */
423 struct rsc rsci
, *rscp
= NULL
;
425 int status
= -EINVAL
;
426 struct gss_api_mech
*gm
= NULL
;
428 memset(&rsci
, 0, sizeof(rsci
));
430 len
= qword_get(&mesg
, buf
, mlen
);
431 if (len
< 0) goto out
;
433 if (dup_to_netobj(&rsci
.handle
, buf
, len
))
438 expiry
= get_expiry(&mesg
);
443 rscp
= rsc_lookup(&rsci
);
447 /* uid, or NEGATIVE */
448 rv
= get_int(&mesg
, &rsci
.cred
.cr_uid
);
452 set_bit(CACHE_NEGATIVE
, &rsci
.h
.flags
);
457 if (get_int(&mesg
, &rsci
.cred
.cr_gid
))
460 /* number of additional gid's */
461 if (get_int(&mesg
, &N
))
464 rsci
.cred
.cr_group_info
= groups_alloc(N
);
465 if (rsci
.cred
.cr_group_info
== NULL
)
470 for (i
=0; i
<N
; i
++) {
472 if (get_int(&mesg
, &gid
))
474 GROUP_AT(rsci
.cred
.cr_group_info
, i
) = gid
;
478 len
= qword_get(&mesg
, buf
, mlen
);
481 gm
= gss_mech_get_by_name(buf
);
482 status
= -EOPNOTSUPP
;
487 /* mech-specific data: */
488 len
= qword_get(&mesg
, buf
, mlen
);
491 status
= gss_import_sec_context(buf
, len
, gm
, &rsci
.mechctx
);
495 rsci
.h
.expiry_time
= expiry
;
496 rscp
= rsc_update(&rsci
, rscp
);
502 cache_put(&rscp
->h
, &rsc_cache
);
508 static struct cache_detail rsc_cache
= {
509 .owner
= THIS_MODULE
,
510 .hash_size
= RSC_HASHMAX
,
511 .hash_table
= rsc_table
,
512 .name
= "auth.rpcsec.context",
513 .cache_put
= rsc_put
,
514 .cache_parse
= rsc_parse
,
517 .update
= update_rsc
,
521 static struct rsc
*rsc_lookup(struct rsc
*item
)
523 struct cache_head
*ch
;
524 int hash
= rsc_hash(item
);
526 ch
= sunrpc_cache_lookup(&rsc_cache
, &item
->h
, hash
);
528 return container_of(ch
, struct rsc
, h
);
533 static struct rsc
*rsc_update(struct rsc
*new, struct rsc
*old
)
535 struct cache_head
*ch
;
536 int hash
= rsc_hash(new);
538 ch
= sunrpc_cache_update(&rsc_cache
, &new->h
,
541 return container_of(ch
, struct rsc
, h
);
548 gss_svc_searchbyctx(struct xdr_netobj
*handle
)
553 memset(&rsci
, 0, sizeof(rsci
));
554 if (dup_to_netobj(&rsci
.handle
, handle
->data
, handle
->len
))
556 found
= rsc_lookup(&rsci
);
560 if (cache_check(&rsc_cache
, &found
->h
, NULL
))
565 /* Implements sequence number algorithm as specified in RFC 2203. */
567 gss_check_seq_num(struct rsc
*rsci
, int seq_num
)
569 struct gss_svc_seq_data
*sd
= &rsci
->seqdata
;
571 spin_lock(&sd
->sd_lock
);
572 if (seq_num
> sd
->sd_max
) {
573 if (seq_num
>= sd
->sd_max
+ GSS_SEQ_WIN
) {
574 memset(sd
->sd_win
,0,sizeof(sd
->sd_win
));
575 sd
->sd_max
= seq_num
;
576 } else while (sd
->sd_max
< seq_num
) {
578 __clear_bit(sd
->sd_max
% GSS_SEQ_WIN
, sd
->sd_win
);
580 __set_bit(seq_num
% GSS_SEQ_WIN
, sd
->sd_win
);
582 } else if (seq_num
<= sd
->sd_max
- GSS_SEQ_WIN
) {
585 /* sd_max - GSS_SEQ_WIN < seq_num <= sd_max */
586 if (__test_and_set_bit(seq_num
% GSS_SEQ_WIN
, sd
->sd_win
))
589 spin_unlock(&sd
->sd_lock
);
592 spin_unlock(&sd
->sd_lock
);
596 static inline u32
round_up_to_quad(u32 i
)
598 return (i
+ 3 ) & ~3;
602 svc_safe_getnetobj(struct kvec
*argv
, struct xdr_netobj
*o
)
606 if (argv
->iov_len
< 4)
608 o
->len
= svc_getnl(argv
);
609 l
= round_up_to_quad(o
->len
);
610 if (argv
->iov_len
< l
)
612 o
->data
= argv
->iov_base
;
619 svc_safe_putnetobj(struct kvec
*resv
, struct xdr_netobj
*o
)
623 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
625 svc_putnl(resv
, o
->len
);
626 p
= resv
->iov_base
+ resv
->iov_len
;
627 resv
->iov_len
+= round_up_to_quad(o
->len
);
628 if (resv
->iov_len
> PAGE_SIZE
)
630 memcpy(p
, o
->data
, o
->len
);
631 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 large sequence number %d\n",
674 *authp
= rpcsec_gsserr_ctxproblem
;
677 if (!gss_check_seq_num(rsci
, gc
->gc_seq
)) {
678 dprintk("RPC: svcauth_gss: discarding request with old sequence number %d\n",
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
;
747 svcauth_gss_register_pseudoflavor(u32 pseudoflavor
, char * name
)
749 struct gss_domain
*new;
750 struct auth_domain
*test
;
753 new = kmalloc(sizeof(*new), GFP_KERNEL
);
756 kref_init(&new->h
.ref
);
757 new->h
.name
= kstrdup(name
, GFP_KERNEL
);
760 new->h
.flavour
= &svcauthops_gss
;
761 new->pseudoflavor
= pseudoflavor
;
763 test
= auth_domain_lookup(name
, &new->h
);
764 if (test
!= &new->h
) { /* XXX Duplicate registration? */
765 auth_domain_put(&new->h
);
766 /* dangling ref-count... */
777 EXPORT_SYMBOL(svcauth_gss_register_pseudoflavor
);
780 read_u32_from_xdr_buf(struct xdr_buf
*buf
, int base
, u32
*obj
)
785 status
= read_bytes_from_xdr_buf(buf
, base
, &raw
, sizeof(*obj
));
792 /* It would be nice if this bit of code could be shared with the client.
794 * The client shouldn't malloc(), would have to pass in own memory.
795 * The server uses base of head iovec as read pointer, while the
796 * client uses separate pointer. */
798 unwrap_integ_data(struct xdr_buf
*buf
, u32 seq
, struct gss_ctx
*ctx
)
801 u32 integ_len
, maj_stat
;
802 struct xdr_netobj mic
;
803 struct xdr_buf integ_buf
;
805 integ_len
= svc_getnl(&buf
->head
[0]);
808 if (integ_len
> buf
->len
)
810 if (xdr_buf_subsegment(buf
, &integ_buf
, 0, integ_len
))
812 /* copy out mic... */
813 if (read_u32_from_xdr_buf(buf
, integ_len
, &mic
.len
))
815 if (mic
.len
> RPC_MAX_AUTH_SIZE
)
817 mic
.data
= kmalloc(mic
.len
, GFP_KERNEL
);
820 if (read_bytes_from_xdr_buf(buf
, integ_len
+ 4, mic
.data
, mic
.len
))
822 maj_stat
= gss_verify_mic(ctx
, &integ_buf
, &mic
);
823 if (maj_stat
!= GSS_S_COMPLETE
)
825 if (svc_getnl(&buf
->head
[0]) != seq
)
833 total_buf_len(struct xdr_buf
*buf
)
835 return buf
->head
[0].iov_len
+ buf
->page_len
+ buf
->tail
[0].iov_len
;
839 fix_priv_head(struct xdr_buf
*buf
, int pad
)
841 if (buf
->page_len
== 0) {
842 /* We need to adjust head and buf->len in tandem in this
843 * case to make svc_defer() work--it finds the original
844 * buffer start using buf->len - buf->head[0].iov_len. */
845 buf
->head
[0].iov_len
-= pad
;
850 unwrap_priv_data(struct svc_rqst
*rqstp
, struct xdr_buf
*buf
, u32 seq
, struct gss_ctx
*ctx
)
852 u32 priv_len
, maj_stat
;
853 int pad
, saved_len
, remaining_len
, offset
;
855 rqstp
->rq_sendfile_ok
= 0;
857 priv_len
= svc_getnl(&buf
->head
[0]);
858 if (rqstp
->rq_deferred
) {
859 /* Already decrypted last time through! The sequence number
860 * check at out_seq is unnecessary but harmless: */
863 /* buf->len is the number of bytes from the original start of the
864 * request to the end, where head[0].iov_len is just the bytes
865 * not yet read from the head, so these two values are different: */
866 remaining_len
= total_buf_len(buf
);
867 if (priv_len
> remaining_len
)
869 pad
= remaining_len
- priv_len
;
871 fix_priv_head(buf
, pad
);
873 /* Maybe it would be better to give gss_unwrap a length parameter: */
874 saved_len
= buf
->len
;
876 maj_stat
= gss_unwrap(ctx
, 0, buf
);
877 pad
= priv_len
- buf
->len
;
878 buf
->len
= saved_len
;
880 /* The upper layers assume the buffer is aligned on 4-byte boundaries.
881 * In the krb5p case, at least, the data ends up offset, so we need to
883 /* XXX: This is very inefficient. It would be better to either do
884 * this while we encrypt, or maybe in the receive code, if we can peak
885 * ahead and work out the service and mechanism there. */
886 offset
= buf
->head
[0].iov_len
% 4;
888 buf
->buflen
= RPCSVC_MAXPAYLOAD
;
889 xdr_shift_buf(buf
, offset
);
890 fix_priv_head(buf
, pad
);
892 if (maj_stat
!= GSS_S_COMPLETE
)
895 if (svc_getnl(&buf
->head
[0]) != seq
)
900 struct gss_svc_data
{
901 /* decoded gss client cred: */
902 struct rpc_gss_wire_cred clcred
;
903 /* save a pointer to the beginning of the encoded verifier,
904 * for use in encryption/checksumming in svcauth_gss_release: */
910 svcauth_gss_set_client(struct svc_rqst
*rqstp
)
912 struct gss_svc_data
*svcdata
= rqstp
->rq_auth_data
;
913 struct rsc
*rsci
= svcdata
->rsci
;
914 struct rpc_gss_wire_cred
*gc
= &svcdata
->clcred
;
916 rqstp
->rq_client
= find_gss_auth_domain(rsci
->mechctx
, gc
->gc_svc
);
917 if (rqstp
->rq_client
== NULL
)
923 gss_write_init_verf(struct svc_rqst
*rqstp
, struct rsi
*rsip
)
927 if (rsip
->major_status
!= GSS_S_COMPLETE
)
928 return gss_write_null_verf(rqstp
);
929 rsci
= gss_svc_searchbyctx(&rsip
->out_handle
);
931 rsip
->major_status
= GSS_S_NO_CONTEXT
;
932 return gss_write_null_verf(rqstp
);
934 return gss_write_verf(rqstp
, rsci
->mechctx
, GSS_SEQ_WIN
);
938 * Accept an rpcsec packet.
939 * If context establishment, punt to user space
940 * If data exchange, verify/decrypt
941 * If context destruction, handle here
942 * In the context establishment and destruction case we encode
943 * response here and return SVC_COMPLETE.
946 svcauth_gss_accept(struct svc_rqst
*rqstp
, __be32
*authp
)
948 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
949 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
951 struct xdr_netobj tmpobj
;
952 struct gss_svc_data
*svcdata
= rqstp
->rq_auth_data
;
953 struct rpc_gss_wire_cred
*gc
;
954 struct rsc
*rsci
= NULL
;
955 struct rsi
*rsip
, rsikey
;
957 __be32
*reject_stat
= resv
->iov_base
+ resv
->iov_len
;
960 dprintk("RPC: svcauth_gss: argv->iov_len = %zd\n",argv
->iov_len
);
962 *authp
= rpc_autherr_badcred
;
964 svcdata
= kmalloc(sizeof(*svcdata
), GFP_KERNEL
);
967 rqstp
->rq_auth_data
= svcdata
;
968 svcdata
->verf_start
= NULL
;
969 svcdata
->rsci
= NULL
;
970 gc
= &svcdata
->clcred
;
972 /* start of rpc packet is 7 u32's back from here:
973 * xid direction rpcversion prog vers proc flavour
975 rpcstart
= argv
->iov_base
;
979 * version(==1), proc(0,1,2,3), seq, service (1,2,3), handle
980 * at least 5 u32s, and is preceeded by length, so that makes 6.
983 if (argv
->iov_len
< 5 * 4)
985 crlen
= svc_getnl(argv
);
986 if (svc_getnl(argv
) != RPC_GSS_VERSION
)
988 gc
->gc_proc
= svc_getnl(argv
);
989 gc
->gc_seq
= svc_getnl(argv
);
990 gc
->gc_svc
= svc_getnl(argv
);
991 if (svc_safe_getnetobj(argv
, &gc
->gc_ctx
))
993 if (crlen
!= round_up_to_quad(gc
->gc_ctx
.len
) + 5 * 4)
996 if ((gc
->gc_proc
!= RPC_GSS_PROC_DATA
) && (rqstp
->rq_proc
!= 0))
1000 * We've successfully parsed the credential. Let's check out the
1001 * verifier. An AUTH_NULL verifier is allowed (and required) for
1002 * INIT and CONTINUE_INIT requests. AUTH_RPCSEC_GSS is required for
1003 * PROC_DATA and PROC_DESTROY.
1005 * AUTH_NULL verifier is 0 (AUTH_NULL), 0 (length).
1006 * AUTH_RPCSEC_GSS verifier is:
1007 * 6 (AUTH_RPCSEC_GSS), length, checksum.
1008 * checksum is calculated over rpcheader from xid up to here.
1010 *authp
= rpc_autherr_badverf
;
1011 switch (gc
->gc_proc
) {
1012 case RPC_GSS_PROC_INIT
:
1013 case RPC_GSS_PROC_CONTINUE_INIT
:
1014 if (argv
->iov_len
< 2 * 4)
1016 if (svc_getnl(argv
) != RPC_AUTH_NULL
)
1018 if (svc_getnl(argv
) != 0)
1021 case RPC_GSS_PROC_DATA
:
1022 case RPC_GSS_PROC_DESTROY
:
1023 *authp
= rpcsec_gsserr_credproblem
;
1024 rsci
= gss_svc_searchbyctx(&gc
->gc_ctx
);
1027 switch (gss_verify_header(rqstp
, rsci
, rpcstart
, gc
, authp
)) {
1037 *authp
= rpc_autherr_rejectedcred
;
1041 /* now act upon the command: */
1042 switch (gc
->gc_proc
) {
1043 case RPC_GSS_PROC_INIT
:
1044 case RPC_GSS_PROC_CONTINUE_INIT
:
1045 *authp
= rpc_autherr_badcred
;
1046 if (gc
->gc_proc
== RPC_GSS_PROC_INIT
&& gc
->gc_ctx
.len
!= 0)
1048 memset(&rsikey
, 0, sizeof(rsikey
));
1049 if (dup_netobj(&rsikey
.in_handle
, &gc
->gc_ctx
))
1051 *authp
= rpc_autherr_badverf
;
1052 if (svc_safe_getnetobj(argv
, &tmpobj
)) {
1053 kfree(rsikey
.in_handle
.data
);
1056 if (dup_netobj(&rsikey
.in_token
, &tmpobj
)) {
1057 kfree(rsikey
.in_handle
.data
);
1061 rsip
= rsi_lookup(&rsikey
);
1066 switch(cache_check(&rsi_cache
, &rsip
->h
, &rqstp
->rq_chandle
)) {
1072 if (gss_write_init_verf(rqstp
, rsip
))
1074 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
1076 svc_putnl(resv
, RPC_SUCCESS
);
1077 if (svc_safe_putnetobj(resv
, &rsip
->out_handle
))
1079 if (resv
->iov_len
+ 3 * 4 > PAGE_SIZE
)
1081 svc_putnl(resv
, rsip
->major_status
);
1082 svc_putnl(resv
, rsip
->minor_status
);
1083 svc_putnl(resv
, GSS_SEQ_WIN
);
1084 if (svc_safe_putnetobj(resv
, &rsip
->out_token
))
1086 rqstp
->rq_client
= NULL
;
1089 case RPC_GSS_PROC_DESTROY
:
1090 set_bit(CACHE_NEGATIVE
, &rsci
->h
.flags
);
1091 if (resv
->iov_len
+ 4 > PAGE_SIZE
)
1093 svc_putnl(resv
, RPC_SUCCESS
);
1095 case RPC_GSS_PROC_DATA
:
1096 *authp
= rpcsec_gsserr_ctxproblem
;
1097 svcdata
->verf_start
= resv
->iov_base
+ resv
->iov_len
;
1098 if (gss_write_verf(rqstp
, rsci
->mechctx
, gc
->gc_seq
))
1100 rqstp
->rq_cred
= rsci
->cred
;
1101 get_group_info(rsci
->cred
.cr_group_info
);
1102 *authp
= rpc_autherr_badcred
;
1103 switch (gc
->gc_svc
) {
1104 case RPC_GSS_SVC_NONE
:
1106 case RPC_GSS_SVC_INTEGRITY
:
1107 if (unwrap_integ_data(&rqstp
->rq_arg
,
1108 gc
->gc_seq
, rsci
->mechctx
))
1110 /* placeholders for length and seq. number: */
1114 case RPC_GSS_SVC_PRIVACY
:
1115 if (unwrap_priv_data(rqstp
, &rqstp
->rq_arg
,
1116 gc
->gc_seq
, rsci
->mechctx
))
1118 /* placeholders for length and seq. number: */
1125 svcdata
->rsci
= rsci
;
1126 cache_get(&rsci
->h
);
1131 /* Restore write pointer to original value: */
1132 xdr_ressize_check(rqstp
, reject_stat
);
1142 cache_put(&rsci
->h
, &rsc_cache
);
1147 svcauth_gss_prepare_to_wrap(struct xdr_buf
*resbuf
, struct gss_svc_data
*gsd
)
1152 p
= gsd
->verf_start
;
1153 gsd
->verf_start
= NULL
;
1155 /* If the reply stat is nonzero, don't wrap: */
1156 if (*(p
-1) != rpc_success
)
1158 /* Skip the verifier: */
1160 verf_len
= ntohl(*p
++);
1161 p
+= XDR_QUADLEN(verf_len
);
1162 /* move accept_stat to right place: */
1163 memcpy(p
, p
+ 2, 4);
1164 /* Also don't wrap if the accept stat is nonzero: */
1165 if (*p
!= rpc_success
) {
1166 resbuf
->head
[0].iov_len
-= 2 * 4;
1174 svcauth_gss_wrap_resp_integ(struct svc_rqst
*rqstp
)
1176 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1177 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1178 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1179 struct xdr_buf integ_buf
;
1180 struct xdr_netobj mic
;
1183 int integ_offset
, integ_len
;
1186 p
= svcauth_gss_prepare_to_wrap(resbuf
, gsd
);
1189 integ_offset
= (u8
*)(p
+ 1) - (u8
*)resbuf
->head
[0].iov_base
;
1190 integ_len
= resbuf
->len
- integ_offset
;
1191 BUG_ON(integ_len
% 4);
1192 *p
++ = htonl(integ_len
);
1193 *p
++ = htonl(gc
->gc_seq
);
1194 if (xdr_buf_subsegment(resbuf
, &integ_buf
, integ_offset
,
1197 if (resbuf
->page_len
== 0
1198 && resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
1200 BUG_ON(resbuf
->tail
[0].iov_len
);
1201 /* Use head for everything */
1202 resv
= &resbuf
->head
[0];
1203 } else if (resbuf
->tail
[0].iov_base
== NULL
) {
1204 if (resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1206 resbuf
->tail
[0].iov_base
= resbuf
->head
[0].iov_base
1207 + resbuf
->head
[0].iov_len
;
1208 resbuf
->tail
[0].iov_len
= 0;
1209 resv
= &resbuf
->tail
[0];
1211 resv
= &resbuf
->tail
[0];
1213 mic
.data
= (u8
*)resv
->iov_base
+ resv
->iov_len
+ 4;
1214 if (gss_get_mic(gsd
->rsci
->mechctx
, &integ_buf
, &mic
))
1216 svc_putnl(resv
, mic
.len
);
1217 memset(mic
.data
+ mic
.len
, 0,
1218 round_up_to_quad(mic
.len
) - mic
.len
);
1219 resv
->iov_len
+= XDR_QUADLEN(mic
.len
) << 2;
1220 /* not strictly required: */
1221 resbuf
->len
+= XDR_QUADLEN(mic
.len
) << 2;
1222 BUG_ON(resv
->iov_len
> PAGE_SIZE
);
1230 svcauth_gss_wrap_resp_priv(struct svc_rqst
*rqstp
)
1232 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1233 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1234 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1235 struct page
**inpages
= NULL
;
1240 p
= svcauth_gss_prepare_to_wrap(resbuf
, gsd
);
1244 offset
= (u8
*)p
- (u8
*)resbuf
->head
[0].iov_base
;
1245 *p
++ = htonl(gc
->gc_seq
);
1246 inpages
= resbuf
->pages
;
1247 /* XXX: Would be better to write some xdr helper functions for
1248 * nfs{2,3,4}xdr.c that place the data right, instead of copying: */
1249 if (resbuf
->tail
[0].iov_base
) {
1250 BUG_ON(resbuf
->tail
[0].iov_base
>= resbuf
->head
[0].iov_base
1252 BUG_ON(resbuf
->tail
[0].iov_base
< resbuf
->head
[0].iov_base
);
1253 if (resbuf
->tail
[0].iov_len
+ resbuf
->head
[0].iov_len
1254 + 2 * RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1256 memmove(resbuf
->tail
[0].iov_base
+ RPC_MAX_AUTH_SIZE
,
1257 resbuf
->tail
[0].iov_base
,
1258 resbuf
->tail
[0].iov_len
);
1259 resbuf
->tail
[0].iov_base
+= RPC_MAX_AUTH_SIZE
;
1261 if (resbuf
->tail
[0].iov_base
== NULL
) {
1262 if (resbuf
->head
[0].iov_len
+ 2*RPC_MAX_AUTH_SIZE
> PAGE_SIZE
)
1264 resbuf
->tail
[0].iov_base
= resbuf
->head
[0].iov_base
1265 + resbuf
->head
[0].iov_len
+ RPC_MAX_AUTH_SIZE
;
1266 resbuf
->tail
[0].iov_len
= 0;
1268 if (gss_wrap(gsd
->rsci
->mechctx
, offset
, resbuf
, inpages
))
1270 *len
= htonl(resbuf
->len
- offset
);
1271 pad
= 3 - ((resbuf
->len
- offset
- 1)&3);
1272 p
= (__be32
*)(resbuf
->tail
[0].iov_base
+ resbuf
->tail
[0].iov_len
);
1274 resbuf
->tail
[0].iov_len
+= pad
;
1280 svcauth_gss_release(struct svc_rqst
*rqstp
)
1282 struct gss_svc_data
*gsd
= (struct gss_svc_data
*)rqstp
->rq_auth_data
;
1283 struct rpc_gss_wire_cred
*gc
= &gsd
->clcred
;
1284 struct xdr_buf
*resbuf
= &rqstp
->rq_res
;
1287 if (gc
->gc_proc
!= RPC_GSS_PROC_DATA
)
1289 /* Release can be called twice, but we only wrap once. */
1290 if (gsd
->verf_start
== NULL
)
1292 /* normally not set till svc_send, but we need it here: */
1293 /* XXX: what for? Do we mess it up the moment we call svc_putu32
1295 resbuf
->len
= total_buf_len(resbuf
);
1296 switch (gc
->gc_svc
) {
1297 case RPC_GSS_SVC_NONE
:
1299 case RPC_GSS_SVC_INTEGRITY
:
1300 stat
= svcauth_gss_wrap_resp_integ(rqstp
);
1304 case RPC_GSS_SVC_PRIVACY
:
1305 stat
= svcauth_gss_wrap_resp_priv(rqstp
);
1316 if (rqstp
->rq_client
)
1317 auth_domain_put(rqstp
->rq_client
);
1318 rqstp
->rq_client
= NULL
;
1319 if (rqstp
->rq_cred
.cr_group_info
)
1320 put_group_info(rqstp
->rq_cred
.cr_group_info
);
1321 rqstp
->rq_cred
.cr_group_info
= NULL
;
1323 cache_put(&gsd
->rsci
->h
, &rsc_cache
);
1330 svcauth_gss_domain_release(struct auth_domain
*dom
)
1332 struct gss_domain
*gd
= container_of(dom
, struct gss_domain
, h
);
1338 static struct auth_ops svcauthops_gss
= {
1339 .name
= "rpcsec_gss",
1340 .owner
= THIS_MODULE
,
1341 .flavour
= RPC_AUTH_GSS
,
1342 .accept
= svcauth_gss_accept
,
1343 .release
= svcauth_gss_release
,
1344 .domain_release
= svcauth_gss_domain_release
,
1345 .set_client
= svcauth_gss_set_client
,
1351 int rv
= svc_auth_register(RPC_AUTH_GSS
, &svcauthops_gss
);
1353 cache_register(&rsc_cache
);
1354 cache_register(&rsi_cache
);
1360 gss_svc_shutdown(void)
1362 if (cache_unregister(&rsc_cache
))
1363 printk(KERN_ERR
"auth_rpcgss: failed to unregister rsc cache\n");
1364 if (cache_unregister(&rsi_cache
))
1365 printk(KERN_ERR
"auth_rpcgss: failed to unregister rsi cache\n");
1366 svc_auth_unregister(RPC_AUTH_GSS
);