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 cred->cr_flags &= ~RPCAUTH_CRED_NEW;
162 write_unlock(&gss_ctx_lock);
168 gss_cred_is_uptodate_ctx(struct rpc_cred *cred)
170 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
173 read_lock(&gss_ctx_lock);
174 if ((cred->cr_flags & RPCAUTH_CRED_UPTODATE) && gss_cred->gc_ctx)
176 read_unlock(&gss_ctx_lock);
181 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
183 const void *q = (const void *)((const char *)p + len);
184 if (unlikely(q > end || q < p))
185 return ERR_PTR(-EFAULT);
190 static inline const void *
191 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
196 p = simple_get_bytes(p, end, &len, sizeof(len));
199 q = (const void *)((const char *)p + len);
200 if (unlikely(q > end || q < p))
201 return ERR_PTR(-EFAULT);
202 dest->data = kmalloc(len, GFP_KERNEL);
203 if (unlikely(dest->data == NULL))
204 return ERR_PTR(-ENOMEM);
206 memcpy(dest->data, p, len);
210 static struct gss_cl_ctx *
211 gss_cred_get_ctx(struct rpc_cred *cred)
213 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
214 struct gss_cl_ctx *ctx = NULL;
216 read_lock(&gss_ctx_lock);
217 if (gss_cred->gc_ctx)
218 ctx = gss_get_ctx(gss_cred->gc_ctx);
219 read_unlock(&gss_ctx_lock);
223 static struct gss_cl_ctx *
224 gss_alloc_context(void)
226 struct gss_cl_ctx *ctx;
228 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
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 = kzalloc(sizeof(*gss_msg), GFP_KERNEL);
394 if (gss_msg != NULL) {
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, RPCAUTH_LOOKUP_NEW);
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) {
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 dput(gss_auth->dentry);
723 gss_auth->dentry = NULL;
724 gss_mech_put(gss_auth->mech);
726 rpcauth_free_credcache(auth);
728 module_put(THIS_MODULE);
731 /* gss_destroy_cred (and gss_destroy_ctx) are used to clean up after failure
732 * to create a new cred or context, so they check that things have been
733 * allocated before freeing them. */
735 gss_destroy_ctx(struct gss_cl_ctx *ctx)
737 dprintk("RPC: gss_destroy_ctx\n");
740 gss_delete_sec_context(&ctx->gc_gss_ctx);
742 kfree(ctx->gc_wire_ctx.data);
747 gss_destroy_cred(struct rpc_cred *rc)
749 struct gss_cred *cred = container_of(rc, struct gss_cred, gc_base);
751 dprintk("RPC: gss_destroy_cred \n");
754 gss_put_ctx(cred->gc_ctx);
759 * Lookup RPCSEC_GSS cred for the current process
761 static struct rpc_cred *
762 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
764 return rpcauth_lookup_credcache(auth, acred, flags);
767 static struct rpc_cred *
768 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
770 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
771 struct gss_cred *cred = NULL;
774 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
775 acred->uid, auth->au_flavor);
777 if (!(cred = kzalloc(sizeof(*cred), GFP_KERNEL)))
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_base.cr_flags = RPCAUTH_CRED_NEW;
789 cred->gc_service = gss_auth->service;
790 return &cred->gc_base;
793 dprintk("RPC: gss_create_cred failed with error %d\n", err);
798 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
800 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
801 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
805 err = gss_create_upcall(gss_auth, gss_cred);
806 } while (err == -EAGAIN);
811 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
813 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
816 * If the searchflags have set RPCAUTH_LOOKUP_NEW, then
817 * we don't really care if the credential has expired or not,
818 * since the caller should be prepared to reinitialise it.
820 if ((flags & RPCAUTH_LOOKUP_NEW) && (rc->cr_flags & RPCAUTH_CRED_NEW))
822 /* Don't match with creds that have expired. */
823 if (gss_cred->gc_ctx && time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
826 return (rc->cr_uid == acred->uid);
830 * Marshal credentials.
831 * Maybe we should keep a cached credential for performance reasons.
834 gss_marshal(struct rpc_task *task, u32 *p)
836 struct rpc_cred *cred = task->tk_msg.rpc_cred;
837 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
839 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
841 struct rpc_rqst *req = task->tk_rqstp;
843 struct xdr_netobj mic;
845 struct xdr_buf verf_buf;
847 dprintk("RPC: %4u gss_marshal\n", task->tk_pid);
849 *p++ = htonl(RPC_AUTH_GSS);
852 spin_lock(&ctx->gc_seq_lock);
853 req->rq_seqno = ctx->gc_seq++;
854 spin_unlock(&ctx->gc_seq_lock);
856 *p++ = htonl((u32) RPC_GSS_VERSION);
857 *p++ = htonl((u32) ctx->gc_proc);
858 *p++ = htonl((u32) req->rq_seqno);
859 *p++ = htonl((u32) gss_cred->gc_service);
860 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
861 *cred_len = htonl((p - (cred_len + 1)) << 2);
863 /* We compute the checksum for the verifier over the xdr-encoded bytes
864 * starting with the xid and ending at the end of the credential: */
865 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
866 req->rq_snd_buf.head[0].iov_base);
867 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
868 xdr_buf_from_iov(&iov, &verf_buf);
870 /* set verifier flavor*/
871 *p++ = htonl(RPC_AUTH_GSS);
873 mic.data = (u8 *)(p + 1);
874 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
875 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
876 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
877 } else if (maj_stat != 0) {
878 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
881 p = xdr_encode_opaque(p, NULL, mic.len);
890 * Refresh credentials. XXX - finish
893 gss_refresh(struct rpc_task *task)
896 if (!gss_cred_is_uptodate_ctx(task->tk_msg.rpc_cred))
897 return gss_refresh_upcall(task);
902 gss_validate(struct rpc_task *task, u32 *p)
904 struct rpc_cred *cred = task->tk_msg.rpc_cred;
905 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
908 struct xdr_buf verf_buf;
909 struct xdr_netobj mic;
913 dprintk("RPC: %4u gss_validate\n", task->tk_pid);
916 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
918 if (flav != RPC_AUTH_GSS)
920 seq = htonl(task->tk_rqstp->rq_seqno);
922 iov.iov_len = sizeof(seq);
923 xdr_buf_from_iov(&iov, &verf_buf);
927 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
928 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
929 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
932 /* We leave it to unwrap to calculate au_rslack. For now we just
933 * calculate the length of the verifier: */
934 task->tk_auth->au_verfsize = XDR_QUADLEN(len) + 2;
936 dprintk("RPC: %4u GSS gss_validate: gss_verify_mic succeeded.\n",
938 return p + XDR_QUADLEN(len);
941 dprintk("RPC: %4u gss_validate failed.\n", task->tk_pid);
946 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
947 kxdrproc_t encode, struct rpc_rqst *rqstp, u32 *p, void *obj)
949 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
950 struct xdr_buf integ_buf;
951 u32 *integ_len = NULL;
952 struct xdr_netobj mic;
959 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
960 *p++ = htonl(rqstp->rq_seqno);
962 status = encode(rqstp, p, obj);
966 if (xdr_buf_subsegment(snd_buf, &integ_buf,
967 offset, snd_buf->len - offset))
969 *integ_len = htonl(integ_buf.len);
971 /* guess whether we're in the head or the tail: */
972 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
976 p = iov->iov_base + iov->iov_len;
977 mic.data = (u8 *)(p + 1);
979 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
980 status = -EIO; /* XXX? */
981 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
982 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
985 q = xdr_encode_opaque(p, NULL, mic.len);
987 offset = (u8 *)q - (u8 *)p;
988 iov->iov_len += offset;
989 snd_buf->len += offset;
994 priv_release_snd_buf(struct rpc_rqst *rqstp)
998 for (i=0; i < rqstp->rq_enc_pages_num; i++)
999 __free_page(rqstp->rq_enc_pages[i]);
1000 kfree(rqstp->rq_enc_pages);
1004 alloc_enc_pages(struct rpc_rqst *rqstp)
1006 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1009 if (snd_buf->page_len == 0) {
1010 rqstp->rq_enc_pages_num = 0;
1014 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1015 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
1016 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1018 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
1020 if (!rqstp->rq_enc_pages)
1022 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1023 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1024 if (rqstp->rq_enc_pages[i] == NULL)
1027 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1030 for (i--; i >= 0; i--) {
1031 __free_page(rqstp->rq_enc_pages[i]);
1038 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1039 kxdrproc_t encode, struct rpc_rqst *rqstp, u32 *p, void *obj)
1041 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1046 struct page **inpages;
1053 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1054 *p++ = htonl(rqstp->rq_seqno);
1056 status = encode(rqstp, p, obj);
1060 status = alloc_enc_pages(rqstp);
1063 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1064 inpages = snd_buf->pages + first;
1065 snd_buf->pages = rqstp->rq_enc_pages;
1066 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1067 /* Give the tail its own page, in case we need extra space in the
1068 * head when wrapping: */
1069 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1070 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1071 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1072 snd_buf->tail[0].iov_base = tmp;
1074 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1075 /* RPC_SLACK_SPACE should prevent this ever happening: */
1076 BUG_ON(snd_buf->len > snd_buf->buflen);
1078 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1079 * done anyway, so it's safe to put the request on the wire: */
1080 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1081 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1085 *opaque_len = htonl(snd_buf->len - offset);
1086 /* guess whether we're in the head or the tail: */
1087 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1088 iov = snd_buf->tail;
1090 iov = snd_buf->head;
1091 p = iov->iov_base + iov->iov_len;
1092 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1094 iov->iov_len += pad;
1095 snd_buf->len += pad;
1101 gss_wrap_req(struct rpc_task *task,
1102 kxdrproc_t encode, void *rqstp, u32 *p, void *obj)
1104 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1105 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1107 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1110 dprintk("RPC: %4u gss_wrap_req\n", task->tk_pid);
1111 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1112 /* The spec seems a little ambiguous here, but I think that not
1113 * wrapping context destruction requests makes the most sense.
1115 status = encode(rqstp, p, obj);
1118 switch (gss_cred->gc_service) {
1119 case RPC_GSS_SVC_NONE:
1120 status = encode(rqstp, p, obj);
1122 case RPC_GSS_SVC_INTEGRITY:
1123 status = gss_wrap_req_integ(cred, ctx, encode,
1126 case RPC_GSS_SVC_PRIVACY:
1127 status = gss_wrap_req_priv(cred, ctx, encode,
1133 dprintk("RPC: %4u gss_wrap_req returning %d\n", task->tk_pid, status);
1138 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1139 struct rpc_rqst *rqstp, u32 **p)
1141 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1142 struct xdr_buf integ_buf;
1143 struct xdr_netobj mic;
1144 u32 data_offset, mic_offset;
1149 integ_len = ntohl(*(*p)++);
1152 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1153 mic_offset = integ_len + data_offset;
1154 if (mic_offset > rcv_buf->len)
1156 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1159 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1160 mic_offset - data_offset))
1163 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1166 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1167 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1168 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1169 if (maj_stat != GSS_S_COMPLETE)
1175 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1176 struct rpc_rqst *rqstp, u32 **p)
1178 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1184 opaque_len = ntohl(*(*p)++);
1185 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1186 if (offset + opaque_len > rcv_buf->len)
1188 /* remove padding: */
1189 rcv_buf->len = offset + opaque_len;
1191 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1192 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1193 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1194 if (maj_stat != GSS_S_COMPLETE)
1196 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1204 gss_unwrap_resp(struct rpc_task *task,
1205 kxdrproc_t decode, void *rqstp, u32 *p, void *obj)
1207 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1208 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1210 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1212 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1213 int savedlen = head->iov_len;
1216 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1218 switch (gss_cred->gc_service) {
1219 case RPC_GSS_SVC_NONE:
1221 case RPC_GSS_SVC_INTEGRITY:
1222 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1226 case RPC_GSS_SVC_PRIVACY:
1227 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1232 /* take into account extra slack for integrity and privacy cases: */
1233 task->tk_auth->au_rslack = task->tk_auth->au_verfsize + (p - savedp)
1234 + (savedlen - head->iov_len);
1236 status = decode(rqstp, p, obj);
1239 dprintk("RPC: %4u gss_unwrap_resp returning %d\n", task->tk_pid,
1244 static struct rpc_authops authgss_ops = {
1245 .owner = THIS_MODULE,
1246 .au_flavor = RPC_AUTH_GSS,
1248 .au_name = "RPCSEC_GSS",
1250 .create = gss_create,
1251 .destroy = gss_destroy,
1252 .lookup_cred = gss_lookup_cred,
1253 .crcreate = gss_create_cred
1256 static struct rpc_credops gss_credops = {
1257 .cr_name = "AUTH_GSS",
1258 .crdestroy = gss_destroy_cred,
1259 .cr_init = gss_cred_init,
1260 .crmatch = gss_match,
1261 .crmarshal = gss_marshal,
1262 .crrefresh = gss_refresh,
1263 .crvalidate = gss_validate,
1264 .crwrap_req = gss_wrap_req,
1265 .crunwrap_resp = gss_unwrap_resp,
1268 static struct rpc_pipe_ops gss_upcall_ops = {
1269 .upcall = gss_pipe_upcall,
1270 .downcall = gss_pipe_downcall,
1271 .destroy_msg = gss_pipe_destroy_msg,
1272 .release_pipe = gss_pipe_release,
1276 * Initialize RPCSEC_GSS module
1278 static int __init init_rpcsec_gss(void)
1282 err = rpcauth_register(&authgss_ops);
1285 err = gss_svc_init();
1287 goto out_unregister;
1290 rpcauth_unregister(&authgss_ops);
1295 static void __exit exit_rpcsec_gss(void)
1298 rpcauth_unregister(&authgss_ops);
1301 MODULE_LICENSE("GPL");
1302 module_init(init_rpcsec_gss)
1303 module_exit(exit_rpcsec_gss)