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/sunrpc/clnt.h>
47 #include <linux/sunrpc/auth.h>
48 #include <linux/sunrpc/auth_gss.h>
49 #include <linux/sunrpc/svcauth_gss.h>
50 #include <linux/sunrpc/gss_err.h>
51 #include <linux/workqueue.h>
52 #include <linux/sunrpc/rpc_pipe_fs.h>
53 #include <linux/sunrpc/gss_api.h>
54 #include <asm/uaccess.h>
56 static struct rpc_authops authgss_ops;
58 static struct rpc_credops gss_credops;
61 # define RPCDBG_FACILITY RPCDBG_AUTH
64 #define NFS_NGROUPS 16
66 #define GSS_CRED_EXPIRE (60 * HZ) /* XXX: reasonable? */
67 #define GSS_CRED_SLACK 1024 /* XXX: unused */
68 /* length of a krb5 verifier (48), plus data added before arguments when
69 * using integrity (two 4-byte integers): */
70 #define GSS_VERF_SLACK 56
72 /* XXX this define must match the gssd define
73 * as it is passed to gssd to signal the use of
74 * machine creds should be part of the shared rpc interface */
76 #define CA_RUN_AS_MACHINE 0x00000200
78 /* dump the buffer in `emacs-hexl' style */
79 #define isprint(c) ((c > 0x1f) && (c < 0x7f))
81 static DEFINE_RWLOCK(gss_ctx_lock);
84 struct rpc_auth rpc_auth;
85 struct gss_api_mech *mech;
86 enum rpc_gss_svc service;
87 struct list_head upcalls;
88 struct rpc_clnt *client;
89 struct dentry *dentry;
94 static void gss_destroy_ctx(struct gss_cl_ctx *);
95 static struct rpc_pipe_ops gss_upcall_ops;
98 print_hexl(u32 *p, u_int length, u_int offset)
103 dprintk("RPC: print_hexl: length %d\n",length);
107 for (i = 0; i < length; i += 0x10) {
108 dprintk(" %04x: ", (u_int)(i + offset));
110 jm = jm > 16 ? 16 : jm;
112 for (j = 0; j < jm; j++) {
114 dprintk("%02x ", (u_int)cp[i+j]);
116 dprintk("%02x", (u_int)cp[i+j]);
118 for (; j < 16; j++) {
126 for (j = 0; j < jm; j++) {
128 c = isprint(c) ? c : '.';
135 EXPORT_SYMBOL(print_hexl);
137 static inline struct gss_cl_ctx *
138 gss_get_ctx(struct gss_cl_ctx *ctx)
140 atomic_inc(&ctx->count);
145 gss_put_ctx(struct gss_cl_ctx *ctx)
147 if (atomic_dec_and_test(&ctx->count))
148 gss_destroy_ctx(ctx);
152 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
154 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
155 struct gss_cl_ctx *old;
156 write_lock(&gss_ctx_lock);
157 old = gss_cred->gc_ctx;
158 gss_cred->gc_ctx = ctx;
159 cred->cr_flags |= RPCAUTH_CRED_UPTODATE;
160 write_unlock(&gss_ctx_lock);
166 gss_cred_is_uptodate_ctx(struct rpc_cred *cred)
168 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
171 read_lock(&gss_ctx_lock);
172 if ((cred->cr_flags & RPCAUTH_CRED_UPTODATE) && gss_cred->gc_ctx)
174 read_unlock(&gss_ctx_lock);
179 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
181 const void *q = (const void *)((const char *)p + len);
182 if (unlikely(q > end || q < p))
183 return ERR_PTR(-EFAULT);
188 static inline const void *
189 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
194 p = simple_get_bytes(p, end, &len, sizeof(len));
197 q = (const void *)((const char *)p + len);
198 if (unlikely(q > end || q < p))
199 return ERR_PTR(-EFAULT);
200 dest->data = kmalloc(len, GFP_KERNEL);
201 if (unlikely(dest->data == NULL))
202 return ERR_PTR(-ENOMEM);
204 memcpy(dest->data, p, len);
208 static struct gss_cl_ctx *
209 gss_cred_get_ctx(struct rpc_cred *cred)
211 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
212 struct gss_cl_ctx *ctx = NULL;
214 read_lock(&gss_ctx_lock);
215 if (gss_cred->gc_ctx)
216 ctx = gss_get_ctx(gss_cred->gc_ctx);
217 read_unlock(&gss_ctx_lock);
221 static struct gss_cl_ctx *
222 gss_alloc_context(void)
224 struct gss_cl_ctx *ctx;
226 ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
228 memset(ctx, 0, sizeof(*ctx));
229 ctx->gc_proc = RPC_GSS_PROC_DATA;
230 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
231 spin_lock_init(&ctx->gc_seq_lock);
232 atomic_set(&ctx->count,1);
237 #define GSSD_MIN_TIMEOUT (60 * 60)
239 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
243 unsigned int timeout;
247 /* First unsigned int gives the lifetime (in seconds) of the cred */
248 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
252 timeout = GSSD_MIN_TIMEOUT;
253 ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
254 /* Sequence number window. Determines the maximum number of simultaneous requests */
255 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
258 ctx->gc_win = window_size;
259 /* gssd signals an error by passing ctx->gc_win = 0: */
260 if (ctx->gc_win == 0) {
261 /* in which case, p points to an error code which we ignore */
262 p = ERR_PTR(-EACCES);
265 /* copy the opaque wire context */
266 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
269 /* import the opaque security context */
270 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
273 q = (const void *)((const char *)p + seclen);
274 if (unlikely(q > end || q < p)) {
275 p = ERR_PTR(-EFAULT);
278 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
285 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p));
290 struct gss_upcall_msg {
293 struct rpc_pipe_msg msg;
294 struct list_head list;
295 struct gss_auth *auth;
296 struct rpc_wait_queue rpc_waitqueue;
297 wait_queue_head_t waitqueue;
298 struct gss_cl_ctx *ctx;
302 gss_release_msg(struct gss_upcall_msg *gss_msg)
304 if (!atomic_dec_and_test(&gss_msg->count))
306 BUG_ON(!list_empty(&gss_msg->list));
307 if (gss_msg->ctx != NULL)
308 gss_put_ctx(gss_msg->ctx);
312 static struct gss_upcall_msg *
313 __gss_find_upcall(struct gss_auth *gss_auth, uid_t uid)
315 struct gss_upcall_msg *pos;
316 list_for_each_entry(pos, &gss_auth->upcalls, list) {
319 atomic_inc(&pos->count);
320 dprintk("RPC: gss_find_upcall found msg %p\n", pos);
323 dprintk("RPC: gss_find_upcall found nothing\n");
327 /* Try to add a upcall to the pipefs queue.
328 * If an upcall owned by our uid already exists, then we return a reference
329 * to that upcall instead of adding the new upcall.
331 static inline struct gss_upcall_msg *
332 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
334 struct gss_upcall_msg *old;
336 spin_lock(&gss_auth->lock);
337 old = __gss_find_upcall(gss_auth, gss_msg->uid);
339 atomic_inc(&gss_msg->count);
340 list_add(&gss_msg->list, &gss_auth->upcalls);
343 spin_unlock(&gss_auth->lock);
348 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
350 if (list_empty(&gss_msg->list))
352 list_del_init(&gss_msg->list);
353 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
354 wake_up_all(&gss_msg->waitqueue);
355 atomic_dec(&gss_msg->count);
359 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
361 struct gss_auth *gss_auth = gss_msg->auth;
363 spin_lock(&gss_auth->lock);
364 __gss_unhash_msg(gss_msg);
365 spin_unlock(&gss_auth->lock);
369 gss_upcall_callback(struct rpc_task *task)
371 struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
372 struct gss_cred, gc_base);
373 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
375 BUG_ON(gss_msg == NULL);
377 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_get_ctx(gss_msg->ctx));
379 task->tk_status = gss_msg->msg.errno;
380 spin_lock(&gss_msg->auth->lock);
381 gss_cred->gc_upcall = NULL;
382 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
383 spin_unlock(&gss_msg->auth->lock);
384 gss_release_msg(gss_msg);
387 static inline struct gss_upcall_msg *
388 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
390 struct gss_upcall_msg *gss_msg;
392 gss_msg = kmalloc(sizeof(*gss_msg), GFP_KERNEL);
393 if (gss_msg != NULL) {
394 memset(gss_msg, 0, sizeof(*gss_msg));
395 INIT_LIST_HEAD(&gss_msg->list);
396 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
397 init_waitqueue_head(&gss_msg->waitqueue);
398 atomic_set(&gss_msg->count, 1);
399 gss_msg->msg.data = &gss_msg->uid;
400 gss_msg->msg.len = sizeof(gss_msg->uid);
402 gss_msg->auth = gss_auth;
407 static struct gss_upcall_msg *
408 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
410 struct gss_upcall_msg *gss_new, *gss_msg;
412 gss_new = gss_alloc_msg(gss_auth, cred->cr_uid);
414 return ERR_PTR(-ENOMEM);
415 gss_msg = gss_add_msg(gss_auth, gss_new);
416 if (gss_msg == gss_new) {
417 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
419 gss_unhash_msg(gss_new);
420 gss_msg = ERR_PTR(res);
423 gss_release_msg(gss_new);
428 gss_refresh_upcall(struct rpc_task *task)
430 struct rpc_cred *cred = task->tk_msg.rpc_cred;
431 struct gss_auth *gss_auth = container_of(task->tk_client->cl_auth,
432 struct gss_auth, rpc_auth);
433 struct gss_cred *gss_cred = container_of(cred,
434 struct gss_cred, gc_base);
435 struct gss_upcall_msg *gss_msg;
438 dprintk("RPC: %4u gss_refresh_upcall for uid %u\n", task->tk_pid, cred->cr_uid);
439 gss_msg = gss_setup_upcall(task->tk_client, gss_auth, cred);
440 if (IS_ERR(gss_msg)) {
441 err = PTR_ERR(gss_msg);
444 spin_lock(&gss_auth->lock);
445 if (gss_cred->gc_upcall != NULL)
446 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL, NULL);
447 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
448 task->tk_timeout = 0;
449 gss_cred->gc_upcall = gss_msg;
450 /* gss_upcall_callback will release the reference to gss_upcall_msg */
451 atomic_inc(&gss_msg->count);
452 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback, NULL);
454 err = gss_msg->msg.errno;
455 spin_unlock(&gss_auth->lock);
456 gss_release_msg(gss_msg);
458 dprintk("RPC: %4u gss_refresh_upcall for uid %u result %d\n", task->tk_pid,
464 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
466 struct rpc_cred *cred = &gss_cred->gc_base;
467 struct gss_upcall_msg *gss_msg;
471 dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
472 gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
473 if (IS_ERR(gss_msg)) {
474 err = PTR_ERR(gss_msg);
478 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
479 spin_lock(&gss_auth->lock);
480 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
481 spin_unlock(&gss_auth->lock);
484 spin_unlock(&gss_auth->lock);
492 gss_cred_set_ctx(cred, gss_get_ctx(gss_msg->ctx));
494 err = gss_msg->msg.errno;
496 finish_wait(&gss_msg->waitqueue, &wait);
497 gss_release_msg(gss_msg);
499 dprintk("RPC: gss_create_upcall for uid %u result %d\n", cred->cr_uid, err);
504 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
505 char __user *dst, size_t buflen)
507 char *data = (char *)msg->data + msg->copied;
508 ssize_t mlen = msg->len;
513 left = copy_to_user(dst, data, mlen);
524 #define MSG_BUF_MAXSIZE 1024
527 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
531 struct rpc_clnt *clnt;
532 struct gss_auth *gss_auth;
533 struct rpc_cred *cred;
534 struct gss_upcall_msg *gss_msg;
535 struct gss_cl_ctx *ctx;
539 if (mlen > MSG_BUF_MAXSIZE)
542 buf = kmalloc(mlen, GFP_KERNEL);
546 clnt = RPC_I(filp->f_dentry->d_inode)->private;
548 if (copy_from_user(buf, src, mlen))
551 end = (const void *)((char *)buf + mlen);
552 p = simple_get_bytes(buf, end, &uid, sizeof(uid));
559 ctx = gss_alloc_context();
563 gss_auth = container_of(clnt->cl_auth, struct gss_auth, rpc_auth);
564 p = gss_fill_context(p, end, ctx, gss_auth->mech);
570 spin_lock(&gss_auth->lock);
571 gss_msg = __gss_find_upcall(gss_auth, uid);
573 if (err == 0 && gss_msg->ctx == NULL)
574 gss_msg->ctx = gss_get_ctx(ctx);
575 gss_msg->msg.errno = err;
576 __gss_unhash_msg(gss_msg);
577 spin_unlock(&gss_auth->lock);
578 gss_release_msg(gss_msg);
580 struct auth_cred acred = { .uid = uid };
581 spin_unlock(&gss_auth->lock);
582 cred = rpcauth_lookup_credcache(clnt->cl_auth, &acred, 0);
587 gss_cred_set_ctx(cred, gss_get_ctx(ctx));
591 dprintk("RPC: gss_pipe_downcall returning length %Zu\n", mlen);
598 dprintk("RPC: gss_pipe_downcall returning %d\n", err);
603 gss_pipe_release(struct inode *inode)
605 struct rpc_inode *rpci = RPC_I(inode);
606 struct rpc_clnt *clnt;
607 struct rpc_auth *auth;
608 struct gss_auth *gss_auth;
610 clnt = rpci->private;
611 auth = clnt->cl_auth;
612 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
613 spin_lock(&gss_auth->lock);
614 while (!list_empty(&gss_auth->upcalls)) {
615 struct gss_upcall_msg *gss_msg;
617 gss_msg = list_entry(gss_auth->upcalls.next,
618 struct gss_upcall_msg, list);
619 gss_msg->msg.errno = -EPIPE;
620 atomic_inc(&gss_msg->count);
621 __gss_unhash_msg(gss_msg);
622 spin_unlock(&gss_auth->lock);
623 gss_release_msg(gss_msg);
624 spin_lock(&gss_auth->lock);
626 spin_unlock(&gss_auth->lock);
630 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
632 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
633 static unsigned long ratelimit;
635 if (msg->errno < 0) {
636 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
638 atomic_inc(&gss_msg->count);
639 gss_unhash_msg(gss_msg);
640 if (msg->errno == -ETIMEDOUT || msg->errno == -EPIPE) {
641 unsigned long now = jiffies;
642 if (time_after(now, ratelimit)) {
643 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
644 "Please check user daemon is running!\n");
645 ratelimit = now + 15*HZ;
648 gss_release_msg(gss_msg);
653 * NOTE: we have the opportunity to use different
654 * parameters based on the input flavor (which must be a pseudoflavor)
656 static struct rpc_auth *
657 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
659 struct gss_auth *gss_auth;
660 struct rpc_auth * auth;
661 int err = -ENOMEM; /* XXX? */
663 dprintk("RPC: creating GSS authenticator for client %p\n",clnt);
665 if (!try_module_get(THIS_MODULE))
667 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
669 gss_auth->client = clnt;
671 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
672 if (!gss_auth->mech) {
673 printk(KERN_WARNING "%s: Pseudoflavor %d not found!",
674 __FUNCTION__, flavor);
677 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
678 if (gss_auth->service == 0)
680 INIT_LIST_HEAD(&gss_auth->upcalls);
681 spin_lock_init(&gss_auth->lock);
682 auth = &gss_auth->rpc_auth;
683 auth->au_cslack = GSS_CRED_SLACK >> 2;
684 auth->au_rslack = GSS_VERF_SLACK >> 2;
685 auth->au_ops = &authgss_ops;
686 auth->au_flavor = flavor;
687 atomic_set(&auth->au_count, 1);
689 err = rpcauth_init_credcache(auth, GSS_CRED_EXPIRE);
693 snprintf(gss_auth->path, sizeof(gss_auth->path), "%s/%s",
695 gss_auth->mech->gm_name);
696 gss_auth->dentry = rpc_mkpipe(gss_auth->path, clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
697 if (IS_ERR(gss_auth->dentry)) {
698 err = PTR_ERR(gss_auth->dentry);
704 gss_mech_put(gss_auth->mech);
708 module_put(THIS_MODULE);
713 gss_destroy(struct rpc_auth *auth)
715 struct gss_auth *gss_auth;
717 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
718 auth, auth->au_flavor);
720 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
721 rpc_unlink(gss_auth->path);
722 gss_mech_put(gss_auth->mech);
724 rpcauth_free_credcache(auth);
726 module_put(THIS_MODULE);
729 /* gss_destroy_cred (and gss_destroy_ctx) are used to clean up after failure
730 * to create a new cred or context, so they check that things have been
731 * allocated before freeing them. */
733 gss_destroy_ctx(struct gss_cl_ctx *ctx)
735 dprintk("RPC: gss_destroy_ctx\n");
738 gss_delete_sec_context(&ctx->gc_gss_ctx);
740 kfree(ctx->gc_wire_ctx.data);
745 gss_destroy_cred(struct rpc_cred *rc)
747 struct gss_cred *cred = container_of(rc, struct gss_cred, gc_base);
749 dprintk("RPC: gss_destroy_cred \n");
752 gss_put_ctx(cred->gc_ctx);
757 * Lookup RPCSEC_GSS cred for the current process
759 static struct rpc_cred *
760 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int taskflags)
762 return rpcauth_lookup_credcache(auth, acred, taskflags);
765 static struct rpc_cred *
766 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int taskflags)
768 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
769 struct gss_cred *cred = NULL;
772 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
773 acred->uid, auth->au_flavor);
775 if (!(cred = kmalloc(sizeof(*cred), GFP_KERNEL)))
778 memset(cred, 0, sizeof(*cred));
779 atomic_set(&cred->gc_count, 1);
780 cred->gc_uid = acred->uid;
782 * Note: in order to force a call to call_refresh(), we deliberately
783 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
786 cred->gc_base.cr_ops = &gss_credops;
787 cred->gc_service = gss_auth->service;
788 err = gss_create_upcall(gss_auth, cred);
792 return &cred->gc_base;
795 dprintk("RPC: gss_create_cred failed with error %d\n", err);
796 if (cred) gss_destroy_cred(&cred->gc_base);
801 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int taskflags)
803 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
805 /* Don't match with creds that have expired. */
806 if (gss_cred->gc_ctx && time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
808 return (rc->cr_uid == acred->uid);
812 * Marshal credentials.
813 * Maybe we should keep a cached credential for performance reasons.
816 gss_marshal(struct rpc_task *task, u32 *p)
818 struct rpc_cred *cred = task->tk_msg.rpc_cred;
819 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
821 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
823 struct rpc_rqst *req = task->tk_rqstp;
825 struct xdr_netobj mic;
827 struct xdr_buf verf_buf;
829 dprintk("RPC: %4u gss_marshal\n", task->tk_pid);
831 *p++ = htonl(RPC_AUTH_GSS);
834 spin_lock(&ctx->gc_seq_lock);
835 req->rq_seqno = ctx->gc_seq++;
836 spin_unlock(&ctx->gc_seq_lock);
838 *p++ = htonl((u32) RPC_GSS_VERSION);
839 *p++ = htonl((u32) ctx->gc_proc);
840 *p++ = htonl((u32) req->rq_seqno);
841 *p++ = htonl((u32) gss_cred->gc_service);
842 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
843 *cred_len = htonl((p - (cred_len + 1)) << 2);
845 /* We compute the checksum for the verifier over the xdr-encoded bytes
846 * starting with the xid and ending at the end of the credential: */
847 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
848 req->rq_snd_buf.head[0].iov_base);
849 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
850 xdr_buf_from_iov(&iov, &verf_buf);
852 /* set verifier flavor*/
853 *p++ = htonl(RPC_AUTH_GSS);
855 mic.data = (u8 *)(p + 1);
856 maj_stat = gss_get_mic(ctx->gc_gss_ctx,
859 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
860 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
861 } else if (maj_stat != 0) {
862 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
865 p = xdr_encode_opaque(p, NULL, mic.len);
874 * Refresh credentials. XXX - finish
877 gss_refresh(struct rpc_task *task)
880 if (!gss_cred_is_uptodate_ctx(task->tk_msg.rpc_cred))
881 return gss_refresh_upcall(task);
886 gss_validate(struct rpc_task *task, u32 *p)
888 struct rpc_cred *cred = task->tk_msg.rpc_cred;
889 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
892 struct xdr_buf verf_buf;
893 struct xdr_netobj mic;
897 dprintk("RPC: %4u gss_validate\n", task->tk_pid);
900 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
902 if (flav != RPC_AUTH_GSS)
904 seq = htonl(task->tk_rqstp->rq_seqno);
906 iov.iov_len = sizeof(seq);
907 xdr_buf_from_iov(&iov, &verf_buf);
911 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic, &qop_state);
912 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
913 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
916 /* We leave it to unwrap to calculate au_rslack. For now we just
917 * calculate the length of the verifier: */
918 task->tk_auth->au_verfsize = XDR_QUADLEN(len) + 2;
920 dprintk("RPC: %4u GSS gss_validate: gss_verify_mic succeeded.\n",
922 return p + XDR_QUADLEN(len);
925 dprintk("RPC: %4u gss_validate failed.\n", task->tk_pid);
930 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
931 kxdrproc_t encode, struct rpc_rqst *rqstp, u32 *p, void *obj)
933 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
934 struct xdr_buf integ_buf;
935 u32 *integ_len = NULL;
936 struct xdr_netobj mic;
943 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
944 *p++ = htonl(rqstp->rq_seqno);
946 status = encode(rqstp, p, obj);
950 if (xdr_buf_subsegment(snd_buf, &integ_buf,
951 offset, snd_buf->len - offset))
953 *integ_len = htonl(integ_buf.len);
955 /* guess whether we're in the head or the tail: */
956 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
960 p = iov->iov_base + iov->iov_len;
961 mic.data = (u8 *)(p + 1);
963 maj_stat = gss_get_mic(ctx->gc_gss_ctx,
964 GSS_C_QOP_DEFAULT, &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 gss_wrap_req(struct rpc_task *task,
980 kxdrproc_t encode, void *rqstp, u32 *p, void *obj)
982 struct rpc_cred *cred = task->tk_msg.rpc_cred;
983 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
985 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
988 dprintk("RPC: %4u gss_wrap_req\n", task->tk_pid);
989 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
990 /* The spec seems a little ambiguous here, but I think that not
991 * wrapping context destruction requests makes the most sense.
993 status = encode(rqstp, p, obj);
996 switch (gss_cred->gc_service) {
997 case RPC_GSS_SVC_NONE:
998 status = encode(rqstp, p, obj);
1000 case RPC_GSS_SVC_INTEGRITY:
1001 status = gss_wrap_req_integ(cred, ctx, encode,
1004 case RPC_GSS_SVC_PRIVACY:
1009 dprintk("RPC: %4u gss_wrap_req returning %d\n", task->tk_pid, status);
1014 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1015 struct rpc_rqst *rqstp, u32 **p)
1017 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1018 struct xdr_buf integ_buf;
1019 struct xdr_netobj mic;
1020 u32 data_offset, mic_offset;
1025 integ_len = ntohl(*(*p)++);
1028 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1029 mic_offset = integ_len + data_offset;
1030 if (mic_offset > rcv_buf->len)
1032 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1035 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1036 mic_offset - data_offset))
1039 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1042 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf,
1044 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1045 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1046 if (maj_stat != GSS_S_COMPLETE)
1052 gss_unwrap_resp(struct rpc_task *task,
1053 kxdrproc_t decode, void *rqstp, u32 *p, void *obj)
1055 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1056 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1058 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1062 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1064 switch (gss_cred->gc_service) {
1065 case RPC_GSS_SVC_NONE:
1067 case RPC_GSS_SVC_INTEGRITY:
1068 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1072 case RPC_GSS_SVC_PRIVACY:
1075 /* take into account extra slack for integrity and privacy cases: */
1076 task->tk_auth->au_rslack = task->tk_auth->au_verfsize + (p - savedp);
1078 status = decode(rqstp, p, obj);
1081 dprintk("RPC: %4u gss_unwrap_resp returning %d\n", task->tk_pid,
1086 static struct rpc_authops authgss_ops = {
1087 .owner = THIS_MODULE,
1088 .au_flavor = RPC_AUTH_GSS,
1090 .au_name = "RPCSEC_GSS",
1092 .create = gss_create,
1093 .destroy = gss_destroy,
1094 .lookup_cred = gss_lookup_cred,
1095 .crcreate = gss_create_cred
1098 static struct rpc_credops gss_credops = {
1099 .cr_name = "AUTH_GSS",
1100 .crdestroy = gss_destroy_cred,
1101 .crmatch = gss_match,
1102 .crmarshal = gss_marshal,
1103 .crrefresh = gss_refresh,
1104 .crvalidate = gss_validate,
1105 .crwrap_req = gss_wrap_req,
1106 .crunwrap_resp = gss_unwrap_resp,
1109 static struct rpc_pipe_ops gss_upcall_ops = {
1110 .upcall = gss_pipe_upcall,
1111 .downcall = gss_pipe_downcall,
1112 .destroy_msg = gss_pipe_destroy_msg,
1113 .release_pipe = gss_pipe_release,
1117 * Initialize RPCSEC_GSS module
1119 static int __init init_rpcsec_gss(void)
1123 err = rpcauth_register(&authgss_ops);
1126 err = gss_svc_init();
1128 goto out_unregister;
1131 rpcauth_unregister(&authgss_ops);
1136 static void __exit exit_rpcsec_gss(void)
1139 rpcauth_unregister(&authgss_ops);
1142 MODULE_LICENSE("GPL");
1143 module_init(init_rpcsec_gss)
1144 module_exit(exit_rpcsec_gss)