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.
41 #include <linux/module.h>
42 #include <linux/init.h>
43 #include <linux/types.h>
44 #include <linux/slab.h>
45 #include <linux/sched.h>
46 #include <linux/pagemap.h>
47 #include <linux/sunrpc/clnt.h>
48 #include <linux/sunrpc/auth.h>
49 #include <linux/sunrpc/auth_gss.h>
50 #include <linux/sunrpc/svcauth_gss.h>
51 #include <linux/sunrpc/gss_err.h>
52 #include <linux/workqueue.h>
53 #include <linux/sunrpc/rpc_pipe_fs.h>
54 #include <linux/sunrpc/gss_api.h>
55 #include <asm/uaccess.h>
57 static const struct rpc_authops authgss_ops;
59 static const struct rpc_credops gss_credops;
60 static const struct rpc_credops gss_nullops;
63 # define RPCDBG_FACILITY RPCDBG_AUTH
66 #define NFS_NGROUPS 16
68 #define GSS_CRED_SLACK 1024 /* XXX: unused */
69 /* length of a krb5 verifier (48), plus data added before arguments when
70 * using integrity (two 4-byte integers): */
71 #define GSS_VERF_SLACK 100
73 /* XXX this define must match the gssd define
74 * as it is passed to gssd to signal the use of
75 * machine creds should be part of the shared rpc interface */
77 #define CA_RUN_AS_MACHINE 0x00000200
79 /* dump the buffer in `emacs-hexl' style */
80 #define isprint(c) ((c > 0x1f) && (c < 0x7f))
84 struct rpc_auth rpc_auth;
85 struct gss_api_mech *mech;
86 enum rpc_gss_svc service;
87 struct rpc_clnt *client;
88 struct dentry *dentry;
91 static void gss_free_ctx(struct gss_cl_ctx *);
92 static struct rpc_pipe_ops gss_upcall_ops;
94 static inline struct gss_cl_ctx *
95 gss_get_ctx(struct gss_cl_ctx *ctx)
97 atomic_inc(&ctx->count);
102 gss_put_ctx(struct gss_cl_ctx *ctx)
104 if (atomic_dec_and_test(&ctx->count))
109 * called by gss_upcall_callback and gss_create_upcall in order
110 * to set the gss context. The actual exchange of an old context
111 * and a new one is protected by the inode->i_lock.
114 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
116 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
117 struct gss_cl_ctx *old;
119 old = gss_cred->gc_ctx;
120 rcu_assign_pointer(gss_cred->gc_ctx, ctx);
121 set_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
122 clear_bit(RPCAUTH_CRED_NEW, &cred->cr_flags);
128 gss_cred_is_uptodate_ctx(struct rpc_cred *cred)
130 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
134 if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) && gss_cred->gc_ctx)
141 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
143 const void *q = (const void *)((const char *)p + len);
144 if (unlikely(q > end || q < p))
145 return ERR_PTR(-EFAULT);
150 static inline const void *
151 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
156 p = simple_get_bytes(p, end, &len, sizeof(len));
159 q = (const void *)((const char *)p + len);
160 if (unlikely(q > end || q < p))
161 return ERR_PTR(-EFAULT);
162 dest->data = kmemdup(p, len, GFP_KERNEL);
163 if (unlikely(dest->data == NULL))
164 return ERR_PTR(-ENOMEM);
169 static struct gss_cl_ctx *
170 gss_cred_get_ctx(struct rpc_cred *cred)
172 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
173 struct gss_cl_ctx *ctx = NULL;
176 if (gss_cred->gc_ctx)
177 ctx = gss_get_ctx(gss_cred->gc_ctx);
182 static struct gss_cl_ctx *
183 gss_alloc_context(void)
185 struct gss_cl_ctx *ctx;
187 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
189 ctx->gc_proc = RPC_GSS_PROC_DATA;
190 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
191 spin_lock_init(&ctx->gc_seq_lock);
192 atomic_set(&ctx->count,1);
197 #define GSSD_MIN_TIMEOUT (60 * 60)
199 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
203 unsigned int timeout;
207 /* First unsigned int gives the lifetime (in seconds) of the cred */
208 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
212 timeout = GSSD_MIN_TIMEOUT;
213 ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
214 /* Sequence number window. Determines the maximum number of simultaneous requests */
215 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
218 ctx->gc_win = window_size;
219 /* gssd signals an error by passing ctx->gc_win = 0: */
220 if (ctx->gc_win == 0) {
221 /* in which case, p points to an error code which we ignore */
222 p = ERR_PTR(-EACCES);
225 /* copy the opaque wire context */
226 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
229 /* import the opaque security context */
230 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
233 q = (const void *)((const char *)p + seclen);
234 if (unlikely(q > end || q < p)) {
235 p = ERR_PTR(-EFAULT);
238 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
245 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p));
250 struct gss_upcall_msg {
253 struct rpc_pipe_msg msg;
254 struct list_head list;
255 struct gss_auth *auth;
256 struct rpc_wait_queue rpc_waitqueue;
257 wait_queue_head_t waitqueue;
258 struct gss_cl_ctx *ctx;
262 gss_release_msg(struct gss_upcall_msg *gss_msg)
264 if (!atomic_dec_and_test(&gss_msg->count))
266 BUG_ON(!list_empty(&gss_msg->list));
267 if (gss_msg->ctx != NULL)
268 gss_put_ctx(gss_msg->ctx);
269 rpc_destroy_wait_queue(&gss_msg->rpc_waitqueue);
273 static struct gss_upcall_msg *
274 __gss_find_upcall(struct rpc_inode *rpci, uid_t uid)
276 struct gss_upcall_msg *pos;
277 list_for_each_entry(pos, &rpci->in_downcall, list) {
280 atomic_inc(&pos->count);
281 dprintk("RPC: gss_find_upcall found msg %p\n", pos);
284 dprintk("RPC: gss_find_upcall found nothing\n");
288 /* Try to add a upcall to the pipefs queue.
289 * If an upcall owned by our uid already exists, then we return a reference
290 * to that upcall instead of adding the new upcall.
292 static inline struct gss_upcall_msg *
293 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
295 struct inode *inode = gss_auth->dentry->d_inode;
296 struct rpc_inode *rpci = RPC_I(inode);
297 struct gss_upcall_msg *old;
299 spin_lock(&inode->i_lock);
300 old = __gss_find_upcall(rpci, gss_msg->uid);
302 atomic_inc(&gss_msg->count);
303 list_add(&gss_msg->list, &rpci->in_downcall);
306 spin_unlock(&inode->i_lock);
311 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
313 list_del_init(&gss_msg->list);
314 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
315 wake_up_all(&gss_msg->waitqueue);
316 atomic_dec(&gss_msg->count);
320 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
322 struct gss_auth *gss_auth = gss_msg->auth;
323 struct inode *inode = gss_auth->dentry->d_inode;
325 if (list_empty(&gss_msg->list))
327 spin_lock(&inode->i_lock);
328 if (!list_empty(&gss_msg->list))
329 __gss_unhash_msg(gss_msg);
330 spin_unlock(&inode->i_lock);
334 gss_upcall_callback(struct rpc_task *task)
336 struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
337 struct gss_cred, gc_base);
338 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
339 struct inode *inode = gss_msg->auth->dentry->d_inode;
341 spin_lock(&inode->i_lock);
343 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_get_ctx(gss_msg->ctx));
345 task->tk_status = gss_msg->msg.errno;
346 gss_cred->gc_upcall = NULL;
347 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
348 spin_unlock(&inode->i_lock);
349 gss_release_msg(gss_msg);
352 static inline struct gss_upcall_msg *
353 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
355 struct gss_upcall_msg *gss_msg;
357 gss_msg = kzalloc(sizeof(*gss_msg), GFP_KERNEL);
358 if (gss_msg != NULL) {
359 INIT_LIST_HEAD(&gss_msg->list);
360 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
361 init_waitqueue_head(&gss_msg->waitqueue);
362 atomic_set(&gss_msg->count, 1);
363 gss_msg->msg.data = &gss_msg->uid;
364 gss_msg->msg.len = sizeof(gss_msg->uid);
366 gss_msg->auth = gss_auth;
371 static struct gss_upcall_msg *
372 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
374 struct gss_cred *gss_cred = container_of(cred,
375 struct gss_cred, gc_base);
376 struct gss_upcall_msg *gss_new, *gss_msg;
377 uid_t uid = cred->cr_uid;
379 /* Special case: rpc.gssd assumes that uid == 0 implies machine creds */
380 if (gss_cred->gc_machine_cred != 0)
383 gss_new = gss_alloc_msg(gss_auth, uid);
385 return ERR_PTR(-ENOMEM);
386 gss_msg = gss_add_msg(gss_auth, gss_new);
387 if (gss_msg == gss_new) {
388 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
390 gss_unhash_msg(gss_new);
391 gss_msg = ERR_PTR(res);
394 gss_release_msg(gss_new);
399 gss_refresh_upcall(struct rpc_task *task)
401 struct rpc_cred *cred = task->tk_msg.rpc_cred;
402 struct gss_auth *gss_auth = container_of(cred->cr_auth,
403 struct gss_auth, rpc_auth);
404 struct gss_cred *gss_cred = container_of(cred,
405 struct gss_cred, gc_base);
406 struct gss_upcall_msg *gss_msg;
407 struct inode *inode = gss_auth->dentry->d_inode;
410 dprintk("RPC: %5u gss_refresh_upcall for uid %u\n", task->tk_pid,
412 gss_msg = gss_setup_upcall(task->tk_client, gss_auth, cred);
413 if (IS_ERR(gss_msg)) {
414 err = PTR_ERR(gss_msg);
417 spin_lock(&inode->i_lock);
418 if (gss_cred->gc_upcall != NULL)
419 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL);
420 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
421 task->tk_timeout = 0;
422 gss_cred->gc_upcall = gss_msg;
423 /* gss_upcall_callback will release the reference to gss_upcall_msg */
424 atomic_inc(&gss_msg->count);
425 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback);
427 err = gss_msg->msg.errno;
428 spin_unlock(&inode->i_lock);
429 gss_release_msg(gss_msg);
431 dprintk("RPC: %5u gss_refresh_upcall for uid %u result %d\n",
432 task->tk_pid, cred->cr_uid, err);
437 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
439 struct inode *inode = gss_auth->dentry->d_inode;
440 struct rpc_cred *cred = &gss_cred->gc_base;
441 struct gss_upcall_msg *gss_msg;
445 dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
446 gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
447 if (IS_ERR(gss_msg)) {
448 err = PTR_ERR(gss_msg);
452 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
453 spin_lock(&inode->i_lock);
454 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
457 spin_unlock(&inode->i_lock);
465 gss_cred_set_ctx(cred, gss_get_ctx(gss_msg->ctx));
467 err = gss_msg->msg.errno;
468 spin_unlock(&inode->i_lock);
470 finish_wait(&gss_msg->waitqueue, &wait);
471 gss_release_msg(gss_msg);
473 dprintk("RPC: gss_create_upcall for uid %u result %d\n",
479 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
480 char __user *dst, size_t buflen)
482 char *data = (char *)msg->data + msg->copied;
483 size_t mlen = min(msg->len, buflen);
486 left = copy_to_user(dst, data, mlen);
488 msg->errno = -EFAULT;
498 #define MSG_BUF_MAXSIZE 1024
501 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
505 struct rpc_clnt *clnt;
506 struct gss_upcall_msg *gss_msg;
507 struct inode *inode = filp->f_path.dentry->d_inode;
508 struct gss_cl_ctx *ctx;
510 ssize_t err = -EFBIG;
512 if (mlen > MSG_BUF_MAXSIZE)
515 buf = kmalloc(mlen, GFP_KERNEL);
519 clnt = RPC_I(inode)->private;
521 if (copy_from_user(buf, src, mlen))
524 end = (const void *)((char *)buf + mlen);
525 p = simple_get_bytes(buf, end, &uid, sizeof(uid));
532 ctx = gss_alloc_context();
537 /* Find a matching upcall */
538 spin_lock(&inode->i_lock);
539 gss_msg = __gss_find_upcall(RPC_I(inode), uid);
540 if (gss_msg == NULL) {
541 spin_unlock(&inode->i_lock);
544 list_del_init(&gss_msg->list);
545 spin_unlock(&inode->i_lock);
547 p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
550 gss_msg->msg.errno = (err == -EAGAIN) ? -EAGAIN : -EACCES;
551 goto err_release_msg;
553 gss_msg->ctx = gss_get_ctx(ctx);
557 spin_lock(&inode->i_lock);
558 __gss_unhash_msg(gss_msg);
559 spin_unlock(&inode->i_lock);
560 gss_release_msg(gss_msg);
566 dprintk("RPC: gss_pipe_downcall returning %Zd\n", err);
571 gss_pipe_release(struct inode *inode)
573 struct rpc_inode *rpci = RPC_I(inode);
574 struct gss_upcall_msg *gss_msg;
576 spin_lock(&inode->i_lock);
577 while (!list_empty(&rpci->in_downcall)) {
579 gss_msg = list_entry(rpci->in_downcall.next,
580 struct gss_upcall_msg, list);
581 gss_msg->msg.errno = -EPIPE;
582 atomic_inc(&gss_msg->count);
583 __gss_unhash_msg(gss_msg);
584 spin_unlock(&inode->i_lock);
585 gss_release_msg(gss_msg);
586 spin_lock(&inode->i_lock);
588 spin_unlock(&inode->i_lock);
592 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
594 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
595 static unsigned long ratelimit;
597 if (msg->errno < 0) {
598 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
600 atomic_inc(&gss_msg->count);
601 gss_unhash_msg(gss_msg);
602 if (msg->errno == -ETIMEDOUT) {
603 unsigned long now = jiffies;
604 if (time_after(now, ratelimit)) {
605 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
606 "Please check user daemon is running!\n");
607 ratelimit = now + 15*HZ;
610 gss_release_msg(gss_msg);
615 * NOTE: we have the opportunity to use different
616 * parameters based on the input flavor (which must be a pseudoflavor)
618 static struct rpc_auth *
619 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
621 struct gss_auth *gss_auth;
622 struct rpc_auth * auth;
623 int err = -ENOMEM; /* XXX? */
625 dprintk("RPC: creating GSS authenticator for client %p\n", clnt);
627 if (!try_module_get(THIS_MODULE))
629 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
631 gss_auth->client = clnt;
633 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
634 if (!gss_auth->mech) {
635 printk(KERN_WARNING "%s: Pseudoflavor %d not found!\n",
636 __FUNCTION__, flavor);
639 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
640 if (gss_auth->service == 0)
642 auth = &gss_auth->rpc_auth;
643 auth->au_cslack = GSS_CRED_SLACK >> 2;
644 auth->au_rslack = GSS_VERF_SLACK >> 2;
645 auth->au_ops = &authgss_ops;
646 auth->au_flavor = flavor;
647 atomic_set(&auth->au_count, 1);
648 kref_init(&gss_auth->kref);
650 gss_auth->dentry = rpc_mkpipe(clnt->cl_dentry, gss_auth->mech->gm_name,
651 clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
652 if (IS_ERR(gss_auth->dentry)) {
653 err = PTR_ERR(gss_auth->dentry);
657 err = rpcauth_init_credcache(auth);
659 goto err_unlink_pipe;
663 rpc_unlink(gss_auth->dentry);
665 gss_mech_put(gss_auth->mech);
669 module_put(THIS_MODULE);
674 gss_free(struct gss_auth *gss_auth)
676 rpc_unlink(gss_auth->dentry);
677 gss_auth->dentry = NULL;
678 gss_mech_put(gss_auth->mech);
681 module_put(THIS_MODULE);
685 gss_free_callback(struct kref *kref)
687 struct gss_auth *gss_auth = container_of(kref, struct gss_auth, kref);
693 gss_destroy(struct rpc_auth *auth)
695 struct gss_auth *gss_auth;
697 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
698 auth, auth->au_flavor);
700 rpcauth_destroy_credcache(auth);
702 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
703 kref_put(&gss_auth->kref, gss_free_callback);
707 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
708 * to the server with the GSS control procedure field set to
709 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
710 * all RPCSEC_GSS state associated with that context.
713 gss_destroying_context(struct rpc_cred *cred)
715 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
716 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
717 struct rpc_task *task;
719 if (gss_cred->gc_ctx == NULL ||
720 test_and_clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) == 0)
723 gss_cred->gc_ctx->gc_proc = RPC_GSS_PROC_DESTROY;
724 cred->cr_ops = &gss_nullops;
726 /* Take a reference to ensure the cred will be destroyed either
727 * by the RPC call or by the put_rpccred() below */
730 task = rpc_call_null(gss_auth->client, cred, RPC_TASK_ASYNC|RPC_TASK_SOFT);
738 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
739 * to create a new cred or context, so they check that things have been
740 * allocated before freeing them. */
742 gss_do_free_ctx(struct gss_cl_ctx *ctx)
744 dprintk("RPC: gss_free_ctx\n");
746 kfree(ctx->gc_wire_ctx.data);
751 gss_free_ctx_callback(struct rcu_head *head)
753 struct gss_cl_ctx *ctx = container_of(head, struct gss_cl_ctx, gc_rcu);
754 gss_do_free_ctx(ctx);
758 gss_free_ctx(struct gss_cl_ctx *ctx)
760 struct gss_ctx *gc_gss_ctx;
762 gc_gss_ctx = rcu_dereference(ctx->gc_gss_ctx);
763 rcu_assign_pointer(ctx->gc_gss_ctx, NULL);
764 call_rcu(&ctx->gc_rcu, gss_free_ctx_callback);
766 gss_delete_sec_context(&gc_gss_ctx);
770 gss_free_cred(struct gss_cred *gss_cred)
772 dprintk("RPC: gss_free_cred %p\n", gss_cred);
777 gss_free_cred_callback(struct rcu_head *head)
779 struct gss_cred *gss_cred = container_of(head, struct gss_cred, gc_base.cr_rcu);
780 gss_free_cred(gss_cred);
784 gss_destroy_cred(struct rpc_cred *cred)
786 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
787 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
788 struct gss_cl_ctx *ctx = gss_cred->gc_ctx;
790 if (gss_destroying_context(cred))
792 rcu_assign_pointer(gss_cred->gc_ctx, NULL);
793 call_rcu(&cred->cr_rcu, gss_free_cred_callback);
796 kref_put(&gss_auth->kref, gss_free_callback);
800 * Lookup RPCSEC_GSS cred for the current process
802 static struct rpc_cred *
803 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
805 return rpcauth_lookup_credcache(auth, acred, flags);
808 static struct rpc_cred *
809 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
811 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
812 struct gss_cred *cred = NULL;
815 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
816 acred->uid, auth->au_flavor);
818 if (!(cred = kzalloc(sizeof(*cred), GFP_KERNEL)))
821 rpcauth_init_cred(&cred->gc_base, acred, auth, &gss_credops);
823 * Note: in order to force a call to call_refresh(), we deliberately
824 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
826 cred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_NEW;
827 cred->gc_service = gss_auth->service;
828 cred->gc_machine_cred = acred->machine_cred;
829 kref_get(&gss_auth->kref);
830 return &cred->gc_base;
833 dprintk("RPC: gss_create_cred failed with error %d\n", err);
838 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
840 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
841 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
845 err = gss_create_upcall(gss_auth, gss_cred);
846 } while (err == -EAGAIN);
851 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
853 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
856 * If the searchflags have set RPCAUTH_LOOKUP_NEW, then
857 * we don't really care if the credential has expired or not,
858 * since the caller should be prepared to reinitialise it.
860 if ((flags & RPCAUTH_LOOKUP_NEW) && test_bit(RPCAUTH_CRED_NEW, &rc->cr_flags))
862 /* Don't match with creds that have expired. */
863 if (gss_cred->gc_ctx && time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
866 if (acred->machine_cred != gss_cred->gc_machine_cred)
868 return (rc->cr_uid == acred->uid);
872 * Marshal credentials.
873 * Maybe we should keep a cached credential for performance reasons.
876 gss_marshal(struct rpc_task *task, __be32 *p)
878 struct rpc_cred *cred = task->tk_msg.rpc_cred;
879 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
881 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
883 struct rpc_rqst *req = task->tk_rqstp;
885 struct xdr_netobj mic;
887 struct xdr_buf verf_buf;
889 dprintk("RPC: %5u gss_marshal\n", task->tk_pid);
891 *p++ = htonl(RPC_AUTH_GSS);
894 spin_lock(&ctx->gc_seq_lock);
895 req->rq_seqno = ctx->gc_seq++;
896 spin_unlock(&ctx->gc_seq_lock);
898 *p++ = htonl((u32) RPC_GSS_VERSION);
899 *p++ = htonl((u32) ctx->gc_proc);
900 *p++ = htonl((u32) req->rq_seqno);
901 *p++ = htonl((u32) gss_cred->gc_service);
902 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
903 *cred_len = htonl((p - (cred_len + 1)) << 2);
905 /* We compute the checksum for the verifier over the xdr-encoded bytes
906 * starting with the xid and ending at the end of the credential: */
907 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
908 req->rq_snd_buf.head[0].iov_base);
909 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
910 xdr_buf_from_iov(&iov, &verf_buf);
912 /* set verifier flavor*/
913 *p++ = htonl(RPC_AUTH_GSS);
915 mic.data = (u8 *)(p + 1);
916 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
917 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
918 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
919 } else if (maj_stat != 0) {
920 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
923 p = xdr_encode_opaque(p, NULL, mic.len);
932 * Refresh credentials. XXX - finish
935 gss_refresh(struct rpc_task *task)
938 if (!gss_cred_is_uptodate_ctx(task->tk_msg.rpc_cred))
939 return gss_refresh_upcall(task);
943 /* Dummy refresh routine: used only when destroying the context */
945 gss_refresh_null(struct rpc_task *task)
951 gss_validate(struct rpc_task *task, __be32 *p)
953 struct rpc_cred *cred = task->tk_msg.rpc_cred;
954 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
957 struct xdr_buf verf_buf;
958 struct xdr_netobj mic;
962 dprintk("RPC: %5u gss_validate\n", task->tk_pid);
965 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
967 if (flav != RPC_AUTH_GSS)
969 seq = htonl(task->tk_rqstp->rq_seqno);
971 iov.iov_len = sizeof(seq);
972 xdr_buf_from_iov(&iov, &verf_buf);
976 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
977 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
978 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
980 dprintk("RPC: %5u gss_validate: gss_verify_mic returned "
981 "error 0x%08x\n", task->tk_pid, maj_stat);
984 /* We leave it to unwrap to calculate au_rslack. For now we just
985 * calculate the length of the verifier: */
986 cred->cr_auth->au_verfsize = XDR_QUADLEN(len) + 2;
988 dprintk("RPC: %5u gss_validate: gss_verify_mic succeeded.\n",
990 return p + XDR_QUADLEN(len);
993 dprintk("RPC: %5u gss_validate failed.\n", task->tk_pid);
998 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
999 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
1001 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1002 struct xdr_buf integ_buf;
1003 __be32 *integ_len = NULL;
1004 struct xdr_netobj mic;
1012 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1013 *p++ = htonl(rqstp->rq_seqno);
1015 status = rpc_call_xdrproc(encode, rqstp, p, obj);
1019 if (xdr_buf_subsegment(snd_buf, &integ_buf,
1020 offset, snd_buf->len - offset))
1022 *integ_len = htonl(integ_buf.len);
1024 /* guess whether we're in the head or the tail: */
1025 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1026 iov = snd_buf->tail;
1028 iov = snd_buf->head;
1029 p = iov->iov_base + iov->iov_len;
1030 mic.data = (u8 *)(p + 1);
1032 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1033 status = -EIO; /* XXX? */
1034 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1035 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1038 q = xdr_encode_opaque(p, NULL, mic.len);
1040 offset = (u8 *)q - (u8 *)p;
1041 iov->iov_len += offset;
1042 snd_buf->len += offset;
1047 priv_release_snd_buf(struct rpc_rqst *rqstp)
1051 for (i=0; i < rqstp->rq_enc_pages_num; i++)
1052 __free_page(rqstp->rq_enc_pages[i]);
1053 kfree(rqstp->rq_enc_pages);
1057 alloc_enc_pages(struct rpc_rqst *rqstp)
1059 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1062 if (snd_buf->page_len == 0) {
1063 rqstp->rq_enc_pages_num = 0;
1067 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1068 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
1069 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1071 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
1073 if (!rqstp->rq_enc_pages)
1075 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1076 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1077 if (rqstp->rq_enc_pages[i] == NULL)
1080 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1083 for (i--; i >= 0; i--) {
1084 __free_page(rqstp->rq_enc_pages[i]);
1091 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1092 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
1094 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1099 struct page **inpages;
1106 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1107 *p++ = htonl(rqstp->rq_seqno);
1109 status = rpc_call_xdrproc(encode, rqstp, p, obj);
1113 status = alloc_enc_pages(rqstp);
1116 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1117 inpages = snd_buf->pages + first;
1118 snd_buf->pages = rqstp->rq_enc_pages;
1119 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1120 /* Give the tail its own page, in case we need extra space in the
1121 * head when wrapping: */
1122 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1123 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1124 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1125 snd_buf->tail[0].iov_base = tmp;
1127 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1128 /* RPC_SLACK_SPACE should prevent this ever happening: */
1129 BUG_ON(snd_buf->len > snd_buf->buflen);
1131 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1132 * done anyway, so it's safe to put the request on the wire: */
1133 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1134 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1138 *opaque_len = htonl(snd_buf->len - offset);
1139 /* guess whether we're in the head or the tail: */
1140 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1141 iov = snd_buf->tail;
1143 iov = snd_buf->head;
1144 p = iov->iov_base + iov->iov_len;
1145 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1147 iov->iov_len += pad;
1148 snd_buf->len += pad;
1154 gss_wrap_req(struct rpc_task *task,
1155 kxdrproc_t encode, void *rqstp, __be32 *p, void *obj)
1157 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1158 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1160 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1163 dprintk("RPC: %5u gss_wrap_req\n", task->tk_pid);
1164 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1165 /* The spec seems a little ambiguous here, but I think that not
1166 * wrapping context destruction requests makes the most sense.
1168 status = rpc_call_xdrproc(encode, rqstp, p, obj);
1171 switch (gss_cred->gc_service) {
1172 case RPC_GSS_SVC_NONE:
1173 status = rpc_call_xdrproc(encode, rqstp, p, obj);
1175 case RPC_GSS_SVC_INTEGRITY:
1176 status = gss_wrap_req_integ(cred, ctx, encode,
1179 case RPC_GSS_SVC_PRIVACY:
1180 status = gss_wrap_req_priv(cred, ctx, encode,
1186 dprintk("RPC: %5u gss_wrap_req returning %d\n", task->tk_pid, status);
1191 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1192 struct rpc_rqst *rqstp, __be32 **p)
1194 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1195 struct xdr_buf integ_buf;
1196 struct xdr_netobj mic;
1197 u32 data_offset, mic_offset;
1202 integ_len = ntohl(*(*p)++);
1205 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1206 mic_offset = integ_len + data_offset;
1207 if (mic_offset > rcv_buf->len)
1209 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1212 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1213 mic_offset - data_offset))
1216 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1219 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1220 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1221 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1222 if (maj_stat != GSS_S_COMPLETE)
1228 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1229 struct rpc_rqst *rqstp, __be32 **p)
1231 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1237 opaque_len = ntohl(*(*p)++);
1238 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1239 if (offset + opaque_len > rcv_buf->len)
1241 /* remove padding: */
1242 rcv_buf->len = offset + opaque_len;
1244 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1245 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1246 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1247 if (maj_stat != GSS_S_COMPLETE)
1249 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1257 gss_unwrap_resp(struct rpc_task *task,
1258 kxdrproc_t decode, void *rqstp, __be32 *p, void *obj)
1260 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1261 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1263 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1265 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1266 int savedlen = head->iov_len;
1269 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1271 switch (gss_cred->gc_service) {
1272 case RPC_GSS_SVC_NONE:
1274 case RPC_GSS_SVC_INTEGRITY:
1275 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1279 case RPC_GSS_SVC_PRIVACY:
1280 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1285 /* take into account extra slack for integrity and privacy cases: */
1286 cred->cr_auth->au_rslack = cred->cr_auth->au_verfsize + (p - savedp)
1287 + (savedlen - head->iov_len);
1289 status = rpc_call_xdrproc(decode, rqstp, p, obj);
1292 dprintk("RPC: %5u gss_unwrap_resp returning %d\n", task->tk_pid,
1297 static const struct rpc_authops authgss_ops = {
1298 .owner = THIS_MODULE,
1299 .au_flavor = RPC_AUTH_GSS,
1300 .au_name = "RPCSEC_GSS",
1301 .create = gss_create,
1302 .destroy = gss_destroy,
1303 .lookup_cred = gss_lookup_cred,
1304 .crcreate = gss_create_cred
1307 static const struct rpc_credops gss_credops = {
1308 .cr_name = "AUTH_GSS",
1309 .crdestroy = gss_destroy_cred,
1310 .cr_init = gss_cred_init,
1311 .crbind = rpcauth_generic_bind_cred,
1312 .crmatch = gss_match,
1313 .crmarshal = gss_marshal,
1314 .crrefresh = gss_refresh,
1315 .crvalidate = gss_validate,
1316 .crwrap_req = gss_wrap_req,
1317 .crunwrap_resp = gss_unwrap_resp,
1320 static const struct rpc_credops gss_nullops = {
1321 .cr_name = "AUTH_GSS",
1322 .crdestroy = gss_destroy_cred,
1323 .crbind = rpcauth_generic_bind_cred,
1324 .crmatch = gss_match,
1325 .crmarshal = gss_marshal,
1326 .crrefresh = gss_refresh_null,
1327 .crvalidate = gss_validate,
1328 .crwrap_req = gss_wrap_req,
1329 .crunwrap_resp = gss_unwrap_resp,
1332 static struct rpc_pipe_ops gss_upcall_ops = {
1333 .upcall = gss_pipe_upcall,
1334 .downcall = gss_pipe_downcall,
1335 .destroy_msg = gss_pipe_destroy_msg,
1336 .release_pipe = gss_pipe_release,
1340 * Initialize RPCSEC_GSS module
1342 static int __init init_rpcsec_gss(void)
1346 err = rpcauth_register(&authgss_ops);
1349 err = gss_svc_init();
1351 goto out_unregister;
1354 rpcauth_unregister(&authgss_ops);
1359 static void __exit exit_rpcsec_gss(void)
1362 rpcauth_unregister(&authgss_ops);
1365 MODULE_LICENSE("GPL");
1366 module_init(init_rpcsec_gss)
1367 module_exit(exit_rpcsec_gss)