2 * linux/net/sunrpc/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 struct rpc_authops authgss_ops;
59 static struct rpc_credops gss_credops;
62 # define RPCDBG_FACILITY RPCDBG_AUTH
65 #define NFS_NGROUPS 16
67 #define GSS_CRED_EXPIRE (60 * HZ) /* XXX: reasonable? */
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 56
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))
82 static DEFINE_RWLOCK(gss_ctx_lock);
85 struct rpc_auth rpc_auth;
86 struct gss_api_mech *mech;
87 enum rpc_gss_svc service;
88 struct list_head upcalls;
89 struct rpc_clnt *client;
90 struct dentry *dentry;
95 static void gss_destroy_ctx(struct gss_cl_ctx *);
96 static struct rpc_pipe_ops gss_upcall_ops;
99 print_hexl(u32 *p, u_int length, u_int offset)
104 dprintk("RPC: print_hexl: length %d\n",length);
108 for (i = 0; i < length; i += 0x10) {
109 dprintk(" %04x: ", (u_int)(i + offset));
111 jm = jm > 16 ? 16 : jm;
113 for (j = 0; j < jm; j++) {
115 dprintk("%02x ", (u_int)cp[i+j]);
117 dprintk("%02x", (u_int)cp[i+j]);
119 for (; j < 16; j++) {
127 for (j = 0; j < jm; j++) {
129 c = isprint(c) ? c : '.';
136 EXPORT_SYMBOL(print_hexl);
138 static inline struct gss_cl_ctx *
139 gss_get_ctx(struct gss_cl_ctx *ctx)
141 atomic_inc(&ctx->count);
146 gss_put_ctx(struct gss_cl_ctx *ctx)
148 if (atomic_dec_and_test(&ctx->count))
149 gss_destroy_ctx(ctx);
153 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
155 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
156 struct gss_cl_ctx *old;
157 write_lock(&gss_ctx_lock);
158 old = gss_cred->gc_ctx;
159 gss_cred->gc_ctx = ctx;
160 cred->cr_flags |= RPCAUTH_CRED_UPTODATE;
161 write_unlock(&gss_ctx_lock);
167 gss_cred_is_uptodate_ctx(struct rpc_cred *cred)
169 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
172 read_lock(&gss_ctx_lock);
173 if ((cred->cr_flags & RPCAUTH_CRED_UPTODATE) && gss_cred->gc_ctx)
175 read_unlock(&gss_ctx_lock);
180 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
182 const void *q = (const void *)((const char *)p + len);
183 if (unlikely(q > end || q < p))
184 return ERR_PTR(-EFAULT);
189 static inline const void *
190 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
195 p = simple_get_bytes(p, end, &len, sizeof(len));
198 q = (const void *)((const char *)p + len);
199 if (unlikely(q > end || q < p))
200 return ERR_PTR(-EFAULT);
201 dest->data = kmalloc(len, GFP_KERNEL);
202 if (unlikely(dest->data == NULL))
203 return ERR_PTR(-ENOMEM);
205 memcpy(dest->data, p, len);
209 static struct gss_cl_ctx *
210 gss_cred_get_ctx(struct rpc_cred *cred)
212 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
213 struct gss_cl_ctx *ctx = NULL;
215 read_lock(&gss_ctx_lock);
216 if (gss_cred->gc_ctx)
217 ctx = gss_get_ctx(gss_cred->gc_ctx);
218 read_unlock(&gss_ctx_lock);
222 static struct gss_cl_ctx *
223 gss_alloc_context(void)
225 struct gss_cl_ctx *ctx;
227 ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
229 memset(ctx, 0, sizeof(*ctx));
230 ctx->gc_proc = RPC_GSS_PROC_DATA;
231 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
232 spin_lock_init(&ctx->gc_seq_lock);
233 atomic_set(&ctx->count,1);
238 #define GSSD_MIN_TIMEOUT (60 * 60)
240 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
244 unsigned int timeout;
248 /* First unsigned int gives the lifetime (in seconds) of the cred */
249 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
253 timeout = GSSD_MIN_TIMEOUT;
254 ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
255 /* Sequence number window. Determines the maximum number of simultaneous requests */
256 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
259 ctx->gc_win = window_size;
260 /* gssd signals an error by passing ctx->gc_win = 0: */
261 if (ctx->gc_win == 0) {
262 /* in which case, p points to an error code which we ignore */
263 p = ERR_PTR(-EACCES);
266 /* copy the opaque wire context */
267 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
270 /* import the opaque security context */
271 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
274 q = (const void *)((const char *)p + seclen);
275 if (unlikely(q > end || q < p)) {
276 p = ERR_PTR(-EFAULT);
279 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
286 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p));
291 struct gss_upcall_msg {
294 struct rpc_pipe_msg msg;
295 struct list_head list;
296 struct gss_auth *auth;
297 struct rpc_wait_queue rpc_waitqueue;
298 wait_queue_head_t waitqueue;
299 struct gss_cl_ctx *ctx;
303 gss_release_msg(struct gss_upcall_msg *gss_msg)
305 if (!atomic_dec_and_test(&gss_msg->count))
307 BUG_ON(!list_empty(&gss_msg->list));
308 if (gss_msg->ctx != NULL)
309 gss_put_ctx(gss_msg->ctx);
313 static struct gss_upcall_msg *
314 __gss_find_upcall(struct gss_auth *gss_auth, uid_t uid)
316 struct gss_upcall_msg *pos;
317 list_for_each_entry(pos, &gss_auth->upcalls, list) {
320 atomic_inc(&pos->count);
321 dprintk("RPC: gss_find_upcall found msg %p\n", pos);
324 dprintk("RPC: gss_find_upcall found nothing\n");
328 /* Try to add a upcall to the pipefs queue.
329 * If an upcall owned by our uid already exists, then we return a reference
330 * to that upcall instead of adding the new upcall.
332 static inline struct gss_upcall_msg *
333 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
335 struct gss_upcall_msg *old;
337 spin_lock(&gss_auth->lock);
338 old = __gss_find_upcall(gss_auth, gss_msg->uid);
340 atomic_inc(&gss_msg->count);
341 list_add(&gss_msg->list, &gss_auth->upcalls);
344 spin_unlock(&gss_auth->lock);
349 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
351 if (list_empty(&gss_msg->list))
353 list_del_init(&gss_msg->list);
354 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
355 wake_up_all(&gss_msg->waitqueue);
356 atomic_dec(&gss_msg->count);
360 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
362 struct gss_auth *gss_auth = gss_msg->auth;
364 spin_lock(&gss_auth->lock);
365 __gss_unhash_msg(gss_msg);
366 spin_unlock(&gss_auth->lock);
370 gss_upcall_callback(struct rpc_task *task)
372 struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
373 struct gss_cred, gc_base);
374 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
376 BUG_ON(gss_msg == NULL);
378 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_get_ctx(gss_msg->ctx));
380 task->tk_status = gss_msg->msg.errno;
381 spin_lock(&gss_msg->auth->lock);
382 gss_cred->gc_upcall = NULL;
383 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
384 spin_unlock(&gss_msg->auth->lock);
385 gss_release_msg(gss_msg);
388 static inline struct gss_upcall_msg *
389 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
391 struct gss_upcall_msg *gss_msg;
393 gss_msg = kmalloc(sizeof(*gss_msg), GFP_KERNEL);
394 if (gss_msg != NULL) {
395 memset(gss_msg, 0, sizeof(*gss_msg));
396 INIT_LIST_HEAD(&gss_msg->list);
397 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
398 init_waitqueue_head(&gss_msg->waitqueue);
399 atomic_set(&gss_msg->count, 1);
400 gss_msg->msg.data = &gss_msg->uid;
401 gss_msg->msg.len = sizeof(gss_msg->uid);
403 gss_msg->auth = gss_auth;
408 static struct gss_upcall_msg *
409 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
411 struct gss_upcall_msg *gss_new, *gss_msg;
413 gss_new = gss_alloc_msg(gss_auth, cred->cr_uid);
415 return ERR_PTR(-ENOMEM);
416 gss_msg = gss_add_msg(gss_auth, gss_new);
417 if (gss_msg == gss_new) {
418 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
420 gss_unhash_msg(gss_new);
421 gss_msg = ERR_PTR(res);
424 gss_release_msg(gss_new);
429 gss_refresh_upcall(struct rpc_task *task)
431 struct rpc_cred *cred = task->tk_msg.rpc_cred;
432 struct gss_auth *gss_auth = container_of(task->tk_client->cl_auth,
433 struct gss_auth, rpc_auth);
434 struct gss_cred *gss_cred = container_of(cred,
435 struct gss_cred, gc_base);
436 struct gss_upcall_msg *gss_msg;
439 dprintk("RPC: %4u gss_refresh_upcall for uid %u\n", task->tk_pid, cred->cr_uid);
440 gss_msg = gss_setup_upcall(task->tk_client, gss_auth, cred);
441 if (IS_ERR(gss_msg)) {
442 err = PTR_ERR(gss_msg);
445 spin_lock(&gss_auth->lock);
446 if (gss_cred->gc_upcall != NULL)
447 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL, NULL);
448 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
449 task->tk_timeout = 0;
450 gss_cred->gc_upcall = gss_msg;
451 /* gss_upcall_callback will release the reference to gss_upcall_msg */
452 atomic_inc(&gss_msg->count);
453 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback, NULL);
455 err = gss_msg->msg.errno;
456 spin_unlock(&gss_auth->lock);
457 gss_release_msg(gss_msg);
459 dprintk("RPC: %4u gss_refresh_upcall for uid %u result %d\n", task->tk_pid,
465 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
467 struct rpc_cred *cred = &gss_cred->gc_base;
468 struct gss_upcall_msg *gss_msg;
472 dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
473 gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
474 if (IS_ERR(gss_msg)) {
475 err = PTR_ERR(gss_msg);
479 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
480 spin_lock(&gss_auth->lock);
481 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
482 spin_unlock(&gss_auth->lock);
485 spin_unlock(&gss_auth->lock);
493 gss_cred_set_ctx(cred, gss_get_ctx(gss_msg->ctx));
495 err = gss_msg->msg.errno;
497 finish_wait(&gss_msg->waitqueue, &wait);
498 gss_release_msg(gss_msg);
500 dprintk("RPC: gss_create_upcall for uid %u result %d\n", cred->cr_uid, err);
505 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
506 char __user *dst, size_t buflen)
508 char *data = (char *)msg->data + msg->copied;
509 ssize_t mlen = msg->len;
514 left = copy_to_user(dst, data, mlen);
525 #define MSG_BUF_MAXSIZE 1024
528 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
532 struct rpc_clnt *clnt;
533 struct gss_auth *gss_auth;
534 struct rpc_cred *cred;
535 struct gss_upcall_msg *gss_msg;
536 struct gss_cl_ctx *ctx;
540 if (mlen > MSG_BUF_MAXSIZE)
543 buf = kmalloc(mlen, GFP_KERNEL);
547 clnt = RPC_I(filp->f_dentry->d_inode)->private;
549 if (copy_from_user(buf, src, mlen))
552 end = (const void *)((char *)buf + mlen);
553 p = simple_get_bytes(buf, end, &uid, sizeof(uid));
560 ctx = gss_alloc_context();
564 gss_auth = container_of(clnt->cl_auth, struct gss_auth, rpc_auth);
565 p = gss_fill_context(p, end, ctx, gss_auth->mech);
571 spin_lock(&gss_auth->lock);
572 gss_msg = __gss_find_upcall(gss_auth, uid);
574 if (err == 0 && gss_msg->ctx == NULL)
575 gss_msg->ctx = gss_get_ctx(ctx);
576 gss_msg->msg.errno = err;
577 __gss_unhash_msg(gss_msg);
578 spin_unlock(&gss_auth->lock);
579 gss_release_msg(gss_msg);
581 struct auth_cred acred = { .uid = uid };
582 spin_unlock(&gss_auth->lock);
583 cred = rpcauth_lookup_credcache(clnt->cl_auth, &acred, 0);
588 gss_cred_set_ctx(cred, gss_get_ctx(ctx));
592 dprintk("RPC: gss_pipe_downcall returning length %Zu\n", mlen);
599 dprintk("RPC: gss_pipe_downcall returning %d\n", err);
604 gss_pipe_release(struct inode *inode)
606 struct rpc_inode *rpci = RPC_I(inode);
607 struct rpc_clnt *clnt;
608 struct rpc_auth *auth;
609 struct gss_auth *gss_auth;
611 clnt = rpci->private;
612 auth = clnt->cl_auth;
613 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
614 spin_lock(&gss_auth->lock);
615 while (!list_empty(&gss_auth->upcalls)) {
616 struct gss_upcall_msg *gss_msg;
618 gss_msg = list_entry(gss_auth->upcalls.next,
619 struct gss_upcall_msg, list);
620 gss_msg->msg.errno = -EPIPE;
621 atomic_inc(&gss_msg->count);
622 __gss_unhash_msg(gss_msg);
623 spin_unlock(&gss_auth->lock);
624 gss_release_msg(gss_msg);
625 spin_lock(&gss_auth->lock);
627 spin_unlock(&gss_auth->lock);
631 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
633 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
634 static unsigned long ratelimit;
636 if (msg->errno < 0) {
637 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
639 atomic_inc(&gss_msg->count);
640 gss_unhash_msg(gss_msg);
641 if (msg->errno == -ETIMEDOUT) {
642 unsigned long now = jiffies;
643 if (time_after(now, ratelimit)) {
644 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
645 "Please check user daemon is running!\n");
646 ratelimit = now + 15*HZ;
649 gss_release_msg(gss_msg);
654 * NOTE: we have the opportunity to use different
655 * parameters based on the input flavor (which must be a pseudoflavor)
657 static struct rpc_auth *
658 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
660 struct gss_auth *gss_auth;
661 struct rpc_auth * auth;
662 int err = -ENOMEM; /* XXX? */
664 dprintk("RPC: creating GSS authenticator for client %p\n",clnt);
666 if (!try_module_get(THIS_MODULE))
668 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
670 gss_auth->client = clnt;
672 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
673 if (!gss_auth->mech) {
674 printk(KERN_WARNING "%s: Pseudoflavor %d not found!",
675 __FUNCTION__, flavor);
678 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
679 if (gss_auth->service == 0)
681 INIT_LIST_HEAD(&gss_auth->upcalls);
682 spin_lock_init(&gss_auth->lock);
683 auth = &gss_auth->rpc_auth;
684 auth->au_cslack = GSS_CRED_SLACK >> 2;
685 auth->au_rslack = GSS_VERF_SLACK >> 2;
686 auth->au_ops = &authgss_ops;
687 auth->au_flavor = flavor;
688 atomic_set(&auth->au_count, 1);
690 err = rpcauth_init_credcache(auth, GSS_CRED_EXPIRE);
694 snprintf(gss_auth->path, sizeof(gss_auth->path), "%s/%s",
696 gss_auth->mech->gm_name);
697 gss_auth->dentry = rpc_mkpipe(gss_auth->path, clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
698 if (IS_ERR(gss_auth->dentry)) {
699 err = PTR_ERR(gss_auth->dentry);
705 gss_mech_put(gss_auth->mech);
709 module_put(THIS_MODULE);
714 gss_destroy(struct rpc_auth *auth)
716 struct gss_auth *gss_auth;
718 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
719 auth, auth->au_flavor);
721 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
722 rpc_unlink(gss_auth->path);
723 gss_mech_put(gss_auth->mech);
725 rpcauth_free_credcache(auth);
727 module_put(THIS_MODULE);
730 /* gss_destroy_cred (and gss_destroy_ctx) are used to clean up after failure
731 * to create a new cred or context, so they check that things have been
732 * allocated before freeing them. */
734 gss_destroy_ctx(struct gss_cl_ctx *ctx)
736 dprintk("RPC: gss_destroy_ctx\n");
739 gss_delete_sec_context(&ctx->gc_gss_ctx);
741 kfree(ctx->gc_wire_ctx.data);
746 gss_destroy_cred(struct rpc_cred *rc)
748 struct gss_cred *cred = container_of(rc, struct gss_cred, gc_base);
750 dprintk("RPC: gss_destroy_cred \n");
753 gss_put_ctx(cred->gc_ctx);
758 * Lookup RPCSEC_GSS cred for the current process
760 static struct rpc_cred *
761 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int taskflags)
763 return rpcauth_lookup_credcache(auth, acred, taskflags);
766 static struct rpc_cred *
767 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int taskflags)
769 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
770 struct gss_cred *cred = NULL;
773 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
774 acred->uid, auth->au_flavor);
776 if (!(cred = kmalloc(sizeof(*cred), GFP_KERNEL)))
779 memset(cred, 0, sizeof(*cred));
780 atomic_set(&cred->gc_count, 1);
781 cred->gc_uid = acred->uid;
783 * Note: in order to force a call to call_refresh(), we deliberately
784 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
787 cred->gc_base.cr_ops = &gss_credops;
788 cred->gc_service = gss_auth->service;
790 err = gss_create_upcall(gss_auth, cred);
791 } while (err == -EAGAIN);
795 return &cred->gc_base;
798 dprintk("RPC: gss_create_cred failed with error %d\n", err);
799 if (cred) gss_destroy_cred(&cred->gc_base);
804 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int taskflags)
806 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
808 /* Don't match with creds that have expired. */
809 if (gss_cred->gc_ctx && time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
811 return (rc->cr_uid == acred->uid);
815 * Marshal credentials.
816 * Maybe we should keep a cached credential for performance reasons.
819 gss_marshal(struct rpc_task *task, u32 *p)
821 struct rpc_cred *cred = task->tk_msg.rpc_cred;
822 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
824 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
826 struct rpc_rqst *req = task->tk_rqstp;
828 struct xdr_netobj mic;
830 struct xdr_buf verf_buf;
832 dprintk("RPC: %4u gss_marshal\n", task->tk_pid);
834 *p++ = htonl(RPC_AUTH_GSS);
837 spin_lock(&ctx->gc_seq_lock);
838 req->rq_seqno = ctx->gc_seq++;
839 spin_unlock(&ctx->gc_seq_lock);
841 *p++ = htonl((u32) RPC_GSS_VERSION);
842 *p++ = htonl((u32) ctx->gc_proc);
843 *p++ = htonl((u32) req->rq_seqno);
844 *p++ = htonl((u32) gss_cred->gc_service);
845 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
846 *cred_len = htonl((p - (cred_len + 1)) << 2);
848 /* We compute the checksum for the verifier over the xdr-encoded bytes
849 * starting with the xid and ending at the end of the credential: */
850 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
851 req->rq_snd_buf.head[0].iov_base);
852 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
853 xdr_buf_from_iov(&iov, &verf_buf);
855 /* set verifier flavor*/
856 *p++ = htonl(RPC_AUTH_GSS);
858 mic.data = (u8 *)(p + 1);
859 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
860 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
861 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
862 } else if (maj_stat != 0) {
863 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
866 p = xdr_encode_opaque(p, NULL, mic.len);
875 * Refresh credentials. XXX - finish
878 gss_refresh(struct rpc_task *task)
881 if (!gss_cred_is_uptodate_ctx(task->tk_msg.rpc_cred))
882 return gss_refresh_upcall(task);
887 gss_validate(struct rpc_task *task, u32 *p)
889 struct rpc_cred *cred = task->tk_msg.rpc_cred;
890 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
893 struct xdr_buf verf_buf;
894 struct xdr_netobj mic;
898 dprintk("RPC: %4u gss_validate\n", task->tk_pid);
901 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
903 if (flav != RPC_AUTH_GSS)
905 seq = htonl(task->tk_rqstp->rq_seqno);
907 iov.iov_len = sizeof(seq);
908 xdr_buf_from_iov(&iov, &verf_buf);
912 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
913 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
914 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
917 /* We leave it to unwrap to calculate au_rslack. For now we just
918 * calculate the length of the verifier: */
919 task->tk_auth->au_verfsize = XDR_QUADLEN(len) + 2;
921 dprintk("RPC: %4u GSS gss_validate: gss_verify_mic succeeded.\n",
923 return p + XDR_QUADLEN(len);
926 dprintk("RPC: %4u gss_validate failed.\n", task->tk_pid);
931 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
932 kxdrproc_t encode, struct rpc_rqst *rqstp, u32 *p, void *obj)
934 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
935 struct xdr_buf integ_buf;
936 u32 *integ_len = NULL;
937 struct xdr_netobj mic;
944 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
945 *p++ = htonl(rqstp->rq_seqno);
947 status = encode(rqstp, p, obj);
951 if (xdr_buf_subsegment(snd_buf, &integ_buf,
952 offset, snd_buf->len - offset))
954 *integ_len = htonl(integ_buf.len);
956 /* guess whether we're in the head or the tail: */
957 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
961 p = iov->iov_base + iov->iov_len;
962 mic.data = (u8 *)(p + 1);
964 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
965 status = -EIO; /* XXX? */
966 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
967 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
970 q = xdr_encode_opaque(p, NULL, mic.len);
972 offset = (u8 *)q - (u8 *)p;
973 iov->iov_len += offset;
974 snd_buf->len += offset;
979 priv_release_snd_buf(struct rpc_rqst *rqstp)
983 for (i=0; i < rqstp->rq_enc_pages_num; i++)
984 __free_page(rqstp->rq_enc_pages[i]);
985 kfree(rqstp->rq_enc_pages);
989 alloc_enc_pages(struct rpc_rqst *rqstp)
991 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
994 if (snd_buf->page_len == 0) {
995 rqstp->rq_enc_pages_num = 0;
999 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1000 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
1001 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1003 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
1005 if (!rqstp->rq_enc_pages)
1007 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1008 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1009 if (rqstp->rq_enc_pages[i] == NULL)
1012 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1015 for (i--; i >= 0; i--) {
1016 __free_page(rqstp->rq_enc_pages[i]);
1023 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1024 kxdrproc_t encode, struct rpc_rqst *rqstp, u32 *p, void *obj)
1026 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1031 struct page **inpages;
1038 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1039 *p++ = htonl(rqstp->rq_seqno);
1041 status = encode(rqstp, p, obj);
1045 status = alloc_enc_pages(rqstp);
1048 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1049 inpages = snd_buf->pages + first;
1050 snd_buf->pages = rqstp->rq_enc_pages;
1051 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1052 /* Give the tail its own page, in case we need extra space in the
1053 * head when wrapping: */
1054 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1055 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1056 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1057 snd_buf->tail[0].iov_base = tmp;
1059 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1060 /* RPC_SLACK_SPACE should prevent this ever happening: */
1061 BUG_ON(snd_buf->len > snd_buf->buflen);
1063 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1064 * done anyway, so it's safe to put the request on the wire: */
1065 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1066 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1070 *opaque_len = htonl(snd_buf->len - offset);
1071 /* guess whether we're in the head or the tail: */
1072 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1073 iov = snd_buf->tail;
1075 iov = snd_buf->head;
1076 p = iov->iov_base + iov->iov_len;
1077 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1079 iov->iov_len += pad;
1080 snd_buf->len += pad;
1086 gss_wrap_req(struct rpc_task *task,
1087 kxdrproc_t encode, void *rqstp, u32 *p, void *obj)
1089 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1090 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1092 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1095 dprintk("RPC: %4u gss_wrap_req\n", task->tk_pid);
1096 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1097 /* The spec seems a little ambiguous here, but I think that not
1098 * wrapping context destruction requests makes the most sense.
1100 status = encode(rqstp, p, obj);
1103 switch (gss_cred->gc_service) {
1104 case RPC_GSS_SVC_NONE:
1105 status = encode(rqstp, p, obj);
1107 case RPC_GSS_SVC_INTEGRITY:
1108 status = gss_wrap_req_integ(cred, ctx, encode,
1111 case RPC_GSS_SVC_PRIVACY:
1112 status = gss_wrap_req_priv(cred, ctx, encode,
1118 dprintk("RPC: %4u gss_wrap_req returning %d\n", task->tk_pid, status);
1123 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1124 struct rpc_rqst *rqstp, u32 **p)
1126 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1127 struct xdr_buf integ_buf;
1128 struct xdr_netobj mic;
1129 u32 data_offset, mic_offset;
1134 integ_len = ntohl(*(*p)++);
1137 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1138 mic_offset = integ_len + data_offset;
1139 if (mic_offset > rcv_buf->len)
1141 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1144 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1145 mic_offset - data_offset))
1148 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1151 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1152 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1153 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1154 if (maj_stat != GSS_S_COMPLETE)
1160 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1161 struct rpc_rqst *rqstp, u32 **p)
1163 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1169 opaque_len = ntohl(*(*p)++);
1170 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1171 if (offset + opaque_len > rcv_buf->len)
1173 /* remove padding: */
1174 rcv_buf->len = offset + opaque_len;
1176 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1177 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1178 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1179 if (maj_stat != GSS_S_COMPLETE)
1181 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1189 gss_unwrap_resp(struct rpc_task *task,
1190 kxdrproc_t decode, void *rqstp, u32 *p, void *obj)
1192 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1193 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1195 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1197 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1198 int savedlen = head->iov_len;
1201 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1203 switch (gss_cred->gc_service) {
1204 case RPC_GSS_SVC_NONE:
1206 case RPC_GSS_SVC_INTEGRITY:
1207 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1211 case RPC_GSS_SVC_PRIVACY:
1212 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1217 /* take into account extra slack for integrity and privacy cases: */
1218 task->tk_auth->au_rslack = task->tk_auth->au_verfsize + (p - savedp)
1219 + (savedlen - head->iov_len);
1221 status = decode(rqstp, p, obj);
1224 dprintk("RPC: %4u gss_unwrap_resp returning %d\n", task->tk_pid,
1229 static struct rpc_authops authgss_ops = {
1230 .owner = THIS_MODULE,
1231 .au_flavor = RPC_AUTH_GSS,
1233 .au_name = "RPCSEC_GSS",
1235 .create = gss_create,
1236 .destroy = gss_destroy,
1237 .lookup_cred = gss_lookup_cred,
1238 .crcreate = gss_create_cred
1241 static struct rpc_credops gss_credops = {
1242 .cr_name = "AUTH_GSS",
1243 .crdestroy = gss_destroy_cred,
1244 .crmatch = gss_match,
1245 .crmarshal = gss_marshal,
1246 .crrefresh = gss_refresh,
1247 .crvalidate = gss_validate,
1248 .crwrap_req = gss_wrap_req,
1249 .crunwrap_resp = gss_unwrap_resp,
1252 static struct rpc_pipe_ops gss_upcall_ops = {
1253 .upcall = gss_pipe_upcall,
1254 .downcall = gss_pipe_downcall,
1255 .destroy_msg = gss_pipe_destroy_msg,
1256 .release_pipe = gss_pipe_release,
1260 * Initialize RPCSEC_GSS module
1262 static int __init init_rpcsec_gss(void)
1266 err = rpcauth_register(&authgss_ops);
1269 err = gss_svc_init();
1271 goto out_unregister;
1274 rpcauth_unregister(&authgss_ops);
1279 static void __exit exit_rpcsec_gss(void)
1282 rpcauth_unregister(&authgss_ops);
1285 MODULE_LICENSE("GPL");
1286 module_init(init_rpcsec_gss)
1287 module_exit(exit_rpcsec_gss)