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 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 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))
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;
93 static void gss_destroy_ctx(struct gss_cl_ctx *);
94 static struct rpc_pipe_ops gss_upcall_ops;
96 static inline struct gss_cl_ctx *
97 gss_get_ctx(struct gss_cl_ctx *ctx)
99 atomic_inc(&ctx->count);
104 gss_put_ctx(struct gss_cl_ctx *ctx)
106 if (atomic_dec_and_test(&ctx->count))
107 gss_destroy_ctx(ctx);
111 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
113 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
114 struct gss_cl_ctx *old;
115 write_lock(&gss_ctx_lock);
116 old = gss_cred->gc_ctx;
117 gss_cred->gc_ctx = ctx;
118 cred->cr_flags |= RPCAUTH_CRED_UPTODATE;
119 cred->cr_flags &= ~RPCAUTH_CRED_NEW;
120 write_unlock(&gss_ctx_lock);
126 gss_cred_is_uptodate_ctx(struct rpc_cred *cred)
128 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
131 read_lock(&gss_ctx_lock);
132 if ((cred->cr_flags & RPCAUTH_CRED_UPTODATE) && gss_cred->gc_ctx)
134 read_unlock(&gss_ctx_lock);
139 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
141 const void *q = (const void *)((const char *)p + len);
142 if (unlikely(q > end || q < p))
143 return ERR_PTR(-EFAULT);
148 static inline const void *
149 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
154 p = simple_get_bytes(p, end, &len, sizeof(len));
157 q = (const void *)((const char *)p + len);
158 if (unlikely(q > end || q < p))
159 return ERR_PTR(-EFAULT);
160 dest->data = kmemdup(p, len, GFP_KERNEL);
161 if (unlikely(dest->data == NULL))
162 return ERR_PTR(-ENOMEM);
167 static struct gss_cl_ctx *
168 gss_cred_get_ctx(struct rpc_cred *cred)
170 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
171 struct gss_cl_ctx *ctx = NULL;
173 read_lock(&gss_ctx_lock);
174 if (gss_cred->gc_ctx)
175 ctx = gss_get_ctx(gss_cred->gc_ctx);
176 read_unlock(&gss_ctx_lock);
180 static struct gss_cl_ctx *
181 gss_alloc_context(void)
183 struct gss_cl_ctx *ctx;
185 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
187 ctx->gc_proc = RPC_GSS_PROC_DATA;
188 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
189 spin_lock_init(&ctx->gc_seq_lock);
190 atomic_set(&ctx->count,1);
195 #define GSSD_MIN_TIMEOUT (60 * 60)
197 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
201 unsigned int timeout;
205 /* First unsigned int gives the lifetime (in seconds) of the cred */
206 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
210 timeout = GSSD_MIN_TIMEOUT;
211 ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
212 /* Sequence number window. Determines the maximum number of simultaneous requests */
213 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
216 ctx->gc_win = window_size;
217 /* gssd signals an error by passing ctx->gc_win = 0: */
218 if (ctx->gc_win == 0) {
219 /* in which case, p points to an error code which we ignore */
220 p = ERR_PTR(-EACCES);
223 /* copy the opaque wire context */
224 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
227 /* import the opaque security context */
228 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
231 q = (const void *)((const char *)p + seclen);
232 if (unlikely(q > end || q < p)) {
233 p = ERR_PTR(-EFAULT);
236 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
243 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p));
248 struct gss_upcall_msg {
251 struct rpc_pipe_msg msg;
252 struct list_head list;
253 struct gss_auth *auth;
254 struct rpc_wait_queue rpc_waitqueue;
255 wait_queue_head_t waitqueue;
256 struct gss_cl_ctx *ctx;
260 gss_release_msg(struct gss_upcall_msg *gss_msg)
262 if (!atomic_dec_and_test(&gss_msg->count))
264 BUG_ON(!list_empty(&gss_msg->list));
265 if (gss_msg->ctx != NULL)
266 gss_put_ctx(gss_msg->ctx);
270 static struct gss_upcall_msg *
271 __gss_find_upcall(struct gss_auth *gss_auth, uid_t uid)
273 struct gss_upcall_msg *pos;
274 list_for_each_entry(pos, &gss_auth->upcalls, list) {
277 atomic_inc(&pos->count);
278 dprintk("RPC: gss_find_upcall found msg %p\n", pos);
281 dprintk("RPC: gss_find_upcall found nothing\n");
285 /* Try to add a upcall to the pipefs queue.
286 * If an upcall owned by our uid already exists, then we return a reference
287 * to that upcall instead of adding the new upcall.
289 static inline struct gss_upcall_msg *
290 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
292 struct inode *inode = gss_auth->dentry->d_inode;
293 struct gss_upcall_msg *old;
295 spin_lock(&inode->i_lock);
296 old = __gss_find_upcall(gss_auth, gss_msg->uid);
298 atomic_inc(&gss_msg->count);
299 list_add(&gss_msg->list, &gss_auth->upcalls);
302 spin_unlock(&inode->i_lock);
307 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
309 if (list_empty(&gss_msg->list))
311 list_del_init(&gss_msg->list);
312 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
313 wake_up_all(&gss_msg->waitqueue);
314 atomic_dec(&gss_msg->count);
318 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
320 struct gss_auth *gss_auth = gss_msg->auth;
321 struct inode *inode = gss_auth->dentry->d_inode;
323 spin_lock(&inode->i_lock);
324 __gss_unhash_msg(gss_msg);
325 spin_unlock(&inode->i_lock);
329 gss_upcall_callback(struct rpc_task *task)
331 struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
332 struct gss_cred, gc_base);
333 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
334 struct inode *inode = gss_msg->auth->dentry->d_inode;
337 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_get_ctx(gss_msg->ctx));
339 task->tk_status = gss_msg->msg.errno;
340 spin_lock(&inode->i_lock);
341 gss_cred->gc_upcall = NULL;
342 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
343 spin_unlock(&inode->i_lock);
344 gss_release_msg(gss_msg);
347 static inline struct gss_upcall_msg *
348 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
350 struct gss_upcall_msg *gss_msg;
352 gss_msg = kzalloc(sizeof(*gss_msg), GFP_KERNEL);
353 if (gss_msg != NULL) {
354 INIT_LIST_HEAD(&gss_msg->list);
355 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
356 init_waitqueue_head(&gss_msg->waitqueue);
357 atomic_set(&gss_msg->count, 1);
358 gss_msg->msg.data = &gss_msg->uid;
359 gss_msg->msg.len = sizeof(gss_msg->uid);
361 gss_msg->auth = gss_auth;
366 static struct gss_upcall_msg *
367 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
369 struct gss_upcall_msg *gss_new, *gss_msg;
371 gss_new = gss_alloc_msg(gss_auth, cred->cr_uid);
373 return ERR_PTR(-ENOMEM);
374 gss_msg = gss_add_msg(gss_auth, gss_new);
375 if (gss_msg == gss_new) {
376 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
378 gss_unhash_msg(gss_new);
379 gss_msg = ERR_PTR(res);
382 gss_release_msg(gss_new);
387 gss_refresh_upcall(struct rpc_task *task)
389 struct rpc_cred *cred = task->tk_msg.rpc_cred;
390 struct gss_auth *gss_auth = container_of(cred->cr_auth,
391 struct gss_auth, rpc_auth);
392 struct gss_cred *gss_cred = container_of(cred,
393 struct gss_cred, gc_base);
394 struct gss_upcall_msg *gss_msg;
395 struct inode *inode = gss_auth->dentry->d_inode;
398 dprintk("RPC: %5u gss_refresh_upcall for uid %u\n", task->tk_pid,
400 gss_msg = gss_setup_upcall(task->tk_client, gss_auth, cred);
401 if (IS_ERR(gss_msg)) {
402 err = PTR_ERR(gss_msg);
405 spin_lock(&inode->i_lock);
406 if (gss_cred->gc_upcall != NULL)
407 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL, NULL);
408 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
409 task->tk_timeout = 0;
410 gss_cred->gc_upcall = gss_msg;
411 /* gss_upcall_callback will release the reference to gss_upcall_msg */
412 atomic_inc(&gss_msg->count);
413 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback, NULL);
415 err = gss_msg->msg.errno;
416 spin_unlock(&inode->i_lock);
417 gss_release_msg(gss_msg);
419 dprintk("RPC: %5u gss_refresh_upcall for uid %u result %d\n",
420 task->tk_pid, cred->cr_uid, err);
425 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
427 struct inode *inode = gss_auth->dentry->d_inode;
428 struct rpc_cred *cred = &gss_cred->gc_base;
429 struct gss_upcall_msg *gss_msg;
433 dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
434 gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
435 if (IS_ERR(gss_msg)) {
436 err = PTR_ERR(gss_msg);
440 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
441 spin_lock(&inode->i_lock);
442 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
443 spin_unlock(&inode->i_lock);
446 spin_unlock(&inode->i_lock);
454 gss_cred_set_ctx(cred, gss_get_ctx(gss_msg->ctx));
456 err = gss_msg->msg.errno;
458 finish_wait(&gss_msg->waitqueue, &wait);
459 gss_release_msg(gss_msg);
461 dprintk("RPC: gss_create_upcall for uid %u result %d\n",
467 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
468 char __user *dst, size_t buflen)
470 char *data = (char *)msg->data + msg->copied;
471 ssize_t mlen = msg->len;
476 left = copy_to_user(dst, data, mlen);
487 #define MSG_BUF_MAXSIZE 1024
490 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
494 struct rpc_clnt *clnt;
495 struct gss_auth *gss_auth;
496 struct rpc_cred *cred;
497 struct gss_upcall_msg *gss_msg;
498 struct inode *inode = filp->f_path.dentry->d_inode;
499 struct gss_cl_ctx *ctx;
503 if (mlen > MSG_BUF_MAXSIZE)
506 buf = kmalloc(mlen, GFP_KERNEL);
510 clnt = RPC_I(inode)->private;
512 if (copy_from_user(buf, src, mlen))
515 end = (const void *)((char *)buf + mlen);
516 p = simple_get_bytes(buf, end, &uid, sizeof(uid));
523 ctx = gss_alloc_context();
527 gss_auth = container_of(clnt->cl_auth, struct gss_auth, rpc_auth);
528 p = gss_fill_context(p, end, ctx, gss_auth->mech);
534 spin_lock(&inode->i_lock);
535 gss_msg = __gss_find_upcall(gss_auth, uid);
537 if (err == 0 && gss_msg->ctx == NULL)
538 gss_msg->ctx = gss_get_ctx(ctx);
539 gss_msg->msg.errno = err;
540 __gss_unhash_msg(gss_msg);
541 spin_unlock(&inode->i_lock);
542 gss_release_msg(gss_msg);
544 struct auth_cred acred = { .uid = uid };
545 spin_unlock(&inode->i_lock);
546 cred = rpcauth_lookup_credcache(clnt->cl_auth, &acred, RPCAUTH_LOOKUP_NEW);
551 gss_cred_set_ctx(cred, gss_get_ctx(ctx));
555 dprintk("RPC: gss_pipe_downcall returning length %Zu\n", mlen);
562 dprintk("RPC: gss_pipe_downcall returning %d\n", err);
567 gss_pipe_release(struct inode *inode)
569 struct rpc_inode *rpci = RPC_I(inode);
570 struct rpc_clnt *clnt;
571 struct rpc_auth *auth;
572 struct gss_auth *gss_auth;
574 clnt = rpci->private;
575 auth = clnt->cl_auth;
576 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
577 spin_lock(&inode->i_lock);
578 while (!list_empty(&gss_auth->upcalls)) {
579 struct gss_upcall_msg *gss_msg;
581 gss_msg = list_entry(gss_auth->upcalls.next,
582 struct gss_upcall_msg, list);
583 gss_msg->msg.errno = -EPIPE;
584 atomic_inc(&gss_msg->count);
585 __gss_unhash_msg(gss_msg);
586 spin_unlock(&inode->i_lock);
587 gss_release_msg(gss_msg);
588 spin_lock(&inode->i_lock);
590 spin_unlock(&inode->i_lock);
594 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
596 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
597 static unsigned long ratelimit;
599 if (msg->errno < 0) {
600 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
602 atomic_inc(&gss_msg->count);
603 gss_unhash_msg(gss_msg);
604 if (msg->errno == -ETIMEDOUT) {
605 unsigned long now = jiffies;
606 if (time_after(now, ratelimit)) {
607 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
608 "Please check user daemon is running!\n");
609 ratelimit = now + 15*HZ;
612 gss_release_msg(gss_msg);
617 * NOTE: we have the opportunity to use different
618 * parameters based on the input flavor (which must be a pseudoflavor)
620 static struct rpc_auth *
621 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
623 struct gss_auth *gss_auth;
624 struct rpc_auth * auth;
625 int err = -ENOMEM; /* XXX? */
627 dprintk("RPC: creating GSS authenticator for client %p\n", clnt);
629 if (!try_module_get(THIS_MODULE))
631 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
633 gss_auth->client = clnt;
635 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
636 if (!gss_auth->mech) {
637 printk(KERN_WARNING "%s: Pseudoflavor %d not found!",
638 __FUNCTION__, flavor);
641 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
642 if (gss_auth->service == 0)
644 INIT_LIST_HEAD(&gss_auth->upcalls);
645 auth = &gss_auth->rpc_auth;
646 auth->au_cslack = GSS_CRED_SLACK >> 2;
647 auth->au_rslack = GSS_VERF_SLACK >> 2;
648 auth->au_ops = &authgss_ops;
649 auth->au_flavor = flavor;
650 atomic_set(&auth->au_count, 1);
652 err = rpcauth_init_credcache(auth, GSS_CRED_EXPIRE);
656 gss_auth->dentry = rpc_mkpipe(clnt->cl_dentry, gss_auth->mech->gm_name,
657 clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
658 if (IS_ERR(gss_auth->dentry)) {
659 err = PTR_ERR(gss_auth->dentry);
665 gss_mech_put(gss_auth->mech);
669 module_put(THIS_MODULE);
674 gss_destroy(struct rpc_auth *auth)
676 struct gss_auth *gss_auth;
678 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
679 auth, auth->au_flavor);
681 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
682 rpc_unlink(gss_auth->dentry);
683 gss_auth->dentry = NULL;
684 gss_mech_put(gss_auth->mech);
686 rpcauth_free_credcache(auth);
688 module_put(THIS_MODULE);
691 /* gss_destroy_cred (and gss_destroy_ctx) are used to clean up after failure
692 * to create a new cred or context, so they check that things have been
693 * allocated before freeing them. */
695 gss_destroy_ctx(struct gss_cl_ctx *ctx)
697 dprintk("RPC: gss_destroy_ctx\n");
700 gss_delete_sec_context(&ctx->gc_gss_ctx);
702 kfree(ctx->gc_wire_ctx.data);
707 gss_destroy_cred(struct rpc_cred *rc)
709 struct gss_cred *cred = container_of(rc, struct gss_cred, gc_base);
711 dprintk("RPC: gss_destroy_cred \n");
714 gss_put_ctx(cred->gc_ctx);
719 * Lookup RPCSEC_GSS cred for the current process
721 static struct rpc_cred *
722 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
724 return rpcauth_lookup_credcache(auth, acred, flags);
727 static struct rpc_cred *
728 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
730 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
731 struct gss_cred *cred = NULL;
734 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
735 acred->uid, auth->au_flavor);
737 if (!(cred = kzalloc(sizeof(*cred), GFP_KERNEL)))
740 atomic_set(&cred->gc_count, 1);
741 cred->gc_uid = acred->uid;
743 * Note: in order to force a call to call_refresh(), we deliberately
744 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
747 cred->gc_base.cr_auth = auth;
748 cred->gc_base.cr_ops = &gss_credops;
749 cred->gc_base.cr_flags = RPCAUTH_CRED_NEW;
750 cred->gc_service = gss_auth->service;
751 return &cred->gc_base;
754 dprintk("RPC: gss_create_cred failed with error %d\n", err);
759 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
761 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
762 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
766 err = gss_create_upcall(gss_auth, gss_cred);
767 } while (err == -EAGAIN);
772 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
774 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
777 * If the searchflags have set RPCAUTH_LOOKUP_NEW, then
778 * we don't really care if the credential has expired or not,
779 * since the caller should be prepared to reinitialise it.
781 if ((flags & RPCAUTH_LOOKUP_NEW) && (rc->cr_flags & RPCAUTH_CRED_NEW))
783 /* Don't match with creds that have expired. */
784 if (gss_cred->gc_ctx && time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
787 return (rc->cr_uid == acred->uid);
791 * Marshal credentials.
792 * Maybe we should keep a cached credential for performance reasons.
795 gss_marshal(struct rpc_task *task, __be32 *p)
797 struct rpc_cred *cred = task->tk_msg.rpc_cred;
798 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
800 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
802 struct rpc_rqst *req = task->tk_rqstp;
804 struct xdr_netobj mic;
806 struct xdr_buf verf_buf;
808 dprintk("RPC: %5u gss_marshal\n", task->tk_pid);
810 *p++ = htonl(RPC_AUTH_GSS);
813 spin_lock(&ctx->gc_seq_lock);
814 req->rq_seqno = ctx->gc_seq++;
815 spin_unlock(&ctx->gc_seq_lock);
817 *p++ = htonl((u32) RPC_GSS_VERSION);
818 *p++ = htonl((u32) ctx->gc_proc);
819 *p++ = htonl((u32) req->rq_seqno);
820 *p++ = htonl((u32) gss_cred->gc_service);
821 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
822 *cred_len = htonl((p - (cred_len + 1)) << 2);
824 /* We compute the checksum for the verifier over the xdr-encoded bytes
825 * starting with the xid and ending at the end of the credential: */
826 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
827 req->rq_snd_buf.head[0].iov_base);
828 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
829 xdr_buf_from_iov(&iov, &verf_buf);
831 /* set verifier flavor*/
832 *p++ = htonl(RPC_AUTH_GSS);
834 mic.data = (u8 *)(p + 1);
835 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
836 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
837 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
838 } else if (maj_stat != 0) {
839 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
842 p = xdr_encode_opaque(p, NULL, mic.len);
851 * Refresh credentials. XXX - finish
854 gss_refresh(struct rpc_task *task)
857 if (!gss_cred_is_uptodate_ctx(task->tk_msg.rpc_cred))
858 return gss_refresh_upcall(task);
863 gss_validate(struct rpc_task *task, __be32 *p)
865 struct rpc_cred *cred = task->tk_msg.rpc_cred;
866 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
869 struct xdr_buf verf_buf;
870 struct xdr_netobj mic;
874 dprintk("RPC: %5u gss_validate\n", task->tk_pid);
877 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
879 if (flav != RPC_AUTH_GSS)
881 seq = htonl(task->tk_rqstp->rq_seqno);
883 iov.iov_len = sizeof(seq);
884 xdr_buf_from_iov(&iov, &verf_buf);
888 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
889 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
890 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
893 /* We leave it to unwrap to calculate au_rslack. For now we just
894 * calculate the length of the verifier: */
895 task->tk_auth->au_verfsize = XDR_QUADLEN(len) + 2;
897 dprintk("RPC: %5u gss_validate: gss_verify_mic succeeded.\n",
899 return p + XDR_QUADLEN(len);
902 dprintk("RPC: %5u gss_validate failed.\n", task->tk_pid);
907 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
908 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
910 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
911 struct xdr_buf integ_buf;
912 __be32 *integ_len = NULL;
913 struct xdr_netobj mic;
921 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
922 *p++ = htonl(rqstp->rq_seqno);
924 status = encode(rqstp, p, obj);
928 if (xdr_buf_subsegment(snd_buf, &integ_buf,
929 offset, snd_buf->len - offset))
931 *integ_len = htonl(integ_buf.len);
933 /* guess whether we're in the head or the tail: */
934 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
938 p = iov->iov_base + iov->iov_len;
939 mic.data = (u8 *)(p + 1);
941 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
942 status = -EIO; /* XXX? */
943 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
944 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
947 q = xdr_encode_opaque(p, NULL, mic.len);
949 offset = (u8 *)q - (u8 *)p;
950 iov->iov_len += offset;
951 snd_buf->len += offset;
956 priv_release_snd_buf(struct rpc_rqst *rqstp)
960 for (i=0; i < rqstp->rq_enc_pages_num; i++)
961 __free_page(rqstp->rq_enc_pages[i]);
962 kfree(rqstp->rq_enc_pages);
966 alloc_enc_pages(struct rpc_rqst *rqstp)
968 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
971 if (snd_buf->page_len == 0) {
972 rqstp->rq_enc_pages_num = 0;
976 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
977 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
978 rqstp->rq_enc_pages_num = last - first + 1 + 1;
980 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
982 if (!rqstp->rq_enc_pages)
984 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
985 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
986 if (rqstp->rq_enc_pages[i] == NULL)
989 rqstp->rq_release_snd_buf = priv_release_snd_buf;
992 for (i--; i >= 0; i--) {
993 __free_page(rqstp->rq_enc_pages[i]);
1000 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1001 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
1003 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1008 struct page **inpages;
1015 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1016 *p++ = htonl(rqstp->rq_seqno);
1018 status = encode(rqstp, p, obj);
1022 status = alloc_enc_pages(rqstp);
1025 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1026 inpages = snd_buf->pages + first;
1027 snd_buf->pages = rqstp->rq_enc_pages;
1028 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1029 /* Give the tail its own page, in case we need extra space in the
1030 * head when wrapping: */
1031 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1032 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1033 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1034 snd_buf->tail[0].iov_base = tmp;
1036 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1037 /* RPC_SLACK_SPACE should prevent this ever happening: */
1038 BUG_ON(snd_buf->len > snd_buf->buflen);
1040 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1041 * done anyway, so it's safe to put the request on the wire: */
1042 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1043 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1047 *opaque_len = htonl(snd_buf->len - offset);
1048 /* guess whether we're in the head or the tail: */
1049 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1050 iov = snd_buf->tail;
1052 iov = snd_buf->head;
1053 p = iov->iov_base + iov->iov_len;
1054 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1056 iov->iov_len += pad;
1057 snd_buf->len += pad;
1063 gss_wrap_req(struct rpc_task *task,
1064 kxdrproc_t encode, void *rqstp, __be32 *p, void *obj)
1066 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1067 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1069 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1072 dprintk("RPC: %5u gss_wrap_req\n", task->tk_pid);
1073 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1074 /* The spec seems a little ambiguous here, but I think that not
1075 * wrapping context destruction requests makes the most sense.
1077 status = encode(rqstp, p, obj);
1080 switch (gss_cred->gc_service) {
1081 case RPC_GSS_SVC_NONE:
1082 status = encode(rqstp, p, obj);
1084 case RPC_GSS_SVC_INTEGRITY:
1085 status = gss_wrap_req_integ(cred, ctx, encode,
1088 case RPC_GSS_SVC_PRIVACY:
1089 status = gss_wrap_req_priv(cred, ctx, encode,
1095 dprintk("RPC: %5u gss_wrap_req returning %d\n", task->tk_pid, status);
1100 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1101 struct rpc_rqst *rqstp, __be32 **p)
1103 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1104 struct xdr_buf integ_buf;
1105 struct xdr_netobj mic;
1106 u32 data_offset, mic_offset;
1111 integ_len = ntohl(*(*p)++);
1114 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1115 mic_offset = integ_len + data_offset;
1116 if (mic_offset > rcv_buf->len)
1118 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1121 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1122 mic_offset - data_offset))
1125 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1128 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1129 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1130 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1131 if (maj_stat != GSS_S_COMPLETE)
1137 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1138 struct rpc_rqst *rqstp, __be32 **p)
1140 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1146 opaque_len = ntohl(*(*p)++);
1147 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1148 if (offset + opaque_len > rcv_buf->len)
1150 /* remove padding: */
1151 rcv_buf->len = offset + opaque_len;
1153 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1154 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1155 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1156 if (maj_stat != GSS_S_COMPLETE)
1158 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1166 gss_unwrap_resp(struct rpc_task *task,
1167 kxdrproc_t decode, void *rqstp, __be32 *p, void *obj)
1169 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1170 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1172 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1174 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1175 int savedlen = head->iov_len;
1178 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1180 switch (gss_cred->gc_service) {
1181 case RPC_GSS_SVC_NONE:
1183 case RPC_GSS_SVC_INTEGRITY:
1184 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1188 case RPC_GSS_SVC_PRIVACY:
1189 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1194 /* take into account extra slack for integrity and privacy cases: */
1195 task->tk_auth->au_rslack = task->tk_auth->au_verfsize + (p - savedp)
1196 + (savedlen - head->iov_len);
1198 status = decode(rqstp, p, obj);
1201 dprintk("RPC: %5u gss_unwrap_resp returning %d\n", task->tk_pid,
1206 static struct rpc_authops authgss_ops = {
1207 .owner = THIS_MODULE,
1208 .au_flavor = RPC_AUTH_GSS,
1210 .au_name = "RPCSEC_GSS",
1212 .create = gss_create,
1213 .destroy = gss_destroy,
1214 .lookup_cred = gss_lookup_cred,
1215 .crcreate = gss_create_cred
1218 static struct rpc_credops gss_credops = {
1219 .cr_name = "AUTH_GSS",
1220 .crdestroy = gss_destroy_cred,
1221 .cr_init = gss_cred_init,
1222 .crmatch = gss_match,
1223 .crmarshal = gss_marshal,
1224 .crrefresh = gss_refresh,
1225 .crvalidate = gss_validate,
1226 .crwrap_req = gss_wrap_req,
1227 .crunwrap_resp = gss_unwrap_resp,
1230 static struct rpc_pipe_ops gss_upcall_ops = {
1231 .upcall = gss_pipe_upcall,
1232 .downcall = gss_pipe_downcall,
1233 .destroy_msg = gss_pipe_destroy_msg,
1234 .release_pipe = gss_pipe_release,
1238 * Initialize RPCSEC_GSS module
1240 static int __init init_rpcsec_gss(void)
1244 err = rpcauth_register(&authgss_ops);
1247 err = gss_svc_init();
1249 goto out_unregister;
1252 rpcauth_unregister(&authgss_ops);
1257 static void __exit exit_rpcsec_gss(void)
1260 rpcauth_unregister(&authgss_ops);
1263 MODULE_LICENSE("GPL");
1264 module_init(init_rpcsec_gss)
1265 module_exit(exit_rpcsec_gss)