2 * linux/net/sunrpc/auth_gss/auth_gss.c
4 * RPCSEC_GSS client authentication.
6 * Copyright (c) 2000 The Regents of the University of Michigan.
9 * Dug Song <dugsong@monkey.org>
10 * Andy Adamson <andros@umich.edu>
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its
22 * contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
26 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
27 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include <linux/module.h>
40 #include <linux/init.h>
41 #include <linux/types.h>
42 #include <linux/slab.h>
43 #include <linux/sched.h>
44 #include <linux/pagemap.h>
45 #include <linux/sunrpc/clnt.h>
46 #include <linux/sunrpc/auth.h>
47 #include <linux/sunrpc/auth_gss.h>
48 #include <linux/sunrpc/svcauth_gss.h>
49 #include <linux/sunrpc/gss_err.h>
50 #include <linux/workqueue.h>
51 #include <linux/sunrpc/rpc_pipe_fs.h>
52 #include <linux/sunrpc/gss_api.h>
53 #include <asm/uaccess.h>
55 static const struct rpc_authops authgss_ops
;
57 static const struct rpc_credops gss_credops
;
58 static const struct rpc_credops gss_nullops
;
61 # define RPCDBG_FACILITY RPCDBG_AUTH
64 #define GSS_CRED_SLACK 1024
65 /* length of a krb5 verifier (48), plus data added before arguments when
66 * using integrity (two 4-byte integers): */
67 #define GSS_VERF_SLACK 100
71 struct rpc_auth rpc_auth
;
72 struct gss_api_mech
*mech
;
73 enum rpc_gss_svc service
;
74 struct rpc_clnt
*client
;
75 struct dentry
*dentry
;
78 static void gss_free_ctx(struct gss_cl_ctx
*);
79 static struct rpc_pipe_ops gss_upcall_ops
;
81 static inline struct gss_cl_ctx
*
82 gss_get_ctx(struct gss_cl_ctx
*ctx
)
84 atomic_inc(&ctx
->count
);
89 gss_put_ctx(struct gss_cl_ctx
*ctx
)
91 if (atomic_dec_and_test(&ctx
->count
))
96 * called by gss_upcall_callback and gss_create_upcall in order
97 * to set the gss context. The actual exchange of an old context
98 * and a new one is protected by the inode->i_lock.
101 gss_cred_set_ctx(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
)
103 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
105 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
108 rcu_assign_pointer(gss_cred
->gc_ctx
, ctx
);
109 set_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
110 smp_mb__before_clear_bit();
111 clear_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
);
115 simple_get_bytes(const void *p
, const void *end
, void *res
, size_t len
)
117 const void *q
= (const void *)((const char *)p
+ len
);
118 if (unlikely(q
> end
|| q
< p
))
119 return ERR_PTR(-EFAULT
);
124 static inline const void *
125 simple_get_netobj(const void *p
, const void *end
, struct xdr_netobj
*dest
)
130 p
= simple_get_bytes(p
, end
, &len
, sizeof(len
));
133 q
= (const void *)((const char *)p
+ len
);
134 if (unlikely(q
> end
|| q
< p
))
135 return ERR_PTR(-EFAULT
);
136 dest
->data
= kmemdup(p
, len
, GFP_NOFS
);
137 if (unlikely(dest
->data
== NULL
))
138 return ERR_PTR(-ENOMEM
);
143 static struct gss_cl_ctx
*
144 gss_cred_get_ctx(struct rpc_cred
*cred
)
146 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
147 struct gss_cl_ctx
*ctx
= NULL
;
150 if (gss_cred
->gc_ctx
)
151 ctx
= gss_get_ctx(gss_cred
->gc_ctx
);
156 static struct gss_cl_ctx
*
157 gss_alloc_context(void)
159 struct gss_cl_ctx
*ctx
;
161 ctx
= kzalloc(sizeof(*ctx
), GFP_NOFS
);
163 ctx
->gc_proc
= RPC_GSS_PROC_DATA
;
164 ctx
->gc_seq
= 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
165 spin_lock_init(&ctx
->gc_seq_lock
);
166 atomic_set(&ctx
->count
,1);
171 #define GSSD_MIN_TIMEOUT (60 * 60)
173 gss_fill_context(const void *p
, const void *end
, struct gss_cl_ctx
*ctx
, struct gss_api_mech
*gm
)
177 unsigned int timeout
;
181 /* First unsigned int gives the lifetime (in seconds) of the cred */
182 p
= simple_get_bytes(p
, end
, &timeout
, sizeof(timeout
));
186 timeout
= GSSD_MIN_TIMEOUT
;
187 ctx
->gc_expiry
= jiffies
+ (unsigned long)timeout
* HZ
* 3 / 4;
188 /* Sequence number window. Determines the maximum number of simultaneous requests */
189 p
= simple_get_bytes(p
, end
, &window_size
, sizeof(window_size
));
192 ctx
->gc_win
= window_size
;
193 /* gssd signals an error by passing ctx->gc_win = 0: */
194 if (ctx
->gc_win
== 0) {
195 /* in which case, p points to an error code which we ignore */
196 p
= ERR_PTR(-EACCES
);
199 /* copy the opaque wire context */
200 p
= simple_get_netobj(p
, end
, &ctx
->gc_wire_ctx
);
203 /* import the opaque security context */
204 p
= simple_get_bytes(p
, end
, &seclen
, sizeof(seclen
));
207 q
= (const void *)((const char *)p
+ seclen
);
208 if (unlikely(q
> end
|| q
< p
)) {
209 p
= ERR_PTR(-EFAULT
);
212 ret
= gss_import_sec_context(p
, seclen
, gm
, &ctx
->gc_gss_ctx
);
219 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p
));
224 struct gss_upcall_msg
{
227 struct rpc_pipe_msg msg
;
228 struct list_head list
;
229 struct gss_auth
*auth
;
230 struct rpc_wait_queue rpc_waitqueue
;
231 wait_queue_head_t waitqueue
;
232 struct gss_cl_ctx
*ctx
;
236 gss_release_msg(struct gss_upcall_msg
*gss_msg
)
238 if (!atomic_dec_and_test(&gss_msg
->count
))
240 BUG_ON(!list_empty(&gss_msg
->list
));
241 if (gss_msg
->ctx
!= NULL
)
242 gss_put_ctx(gss_msg
->ctx
);
243 rpc_destroy_wait_queue(&gss_msg
->rpc_waitqueue
);
247 static struct gss_upcall_msg
*
248 __gss_find_upcall(struct rpc_inode
*rpci
, uid_t uid
)
250 struct gss_upcall_msg
*pos
;
251 list_for_each_entry(pos
, &rpci
->in_downcall
, list
) {
254 atomic_inc(&pos
->count
);
255 dprintk("RPC: gss_find_upcall found msg %p\n", pos
);
258 dprintk("RPC: gss_find_upcall found nothing\n");
262 /* Try to add an upcall to the pipefs queue.
263 * If an upcall owned by our uid already exists, then we return a reference
264 * to that upcall instead of adding the new upcall.
266 static inline struct gss_upcall_msg
*
267 gss_add_msg(struct gss_auth
*gss_auth
, struct gss_upcall_msg
*gss_msg
)
269 struct inode
*inode
= gss_auth
->dentry
->d_inode
;
270 struct rpc_inode
*rpci
= RPC_I(inode
);
271 struct gss_upcall_msg
*old
;
273 spin_lock(&inode
->i_lock
);
274 old
= __gss_find_upcall(rpci
, gss_msg
->uid
);
276 atomic_inc(&gss_msg
->count
);
277 list_add(&gss_msg
->list
, &rpci
->in_downcall
);
280 spin_unlock(&inode
->i_lock
);
285 __gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
287 list_del_init(&gss_msg
->list
);
288 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
289 wake_up_all(&gss_msg
->waitqueue
);
290 atomic_dec(&gss_msg
->count
);
294 gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
296 struct gss_auth
*gss_auth
= gss_msg
->auth
;
297 struct inode
*inode
= gss_auth
->dentry
->d_inode
;
299 if (list_empty(&gss_msg
->list
))
301 spin_lock(&inode
->i_lock
);
302 if (!list_empty(&gss_msg
->list
))
303 __gss_unhash_msg(gss_msg
);
304 spin_unlock(&inode
->i_lock
);
308 gss_upcall_callback(struct rpc_task
*task
)
310 struct gss_cred
*gss_cred
= container_of(task
->tk_msg
.rpc_cred
,
311 struct gss_cred
, gc_base
);
312 struct gss_upcall_msg
*gss_msg
= gss_cred
->gc_upcall
;
313 struct inode
*inode
= gss_msg
->auth
->dentry
->d_inode
;
315 spin_lock(&inode
->i_lock
);
317 gss_cred_set_ctx(task
->tk_msg
.rpc_cred
, gss_msg
->ctx
);
319 task
->tk_status
= gss_msg
->msg
.errno
;
320 gss_cred
->gc_upcall
= NULL
;
321 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
322 spin_unlock(&inode
->i_lock
);
323 gss_release_msg(gss_msg
);
326 static inline struct gss_upcall_msg
*
327 gss_alloc_msg(struct gss_auth
*gss_auth
, uid_t uid
)
329 struct gss_upcall_msg
*gss_msg
;
331 gss_msg
= kzalloc(sizeof(*gss_msg
), GFP_NOFS
);
332 if (gss_msg
!= NULL
) {
333 INIT_LIST_HEAD(&gss_msg
->list
);
334 rpc_init_wait_queue(&gss_msg
->rpc_waitqueue
, "RPCSEC_GSS upcall waitq");
335 init_waitqueue_head(&gss_msg
->waitqueue
);
336 atomic_set(&gss_msg
->count
, 1);
337 gss_msg
->msg
.data
= &gss_msg
->uid
;
338 gss_msg
->msg
.len
= sizeof(gss_msg
->uid
);
340 gss_msg
->auth
= gss_auth
;
345 static struct gss_upcall_msg
*
346 gss_setup_upcall(struct rpc_clnt
*clnt
, struct gss_auth
*gss_auth
, struct rpc_cred
*cred
)
348 struct gss_cred
*gss_cred
= container_of(cred
,
349 struct gss_cred
, gc_base
);
350 struct gss_upcall_msg
*gss_new
, *gss_msg
;
351 uid_t uid
= cred
->cr_uid
;
353 /* Special case: rpc.gssd assumes that uid == 0 implies machine creds */
354 if (gss_cred
->gc_machine_cred
!= 0)
357 gss_new
= gss_alloc_msg(gss_auth
, uid
);
359 return ERR_PTR(-ENOMEM
);
360 gss_msg
= gss_add_msg(gss_auth
, gss_new
);
361 if (gss_msg
== gss_new
) {
362 int res
= rpc_queue_upcall(gss_auth
->dentry
->d_inode
, &gss_new
->msg
);
364 gss_unhash_msg(gss_new
);
365 gss_msg
= ERR_PTR(res
);
368 gss_release_msg(gss_new
);
373 gss_refresh_upcall(struct rpc_task
*task
)
375 struct rpc_cred
*cred
= task
->tk_msg
.rpc_cred
;
376 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
,
377 struct gss_auth
, rpc_auth
);
378 struct gss_cred
*gss_cred
= container_of(cred
,
379 struct gss_cred
, gc_base
);
380 struct gss_upcall_msg
*gss_msg
;
381 struct inode
*inode
= gss_auth
->dentry
->d_inode
;
384 dprintk("RPC: %5u gss_refresh_upcall for uid %u\n", task
->tk_pid
,
386 gss_msg
= gss_setup_upcall(task
->tk_client
, gss_auth
, cred
);
387 if (IS_ERR(gss_msg
)) {
388 err
= PTR_ERR(gss_msg
);
391 spin_lock(&inode
->i_lock
);
392 if (gss_cred
->gc_upcall
!= NULL
)
393 rpc_sleep_on(&gss_cred
->gc_upcall
->rpc_waitqueue
, task
, NULL
);
394 else if (gss_msg
->ctx
!= NULL
) {
395 gss_cred_set_ctx(task
->tk_msg
.rpc_cred
, gss_msg
->ctx
);
396 gss_cred
->gc_upcall
= NULL
;
397 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
398 } else if (gss_msg
->msg
.errno
>= 0) {
399 task
->tk_timeout
= 0;
400 gss_cred
->gc_upcall
= gss_msg
;
401 /* gss_upcall_callback will release the reference to gss_upcall_msg */
402 atomic_inc(&gss_msg
->count
);
403 rpc_sleep_on(&gss_msg
->rpc_waitqueue
, task
, gss_upcall_callback
);
405 err
= gss_msg
->msg
.errno
;
406 spin_unlock(&inode
->i_lock
);
407 gss_release_msg(gss_msg
);
409 dprintk("RPC: %5u gss_refresh_upcall for uid %u result %d\n",
410 task
->tk_pid
, cred
->cr_uid
, err
);
415 gss_create_upcall(struct gss_auth
*gss_auth
, struct gss_cred
*gss_cred
)
417 struct inode
*inode
= gss_auth
->dentry
->d_inode
;
418 struct rpc_cred
*cred
= &gss_cred
->gc_base
;
419 struct gss_upcall_msg
*gss_msg
;
423 dprintk("RPC: gss_upcall for uid %u\n", cred
->cr_uid
);
424 gss_msg
= gss_setup_upcall(gss_auth
->client
, gss_auth
, cred
);
425 if (IS_ERR(gss_msg
)) {
426 err
= PTR_ERR(gss_msg
);
430 prepare_to_wait(&gss_msg
->waitqueue
, &wait
, TASK_INTERRUPTIBLE
);
431 spin_lock(&inode
->i_lock
);
432 if (gss_msg
->ctx
!= NULL
|| gss_msg
->msg
.errno
< 0) {
435 spin_unlock(&inode
->i_lock
);
443 gss_cred_set_ctx(cred
, gss_msg
->ctx
);
445 err
= gss_msg
->msg
.errno
;
446 spin_unlock(&inode
->i_lock
);
448 finish_wait(&gss_msg
->waitqueue
, &wait
);
449 gss_release_msg(gss_msg
);
451 dprintk("RPC: gss_create_upcall for uid %u result %d\n",
457 gss_pipe_upcall(struct file
*filp
, struct rpc_pipe_msg
*msg
,
458 char __user
*dst
, size_t buflen
)
460 char *data
= (char *)msg
->data
+ msg
->copied
;
461 size_t mlen
= min(msg
->len
, buflen
);
464 left
= copy_to_user(dst
, data
, mlen
);
466 msg
->errno
= -EFAULT
;
476 #define MSG_BUF_MAXSIZE 1024
479 gss_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
483 struct gss_upcall_msg
*gss_msg
;
484 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
485 struct gss_cl_ctx
*ctx
;
487 ssize_t err
= -EFBIG
;
489 if (mlen
> MSG_BUF_MAXSIZE
)
492 buf
= kmalloc(mlen
, GFP_NOFS
);
497 if (copy_from_user(buf
, src
, mlen
))
500 end
= (const void *)((char *)buf
+ mlen
);
501 p
= simple_get_bytes(buf
, end
, &uid
, sizeof(uid
));
508 ctx
= gss_alloc_context();
513 /* Find a matching upcall */
514 spin_lock(&inode
->i_lock
);
515 gss_msg
= __gss_find_upcall(RPC_I(inode
), uid
);
516 if (gss_msg
== NULL
) {
517 spin_unlock(&inode
->i_lock
);
520 list_del_init(&gss_msg
->list
);
521 spin_unlock(&inode
->i_lock
);
523 p
= gss_fill_context(p
, end
, ctx
, gss_msg
->auth
->mech
);
526 gss_msg
->msg
.errno
= (err
== -EAGAIN
) ? -EAGAIN
: -EACCES
;
527 goto err_release_msg
;
529 gss_msg
->ctx
= gss_get_ctx(ctx
);
533 spin_lock(&inode
->i_lock
);
534 __gss_unhash_msg(gss_msg
);
535 spin_unlock(&inode
->i_lock
);
536 gss_release_msg(gss_msg
);
542 dprintk("RPC: gss_pipe_downcall returning %Zd\n", err
);
547 gss_pipe_release(struct inode
*inode
)
549 struct rpc_inode
*rpci
= RPC_I(inode
);
550 struct gss_upcall_msg
*gss_msg
;
552 spin_lock(&inode
->i_lock
);
553 while (!list_empty(&rpci
->in_downcall
)) {
555 gss_msg
= list_entry(rpci
->in_downcall
.next
,
556 struct gss_upcall_msg
, list
);
557 gss_msg
->msg
.errno
= -EPIPE
;
558 atomic_inc(&gss_msg
->count
);
559 __gss_unhash_msg(gss_msg
);
560 spin_unlock(&inode
->i_lock
);
561 gss_release_msg(gss_msg
);
562 spin_lock(&inode
->i_lock
);
564 spin_unlock(&inode
->i_lock
);
568 gss_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
570 struct gss_upcall_msg
*gss_msg
= container_of(msg
, struct gss_upcall_msg
, msg
);
571 static unsigned long ratelimit
;
573 if (msg
->errno
< 0) {
574 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
576 atomic_inc(&gss_msg
->count
);
577 gss_unhash_msg(gss_msg
);
578 if (msg
->errno
== -ETIMEDOUT
) {
579 unsigned long now
= jiffies
;
580 if (time_after(now
, ratelimit
)) {
581 printk(KERN_WARNING
"RPC: AUTH_GSS upcall timed out.\n"
582 "Please check user daemon is running!\n");
583 ratelimit
= now
+ 15*HZ
;
586 gss_release_msg(gss_msg
);
591 * NOTE: we have the opportunity to use different
592 * parameters based on the input flavor (which must be a pseudoflavor)
594 static struct rpc_auth
*
595 gss_create(struct rpc_clnt
*clnt
, rpc_authflavor_t flavor
)
597 struct gss_auth
*gss_auth
;
598 struct rpc_auth
* auth
;
599 int err
= -ENOMEM
; /* XXX? */
601 dprintk("RPC: creating GSS authenticator for client %p\n", clnt
);
603 if (!try_module_get(THIS_MODULE
))
605 if (!(gss_auth
= kmalloc(sizeof(*gss_auth
), GFP_KERNEL
)))
607 gss_auth
->client
= clnt
;
609 gss_auth
->mech
= gss_mech_get_by_pseudoflavor(flavor
);
610 if (!gss_auth
->mech
) {
611 printk(KERN_WARNING
"%s: Pseudoflavor %d not found!\n",
615 gss_auth
->service
= gss_pseudoflavor_to_service(gss_auth
->mech
, flavor
);
616 if (gss_auth
->service
== 0)
618 auth
= &gss_auth
->rpc_auth
;
619 auth
->au_cslack
= GSS_CRED_SLACK
>> 2;
620 auth
->au_rslack
= GSS_VERF_SLACK
>> 2;
621 auth
->au_ops
= &authgss_ops
;
622 auth
->au_flavor
= flavor
;
623 atomic_set(&auth
->au_count
, 1);
624 kref_init(&gss_auth
->kref
);
626 gss_auth
->dentry
= rpc_mkpipe(clnt
->cl_dentry
, gss_auth
->mech
->gm_name
,
627 clnt
, &gss_upcall_ops
, RPC_PIPE_WAIT_FOR_OPEN
);
628 if (IS_ERR(gss_auth
->dentry
)) {
629 err
= PTR_ERR(gss_auth
->dentry
);
633 err
= rpcauth_init_credcache(auth
);
635 goto err_unlink_pipe
;
639 rpc_unlink(gss_auth
->dentry
);
641 gss_mech_put(gss_auth
->mech
);
645 module_put(THIS_MODULE
);
650 gss_free(struct gss_auth
*gss_auth
)
652 rpc_unlink(gss_auth
->dentry
);
653 gss_auth
->dentry
= NULL
;
654 gss_mech_put(gss_auth
->mech
);
657 module_put(THIS_MODULE
);
661 gss_free_callback(struct kref
*kref
)
663 struct gss_auth
*gss_auth
= container_of(kref
, struct gss_auth
, kref
);
669 gss_destroy(struct rpc_auth
*auth
)
671 struct gss_auth
*gss_auth
;
673 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
674 auth
, auth
->au_flavor
);
676 rpcauth_destroy_credcache(auth
);
678 gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
679 kref_put(&gss_auth
->kref
, gss_free_callback
);
683 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
684 * to the server with the GSS control procedure field set to
685 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
686 * all RPCSEC_GSS state associated with that context.
689 gss_destroying_context(struct rpc_cred
*cred
)
691 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
692 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
693 struct rpc_task
*task
;
695 if (gss_cred
->gc_ctx
== NULL
||
696 test_and_clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
) == 0)
699 gss_cred
->gc_ctx
->gc_proc
= RPC_GSS_PROC_DESTROY
;
700 cred
->cr_ops
= &gss_nullops
;
702 /* Take a reference to ensure the cred will be destroyed either
703 * by the RPC call or by the put_rpccred() below */
706 task
= rpc_call_null(gss_auth
->client
, cred
, RPC_TASK_ASYNC
|RPC_TASK_SOFT
);
714 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
715 * to create a new cred or context, so they check that things have been
716 * allocated before freeing them. */
718 gss_do_free_ctx(struct gss_cl_ctx
*ctx
)
720 dprintk("RPC: gss_free_ctx\n");
722 kfree(ctx
->gc_wire_ctx
.data
);
727 gss_free_ctx_callback(struct rcu_head
*head
)
729 struct gss_cl_ctx
*ctx
= container_of(head
, struct gss_cl_ctx
, gc_rcu
);
730 gss_do_free_ctx(ctx
);
734 gss_free_ctx(struct gss_cl_ctx
*ctx
)
736 struct gss_ctx
*gc_gss_ctx
;
738 gc_gss_ctx
= rcu_dereference(ctx
->gc_gss_ctx
);
739 rcu_assign_pointer(ctx
->gc_gss_ctx
, NULL
);
740 call_rcu(&ctx
->gc_rcu
, gss_free_ctx_callback
);
742 gss_delete_sec_context(&gc_gss_ctx
);
746 gss_free_cred(struct gss_cred
*gss_cred
)
748 dprintk("RPC: gss_free_cred %p\n", gss_cred
);
753 gss_free_cred_callback(struct rcu_head
*head
)
755 struct gss_cred
*gss_cred
= container_of(head
, struct gss_cred
, gc_base
.cr_rcu
);
756 gss_free_cred(gss_cred
);
760 gss_destroy_cred(struct rpc_cred
*cred
)
762 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
763 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
764 struct gss_cl_ctx
*ctx
= gss_cred
->gc_ctx
;
766 if (gss_destroying_context(cred
))
768 rcu_assign_pointer(gss_cred
->gc_ctx
, NULL
);
769 call_rcu(&cred
->cr_rcu
, gss_free_cred_callback
);
772 kref_put(&gss_auth
->kref
, gss_free_callback
);
776 * Lookup RPCSEC_GSS cred for the current process
778 static struct rpc_cred
*
779 gss_lookup_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
781 return rpcauth_lookup_credcache(auth
, acred
, flags
);
784 static struct rpc_cred
*
785 gss_create_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
787 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
788 struct gss_cred
*cred
= NULL
;
791 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
792 acred
->uid
, auth
->au_flavor
);
794 if (!(cred
= kzalloc(sizeof(*cred
), GFP_NOFS
)))
797 rpcauth_init_cred(&cred
->gc_base
, acred
, auth
, &gss_credops
);
799 * Note: in order to force a call to call_refresh(), we deliberately
800 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
802 cred
->gc_base
.cr_flags
= 1UL << RPCAUTH_CRED_NEW
;
803 cred
->gc_service
= gss_auth
->service
;
804 cred
->gc_machine_cred
= acred
->machine_cred
;
805 kref_get(&gss_auth
->kref
);
806 return &cred
->gc_base
;
809 dprintk("RPC: gss_create_cred failed with error %d\n", err
);
814 gss_cred_init(struct rpc_auth
*auth
, struct rpc_cred
*cred
)
816 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
817 struct gss_cred
*gss_cred
= container_of(cred
,struct gss_cred
, gc_base
);
821 err
= gss_create_upcall(gss_auth
, gss_cred
);
822 } while (err
== -EAGAIN
);
827 gss_match(struct auth_cred
*acred
, struct rpc_cred
*rc
, int flags
)
829 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
831 if (test_bit(RPCAUTH_CRED_NEW
, &rc
->cr_flags
))
833 /* Don't match with creds that have expired. */
834 if (time_after(jiffies
, gss_cred
->gc_ctx
->gc_expiry
))
836 if (!test_bit(RPCAUTH_CRED_UPTODATE
, &rc
->cr_flags
))
839 if (acred
->machine_cred
!= gss_cred
->gc_machine_cred
)
841 return (rc
->cr_uid
== acred
->uid
);
845 * Marshal credentials.
846 * Maybe we should keep a cached credential for performance reasons.
849 gss_marshal(struct rpc_task
*task
, __be32
*p
)
851 struct rpc_cred
*cred
= task
->tk_msg
.rpc_cred
;
852 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
854 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
856 struct rpc_rqst
*req
= task
->tk_rqstp
;
858 struct xdr_netobj mic
;
860 struct xdr_buf verf_buf
;
862 dprintk("RPC: %5u gss_marshal\n", task
->tk_pid
);
864 *p
++ = htonl(RPC_AUTH_GSS
);
867 spin_lock(&ctx
->gc_seq_lock
);
868 req
->rq_seqno
= ctx
->gc_seq
++;
869 spin_unlock(&ctx
->gc_seq_lock
);
871 *p
++ = htonl((u32
) RPC_GSS_VERSION
);
872 *p
++ = htonl((u32
) ctx
->gc_proc
);
873 *p
++ = htonl((u32
) req
->rq_seqno
);
874 *p
++ = htonl((u32
) gss_cred
->gc_service
);
875 p
= xdr_encode_netobj(p
, &ctx
->gc_wire_ctx
);
876 *cred_len
= htonl((p
- (cred_len
+ 1)) << 2);
878 /* We compute the checksum for the verifier over the xdr-encoded bytes
879 * starting with the xid and ending at the end of the credential: */
880 iov
.iov_base
= xprt_skip_transport_header(task
->tk_xprt
,
881 req
->rq_snd_buf
.head
[0].iov_base
);
882 iov
.iov_len
= (u8
*)p
- (u8
*)iov
.iov_base
;
883 xdr_buf_from_iov(&iov
, &verf_buf
);
885 /* set verifier flavor*/
886 *p
++ = htonl(RPC_AUTH_GSS
);
888 mic
.data
= (u8
*)(p
+ 1);
889 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
890 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
) {
891 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
892 } else if (maj_stat
!= 0) {
893 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat
);
896 p
= xdr_encode_opaque(p
, NULL
, mic
.len
);
904 static int gss_renew_cred(struct rpc_task
*task
)
906 struct rpc_cred
*oldcred
= task
->tk_msg
.rpc_cred
;
907 struct gss_cred
*gss_cred
= container_of(oldcred
,
910 struct rpc_auth
*auth
= oldcred
->cr_auth
;
911 struct auth_cred acred
= {
912 .uid
= oldcred
->cr_uid
,
913 .machine_cred
= gss_cred
->gc_machine_cred
,
915 struct rpc_cred
*new;
917 new = gss_lookup_cred(auth
, &acred
, RPCAUTH_LOOKUP_NEW
);
920 task
->tk_msg
.rpc_cred
= new;
921 put_rpccred(oldcred
);
926 * Refresh credentials. XXX - finish
929 gss_refresh(struct rpc_task
*task
)
931 struct rpc_cred
*cred
= task
->tk_msg
.rpc_cred
;
934 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
) &&
935 !test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
)) {
936 ret
= gss_renew_cred(task
);
939 cred
= task
->tk_msg
.rpc_cred
;
942 if (test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
943 ret
= gss_refresh_upcall(task
);
948 /* Dummy refresh routine: used only when destroying the context */
950 gss_refresh_null(struct rpc_task
*task
)
956 gss_validate(struct rpc_task
*task
, __be32
*p
)
958 struct rpc_cred
*cred
= task
->tk_msg
.rpc_cred
;
959 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
962 struct xdr_buf verf_buf
;
963 struct xdr_netobj mic
;
967 dprintk("RPC: %5u gss_validate\n", task
->tk_pid
);
970 if ((len
= ntohl(*p
++)) > RPC_MAX_AUTH_SIZE
)
972 if (flav
!= RPC_AUTH_GSS
)
974 seq
= htonl(task
->tk_rqstp
->rq_seqno
);
976 iov
.iov_len
= sizeof(seq
);
977 xdr_buf_from_iov(&iov
, &verf_buf
);
981 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
982 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
983 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
985 dprintk("RPC: %5u gss_validate: gss_verify_mic returned "
986 "error 0x%08x\n", task
->tk_pid
, maj_stat
);
989 /* We leave it to unwrap to calculate au_rslack. For now we just
990 * calculate the length of the verifier: */
991 cred
->cr_auth
->au_verfsize
= XDR_QUADLEN(len
) + 2;
993 dprintk("RPC: %5u gss_validate: gss_verify_mic succeeded.\n",
995 return p
+ XDR_QUADLEN(len
);
998 dprintk("RPC: %5u gss_validate failed.\n", task
->tk_pid
);
1003 gss_wrap_req_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1004 kxdrproc_t encode
, struct rpc_rqst
*rqstp
, __be32
*p
, void *obj
)
1006 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1007 struct xdr_buf integ_buf
;
1008 __be32
*integ_len
= NULL
;
1009 struct xdr_netobj mic
;
1017 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1018 *p
++ = htonl(rqstp
->rq_seqno
);
1020 status
= rpc_call_xdrproc(encode
, rqstp
, p
, obj
);
1024 if (xdr_buf_subsegment(snd_buf
, &integ_buf
,
1025 offset
, snd_buf
->len
- offset
))
1027 *integ_len
= htonl(integ_buf
.len
);
1029 /* guess whether we're in the head or the tail: */
1030 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1031 iov
= snd_buf
->tail
;
1033 iov
= snd_buf
->head
;
1034 p
= iov
->iov_base
+ iov
->iov_len
;
1035 mic
.data
= (u8
*)(p
+ 1);
1037 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1038 status
= -EIO
; /* XXX? */
1039 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1040 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1043 q
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1045 offset
= (u8
*)q
- (u8
*)p
;
1046 iov
->iov_len
+= offset
;
1047 snd_buf
->len
+= offset
;
1052 priv_release_snd_buf(struct rpc_rqst
*rqstp
)
1056 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++)
1057 __free_page(rqstp
->rq_enc_pages
[i
]);
1058 kfree(rqstp
->rq_enc_pages
);
1062 alloc_enc_pages(struct rpc_rqst
*rqstp
)
1064 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1067 if (snd_buf
->page_len
== 0) {
1068 rqstp
->rq_enc_pages_num
= 0;
1072 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1073 last
= (snd_buf
->page_base
+ snd_buf
->page_len
- 1) >> PAGE_CACHE_SHIFT
;
1074 rqstp
->rq_enc_pages_num
= last
- first
+ 1 + 1;
1076 = kmalloc(rqstp
->rq_enc_pages_num
* sizeof(struct page
*),
1078 if (!rqstp
->rq_enc_pages
)
1080 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++) {
1081 rqstp
->rq_enc_pages
[i
] = alloc_page(GFP_NOFS
);
1082 if (rqstp
->rq_enc_pages
[i
] == NULL
)
1085 rqstp
->rq_release_snd_buf
= priv_release_snd_buf
;
1088 for (i
--; i
>= 0; i
--) {
1089 __free_page(rqstp
->rq_enc_pages
[i
]);
1096 gss_wrap_req_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1097 kxdrproc_t encode
, struct rpc_rqst
*rqstp
, __be32
*p
, void *obj
)
1099 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1104 struct page
**inpages
;
1111 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1112 *p
++ = htonl(rqstp
->rq_seqno
);
1114 status
= rpc_call_xdrproc(encode
, rqstp
, p
, obj
);
1118 status
= alloc_enc_pages(rqstp
);
1121 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1122 inpages
= snd_buf
->pages
+ first
;
1123 snd_buf
->pages
= rqstp
->rq_enc_pages
;
1124 snd_buf
->page_base
-= first
<< PAGE_CACHE_SHIFT
;
1125 /* Give the tail its own page, in case we need extra space in the
1126 * head when wrapping: */
1127 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
) {
1128 tmp
= page_address(rqstp
->rq_enc_pages
[rqstp
->rq_enc_pages_num
- 1]);
1129 memcpy(tmp
, snd_buf
->tail
[0].iov_base
, snd_buf
->tail
[0].iov_len
);
1130 snd_buf
->tail
[0].iov_base
= tmp
;
1132 maj_stat
= gss_wrap(ctx
->gc_gss_ctx
, offset
, snd_buf
, inpages
);
1133 /* RPC_SLACK_SPACE should prevent this ever happening: */
1134 BUG_ON(snd_buf
->len
> snd_buf
->buflen
);
1136 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1137 * done anyway, so it's safe to put the request on the wire: */
1138 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1139 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1143 *opaque_len
= htonl(snd_buf
->len
- offset
);
1144 /* guess whether we're in the head or the tail: */
1145 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1146 iov
= snd_buf
->tail
;
1148 iov
= snd_buf
->head
;
1149 p
= iov
->iov_base
+ iov
->iov_len
;
1150 pad
= 3 - ((snd_buf
->len
- offset
- 1) & 3);
1152 iov
->iov_len
+= pad
;
1153 snd_buf
->len
+= pad
;
1159 gss_wrap_req(struct rpc_task
*task
,
1160 kxdrproc_t encode
, void *rqstp
, __be32
*p
, void *obj
)
1162 struct rpc_cred
*cred
= task
->tk_msg
.rpc_cred
;
1163 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1165 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1168 dprintk("RPC: %5u gss_wrap_req\n", task
->tk_pid
);
1169 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
) {
1170 /* The spec seems a little ambiguous here, but I think that not
1171 * wrapping context destruction requests makes the most sense.
1173 status
= rpc_call_xdrproc(encode
, rqstp
, p
, obj
);
1176 switch (gss_cred
->gc_service
) {
1177 case RPC_GSS_SVC_NONE
:
1178 status
= rpc_call_xdrproc(encode
, rqstp
, p
, obj
);
1180 case RPC_GSS_SVC_INTEGRITY
:
1181 status
= gss_wrap_req_integ(cred
, ctx
, encode
,
1184 case RPC_GSS_SVC_PRIVACY
:
1185 status
= gss_wrap_req_priv(cred
, ctx
, encode
,
1191 dprintk("RPC: %5u gss_wrap_req returning %d\n", task
->tk_pid
, status
);
1196 gss_unwrap_resp_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1197 struct rpc_rqst
*rqstp
, __be32
**p
)
1199 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1200 struct xdr_buf integ_buf
;
1201 struct xdr_netobj mic
;
1202 u32 data_offset
, mic_offset
;
1207 integ_len
= ntohl(*(*p
)++);
1210 data_offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1211 mic_offset
= integ_len
+ data_offset
;
1212 if (mic_offset
> rcv_buf
->len
)
1214 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1217 if (xdr_buf_subsegment(rcv_buf
, &integ_buf
, data_offset
,
1218 mic_offset
- data_offset
))
1221 if (xdr_buf_read_netobj(rcv_buf
, &mic
, mic_offset
))
1224 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1225 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1226 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1227 if (maj_stat
!= GSS_S_COMPLETE
)
1233 gss_unwrap_resp_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1234 struct rpc_rqst
*rqstp
, __be32
**p
)
1236 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1242 opaque_len
= ntohl(*(*p
)++);
1243 offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1244 if (offset
+ opaque_len
> rcv_buf
->len
)
1246 /* remove padding: */
1247 rcv_buf
->len
= offset
+ opaque_len
;
1249 maj_stat
= gss_unwrap(ctx
->gc_gss_ctx
, offset
, rcv_buf
);
1250 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1251 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1252 if (maj_stat
!= GSS_S_COMPLETE
)
1254 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1262 gss_unwrap_resp(struct rpc_task
*task
,
1263 kxdrproc_t decode
, void *rqstp
, __be32
*p
, void *obj
)
1265 struct rpc_cred
*cred
= task
->tk_msg
.rpc_cred
;
1266 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1268 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1270 struct kvec
*head
= ((struct rpc_rqst
*)rqstp
)->rq_rcv_buf
.head
;
1271 int savedlen
= head
->iov_len
;
1274 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
)
1276 switch (gss_cred
->gc_service
) {
1277 case RPC_GSS_SVC_NONE
:
1279 case RPC_GSS_SVC_INTEGRITY
:
1280 status
= gss_unwrap_resp_integ(cred
, ctx
, rqstp
, &p
);
1284 case RPC_GSS_SVC_PRIVACY
:
1285 status
= gss_unwrap_resp_priv(cred
, ctx
, rqstp
, &p
);
1290 /* take into account extra slack for integrity and privacy cases: */
1291 cred
->cr_auth
->au_rslack
= cred
->cr_auth
->au_verfsize
+ (p
- savedp
)
1292 + (savedlen
- head
->iov_len
);
1294 status
= rpc_call_xdrproc(decode
, rqstp
, p
, obj
);
1297 dprintk("RPC: %5u gss_unwrap_resp returning %d\n", task
->tk_pid
,
1302 static const struct rpc_authops authgss_ops
= {
1303 .owner
= THIS_MODULE
,
1304 .au_flavor
= RPC_AUTH_GSS
,
1305 .au_name
= "RPCSEC_GSS",
1306 .create
= gss_create
,
1307 .destroy
= gss_destroy
,
1308 .lookup_cred
= gss_lookup_cred
,
1309 .crcreate
= gss_create_cred
1312 static const struct rpc_credops gss_credops
= {
1313 .cr_name
= "AUTH_GSS",
1314 .crdestroy
= gss_destroy_cred
,
1315 .cr_init
= gss_cred_init
,
1316 .crbind
= rpcauth_generic_bind_cred
,
1317 .crmatch
= gss_match
,
1318 .crmarshal
= gss_marshal
,
1319 .crrefresh
= gss_refresh
,
1320 .crvalidate
= gss_validate
,
1321 .crwrap_req
= gss_wrap_req
,
1322 .crunwrap_resp
= gss_unwrap_resp
,
1325 static const struct rpc_credops gss_nullops
= {
1326 .cr_name
= "AUTH_GSS",
1327 .crdestroy
= gss_destroy_cred
,
1328 .crbind
= rpcauth_generic_bind_cred
,
1329 .crmatch
= gss_match
,
1330 .crmarshal
= gss_marshal
,
1331 .crrefresh
= gss_refresh_null
,
1332 .crvalidate
= gss_validate
,
1333 .crwrap_req
= gss_wrap_req
,
1334 .crunwrap_resp
= gss_unwrap_resp
,
1337 static struct rpc_pipe_ops gss_upcall_ops
= {
1338 .upcall
= gss_pipe_upcall
,
1339 .downcall
= gss_pipe_downcall
,
1340 .destroy_msg
= gss_pipe_destroy_msg
,
1341 .release_pipe
= gss_pipe_release
,
1345 * Initialize RPCSEC_GSS module
1347 static int __init
init_rpcsec_gss(void)
1351 err
= rpcauth_register(&authgss_ops
);
1354 err
= gss_svc_init();
1356 goto out_unregister
;
1359 rpcauth_unregister(&authgss_ops
);
1364 static void __exit
exit_rpcsec_gss(void)
1367 rpcauth_unregister(&authgss_ops
);
1370 MODULE_LICENSE("GPL");
1371 module_init(init_rpcsec_gss
)
1372 module_exit(exit_rpcsec_gss
)